[Trennmuster] Dokumentation der Trennmuster

[Stephan Hennig]

Am 04.03.2018 um 22:18 schrieb Keno Wehr:

> (6) Verbesserung der Dokumentation
> 
> [babel]
> [babel-german]
> [ngermanb]
> [ghyphen]
> [gnhyph]

Für Archäologen finden sich in einigen älteren Ausgaben der DTK noch
Artikel mit Ankündigen und Hinweisen zu damaligen Trennmustern.


> Dann ist da schließlich noch „dehyph-exptl“. Hier fällt gleich positiv 
> auf, dass es eine richtige Paketanleitung im PDF-Format gibt und die 
> Dokumentation nicht erst mühsam aus den Codezeilen herausgefischt werden 
> muss. Doch gleich die Titelseite enthält einen Fallstrick für unseren in 
> Sachen Trennmustern noch unerfahrenen Nutzer: „Dieses Paket richtet sich 
> ausschließlich an Nutzer der Programme TeX und pdfTeX.“

Was die damalige Intention dokumentiert.  Die mit TeX und pdfTeX per
Voreinstellung verwendeten Muster sind jedoch fix, weshalb unsere Muster
in Form eines Zusatzpakets angeboten werden.

Dass die Muster in LuaTeX und XeTeX automatisch zur Verfügung stehen,
liegt nicht an uns, sondern daran, dass die Maintainer von hyph-utf8 die
Gelegenheit ergriffen haben, statt der herkömmlichen Muster in den
neueren TeX-Engines gleich unsere Muster zu aktivieren.  Soweit zum
Grund, dass wir bisher abseits von dehyph-exptl keine weitere
Dokumentation der Muster für die Verwendung mit TeX geschaffen haben.


> Falls es sich 
> nun um einen Xe- oder LuaTeX-Nutzer handelt, wird er sich möglicherweise 
> denken: „Diese Anleitung brauche ich mir gar nicht erst anzusehen. Sie 
> ist für mich nicht relevant.“ Dabei enthält sie sehr wahrscheinlich 
> genau die Informationen, die er sucht. Da auch gleich ein Hinweis auf 
> das Paket „hyph-utf8“ auf der Titelseite steht, macht er sich also 
> erneut auf die Suche.
> 
> Die Eingabe „texdoc hyph-utf8“ führt auf ein spanischsprachiges 
> Dokument, das er nicht versteht. Entscheidet er sich nach „texdoc -l 
> hyph-utf8“ für die 5, erhält er die wahre Paketanleitung.

Bitte an die tex-live-Liste melden, am besten noch vor der
Veröffentlichung von TL2018.


> Dieser ist zu 
> entnehmen, wie die experimentellen Trennmuster mit Polyglossia gewählt 
> werden können. Ein Verweis auf die Dokumentation der Muster fehlt, 
> ebenso ein Verweis auf die paketeigene Internetseite. Diese ist nur über 
> den CTAN auffindbar: tug.org/tex-hyphen
> Auf dieser Seite findet er zwar eine übersichtliche Zusammenstellung der 
> Trennmuster aller unterstützten Sprachen, jedoch keinen Verweis auf eine 
> spezifische Dokumentation derselben.

Mojca, ist die Situation in anderen Sprachen besser?  Gibt es eine
vorgesehene Schnittstelle zur Dokumentation von Mustern in hyph-utf8?
(Kenos Mail liest sich so, als ob nicht. :/)

Falls es die gibt, könnte das Kapitel "Trennregeln und Konventionen" aus
dehyph-exptl herausgelöst werden und darauf sowohl von dehyph-exptl als
auch von hyph-utf8 verwiesen werden.  (So als schnelle Idee.)


> Sieht er sich die dehyph-exptl-Anleitung doch näher an, wundert er sich 
> ein wenig, dass das Spielende bei der Trennung schlechter wegkommt als 
> die sehr seltene Wachs-Tube,

Weil das Spielende im Gegensatz zur Wachs-Tube falsch getrennt werden
kann?  Könnte man ändern.  Die Idee/Befürchtung war anfänglich, dass
durch zu viele Eingriffe die Struktur der Sprache verunstaltet wird und
Patgen keine fehlerfreien Trennmuster erstellen kann.  Bisher sind wir
an diese Grenze jedoch noch nicht gestoßen.  Andererseits sind wir auch
schon bei Patgens Bewertungslevel 8 angelangt, dem höchsten destruktiven
Level.


> findet aber ansonsten eine ausführliche und 
> nachvollziehbare Dokumentation der Trennmuster vor. Wenn er den 
> angegebenen Links folgt, findet er allerdings im Dateibereich des 
> Trennmuster-Wikis nicht die versprochenen aktuellen Versionen der 
> Trennmuster.

Ich habe seit längerem keine Zeit mehr für dieses Hobby gefunden (und
perspektivisch auch erst wieder nächsten Winter etwas mehr Freiraum).
Ich kümmere mich um den Link.


> (Die neueste dort aufgeführte Version ist von 2013 (!) und 
> der Link führt auch nicht zum gewünschten ZIP-Archiv, sondern zu einer 
> Fehlermeldung.) Auch sonst entsteht der Eindruck, dass das Wiki seit 
> Jahren vernachlässigt wird.

Wurde es wohl auch.  Falls jemand daran arbeiten möchte, schlage ich
vor, zur leichteren Orientierung Inhalte, die derzeit auf mehrere Seiten
verteilt sind, auf wenigen, längeren Seiten zusammenzufassen.


> Soviel nur, um einige Verbesserungsmöglichkeiten in puncto Dokumentation 
> deutlich zu machen.

Kann bitte jemand die Situation der Dokumentation von Mustern in
hyph-utf8 mit Mojca abklären?

Viele Grüße,
Stephan Hennig