Debian Codegraph @

texmf-dist/doc/generic/hyph-utf8/hyph-utf8.tex

raw
1 \usetypescript[antykwa-poltawskiego]
2 \setupbodyfont[antykwa-poltawskiego,10pt]
3
4 \setuphead
5 [section]
6 [style=\bfc,numberstyle=\bfc]
7 \setuphead
8 [subsection]
9 [style=\bfb,numberstyle=\bfb]
10 \setuphead
11 [subsubsection]
12 [style=\bfa,numberstyle=\bfa]
13 \setuphead
14 [title]
15 [style=\bfd]
16 \setuppagenumbering
17 [location={footer,right},style=\os]
18 \setuplayout
19 [backspace=1in,width=middle,
20 header=0pt,headerdistance=0pt,height=24.5cm]
21
22 \def\sc{\addff{smallcaps}}
23 \def\os{\addff{oldstyle}}
24
25 \def\eTeX{ε-\TeX}
26 % TODO
27 \def\XeLaTeX{Xe\LaTeX}
28 \def\LuaLaTeX{Lua\LaTeX}
29 \def\pTeX{p\TeX}
30
31 \definecolor
32 [verylightgray]
33 [s=.95]
34 \defineframedtext
35 [framedCODE]
36 [frame=off,
37 strut=yes,
38 offset=2mm,
39 width=.9\textwidth,
40 location=middle,
41 background=color,
42 backgroundcolor=verylightgray]
43 \definetyping
44 [TEX]
45 [option=TEX,
46 before={\startframedCODE},
47 after={\stopframedCODE}]
48
49 \starttext
50
51 \title{The {\tt hyph-utf8} package and hyphenation with \TeX}
52
53 \blank[big]
54
55 \startnarrower
56 {\bf Maintainers} of the {\tt hyph-utf8} package and collectors of patterns:
57 \startnarrower
58 \startitemize[packed,joinedup]
59 \item {\it Mojca Miklavec, Arthur Reutenauer}
60 \item With contributions by {\it Khaled Hosny, Manuel Pégourié-Gonnard, Élie Roux}
61 \stopitemize
62 \stopnarrower
63 \stopnarrower
64
65 \blank
66
67 \startnarrower
68 {\bf Main description}:
69 \startnarrower
70 June 2011
71 \stopnarrower
72 \stopnarrower
73
74 \startnarrower
75 {\bf Latest editorial change}:
76 \startnarrower
77 16 Mars 2018
78 \stopnarrower
79 \stopnarrower
80
81 \blank
82
83 \startnarrower
84 {\bf Abstract}:
85 \startnarrower\sl
86 In 2008 all the existing hyphenation patterns from \TeX\ distributions have
87 been collected in a single package {\tt hyph-utf8}, converted into UTF-8
88 encoding and adapted for use in different \TeX\ engines. The patterns can be
89 used directly by Unicode-aware engines such as \LuaTeX\ and \XeTeX, and there
90 is a mechanism to convert the patterns to the appropriate 8-bit encoding when
91 used with \pTeX, \pdfTeX\ or Knuth's \TeX.
92 \stopnarrower
93 \stopnarrower
94
95 \blank
96
97 \startnarrower
98 {\bf Table of Contents}:
99 \blank
100 \startnarrower
101 \setuplist[section] [width=10mm,textstyle=\bf\sc,numberstyle=\bf\os,pagestyle=\os]
102 \setuplist[subsection] [width=15mm,textstyle=normal,numberstyle=\os,pagestyle=\os]
103 \setuplist[subsubsection][distance=20mm,headnumber=no,textstyle=italic,pagestyle=\os]
104
105 \placecontent[criterium=all,alternative=c]
106 \stopnarrower
107 \stopnarrower
108
109 \page
110 \section{Using hyphenation patterns}
111
112 \subsection{Plain \TeX}
113
114 In engines that support \eTeX\ you can select the desired hyphenation patterns with:
115 \startTEX
116 \uselanguage{langname}
117 \stopTEX
118 where \type{langname} is the string identifying a particular hyphenation file in \type{language.def} (see Section \in[sec:languages]).
119
120 \subsection{\LaTeX}
121
122 \subsubsection{\LaTeX\ with Babel}
123
124 You can switch the language in \LaTeX\ with:
125
126 \startTEX
127 \usepackage[languagename]{babel}
128 \stopTEX
129
130 In 8-bit engines you also need to make sure that you load the proper font encoding which supports all the characters used in the language of your choice, for example:
131 \startTEX
132 \usepackage[T1]{fontenc}
133 \stopTEX
134 % TODO: reference to encoding list
135
136 {\it N.B.:}\/ You can use Babel with any \TeX\ engine, however it has never been properly adapted to work well with Unicode engines. If you are using \XeTeX\ it is advisable to use Polyglossia instead.
137
138
139 \subsubsection{\LaTeX\ with Polyglossia}
140
141 Polyglossia should be the preferred choice when using \XeLaTeX. It doesn't support \LuaLaTeX\ yet, but it is planned to extend it in future.
142
143 \startTEX
144 \usepackage{polyglossia}
145 \setmainlanguage[optional settings]{langname}
146 \setotherlanguages{otherlangname}
147
148 \begin[optional settings]{otherlangname} ... \end{otherlangname}
149 \stopTEX
150
151 See Polyglossia manual for extensive list of options.
152
153 \subsubsection{Low-level commands}
154
155 Since Babel's \type{hyphen.cfg} is built into the \LaTeX\ format, hyphenation patterns can be used without even loading Babel or Polyglossia. At the low-level this simply corresponds to defining
156 \startTEX
157 \language=\l@<langname>
158 \stopTEX
159 The user command is supposed to be
160 \startTEX
161 \hyphenrules{langname}
162 \stopTEX
163 or
164 \startTEX
165 \begin{hyphenrules}{langname} ... \end{hyphenrules}.
166 \stopTEX
167 and {\it should}\/ work with any flavour of \LaTeX, however we couldn't make it work.
168
169 \subsection{\ConTeXt}
170
171 \ConTeXt\ doesn't load patterns for all the language that {\tt hyph-utf8} provides. If you miss any language, please contact the mailing list. The general syntax for supported languages is the following:
172
173 \startTEX
174 % language of the main document
175 \mainlanguage[language]
176
177 % to switch to another language locally
178 {\language[otherlanguage] language of some short fragment}
179 \stopTEX
180
181 You can use full language name or the two-letter language code.
182
183 \subsubsection{\ConTeXt\ MkII}
184 When using \ConTeXt\ MkII the EC/T1 font encoding is used by default already, but you might need to change the encoding when using Polish, languages written in Cyrillic scripts, etc. For example:
185
186 \startTEX
187 \usetypescript[iwona][qx]
188 \setupbodyfont[iwona]
189 \mainlanguage[polish]
190 \stopTEX
191
192 \ConTeXt\ loads hyphenation patterns in several encodings. The Czech or Slovak patterns can be used with both EC and IL2 font encoding for example. The right hyphenation patterns will be chosen based on current font encoding.
193
194 \subsection{Some advanced examples}
195
196 \subsubsection{Example for Polyglossia}
197
198 \startTEX
199 \usepackage{polyglossia}
200 % the language used for main document
201 \setmainlanguage{asturian}
202 % American English with extended hyphenation patterns
203 \setotherlanguage[variant=usmax]{english}
204 % German with experimental patterns "ngerman-x-latest"
205 \setotherlanguage[spelling=new,latesthyphen=true]{german}
206 \setotherlanguages{spanish,catalan,french}
207
208 \begin{document}
209
210 Long Asturian text ... (Hyphenation for Asturian is not available,
211 but polyglossia automatically falls back on Catalan for now,
212 which seems to be a reasonable choice.)
213
214 \begin{german}
215 Deutscher Text ... (with the hyphenation patterns selected above:
216 "ngerman-x-latest")
217 \end{german}
218
219 \begin[script=fraktur,spelling=old]{german}
220 Deutſcher Text ... (set in Fraktur, with traditional hyphenation).
221 \end{german}
222
223 \end{document}
224 \stopTEX
225
226 \page
227 \section[sec:languages]{List of supported languages}
228
229 For several languages, there is additional documentation in a separate file: see
230
231 \startitemize[packed]
232 \item For German, \type{dehyph-exptl.pdf}
233 \item For Spanish, \type{division.pdf}
234 \stopitemize
235
236 \def\lanname#1{\hbox to \textwidth{\bf#1\hss}}
237 \def\landata#1#2#3{\hbox to \textwidth{\hbox to 3mm{}\hbox to 6.5em{#1\hss}\hbox to 7em{#2}\hbox{#3}\hss} }
238
239 \lanname{English}
240 \landata{-}{\bf english}{usenglish, USenglish, american}
241 \landata{en-us}{usenglishmax}{}
242 \landata{en-gb}{ukenglish}{british, UKenglish}
243
244 \startcolumns[n=2]
245 \lanname{Afrikaans}
246 \landata{af}{afrikaans}{}
247 \lanname{Ancientgreek}
248 \landata{grc}{ancientgreek}{}
249 \landata{grc-x-ibycus}{ibycus}{}
250 \lanname{Arabic}
251 \landata{ar}{arabic}{}
252 \lanname{Armenian}
253 \landata{hy}{armenian}{}
254 \lanname{Assamese}
255 \landata{as}{assamese}{}
256 \lanname{Basque}
257 \landata{eu}{basque}{}
258 \lanname{Belarusian}
259 \landata{be}{belarusian}{}
260 \lanname{Bengali}
261 \landata{bn}{bengali}{}
262 \lanname{Bulgarian}
263 \landata{bg}{bulgarian}{}
264 \lanname{Catalan}
265 \landata{ca}{catalan}{}
266 \lanname{Chinese}
267 \landata{zh-latn-pinyin}{pinyin}{}
268 \lanname{Church Slavonic}
269 \landata{cu}{churchslavonic}{}
270 \lanname{Coptic}
271 \landata{cop}{coptic}{}
272 \lanname{Croatian}
273 \landata{hr}{croatian}{}
274 \lanname{Czech}
275 \landata{cs}{czech}{}
276 \lanname{Danish}
277 \landata{da}{danish}{}
278 \lanname{Dutch}
279 \landata{nl}{dutch}{}
280 \lanname{Esperanto}
281 \landata{eo}{esperanto}{}
282 \lanname{Estonian}
283 \landata{et}{estonian}{}
284 \lanname{Ethiopic}
285 \landata{mul-ethi}{ethiopic}{amharic, geez}
286 \lanname{Farsi}
287 \landata{fa}{farsi}{persian}
288 \lanname{Finnish}
289 \landata{fi}{finnish}{}
290 \column
291 \lanname{French}
292 \landata{fr}{french}{patois, francais}
293 \lanname{Friulan}
294 \landata{fur}{friulan}{}
295 \lanname{Galician}
296 \landata{gl}{galician}{}
297 \lanname{Georgian}
298 \landata{ka}{georgian}{}
299 \lanname{German}
300 \landata{de-1901}{german}{}
301 \landata{de-1996}{ngerman}{}
302 \landata{de-ch-1901}{swissgerman}{}
303 \lanname{Greek}
304 \landata{el-monoton}{monogreek}{}
305 \landata{el-polyton}{greek}{polygreek}
306 \lanname{Gujarati}
307 \landata{gu}{gujarati}{}
308 \lanname{Hindi}
309 \landata{hi}{hindi}{}
310 \lanname{Hungarian}
311 \landata{hu}{hungarian}{}
312 \lanname{Icelandic}
313 \landata{is}{icelandic}{}
314 \lanname{Indonesian}
315 \landata{id}{indonesian}{}
316 \lanname{Interlingua}
317 \landata{ia}{interlingua}{}
318 \lanname{Irish}
319 \landata{ga}{irish}{}
320 \lanname{Italian}
321 \landata{it}{italian}{}
322 \lanname{Kannada}
323 \landata{kn}{kannada}{}
324 \lanname{Kurmanji}
325 \landata{kmr}{kurmanji}{}
326 \lanname{Latin}
327 \landata{la}{latin}{}
328 \landata{la-x-classic}{classiclatin}{}
329 \landata{la-x-liturgic}{liturgicallatin}{}
330 \lanname{Latvian}
331 \landata{lv}{latvian}{}
332 \lanname{Lithuanian}
333 \landata{lt}{lithuanian}{}
334 \lanname{Malayalam}
335 \landata{ml}{malayalam}{}
336 \column
337 \lanname{Marathi}
338 \landata{mr}{marathi}{}
339 \lanname{Mongolian}
340 \landata{mn-cyrl}{mongolian}{}
341 \landata{mn-cyrl-x-lmc}{mongolianlmc}{}
342 \lanname{Norwegian}
343 \landata{nb}{bokmal}{norwegian, norsk}
344 \landata{nn}{nynorsk}{}
345 \lanname{Occitan}
346 \landata{oc}{occitan}{}
347 \lanname{Oriya}
348 \landata{or}{oriya}{}
349 \lanname{Panjabi}
350 \landata{pa}{panjabi}{}
351 \lanname{Polish}
352 \landata{pl}{polish}{}
353 \lanname{Piedmontese}
354 \landata{pms}{piedmontese}{}
355 \lanname{Portuguese}
356 \landata{pt}{portuguese}{portuges}
357 \lanname{Romanian}
358 \landata{ro}{romanian}{}
359 \lanname{Romansh}
360 \landata{rm}{romansh}{}
361 \lanname{Russian}
362 \landata{ru}{russian}{}
363 \lanname{Sanskrit}
364 \landata{sa}{sanskrit}{}
365 \lanname{Serbian}
366 \landata{sr-latn}{serbian}{}
367 \landata{sr-cyrl}{serbianc}{}
368 \lanname{Slovak}
369 \landata{sk}{slovak}{}
370 \lanname{Slovenian}
371 \landata{sl}{slovenian}{slovene}
372 \lanname{Spanish}
373 \landata{es}{spanish}{espanol}
374 \lanname{Swedish}
375 \landata{sv}{swedish}{}
376 \lanname{Tamil}
377 \landata{ta}{tamil}{}
378 \lanname{Telugu}
379 \landata{te}{telugu}{}
380 \lanname{Thai}
381 \landata{th}{thai}{}
382 \lanname{Turkish}
383 \landata{tr}{turkish}{}
384 \lanname{Turkmen}
385 \landata{tk}{turkmen}{}
386 \lanname{Ukrainian}
387 \landata{uk}{ukrainian}{}
388 \lanname{Uppersorbian}
389 \landata{hsb}{uppersorbian}{}
390 \lanname{Welsh}
391 \landata{cy}{welsh}{}
392 \stopcolumns
393
394 \blank[2*big]
395
396 Babel defines a few more synonyms (which consequently only work in \LaTeX):
397
398 \def\lansyn#1#2{\hbox to \textwidth{\hbox to 3mm{}\hbox to 6.5em{\bf#1\hss}\hbox{#2}\hss}}
399 \lansyn{english}{canadian}
400 \lansyn{british}{australian, newzealand}
401 \lansyn{german}{austrian}
402 \lansyn{ngerman}{naustrian, nswissgerman}
403 \lansyn{portuguese}{brazilian, brazil}
404
405 % TODO: bibliography
406
407 \stoptext