[dehyph-exptl] Aktualisiere Dokumentation.
[wortliste.git] / dehyph-exptl / INSTALL
blobdf63af6d2c130bc1052389069c5b8c4deca29f4b
1 For English installation instructions, see end of this file.
4 **************
5 **  German  **
6 **************
7 Es folgen Installationshinweise für die experimentellen
8 deutschen Trennmuster.  Die Installation der Trennmuster für die
9 traditionelle Rechtschreibung des in der Schweiz gebräuchlichen
10 Standarddeutschs wird nicht ausdrücklich erwähnt, kann aber
11 analog erfolgen.  TeX benötigt dann jedoch zusätzlichen
12 Speicherplatz für die Trennmuster.
14 Die folgenden Installationswege werden beschrieben:
16 1. teilautomatisierte Installation in MiKTeX mit Hilfe der
17     Paketverwaltung,
18 2. manuelle Installation in MiKTeX mit graphischer Oberfläche,
19 3. manuelle Installation in MiKTeX auf der Kommandozeile,
20 4. manuelle Installation in TeX Live auf der Kommandozeile.
22 Nachfolgend ist <datum> jeweils durch die ISO-Notation des
23 Datums der Trennmusterdateien zu ersetzen (JJJJ-MM-TT).
26 *************************************************
27 **  Teilautomatisierte Installation in MiKTeX  **
28 **  mit Paketverwaltung                        **
29 *************************************************
30 Das Paket ist zunächst mit der Paketverwaltung
31 "Browse Packages" zu installieren.  Danach ist Schritt C der
32 manuellen Installation in MiKTeX mit graphischer Oberfläche
33 zu befolgen (siehe nächster Abschnitt).
36 ***************************************
37 **  Manuelle Installation in MiKTeX  **
38 **  mit graphischer Oberfläche       **
39 ***************************************
40 Die Installation der experimentellen Trennmuster erfordert
41 drei Schritte:
43 A. Die Trennmuster- und Wrapperdateien sollten in die
44    folgenden Verzeichnisse innerhalb eines lokalen
45    TEXMF-Baums kopiert werden:
47       tex\generic\dehyph-exptl\dehyphn-x-<datum>.pat
48       tex\generic\dehyph-exptl\dehyphn-x-<datum>.tex
49       tex\generic\dehyph-exptl\dehypht-x-<datum>.pat
50       tex\generic\dehyph-exptl\dehypht-x-<datum>.tex
52   Die verbleibenden Dateien können in das Verzeichnis
54       doc\generic\dehyph-exptl\
56   kopiert werden.
59 B. Aktualisieren der File Name Database:
61     Programm 'Settings'
62       -->  Reiter 'General'
63         -->  Knopf 'Refresh FNDB'
66 C. Anlegen der Sprachen und Erstellen der Formatdateien:
68     Programm 'Settings'
69       -->  Reiter 'Languages'
70         -->  Knopf 'New'
71           -->  Feld 'Language Name' : german-x-<datum>
72           -->  Feld 'Synonyms' : german-x-latest
73           -->  Feld 'Hyphenation File' : <texmfbaum>\tex\generic\dehyph-exptl\dehypht-x-<datum>.tex
74           -->  Box 'Load the hyphenation file' : aktiv
75           -->  Knopf 'OK'
76         -->  Knopf 'New'
77           -->  Feld 'Language Name' : ngerman-x-<datum>
78           -->  Feld 'Synonyms' : ngerman-x-latest
79           -->  Feld 'Hyphenation File' : <texmfbaum>\tex\generic\dehyph-exptl\dehyphn-x-<datum>.tex
80           -->  Box 'Load the hyphenation file' : aktiv
81           -->  Knopf 'OK'
82         Vorhandene Synonyme [n]german-x-latest anderer Sprachen
83           sind gegebenenfalls zu entfernen.
84         -->  Knopf 'Ok'
85       -->  Meldung 'To apply the new settings, it is necessary to rebuild the format files.'
86         -->  Knopf 'OK'
88      Wenn der letzte Schritt mit der Meldung
90        >TeX capacity exceeded, sorry [pattern memory=XXX]
92      oder
94        >TEX capacity exceeded, sorry [pattern memory ops=XXX]
96      fehlschlägt, so müssen Sie andere Sprachen deaktivieren
97      oder die Parameter trie_size und trie_op_size anpassen.
98      Bitte lesen Sie dazu die Dokumentation Ihrer
99      TeX-Verteilung oder fragen Sie jemanden, der das Problem
100      lösen kann.
103 ***************************************
104 **  Manuelle Installation in MiKTeX  **
105 **  auf der Kommandozeile            **
106 ***************************************
107 Achtung: Die manuelle Installation in MiKTeX wird nicht
108 empfohlen, da die Datei language.dat in der Regel automatisch
109 verwaltet wird, hier jedoch von Hand Änderungen vorgenommen
110 werden.  Es kann daher bei späteren (unabhängigen) Updates zu
111 Problemen kommen!
113 Die manuelle Installation der experimentellen Trennmuster
114 erfordert vier Schritte:
116 A. siehe Schritt A im Abschnitt "Manuelle Installation in
117    MiKTeX mit graphischer Oberfläche".
120 B. Anlegen der Sprachen:
122   1. Ermitteln des Pfades der Datei language.dat:
124       >findtexmf language.dat
126      Falls das Ergebnis des obigen Kommandos ein Pfad zu einem
127      lokalen TEXMF-Baum ist, existiert bereits eine lokale
128      Kopie der Datei language.dat.  Springe zu Punkt B.3.
130   2. Eine lokale Kopie von language.dat existiert bisher nicht.
131      Kopiere die Datei aus dem in Schritt B.1 erhaltenen Pfad
132      in einen lokalen TEXMF-Baum, zum Beispiel nach
134        C:\Dokumente und Einstellungen\All Users\Anwendungsdaten\MiKTeX\2.7\tex\generic\config\language.dat
136   3. Öffne die Datei language.dat aus dem lokalen TEXMF-Baum in
137      einem Editor.
139   4. Falls vorhanden, entferne Zeilen
141   =german-x-latest
142   =ngerman-x-latest
144   5. Füge am Ende der Datei die folgenden Zeilen hinzu:
146   german-x-<datum> dehypht-x-<datum>.tex
147   =german-x-latest
148   ngerman-x-<datum> dehyphn-x-<datum>.tex
149   =ngerman-x-latest
151   6. Datei language.dat speichern und schließen.
154 C. Aktualisieren der File Name Database:
156     Kommando
158       >initexmf --update-fndb
160     aufrufen.
163 D. Anlegen der Formatdateien:
165     Kommando
167       >initexmf --dump
169     aufrufen.
171     Wenn dieses Kommando mit der Meldung
173       >TeX capacity exceeded, sorry [pattern memory=XXX]
175     oder
177       >TEX capacity exceeded, sorry [pattern memory ops=XXX]
179     fehlschlägt, so müssen Sie andere Sprachen in der Datei
180     language.dat deaktivieren oder die Parameter trie_size
181     und trie_op_size anpassen.  Bitte lesen Sie dazu die
182     Dokumentation Ihrer TeX-Verteilung oder fragen Sie
183     jemanden, der das Problem lösen kann.
186 *****************************************
187 **  Manuelle Installation in TeX Live  **
188 **  auf der Kommandozeile              **
189 *****************************************
190 Achtung: Die manuelle Installation in TeX Live wird nicht
191 empfohlen, da die Datei language.dat in der Regel automatisch
192 verwaltet wird, hier jedoch von Hand Änderungen vorgenommen
193 werden.  Es kann daher bei späteren (unabhängigen) Updates zu
194 Problemen kommen!
196 In TeX Live ist dieses Paket bereits vorinstalliert und
197 ohne weitere Vorkehrungen nutzbar.
199 Die Installation der experimentellen Trennmuster erfordert
200 vier Schritte:
202 A. Die Trennmuster- und Wrapperdateien sollten in die
203    folgenden Verzeichnisse innerhalb eines lokalen
204    TEXMF-Baums kopiert werden:
206       tex/generic/dehyph-exptl/dehyphn-x-<datum>.pat
207       tex/generic/dehyph-exptl/dehyphn-x-<datum>.tex
208       tex/generic/dehyph-exptl/dehypht-x-<datum>.pat
209       tex/generic/dehyph-exptl/dehypht-x-<datum>.tex
211   Die verbleibenden Dateien können in das Verzeichnis
213       doc/generic/dehyph-exptl/
215   kopiert werden.
218 B. Anlegen der Sprachen:
220   1. Ermitteln des Pfades der Datei language.dat:
222       >kpsewhich language.dat
224      Falls das Ergebnis des obigen Kommandos ein Pfad zu einem
225      lokalen TEXMF-Baum ist, existiert bereits eine lokale
226      Kopie der Datei language.dat.  Springe zu Punkt B.3.
228   2. Eine lokale Kopie von language.dat existiert bisher nicht.
229      Kopiere die Datei aus dem in Schritt B.1 erhaltenen Pfad
230      in einen lokalen TEXMF-Baum, zum Beispiel nach
232        <TeXLiveWurzel>/texmf-local/tex/generic/config/language.dat
234   3. Öffne die Datei language.dat aus dem lokalen TEXMF-Baum in
235      einem Editor.
237   4. Falls vorhanden, entferne Zeilen
239   =german-x-latest
240   =ngerman-x-latest
242   5. Füge am Ende der Datei die folgenden Zeilen hinzu:
244   german-x-<datum> dehypht-x-<datum>.tex
245   =german-x-latest
246   ngerman-x-<datum> dehyphn-x-<datum>.tex
247   =ngerman-x-latest
249   6. Datei language.dat speichern und schließen.
252 C. Aktualisieren der File Name Database:
254     Kommando
256       >mktexlsr
258     aufrufen.
261 D. Anlegen der Formatdateien:
263     Kommando
265       >fmtutil --refresh
267     aufrufen.
269     Wenn dieses Kommando mit der Meldung
271       >TeX capacity exceeded, sorry [pattern memory=XXX]
273     oder
275       >TEX capacity exceeded, sorry [pattern memory ops=XXX]
277     fehlschlägt, so müssen Sie andere Sprachen in der Datei
278     language.dat deaktivieren oder die Parameter trie_size
279     und trie_op_size in der Datei texmf.cnf anpassen.  Bitte
280     lesen Sie dazu die Dokumentation Ihrer TeX-Verteilung oder
281     fragen Sie jemanden, der das Problem lösen kann.
284 ******************************************************
285 **  English installation instructions for TeX Live  **
286 ******************************************************
287 The following installation instructions don't mention
288 hyphenation patterns for traditional orthography of Standard
289 German as used in Switzerland explicitly.  However,
290 installation is analogous to the discussed patterns.  Be
291 warned, that installing all patterns might cause memory
292 problems for TeX.
294 Note, in the remaining text <date> refers to the pattern file
295 date in ISO notation (YYYY-MM-DD)!
297 Installation of the dehyph-exptl package requires four steps:
299 A. Copy pattern and wrapper files to the following location
300    within a local texmf tree:
302       tex/generic/dehyph-exptl/dehyphn-x-<date>.pat
303       tex/generic/dehyph-exptl/dehyphn-x-<date>.tex
304       tex/generic/dehyph-exptl/dehypht-x-<date>.pat
305       tex/generic/dehyph-exptl/dehypht-x-<date>.tex
307    The remaining files can be copied to
309       doc/generic/dehyph-exptl/
312 B. Modify file language.dat:
314   1. Determine the location of language.dat:
316       >kpsewhich language.dat
318      If the resulting path already points to a local tree,
319      jump right to step B.3.
321   2. A local copy of language.dat doesn't exist, yet.  Copy the
322      file that was output in step B.1 to a local texmf tree,
323      e.g.,
325        <TeXLiveRoot>/texmf-local/tex/generic/config/language.dat
327   3. Open language.dat from the local texmf tree into an
328      editor.
330   4. If existent, remove the following lines
332   =german-x-latest
333   =ngerman-x-latest
335   5. Add the following lines to the end of language.dat:
337   german-x-<date> dehypht-x-<date>.tex
338   =german-x-latest
339   ngerman-x-<date> dehyphn-x-<date>.tex
340   =ngerman-x-latest
342   6. Save file language.dat and close the editor.
345 C. Refresh file name database:
347     Execute command
349       >mktexlsr
352 D. Rebuild format files:
354     Execute command
356       >fmtutil --refresh
358     In case this command fails with error message
360       >TeX capacity exceeded, sorry [pattern memory=XXX]
362     or
364       >TEX capacity exceeded, sorry [pattern memory ops=XXX]
366     some languages have to be deactivated in language.dat or
367     parameters trie_size and trie_op_size have to be enlarged
368     (probably in file texmf.cnf).  Please refer to the
369     documentation of your TeX distribution or ask a TeX wizard.
372 END.