[Trennmuster] Dokumentation der Trennmuster

[Keno Wehr]

Am 26.02.2018 um 11:12 schrieb Werner LEMBERG:
>>> Die Einführung von einbuchstabigen Trennstellen steht ja bereits
>>> auf unserer Todo-Liste...
>> Ist diese Liste irgendwo veröffentlicht?
> Nein :-)  Folgendes fällt mir grade so ein.
>
> (1) Konversion ins neue Fünf-Spalten-Format, um das Einpflegen von
>      neuen Wörtern deutlich zu vereinfachen.  Günter und ich haben da
>      schon einiges geleistet; ich will da jetzt bald dran
>      weiterarbeiten.
>
> (2) Silbentrennung nach Sprechsilben.  Das ist ein sehr großes
>      Projekt.
>
> (3) Mehr Wörter.
>
> (4) Eine Erweiterung von (1), um automatisch Wortdeklinationen und
>      -konjugationen zu erzeugen, was eine deutliche Reduktion an
>      Einträgen bringen würde.
>
> (5) Wichtung der ungünstigen Trennstellen.  Derzeit haben wir nur ».«;
>      wir wollen »..« und »...« ergänzen, wie in der README-Datei
>      beschrieben.
>     

Aus meiner Sicht auch und vor allem wichtig:

(6) Verbesserung der Dokumentation

Das betrifft allerdings nicht nur das deutsche Trennmusterprojekt, 
sondern die TeX-Trennmuster im Allgemeinen.
Die Informationen hierüber sind fragmentiert, lückenhaft, schwer 
aufzufinden und teilweise veraltet.

Nehmen wir an, ein deutschsprachiger LaTeX-Nutzer will sich über 
Prinzipien informieren, denen die deutschen Trennmuster folgen 
(schließlich erlaubt gerade die neue Rechtschreibung zahlreiche 
Varianten) oder einfach einen Trennfehler melden.

Der durchschnittlich informierte Nutzer weiß sicherlich, dass die 
Trennmuster durch das Sprachpaket babel geladen werden. Mit dem Befehl 
„texdoc babel“ erhält er die Anleitung zu diesem Paket. In dieser stehen 
zwar ein paar allgemeine Sätze zu Trennmustern und es gibt eine Liste 
der unterstützten Sprachen. Konkrete Informationen zu den Trennmustern 
der einzelnen Sprachen gibt es aber nicht, noch nicht einmal Links oder 
Literaturhinweise, die weiterführen würden.

Da babel separate Anleitungen für die einzelnen Sprachen (genauer gesagt 
für die LDF-Dateien) anbietet, könnte unser Nutzer als nächstes „texdoc 
babel-german“ eingeben. Die dann auftauchende Anleitung enthält zwar 
ausführliche Informationen zur Babel-Unterstützung für die deutsche 
Sprache in alter Rechtschreibung, begnügt sich aber bei den Trennmustern 
mit dem Hinweis, dass passende geladen werden. Wieder findet sich kein 
Literaturhinweis und kein Ansprechpartner in puncto Trennmuster.

Falls der Nutzer die neue Rechtschreibung bevorzugt, erlebt er als 
nächstes eine Enttäuschung mit „texdoc babel-ngerman“; hier kann kein 
Dokument gefunden werden. Er müsste schon „texdoc -l babel-german“ 
eingeben und dann die 2 wählen oder gar „texdoc ngermanb“ (wer würde 
darauf kommen?) tippen. Wahrscheinlicher ist da, dass er auf dem CTAN 
nach Babel-Sprachmodulen sucht. Dann findet er zwar im Paket 
„babel-german“ auch die Anleitung für die neue Rechtschreibung, stellt 
aber fest, dass diese im Wesentlichen durch Copy-and-Paste aus der für 
die alte Rechtschreibung entstanden ist und zu Trennmustern genauso 
wenig Informationen bietet.

Wo er schon mal auf dem CTAN ist und das Paket babel-german aufgerufen 
hat, klickt er vielleicht noch auf das von dort verlinkte Thema 
„Deutsch“ (CTAN-Themen-Kürzel german). Dort findet er drei Pakete, die 
mit Silbentrennung zu tun haben, „ghyphen“, „gnhyph“ und „dehyph-exptl“. 
Die beiden erstgenannten „Pakete“ bestehen jeweils nur aus einer 
einzigen Datei, die vor und nach dem Code immerhin Ansätze von 
Dokumentation enthält:

Das Paket ghyphen weist darauf hin, dass Trennungen mit Umlauten und ß 
möglich sind, dagegen keine Trennungen von ck und Dreifachkonsonanten. 
Als Ansprechpartner für Fehlermeldungen wird die Dante genannt. Die 
Herkunft der Muster wird nicht genannt. Ebensowenig wird erwähnt, dass 
die Muster dieses Pakets als veraltet gelten können und standardmäßig 
nur bei Verwendung von pdfTeX geladen werden.

Das Paket gnhyph weist einen Betreuer aus und erklärt, dass die Muster 
durch manuelle Überarbeitung aus den alten entstanden sind. Es erwähnt, 
dass einbuchstabige Trennungen ausgeschlossen blieben und etymologische 
Trennung Vorrang vor Sprechsilben hat. Dies wird am Beispiel 
lateinischer Fremdwörter mit „str“ verdeutlicht. Auch hier findet sich 
kein Hinweis darauf, dass die Muster als veraltet betrachtet werden 
müssen und von neueren TeX-Compilern in Verbindung mit Babel nicht 
verwendet werden.

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.“ 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. 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. Ruft er die Code-Dateien der 
deutschen Trennmuster auf, findet er darin versteckt einen Link zur 
Wortliste.

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, 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. (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.

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

Gruß
Keno Wehr