Debian Codegraph @

texmf-dist/doc/latex/polyglossia/polyglossia.tex

raw
1 % !TeX spellcheck = en_US
2 % !TeX TS-program = xelatex
3 \documentclass[11pt,nohyperref]{ltxdoc}
4 \usepackage{xcolor}
5 \usepackage{xspace,fancyvrb,longtable,booktabs}
6 \usepackage[neverdecrease]{paralist}
7 \usepackage[format=hang,labelfont=bf,labelsep=period]{caption}
8 \definecolor{xpgblue}{rgb}{0.02,0.04,0.48}
9 \definecolor{lightblue}{rgb}{0.61,.8,.8}
10 \definecolor{xpgred}{rgb}{0.65,0.04,0.07}
11 \usepackage[
12 unicode=true,
13 bookmarks=true,
14 colorlinks=true,
15 linkcolor=xpgblue,
16 urlcolor=xpgblue,
17 citecolor=xpgblue,
18 hyperindex=false,
19 hyperfootnotes=false,
20 pdftitle={Polyglossia: Modern multilingual typesetting with XeLaTeX and LuaLaTeX},
21 pdfauthor={F Charette, A Reutenauer, U Fogiel, B Roucariès, J Spitzmüller},
22 pdfkeywords={xetex, xelatex, luatex, lualatex, multilingual, babel, hyphenation}
23 ]{hyperref}
24 \usepackage{array}
25 \usepackage{metalogo}
26 \ifxetex
27 \let\XeTeX\undefined
28 \let\XeLaTeX\undefined
29 \fi
30 \usepackage[babelshorthands]{polyglossia}
31 \usepackage{farsical}
32 %
33 % Languages we need in the documentation. See below for fonts
34 \setmainlanguage[variant=british,ordinalmonthday=false]{english}
35 \setotherlanguages{arabic,armenian,hebrew,syriac,greek,kyrgyz,russian,serbian,catalan,georgian,chinese}
36 \usepackage[protrusion,nopatch=footnote]{microtype}
37 \renewcommand\MacroFont{\footnotesize\color{xpgblue}\ttfamily}
38 % Customizable version of \DescribeMacro (e.g. if macro is too long)
39 \newcommand*\DescribeMacroCust[2]{%
40 \let\origMacroFont\MacroFont%
41 \renewcommand\MacroFont{\footnotesize\color{xpgblue}\ttfamily#1}%
42 \DescribeMacro{#2}%
43 \let\MacroFont\origMacroFont%
44 }
45 \newcommand*\Cmd[1]{\cmd{#1}\DescribeMacro{#1}\xspace}
46 \newcommand*\pkg[1]{\textsf{\color{xpgblue}#1}}
47 \newcommand*\file[1]{\texttt{\color{xpgblue}#1}}
48 \newcommand*\TR[1]{\textcolor{xpgred}{#1}}
49 \newcommand*\TX[1]{\hyperref[#1]{\textcolor{xpgred}{#1}}}
50 \newcommand*\TA[1]{\textsc{\color{xpgblue}#1}}
51 \newcommand*\link[1]{\href{#1}{#1}}
52 \renewcommand*\meta[1]{\texttt{⟨#1⟩}}
53 \newcommand*\TXI[1]{\href{https://codeberg.org/polyglossia/polyglossia/issues/#1}{\textcolor{xpgred}{\##1}}}
54 \newcommand*\TXP[1]{\href{https://codeberg.org/polyglossia/polyglossia/pulls/#1}{\textcolor{xpgred}{\##1}}}
55 \def\eg{\textit{e.g.,}\xspace}
56 \def\ie{\textit{i.e.,}\xspace}
57 \def\ca{\textit{ca.}\@\xspace}
58 \def\Eg{\textit{E.g.,}\xspace}
59 \def\Ie{\textit{I.e.,}\xspace}
60 \def\etc{\@ifnextchar.{\textit{etc}}{\textit{etc.}\@\xspace}}
61
62 %
63 %% Commands for documenting options
64 %
65 \newcommand*\xpgoption[1]{\textcolor{xpgblue}{\ttfamily\bfseries #1}}
66 \newcommand*\xpgvalue[1]{\texttt{#1}}
67 \newcommand*\xpgpresetvalue[1]{\texttt{\textit{#1}}}
68 \newcommand*\xpgdefaultvalue[1]{\texttt{*#1}}
69
70 % arguments: #1 version number, #2 key name, #3 footnote, #4 possible values
71 \NewDocumentCommand\xpgchoicekey{omom}{%
72 \xpgoption{#2}\IfValueT{#3}{\footnote{#3}}%
73 \IfValueT{#1}{\new{#1}} \xpgvalue{=} #4\par%
74 }
75
76 % arguments: #1 version number, #2 key name, #3 footnote
77 \NewDocumentCommand\xpgboolkey{omo}{\xpgchoicekey[#1]{#2}[#3]{\xpgdefaultvalue{true} or \xpgvalue{false}}}
78 \NewDocumentCommand\xpgboolkeytrue{omo}{\xpgchoicekey[#1]{#2}[#3]{\xpgdefaultvalue{\xpgpresetvalue{true}} or \xpgvalue{false}}}
79 \NewDocumentCommand\xpgboolkeyfalse{omo}{\xpgchoicekey[#1]{#2}[#3]{\xpgdefaultvalue{true} or \xpgpresetvalue{false}}}
80
81 % arguments: #1 version number, #2 key name, #3 default code
82 \NewDocumentCommand\xpgcodekey{omv}{%
83 \xpgoption{#2}\IfValueT{#1}{\new{#1}}
84 \xpgvalue{=} \meta{code} (default value: \texttt{#3})\par%
85 }
86
87 % arguments: #1 version number, #2 key name, #3 value type, #4 default value
88 \NewDocumentCommand\xpgoptkey{ommo}{%
89 \xpgoption{#2}\IfValueT{#1}{\new{#1}}
90 \xpgvalue{=} \meta{#3} (default value: \texttt{#4})\par%
91 }
92
93 %% Sidenotes << copied from fontspec.dtx
94 \newcommand\new[1]{%
95 \edef\thisversion{v#1}%
96 \ifhmode\unskip~\fi{\ifx\thisversion\fileversion\color{blue}\else\color[gray]{0.5}\fi
97 $\leftarrow$}%
98 \marginpar{\centering
99 \small\ifx\thisversion\fileversion\color{blue}\else\color[gray]{0.5}\fi
100 \textsf{v#1}}}
101 \newcommand\displaycmd[2]{%
102 \\\DescribeMacro{#2}\centerline{\cmd{#1}}}
103 \renewenvironment{itemize}{\begin{compactitem}[\char"2023]}%[{\fontspec{DejaVu Sans}\char"25BB}]}%
104 {\end{compactitem}}
105 \renewenvironment{enumerate}{\begin{compactenum}}{\end{compactenum}}
106 \newenvironment{shorthands}{%
107 \begin{list}{}%
108 {\settowidth{\labelwidth}{MM}%
109 \setlength{\leftmargin}{\labelwidth}%
110 \addtolength{\leftmargin}{\labelsep}%
111 \renewcommand{\makelabel}[1]{##1\hfil}}}%
112 {\end{list}}
113
114 % This is to prevent page breaks too short after subsections
115 \def\condbreak#1{%
116 \vskip 0pt plus #1\pagebreak[3]\vskip 0pt plus -#1\relax}
117 \pretocmd{\subsection}{\condbreak{2\baselineskip}}{}{}
118
119 %
120 % Fonts
121 % We try to use fonts that are shipped with TeXLive
122 % (see #478)
123 %
124 %% fontspec declarations:
125 % Main font: Package libertine (Linux Libertine and Biolinum Mono)
126 \usepackage[osf]{libertine}
127 % Monospace: Package dejavu-otf
128 \setmonofont[Scale=MatchLowercase]{DejaVuSansMono}
129 % Package culmus
130 \newfontfamily\hebrewfont[Script=Hebrew]{DavidCLM}[
131 UprightFont = *-Medium,
132 BoldFont = *-Bold,
133 Extension = .otf,
134 ItalicFont = *-MediumItalic,
135 BoldItalicFont = *-BoldItalic]
136 % Package dejavu-otf
137 \newfontfamily\armenianfont[Script=Armenian,Scale=MatchLowercase]{DejaVuSans}
138 \newfontfamily\georgianfont[Scale=MatchLowercase]{DejaVuSerif}
139 % Package amiri
140 \newfontfamily\arabicfont[Script=Arabic]{Amiri}[%
141 UprightFont = *-Regular,
142 BoldFont = *-Bold,
143 Extension = .ttf,
144 ItalicFont = *-Italic,
145 BoldItalicFont = *-BoldItalic]
146 % No Syriac otf/ttf font seems available on CTAN
147 % This one, from the Syriac Institute, is included on Linux
148 % in the x11-fonts set and can be downloaded from
149 % https://bethmardutho.org/meltho/ (Meltho Fonts Package)
150 \newfontfamily\syriacfont[Script=Syriac]{Serto Jerusalem}
151 % Our decorative title: package gfscomplutum
152 \newfontfamily\xpgtitlefont[Scale=1.4, LetterSpace=30]{GFSPolyglot.otf}
153 % Package noto, notoCJKsc
154 \newfontfamily\chinesefont{Noto Serif CJK SC}[Script=CJK]
155
156 \linespread{1.05}
157 \frenchspacing
158 \EnableCrossrefs
159 \CodelineIndex
160 \RecordChanges
161 % COMMENT THE NEXT LINE TO INCLUDE THE CODE
162 \AtBeginDocument{\OnlyDescription}
163
164 \begin{document}
165 \hyphenation{Kha-li-ghi Reu-ten-auer new-zea-land}
166 \GetFileInfo{polyglossia.sty}
167
168 \title{{\textgreek{\xpgtitlefont\color{lightblue}\MakeUppercase{Πολυγλωσσία}}}
169 \\[16pt]
170 \color{xpgblue}Polyglossia: Modern multilingual typesetting with \XeLaTeX\ and \LuaLaTeX}
171 \author{\TA{François Charette} \and \TA{Arthur Reutenauer}
172 \and \TA{Udi Fogiel} \and \TA{Bastien Roucariès} \and \TA{Jürgen Spitzmüller}}
173 \date{\filedate \qquad \fileversion\thanks{Please report bugs to \url{https://codeberg.org/polyglossia/polyglossia/issues}}\\
174 \footnotesize (\textsc{pdf} file generated on \today)}
175
176 \maketitle
177 \tableofcontents
178
179 \condbreak{4\baselineskip}
180
181
182 \DeleteShortVerb{\|}
183 \MakeShortVerb{\¦}
184
185 %\begin{abstract}
186 %Blablabla
187 %\end{abstract}
188
189
190 \section{Introduction}
191
192 \pkg{Polyglossia} is a package for facilitating multilingual typesetting with
193 \XeLaTeX\ and \LuaLaTeX. Basically, it
194 can be used as an alternative to \pkg{babel} for performing the following
195 tasks automatically:
196
197 \begin{enumerate}
198 \item Loading the appropriate hyphenation patterns.
199 \item Setting the script and language tags of the current font (if possible and
200 available), via the package \pkg{fontspec}.
201 \item Switching to a font assigned by the user to a particular script or language.
202 \item Adjusting some typographical conventions according to the current language
203 (such as afterindent, frenchindent, spaces before or after punctuation marks,
204 etc.).
205 \item Redefining all document strings (like “chapter”, “figure”, “bibliography”).
206 \item Adapting the formatting of dates (for non-Gregorian calendars via external
207 packages bundled with polyglossia: currently the Hebrew, Islamic and Farsi
208 calendars are supported).
209 \item For languages that have their own numbering system, modifying the formatting
210 of numbers appropriately (this also includes redefining the alphabetic sequence
211 for non-Latin alphabets).\footnote{%
212 This is done by bundled sub-packages such as \pkg{arabicnumbers}.}
213 \item Ensuring proper directionality if the document contains languages
214 that are written from right to left (via the package \pkg{bidi},
215 available separately).
216 \end{enumerate}
217 %
218 Several features of \pkg{babel} that do not make sense in the \XeTeX\ world (like font
219 encodings, shorthands, etc.) are not supported.
220 Generally speaking, \pkg{polyglossia} aims to remain as compatible as possible
221 with the fundamental features of \pkg{babel} while being cleaner, light-weight,
222 and modern. The package \pkg{antomega} has been very beneficial in our attempt to
223 reach this objective.
224
225 \paragraph{Requirements} The current version of \pkg{polyglossia} makes use of some convenient
226 macros defined in the \pkg{etoolbox} package by \TA{Philipp Lehmann} and \TA{Joseph Wright}.
227 Being designed for \XeLaTeX\ and \LuaLaTeX, it obviously also relies on \pkg{fontspec} by
228 \TA{Will Robertson}. For languages written from right to left, it needs the package \pkg{bidi}
229 (for \XeTeX) or \pkg{luabidi} (for \LuaTeX) by \TA{Vafa Khalighi} (\textarabic{وفا خليقي}) and
230 the \pkg{bidi-tex GitHub Organisation}.
231 Polyglossia also bundles three packages for calendaric computations (\pkg{hebrewcal},
232 \pkg{hijrical}, and \pkg{farsical}).
233
234
235 \section{Setting up multilingual documents}
236
237 \subsection{Activating languages}
238
239 The default language of a document is specified by means of the command
240 \displaycmd{\setdefaultlanguage\oarg{options}\marg{lang}}{\setdefaultlanguage}
241 (or, equivalently, \Cmd\setmainlanguage).
242 Secondary languages are specified with
243 \displaycmd{\setotherlanguage\oarg{options}\marg{lang}.}{\setotherlanguage}
244 All these commands allow you to set language-specific options.\footnote{%
245 Section~\ref{specific} documents these options for the respective languages.}
246 It is also possible to load a series of secondary languages at once (but without options)
247 using
248 \displaycmd{\setotherlanguages\marg{lang1⟩,⟨lang2⟩,⟨lang3⟩,⟨…}.}{\setotherlanguages}
249 %
250 All language-specific options can be modified locally by means of the
251 language-switching commands described in section \ref{languageswitching}.
252
253 \paragraph{Note} In general, it is advisable to activate the languages \emph{after} all
254 packages have been loaded. This is particularly important if you use right-to-left scripts
255 or languages with babel shorthands.
256
257
258 \subsection{Supported languages}
259
260 Table~\ref{tab:lang} lists all languages currently supported.
261 Those in \TR{red} have specific options and/or commands
262 that are explained in section \ref{specific} below.
263
264 \begin{table}[ht]\centering
265 \caption{\label{tab:lang}Languages currently supported in \pkg{polyglossia}}
266 % Produced with tools/insert-language-list.rb -- JS, 2026-01-30
267 \begin{tabular}{lllll}
268 \toprule
269 \TX{afrikaans} & danish & icelandic & \TX{mongolian} & \TX{slovenian}\\
270 albanian & divehi & interlingua & nko & \TX{sorbian} \\
271 amharic & \TX{dutch} & \TX{italian} & \TX{norwegian} & \TX{spanish} \\
272 \TX{arabic} & \TX{english} & japanese & occitan & swedish \\
273 \TX{armenian} & \TX{esperanto} & kannada & \TX{odia} & \TX{syriac} \\
274 asturian & estonian & khmer & \TX{persian} & tamil \\
275 basque & \TX{finnish} & \TX{korean} & piedmontese & telugu \\
276 \TX{belarusian} & \TX{french} & \TX{kurdish} & \TX{polish} & \TX{thai} \\
277 \TX{bengali} & friulian & \TX{kyrgyz} & \TX{portuguese} & \TX{tibetan} \\
278 bosnian & \TX{gaelic} & \TX{lao} & \TX{punjabi} & turkish \\
279 breton & galician & \TX{latin} & romanian & turkmen \\
280 bulgarian & \TX{georgian} & latvian & romansh & \TX{ukrainian}\\
281 \TX{catalan} & \TX{german} & lithuanian & \TX{russian} & \TX{urdu} \\
282 \TX{chinese} & \TX{greek} & macedonian & \TX{sami} & \TX{uyghur} \\
283 coptic & \TX{hebrew} & \TX{malay} & \TX{sanskrit} & vietnamese \\
284 \TX{croatian} & \TX{hindi} & malayalam & \TX{serbian} & \TX{welsh} \\
285 \TX{czech} & \TX{hungarian} & \TX{marathi} & \TX{slovak} & \\
286 \bottomrule
287 \end{tabular}
288
289
290 \end{table}
291
292 \paragraph{Nota bene} Support for Chinese and Japanese is experimental. This particularly concerns the line breaking mechanism which is a proof of concept.
293 Please use with care and report any issues and unexpected output you encounter.
294
295 \paragraph{Version Notes} The support for Amharic\new{1.0.1} should be considered an experimental attempt to
296 port the package \pkg{ethiop}; feedback is welcome.
297 Version 1.1.1\new{1.1.1} added support for Asturian, %\footnote{ Provided by Kevin Godby and Xuacu Saturio.},
298 Lithuanian, %\footnote{ Provided by Kevin Godby and Paulius Sladkevičius.},
299 and Urdu. %\footnote{ Provided by Kamal Abdali.}
300 %
301 Version 1.2\new{1.2.0} introduced Armenian, Occitan, Bengali,
302 Lao, Malayalam, Marathi, Tamil, Telugu, and Turkmen.\footnote{%
303 See acknowledgements at the end for due credit to the various contributors.}
304 Version 1.43\new{1.43} brought basic support for Japanese (this
305 is considered experimental, feedback is appreciated).
306 In version 1.45\new{1.45}, support for Kurdish and Mongolian as well as some new
307 variants (Canadian French and English) have been added. Furthermore, for consistency reasons, some language have
308 been renamed (\emph{farsi}\textrightarrow\emph{persian}, \emph{friulan}\textrightarrow\emph{friulian},
309 \emph{magyar}\textrightarrow\emph{hungarian}, \emph{portuges}\textrightarrow\emph{portuguese},
310 \emph{samin}\textrightarrow\emph{sami}) or merged (\emph{bahasai}\slash\emph{bahasam}\textrightarrow\emph{malay},
311 \emph{brazil}\slash\emph{portuges}\textrightarrow\emph{portuguese},
312 \emph{lsorbian}\slash\emph{usorbian}\textrightarrow\emph{sorbian},
313 \emph{irish}\slash\emph{scottish}\textrightarrow\emph{gaelic},
314 \emph{norsk}\slash\emph{nynorsk}\textrightarrow\emph{norwegian}). The old names are still supported for backwards
315 compatibility reasons.
316 Version 1.46\new{1.46} introduces support for Afrikaans, Belarusian, Bosnian and Georgian.
317 Version 1.52\new{1.52} introduces support for Uyghur.
318 Version 1.59\new{1.59} adds support for (simplified and traditional) Chinese and for Punjabi.
319 Version 1.66\new{1.66} introduces support for Odia.
320 Version 2.10\new{2.10} introduces support for Kyrgyz (Cyrillic writing). This is experimental, and feedback
321 is welcome. Particularly, no hyphenation patterns for Kyrgyz exist yet.
322
323
324 \subsection{Relation to and use of Babel language names}\label{sec:babelnames}
325
326 If you are familiar with the \pkg{babel} package, you will note that \pkg{polyglossia}'s language naming
327 slightly differs. Whereas \pkg{babel} has a unique name for each language variety (\eg\emph{american} and \emph{british}),
328 \pkg{polyglossia} differentiates language varieties via language options (\eg \emph{english}, ¦variant=american¦).
329
330 Furthermore, \pkg{babel} sometimes uses abbreviated language names (\eg\emph{bahasam} for Bahasa Malayu) as well
331 as endonyms, \ie language names coming from the designated languages (such as \emph{bahasa}, \emph{canadien} or \emph{magyar}).
332 As opposed to this, \pkg{polyglossia} always uses spelled-out (lower-cased) English language names.
333 Please refer to table~\ref{tab:bbllang} for the differing language names in both packages.
334
335 \begingroup
336 \small\centering
337 \begin{longtable}{lll}
338 \caption{\label{tab:bbllang}Babel-polyglossia language name matching}\tabularnewline
339 \toprule
340 \textbf{Babel name} & \textbf{Polyglossia name} & \textbf{Polyglossia options}\tabularnewline
341 \midrule
342 acadian & french & variant=acadian \\
343 american & english & variant=american [\emph{default}] \\
344 australian & english & variant=australian \\
345 austrian & german & variant=austrian, spelling=old \\
346 bahasa & malay & variant=indonesian [\emph{default}] \\
347 bahasam & malay & variant=malaysian \\
348 brazil & portuguese & variant=brazilian \\
349 british & english & variant=british \\
350 canadian & english & variant=canadian \\
351 canadien & french & variant=canadian \\
352 classicallatin & latin & variant=classic \\
353 farsi & persian & \\
354 ecclesiasticallatin& latin & variant=ecclesiastic \\
355 friulan & friulian & \\
356 german\footnote{Only available in \pkg{polyglossia} as \emph{germanb},
357 \emph{german-de-1901}, and \emph{german-germany-1901}
358 (which are \pkg{babel} synonyms) due to the name conflict with
359 \pkg{polyglossia}'s \emph{german}.}
360 & german & spelling=old \\
361 german-at & german & variant=austrian \\
362 german-at-1901 & german & variant=austrian, spelling=old \\
363 german-austria & german & variant=austrian \\
364 german-austria-1901& german & variant=austrian, spelling=old \\
365 german-ch & german & variant=swiss \\
366 german-ch-1901 & german & variant=swiss, spelling=old \\
367 german-switzerland & german & variant=swiss \\
368 german-switzerland-1901& german & variant=swiss, spelling=old \\
369 german-de & german & variant=german [\emph{default}] \\
370 german-de-1901 & german & spelling=old \\
371 german-germany & german & variant=german [\emph{default}] \\
372 german-germany-1901& german & spelling=old \\
373 irish & gaelic & variant=irish [\emph{default}] \\
374 kurmanji & kurdish & variant=kurmanji \\
375 lowersorbian & sorbian & variant=lower \\
376 magyar & hungarian & \\
377 medievallatin & latin & variant=medieval \\
378 naustrian & german & variant=austrian \\
379 newzealand & english & variant=newzealand \\
380 ngerman & german & variant=german [\emph{default}] \\
381 norsk & norwegian & variant=bokmal \\
382 nswissgerman & german & variant=swiss \\
383 nynorsk & norwegian & variant=nynorsk [\emph{default}] \\
384 polutonikogreek & greek & variant=polytonic \\
385 portuges & portuguese & variant=portuguese [\emph{default}] \\
386 samin & sami & \\
387 scottish & gaelic & variant=scottish \\
388 serbianc & serbian & script=Cyrillic \\
389 slovene & slovenian & \\
390 spanishmx & spanish & variant=mexican \\
391 swissgerman & german & variant=swiss, spelling=old \\
392 uppersorbian & sorbian & variant=upper [\emph{default}] \\
393 \bottomrule
394 \end{longtable}
395 \endgroup
396
397 For convenience reasons, \pkg{polyglossia} also supports the use of babel names\new{1.46} (for the few justified
398 exceptions, please refer to the notes in table~\ref{tab:bbllang}).
399 The babel names listed in table~\ref{tab:bbllang} can be used instead of the corresponding polyglossia
400 name\slash options in \cmd\setdefaultlanguage\ and \cmd\setotherlanguage\ as well as in the \pkg{polyglossia} and
401 \pkg{babel} language switching commands\slash environments documented in section~\ref{sec:langcmds} and
402 \ref{sec:babelcmds} (\eg \cmd\textaustrian\ is synonymous to ¦\textgerman[variant=austrian,spelling=old]¦).
403 However, unless you have special reasons, we strongly encourage you to use the \pkg{polyglossia} names.
404
405
406 \subsection{Using IETF language tags}\label{sec:langtags}
407
408 \pkg{Polyglossia}\new{1.47} also supports the use of language tags that conform to the IETF BCP-47
409 \emph{Best Current Practice}.\footnote{Please refer to \url{https://tools.ietf.org/html/bcp47} and
410 \url{https://en.wikipedia.org/wiki/IETF_language_tag} for details.}
411 Thus, you can use tags such as ¦en-GB¦ (for British English) or ¦de-AT-1901¦ (for Austrian German, old spelling)
412 in \cmd\setdefaultlanguage\ and \cmd\setotherlanguage\ as well as in the language switching command
413 \cmd{\textlang\marg{tag}}, the environment \cmd{\begin\{lang\}\marg{tag}} \ldots\ \cmd{\end\{lang\}} and the \pkg{babel}
414 language switching commands\slash environments documented in section~\ref{sec:babelcmds}.
415 Table~\ref{tab:BCP47-polyglossia} lists the currently supported tags.
416
417 \bgroup\small\addfontfeatures{Numbers={Monospaced,Lining}}
418 \begin{longtable}[c]{ll>{\raggedright}p{6cm}}
419 \caption{\label{tab:BCP47-polyglossia}BCP47-polyglossia language name matching}\tabularnewline
420 \toprule
421 \textbf{BCP-47 tag} & \textbf{Polyglossia name} & \textbf{Polyglossia options}\tabularnewline
422 \midrule
423 \endfirsthead
424 \caption[]{BCP47-polyglossia language name matching (\emph{continued})}\tabularnewline
425 \toprule
426 \textbf{BCP-47 tag} & \textbf{Polyglossia name} & \textbf{Polyglossia options}\tabularnewline
427 \midrule
428 \endhead
429 aeb & arabic & locale=tunisia \tabularnewline
430 af & afrikaans & \tabularnewline
431 afb & arabic & locale=default \tabularnewline
432 am & amharic & \tabularnewline
433 apd & arabic & locale=default \tabularnewline
434 ar & arabic & \tabularnewline
435 ar-IQ & arabic & locale=mashriq \tabularnewline
436 ar-JO & arabic & locale=mashriq \tabularnewline
437 ar-LB & arabic & locale=mashriq \tabularnewline
438 ar-MR & arabic & locale=mauritania \tabularnewline
439 ar-PS & arabic & locale=mashriq \tabularnewline
440 ar-SY & arabic & locale=mashriq \tabularnewline
441 ar-YE & arabic & locale=default \tabularnewline
442 arq & arabic & locale=algeria \tabularnewline
443 ary & arabic & locale=morocco \tabularnewline
444 arz & arabic & locale=default \tabularnewline
445 ast & asturian & \tabularnewline
446 ayl & arabic & locale=libya \tabularnewline
447 be & belarusian & \tabularnewline
448 be-tarask & belarusian & spelling=classic \tabularnewline
449 bg & bulgarian & \tabularnewline
450 bn & bengali & \tabularnewline
451 bo & tibetan & \tabularnewline
452 br & breton & \tabularnewline
453 bs & bosnian & \tabularnewline
454 ca & catalan & \tabularnewline
455 ckb & kurdish & variant=sorani [\emph{default}] \tabularnewline
456 ckb-Arab & kurdish & variant=sorani, script=Arabic [\emph{default}] \tabularnewline
457 ckb-Latn & kurdish & variant=sorani, script=Latin \tabularnewline
458 cop & coptic & \tabularnewline
459 cy & welsh & \tabularnewline
460 cz & czech & \tabularnewline
461 da & danish & \tabularnewline
462 de & german & \tabularnewline
463 de-AT & german & variant=austrian, spelling=new \tabularnewline
464 de-AT-1901 & german & variant=austrian, spelling=old \tabularnewline
465 de-AT-1996 & german & variant=austrian, spelling=new \tabularnewline
466 de-CH & german & variant=swiss, spelling=new \tabularnewline
467 de-CH-1901 & german & variant=swiss, spelling=old \tabularnewline
468 de-CH-1996 & german & variant=swiss, spelling=new \tabularnewline
469 de-DE & german & variant=german, spelling=new \tabularnewline
470 de-DE-1901 & german & variant=german, spelling=old \tabularnewline
471 de-DE-1996 & german & variant=german, spelling=new [\emph{default}] \tabularnewline
472 de-Latf & german & script=blackletter \tabularnewline
473 de-Latf-AT & german & variant=austrian, spelling=new, script=blackletter \tabularnewline
474 de-Latf-AT-1901 & german & variant=austrian, spelling=old, script=blackletter \tabularnewline
475 de-Latf-AT-1996 & german & variant=austrian, spelling=new, script=blackletter \tabularnewline
476 de-Latf-CH & german & variant=swiss, spelling=new, script=blackletter \tabularnewline
477 de-Latf-CH-1901 & german & variant=swiss, spelling=old, script=blackletter \tabularnewline
478 de-Latf-CH-1996 & german & variant=swiss, spelling=new, script=blackletter \tabularnewline
479 de-Latf-DE & german & variant=german, spelling=new, script=blackletter \tabularnewline
480 de-Latf-DE-1901 & german & variant=german, spelling=old, script=blackletter \tabularnewline
481 de-Latf-DE-1996 & german & variant=german, spelling=new, script=blackletter \tabularnewline
482 dsb & sorbian & variant=lower \tabularnewline
483 dv & divehi & \tabularnewline
484 el & greek & \tabularnewline
485 el-monoton & greek & variant=monotonic [\emph{default}] \tabularnewline
486 el-polyton & greek & variant=polytonic \tabularnewline
487 en & english & \tabularnewline
488 en-AU & english & variant=australian \tabularnewline
489 en-CA & english & variant=canadian \tabularnewline
490 en-GB & english & variant=british \tabularnewline
491 en-NZ & english & variant=newzealand \tabularnewline
492 en-US & english & variant=us [\emph{default}] \tabularnewline
493 eo & esperanto & \tabularnewline
494 es & spanish & \tabularnewline
495 es-ES & spanish & variant=spanish [\emph{default}] \tabularnewline
496 es-MX & spanish & variant=mexican \tabularnewline
497 et & estonian & \tabularnewline
498 eu & basque & \tabularnewline
499 fa & persian & \tabularnewline
500 fi & finnish & \tabularnewline
501 fr & french & \tabularnewline
502 fr-CA & french & variant=canadian \tabularnewline
503 fr-CA-u-sd-canb & french & variant=acadian \tabularnewline
504 fr-CH & french & variant=swiss \tabularnewline
505 fr-FR & french & variant=french [\emph{default}] \tabularnewline
506 fur & friulian & \tabularnewline
507 ga & gaelic & variant=irish [\emph{default}] \tabularnewline
508 gd & gaelic & variant=scottish \tabularnewline
509 gl & galician & \tabularnewline
510 grc & greek & variant=ancient \tabularnewline
511 he & hebrew & \tabularnewline
512 hi & hindi & \tabularnewline
513 hr & croatian & \tabularnewline
514 hsb & sorbian & variant=upper [\emph{default}] \tabularnewline
515 hu & hungarian & \tabularnewline
516 hy & armenian & \tabularnewline
517 ia & interlingua & \tabularnewline
518 id & malay & variant=indonesian \tabularnewline
519 is & icelandic & \tabularnewline
520 it & italian & \tabularnewline
521 ja & japanese & \tabularnewline
522 ka & georgian & \tabularnewline
523 kg & kyrgyz & \tabularnewline
524 km & khmer & \tabularnewline
525 kmr & kurdish & variant=kurmanji \tabularnewline
526 kmr-Arab & kurdish & variant=kurmanji, script=Arabic \tabularnewline
527 kmr-Latn & kurdish & variant=kurmanji, script=Latin \tabularnewline
528 kn & kannada & \tabularnewline
529 ko & korean & \tabularnewline
530 ku & kurdish & \tabularnewline
531 ku-Arab & kurdish & script=Arabic \tabularnewline
532 ku-Latn & kurdish & script=Latin \tabularnewline
533 la & latin & \tabularnewline
534 la-x-classic & latin & variant=classic \tabularnewline
535 la-x-ecclesia & latin & variant=ecclesiastic \tabularnewline
536 la-x-medieval & latin & variant=medieval \tabularnewline
537 lo & lao & \tabularnewline
538 lt & lithuanian & \tabularnewline
539 lv & latvian & \tabularnewline
540 mk & macedonian & \tabularnewline
541 ml & malayalam & \tabularnewline
542 mn & mongolian & \tabularnewline
543 mr & marathi & \tabularnewline
544 nb & norwegian & variant=bokmal \tabularnewline
545 nko & nko & \tabularnewline
546 nl & dutch & \tabularnewline
547 nn & norwegian & variant=nynorsk [\emph{default}] \tabularnewline
548 oc & occitan & \tabularnewline
549 or & odia & changecounternumbering=false, numerals=Devanagari [\emph{default}] \tabularnewline
550 pa & punjabi & numerals=gurmukhi \tabularnewline
551 pl & polish & \tabularnewline
552 pms & piedmontese & \tabularnewline
553 pt & portuguese & \tabularnewline
554 pt-BR & portuguese & variant=brazilian \tabularnewline
555 pt-PT & portuguese & variant=portuguese [\emph{default}] \tabularnewline
556 rm & romansh & \tabularnewline
557 ro & romanian & \tabularnewline
558 ru & russian & \tabularnewline
559 ru-luna1918 & russian & spelling=modern [\emph{default}] \tabularnewline
560 ru-petr1708 & russian & spelling=old \tabularnewline
561 sa & sanskrit & \tabularnewline
562 sa-Beng & sanskrit & script=Bengali \tabularnewline
563 sa-Deva & sanskrit & script=Devanagari [\emph{default}] \tabularnewline
564 sa-Gujr & sanskrit & script=Gujarati \tabularnewline
565 sa-Knda & sanskrit & script=Kannada \tabularnewline
566 sa-Mlym & sanskrit & script=Malayalam \tabularnewline
567 sa-Telu & sanskrit & script=Telugu \tabularnewline
568 se & sami & \tabularnewline
569 sk & slovak & \tabularnewline
570 sl & slovenian & \tabularnewline
571 sq & albanian & \tabularnewline
572 sr & serbian & \tabularnewline
573 sr-Cyrl & serbian & script=Cyrillic \tabularnewline
574 sr-Latn & serbian & script=Latin [\emph{default}] \tabularnewline
575 sv & swedish & \tabularnewline
576 syr & syriac & \tabularnewline
577 ta & tamil & \tabularnewline
578 te & telugu & \tabularnewline
579 th & thai & \tabularnewline
580 tk & turkmen & \tabularnewline
581 tr & turkish & \tabularnewline
582 ug & uyghur & \tabularnewline
583 uk & ukrainian & \tabularnewline
584 ur & urdu & \tabularnewline
585 vi & vietnamese & \tabularnewline
586 zh & chinese & \tabularnewline
587 zh-CN & chinese & variant=simplified [\emph{default}] \tabularnewline
588 zh-TW & chinese & variant=traditional \tabularnewline
589 zsm & malay & variant=malaysian [\emph{default}] \tabularnewline
590 \bottomrule
591 \end{longtable}
592 \egroup
593
594 \subsection{Global options}
595
596 \pkg{Polyglossia} can be loaded with the following global package options:
597
598 \begin{itemize}
599 \item \xpgboolkeyfalse[1.1.1]{babelshorthands}
600 Globally activates \pkg{babel} shorthands whenever available.
601 Please refer to sec.~\ref{shorthands} for details.
602
603 \item \xpgboolkeyfalse{localmarks} redefines the internal \LaTeX\ macros \cmd\markboth\ and
604 \cmd\markright\ to the effect that the header text is explicitly set in the currently
605 active language (\ie wrapped into \cmd\foreignlanguage\{\meta{lang}\}\{\meta{\ldots}\}).
606
607 In earlier versions of \pkg{polyglossia},\new{1.2.0} this
608 option was enabled by default, but we now realize that it causes more problems
609 than it helps (since it breaks if a package or class redefines \cmd\markboth\ or
610 \cmd\markright), so it is now disabled by default. For backwards compatibility, the
611 option \xpgoption{nolocalmarks} which used to switch off the previous default, and
612 now equals the default, is still available.
613
614 \item \xpgoptkey[1.50]{luatexrenderer}{renderer}[Harfbuzz] determines which font renderer is used
615 with \LuaTeX\ output. The correct font renderer is essential particularly for non-Latin scripts.
616 By default, \pkg{polyglossia} uses the \xpgvalue{Harfbuzz} renderer that has been introduced to
617 \LuaTeX\ in 2019 (\TeX Live 2020), as this gives the best results generally. If you want to use
618 a different renderer, you can specify this here (or individually for specific fonts via the optional
619 argument of the font selection commands). Please refer to the \pkg{fontspec} manual for supported
620 values and for details on how to change the renderer for individual fonts.\\
621 \xpgoption{luatexrenderer=none} disables \pkg{polyglossia}'s automatic renderer setting.
622
623 \item \xpgboolkeytrue{verbose} determines whether info messages and (some of the) warnings issued
624 by \LaTeX, \pkg{fontspec} and \pkg{polyglossia} are output.
625 \item \xpgchoicekey[2.10]{unibidi-lua}{\xpgpresetvalue{default} or \xpgvalue{true} or \xpgvalue{false}}
626 loads the \pkg{unibidi-lua} package for unicode bidi algorithm. This
627 allows to write short left-to-right text inside right-to-left text (e.g. arabic numerals in Hebrew text),
628 or vice versa without special markup for the directions switches.
629 with \xpgvalue{default}, \pkg{unibidi-lua} will be loaded if the main language is RTL and
630 the bidi key is true. In \LuaTeX\ this options does nothing.
631 \item \xpgboolkeytrue[2.10]{bidi} If set to false, polyglossia will not load \pkg{bidi} or \pkg{luabidi}. Instead it
632 will use minimal setup for RTL text. You can use this option if you only need short RTL text, or simple
633 paragraphs, and don't want to load these packages.
634 \item \xpgboolkeytrue[2.10]{metadata} use the language provided in \cmd\DocumentMetaData\ \meta{lang} key as the default
635 language. The value is true at loading time.
636 \end{itemize}
637
638 \subsection{Shorthands}\label{shorthands}
639
640 \pkg{Babel} has introduced the nifty feature of \enquote{shorthands} for some of the languages
641 it supports.
642 Shorthands make use of active characters to provide quick access to glyphs and formatting
643 peculiarities that are common in a respective language (\eg ¦"a¦ for German umlaut ⟨ä⟩ in case
644 this is not available on your keyboard).
645 \pkg{Polyglossia} has adopted this feature, we call it \emph{babelshorthands}.
646
647 Shorthands need to be activated for the respective language, or can be activated globally, via
648 the boolean option \xpgoption{babelshorthands} (either passed globally when loading \pkg{polyglossia}
649 or to a specific language when loading it).
650
651 Shorthands are implemented currently for Afrikaans, Belarusian, Catalan, Croatian,
652 Czech, Dutch, Finnish, Georgian, German, Italian, Latin, Mongolian, Occitan,
653 Piedmontese, Polish, Portuguese, Russian, Slovak, and Ukrainian, and their number and function
654 differs between these languages. Please refer to the respective language descriptions (sec.~\ref{specific})
655 for detailed elaborations.
656
657 If you want to re-use the shorthands defined for a specific language in a different language,
658 you can do so by using in preamble:\new{2.0}
659 \displaycmd{\inheritbabelshorthands\marg{source language}\marg{target language}}{\inheritbabelshorthands}
660 in order to input and activate the shorthands defined for the \meta{source language} in
661 the \meta{target language}. Both languages will be loaded as \enquote{other} languages if they have not
662 been loaded yet. If one of the languages does not exist, or if the \meta{source language} does not provide any
663 shorthands, you will get an error message.
664
665 Note, also, that you can only use \cmd{\inheritbabelshorthands} once per language. Subsequent
666 calls will overwrite previous ones (and also the shorthand that might be defined for a
667 \meta{target language} in the first place).
668
669 If you want to enable the shorthands of a specific language inline, also when the language itself
670 is not active (but loaded in the preamble), you can do so by means of\new{2.0}
671 \displaycmd{\usebabelshorthands\marg{language}}{\usebabelshorthands}
672 The effect of this is local to groups. If you want to disable any active shorthands, you can use
673 ¦\usebabelshorthands{none}¦.
674
675 \section{Language-switching commands}\label{languageswitching}
676
677 \subsection{Recommended commands}\label{sec:langcmds}
678 For each activated language the command
679 \cmd{\text\meta{lang}\oarg{options}\marg{…}} \DescribeMacro{\text\meta{lang}}
680 (as well as the synonymous \DescribeMacro{\textlang}%
681 \cmd{\textlang\oarg{options}\marg{lang}\marg{…}}\new{1.46})
682 becomes available for short insertions of text in that language.
683
684 For example ¦\textrussian{\today}¦ and ¦\textlang{russian}{\today}¦ yield \textrussian{\today}
685 The commands switch to the correct hyphenation patterns, they activate
686 some extra features for the selected language (such as extra spacing before
687 punctuation in French), and they translate the date when using \cmd\today.
688 They do not, however, translate so-called \textit{caption strings}, \ie
689 ``chapter'', ``figure'' etc., to the local language (these remain in the currently active `outer'
690 language).
691
692 The\DescribeEnv{\meta{lang}}\ environment \meta{lang}, which is also available for any activated language
693 (as well as the equivalent \DescribeMacro{lang}%
694 \cmd{\begin\{lang\}\oarg{options}\marg{lang}} \dots{} \cmd{\end\{lang\}}\new{1.47}),
695 is meant for longer passages of text. It behaves slightly different than the \cmd{\text\meta{lang}} and
696 \cmd\textlang\ commands: It does everything the latter do, but additionally, the caption strings
697 are translated as well, and the language is also passed to auxiliary files, the table of contents
698 and the lists of figures/tables.
699 Like the commands, the environment provides the possibility of setting language options locally.
700 For instance the following allows us to quote the beginning
701 of Homer’s \textit{Iliad}:
702
703 \begin{Verbatim}[formatcom=\color{xpgblue}]
704 \begin{quote}
705 \begin{greek}[variant=ancient]
706 μῆνιν ἄειδε θεὰ Πηληϊάδεω Ἀχιλῆος οὐλομένην, ἣ μυρί' Ἀχαιοῖς
707 ἄλγε' ἔθηκε, πολλὰς δ' ἰφθίμους ψυχὰς Ἄϊδι προί̈αψεν ἡρώων,
708 αὐτοὺς δὲ ἑλώρια τεῦχε κύνεσσιν οἰωνοῖσί τε πᾶσι, Διὸς δ'
709 ἐτελείετο βουλή, ἐξ οὗ δὴ τὰ πρῶτα διαστήτην ἐρίσαντε Ἀτρεί̈δης
710 τε ἄναξ ἀνδρῶν καὶ δῖος Ἀχιλλεύς.
711 \end{greek}
712 \end{quote}
713 \end{Verbatim}
714
715 \vspace{-.5\baselineskip}
716
717 \begin{quote}
718 \begin{greek}[variant=ancient]
719 μῆνιν ἄειδε θεὰ Πηληϊάδεω Ἀχιλῆος οὐλομένην, ἣ μυρί' Ἀχαιοῖς ἄλγε' ἔθηκε,
720 πολλὰς δ' ἰφθίμους ψυχὰς Ἄϊδι προί̈αψεν ἡρώων, αὐτοὺς δὲ ἑλώρια τεῦχε κύνεσσιν
721 οἰωνοῖσί τε πᾶσι, Διὸς δ' ἐτελείετο βουλή, ἐξ οὗ δὴ τὰ πρῶτα διαστήτην ἐρίσαντε
722 Ἀτρεί̈δης τε ἄναξ ἀνδρῶν καὶ δῖος Ἀχιλλεύς.
723 \end{greek}
724 \end{quote}
725
726 \noindent\DescribeEnv{Arabic} Note that for Arabic one cannot use the environment ¦arabic¦,
727 as \cmd\arabic\ is defined internally by \LaTeX. In this case
728 we need to use the environment ¦Arabic¦ instead.
729
730 \subsection{Babel commands}\label{sec:babelcmds}
731 Some macros defined in \pkg{babel}’s \file{hyphen.cfg} (and thus usually
732 compiled into the \XeLaTeX\ and \LuaLaTeX\ format) are redefined, but keep a
733 similar behaviour.
734 \begin{itemize}
735 \item \DescribeMacro{\selectlanguage}\cmd{\selectlanguage\oarg{options}\marg{lang}}
736 \item \DescribeMacro{\foreignlanguage}\cmd{\foreignlanguage\oarg{options}\marg{lang}\marg{…}}
737 \item \DescribeEnv{otherlanguage}\cmd{\begin\{otherlanguage\}\oarg{options}\marg{lang}} \dots{} \cmd{\end\{otherlanguage\}}
738 \item \DescribeEnv{otherlanguage*}\cmd{\begin\{otherlanguage*\}\oarg{options}\marg{lang}} \dots{} \cmd{\end\{otherlanguage*\}}
739 \item \DescribeEnv{hyphenrules}\cmd{\begin\{hyphenrules\}\oarg{options}\marg{lang}} \dots{} \cmd{\end\{hyphenrules\}}\new{1.50}
740 \end{itemize}
741 %
742 \cmd\selectlanguage\marg{lang} and the ¦otherlanguage¦ environment are identical to the
743 \meta{lang} environment, except that \cmd\selectlanguage\marg{lang}
744 does not need to be explicitly closed. The command \cmd\foreinlanguage\marg{lang}\marg{…} and the ¦otherlanguage*¦
745 environment are identical with the use of the \cmd\text\meta{lang} or \cmd\textlang\ command, with the one
746 notable exception that they do not translate the date with \cmd\today.
747
748 The \meta{hyphenrules} environment only switches the hyphenation patterns to the one associated with the language \meta{lang}
749 (or the language variety as specified via \meta{options}). It does no further language-specific change.
750
751 Since the \XeLaTeX\ and \LuaLaTeX\ format incorporate \pkg{babel}’s \file{hyphen.cfg},
752 the low-level commands for hyphenation and language switching defined there are in principal also accessible.
753 Note, however, that the availability of such low-level commands is not guaranteed, as \file{hyphen.cfg}, which is
754 out of \pkg{polyglossia}'s control, is (or at least has been) subject to regular change.
755
756 \subsection{Other commands}
757 The following commands are probably of lesser interest to the end user, but
758 ought to be mentioned here.
759 \begin{itemize}
760 \item \DescribeMacro{\selectbackgroundlanguage}\cmd{\selectbackgroundlanguage\marg{lang}}:
761 this selects the global font setup and the numbering definitions for the default language.
762
763 \item \DescribeMacro{\resetdefaultlanguage}\cmd{\resetdefaultlanguage\oarg{options}\marg{lang}} (experimental):
764 Switches the default language
765 to another one in the middle of a document: \textit{this may have adverse effects}!
766
767 \item \Cmd\normalfontlatin: in an environment where \cmd\normalfont\ has been redefined
768 to a non-latin script, this will reset to the font defined with \cmd\setmainfont\ etc.
769 In a similar vein, it is possible to use \Cmd\rmfamilylatin, \Cmd\sffamilylatin,
770 and \Cmd\ttfamilylatin.
771
772 \item \DescribeMacro{\latinalph}\cmd{\latinalph\marg{counter}}: Representation of counter as a lower-case letter:
773 1 = a, 2 = b, etc.
774
775 \item \DescribeMacro{\latinAlph}\cmd{\latinAlph\marg{counter}}: Representation of counter as a upper-case letter:
776 1 = A, 2 = B, etc.
777 \end{itemize}
778
779
780 \subsection{Setting up alias commands}
781
782 By means of the macro\new{1.46}
783 \displaycmd{\setlanguagealias\oarg{options}\marg{language}\marg{alias}}{\setlanguagealias}
784 you can define alias commands for specific language (variants). \Eg
785
786 \begin{quote}
787 \begin{verbatim}
788 \setlanguagealias[variant=austrian]{german}{AT}
789 \end{verbatim}
790 \end{quote}
791 %
792 will define a command \cmd{\textAT} as well as an environment ¦{AT}¦ which will link towards
793 the command ¦\textgerman[variant=austrian]¦ and the environment ¦{german}[variant=austrian]¦,
794 respectively. The aliases can also be used in the language switching commands described in
795 section~\ref{sec:langcmds} and \ref{sec:babelcmds}.
796 Note, though, that the usual restrictions for command names apply, so something such as
797 ¦de-AT¦ or ¦de_AT¦ will not work since ¦-¦ and ¦_¦ are not allowed in command names (the same
798 holds true for any non-ASCII character and for digits).
799
800 For the latter case, and for the case where an alias would clash with an existing command
801 (\eg ¦\fi¦) or a \cmd{\text\meta{\ldots}} command (\eg \cmd\textit), a starred version \Cmd{\setlanguagealias*}
802 is provided which does neither define a \cmd{\text\meta{alias}} command nor an \meta{alias} environment,
803 but which will set up the alias for everything else, including \cmd{\textlang\marg{alias}}
804 and \cmd{\begin\{lang\}\marg{alias}}.
805
806 \pkg{Polyglossia} comes with some aliases predefined, namely aliases for \pkg{babel} language names
807 (see sec.~\ref{sec:babelnames}) and for IETF BCP-47 language tags (the latter via \cmd{\setlanguagealias*};
808 see sec.~\ref{sec:langtags}).
809
810 \section{Font setup}
811
812 With \pkg{polyglossia} it is possible to associate a specific font with any script or language
813 that occurs in the document. That font should always be defined as
814 \cmd{\⟨script⟩font}\ or \cmd{\⟨language⟩font}. Note that ¦⟨language⟩¦ points to the \pkg{polyglossia}
815 language name, ¦⟨script⟩¦ might point either to an OpenType script name as defined by \pkg{fontspec}
816 (\eg ¦Latin¦) \new{2.2}or a BCP-47 script tag (\eg ¦Latn¦), though the script is fully lower-cased
817 in the \cmd{\⟨script⟩font}\ command.
818
819 For instance, if the default font defined by \cmd\setmainfont\
820 does not support Greek, then one can define the font used to display Greek with:\\
821 \centerline{\cmd\newfontfamily\cmd{\greekfont[Script=Greek,\meta{…}]\marg{font}}}
822 %
823 If you want to setup a blackletter font specifically for the German blackletter script variant,
824 you might do so by:\\
825 \centerline{\cmd\newfontfamily\cmd{\latffont[\meta{…}]\marg{font}}}
826 %
827 Setting up a font specifically for traditional Chinese is possible via:\\
828 \centerline{\cmd\newfontfamily\cmd{\hantfont[Script=CJK,\meta{…}]\marg{font}}}
829 %
830 Note that \pkg{polyglossia} will use the font defined as is, so assure to do all necessary settings
831 (please refer to the \pkg{fontspec} documentation for details).
832 For instance, if \cmd\arabicfont\ is explicitly defined, then the option ¦Script=Arabic¦ should
833 be included in that definition.
834
835 If a specific sans serif or monospace (`teletype') font is needed for a particular script or language,
836 it can be defined by means of \new{1.2.0}
837 \cmd{\⟨script⟩fontsf} or \cmd{\⟨language⟩fontsf} and \cmd{\⟨script⟩fonttt} or \cmd{\⟨language⟩fonttt}, respectively.
838
839 Whenever a new language is activated, \pkg{polyglossia} will first check whether
840 a font has been defined for that language. If this is not the case, it will check whether a font associated
841 with the BCP-47 script tag of the current language is defined. If this also isn't the case, \pkg{polyglossia}
842 will finally check (but this only for languages in non-Latin scripts) whether there is a font associated
843 with the OpenType script tag. If none of these fonts is defined, \pkg{polyglossia} will use the currently
844 active font as defined by ¦\setmainfont¦, ¦\setsansfont¦ or ¦\setmonofont¦ and – in the case of OpenType fonts –
845 will attempt to turn on the appropriate OpenType tags for the script and language used, in case these are available in
846 the font, by means of \pkg{fontspec}’s \cmd\addfontfeature. If the current font
847 does not appear to support the script of that language, an error message is
848 displayed.
849
850 \section{Adapting hyphenation}
851
852 \subsection{Hyphenation exceptions}
853
854 \TeX\ provides the command \cmd\hyphenation\marg{exceptions} to globally define hyphenation exceptions
855 which override the hyphenation patterns for specified words. The command takes as argument a space-separated
856 list of words where hyphenation points are marked by a dash (if no dash is used, the respective word is not
857 hyphenated at all):
858 \begin{quote}
859 \begin{verbatim}
860 \hyphenation{%
861 po-ly-glos-sia
862 LaTeX
863 }
864 \end{verbatim}
865 \end{quote}
866 %
867 These exceptions, however, apply only to the currently active language.
868
869 In addition to this, \pkg{polyglossia} provides
870 the command\new{1.45}
871 \displaycmd{\pghyphenation\oarg{options}\marg{lang}\marg{exceptions}}{\pghyphenation}
872 which can be used to define exceptions that only apply to a specific language or language variant,
873 respectively.\footnote{More precisely, it applies to all languages or varieties that share the
874 same hyphenation patterns. Hence, for instance, all variants of \xpgoption{german} with
875 \xpgoption{spelling=new} will share the same exceptions, as opposed to \xpgoption{spelling=old}
876 which uses different patterns.}
877
878 \subsection{Hyphenation thresholds}
879
880 \pkg{Polyglossia} sets reasonable defaults for the hyphenation thresholds of each language,
881 \ie the number of characters that must at least be there at the beginning or end of a
882 word before it is hyphenated (\cmd\lefthyphenmin\ and \cmd\righthyphenmin\ in \TeX).
883 For instance, with English, this threshold is 2 at the beginning (`left') and 3 at the end (`right'),
884 so a word will not be hyphenated within the first two characters at the beginning and the last three
885 characters at the end.
886
887 To change this value, \pkg{polyglossia} provides the command\new{1.50}
888 \displaycmd{\setlanghyphenmins\oarg{options}\marg{lang}\marg{l}\marg{r}}{\setlanghyphenmins}
889 %
890 where \meta{lang} is to be replaced with the respective language name or alias, \meta{options}
891 can be used to delimit the modification to a particular variety (\eg via \texttt{variant} or \texttt{spelling}),
892 \meta{l} with the left threshold value (\eg \texttt{3}), and \meta{r} with the right
893 one (\eg \verb|\setlanghyphenmins[spelling=old]{german}{4}{4}|).
894 This setting can be changed repeatedly in the preamble and the document body.
895 It applies to all subsequent text in the respective language (variety), but only after the
896 next language switch.
897
898 \subsection{Hyphenation disabling}
899
900 In some very specific contexts (such as music score creation), \TeX\ hyphenation
901 is something to avoid completely as it may cause troubles.
902 \pkg{Polyglossia} provides two functions: \Cmd\disablehyphenation\ and \Cmd\enablehyphenation.
903 Note that if you select a new language while hyphenation is disabled, it will remain disabled.
904 If you re-enable it, the hyphenation patterns of the currently selected language
905 will be activated.
906
907 \section{Language-specific options and commands}\label{specific}
908
909 This section gives a list of all languages for which options and end-user
910 commands are defined. Note the following conventions:
911 \begin{itemize}
912 \item The preset value of each option (\ie the setting that applies by default,
913 if the option is not explicitly set) is given in \xpgpresetvalue{italics}.
914 \item If an option key may be used without a value, the value that applies
915 for value-less keys is marked by a preceding \xpgdefaultvalue{asterisk}.
916 \end{itemize}
917 For instance, \texttt{babelshorthands = *true} or \texttt{\textit{false}} means that
918 \xpgvalue{babelshorthands} is \xpgvalue{false} by default in the respective language,
919 and that passing \xpgvalue{babelshorthands} (without value) is equivalent to passing
920 \xpgvalue{babelshorthands=true}.
921
922 \subsection{afrikaans}\label{afrikaans}
923 \paragraph*{Options:}
924 \begin{itemize}
925 \item \xpgboolkeyfalse[1.1.1]{babelshorthands}
926 If this is turned on, the following shorthands defined for fine-tuning hyphenation and
927 micro-typography of Afrikaans words are activated:
928 \begin{shorthands}
929 \item[¦"-¦] for an explicit hyphen with a breakpoint, allowing for hyphenation at the
930 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
931 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
932 cases where the hyphen should stick at the following syllable.
933 \item[¦"|¦] disables a ligature at this position.
934 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
935 \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash,
936 hyphenation at the breakpoints preset in the hyphenation patterns is still allowed.
937 \end{shorthands}
938 In addition, the macro \Cmd\- is redefined to allow hyphens in the rest of the word (equivalent to ¦"-¦).
939 \end{itemize}
940
941 \subsection{arabic}\label{arabic}
942 \paragraph*{Options:}
943 \begin{itemize}
944 \item \xpgchoicekey{calendar}{\xpgpresetvalue{gregorian} or \xpgvalue{islamic} (= \xpgvalue{hijri})}
945 \item \xpgoptkey{hijricorrection}{integer}[0]
946 If \xpgvalue{calendar=hijri} or \xpgvalue{calendar=islamic} is selected, \cmd{\today} will output the date
947 according to the lunar Islamic (Hijra) calendar. This option allows to shift the day of the output with respect
948 to the current date. Both positive and negative integer values are allowed (negative decrease the day value).
949 This corresponds to the optional argument of the \cmd{\Hijritoday} command which can be used to output Hijri
950 dates irrespective of the \xpgvalue{calendar} option (see sec.~\ref{sec:hijrical}).
951 \item \xpgchoicekey{locale}{\xpgpresetvalue{default}, \xpgvalue{mashriq}, \xpgvalue{libya},
952 \xpgvalue{algeria}, \xpgvalue{tunisia}, \xpgvalue{morocco}, \xpgvalue{mauritania}}
953 This setting influences the spelling of the month names for the Gregorian calendar,
954 as well as the form of the numerals (unless overridden by the following option). Recommended settings are
955 \xpgvalue{default} for Egypt, Sudan, Yemen and the Gulf states, and \xpgvalue{mashriq} for Iraq, Syria,
956 Jordan, Lebanon and Palestine.
957 \item \xpgchoicekey{numerals}{\xpgpresetvalue{mashriq} (=~\xpgvalue{eastern}\new{1.63}) or \xpgvalue{maghrib}
958 (=~\xpgvalue{western}\new{1.63})}
959 Use Eastern Arabic (a.k.a.\ Indic-Arabic) numerals (\xpgvalue{mashriq} or \xpgvalue{eastern}) or Western numerals
960 (\xpgvalue{maghrib} or \xpgvalue{western}).
961 The latter is the default when \xpgvalue{locale=algeria}, \xpgvalue{tunisia}, or \xpgvalue{morocco}, the former
962 is the default with all other Arabic locales.
963 \item \xpgcodekey[1.63]{sectionsep}¦.¦
964 This option allows to customize the separator between chapters, sections, and subsections (a dot by default),
965 \eg \xpgoption{sectionsep=-}.
966 This might be useful particularly with \xpgoption{numerals=mashriq} or \xpgoption{eastern}, as the dot looks
967 too similar to the zero in many fonts.
968 \item \xpgboolkeyfalse[1.50]{abjadalph}
969 Set this to true if you want the alphabetic counters to be output using \cmd\abjadalph\ rather than \cmd\abjad.
970 Note that this limits the counter scope to 28 (see \cmd\abjadalph\ below).
971 \item \xpgboolkeyfalse[1.0.3]{abjadjimnotail}
972 Set this to true if you want the \textit{abjad} form of the number three to be \textarabic{ج‍} – as in the manuscript
973 tradition – instead of the modern usage \textarabic{ج}.
974 \end{itemize}
975 \paragraph*{Commands:}
976 \begin{itemize}
977 \item \Cmd\abjad outputs Arabic \textit{abjad} numbers according to the Mashriq varieties.
978 Example: ¦\abjad{1863}¦ yields \textarabic{\abjad{1863}}.
979 \item \Cmd\abjadmaghribi outputs Arabic \textit{abjad} numbers according to the Maghrib varieties.
980 Example: ¦\abjadmaghribi{1863}¦ yields \textarabic{\abjadmaghribi{1863}}.
981 \item \Cmd\abjadalph\new{1.50} steps through the Arabic alphabet, thus it can only be used up to 28.
982 Example: ¦\textarabic{\abjadalph{18}}¦ yields \textarabic{\abjadalph{18}}.
983 \item \Cmd\aemph to emphasize text with \cmd\overline.\new{1.2.0}
984 ¦\textarabic{\aemph{اب}}¦ yields \textarabic{\aemph{اب}}.
985 This command is also available for Farsi, Urdu, etc.
986 \end{itemize}
987
988 \subsection{armenian}\label{armenian}
989 \paragraph*{Options:}
990 \begin{itemize}
991 \item \xpgchoicekey[1.45]{variant}{\xpgvalue{eastern} or \xpgpresetvalue{western}}
992 \item \xpgchoicekey[1.45]{numerals}{\xpgvalue{armenian} or \xpgpresetvalue{arabic}}
993 \item \xpgboolkeyfalse[1.63]{capitalyiwn}
994 If this is set to true, \cmd{\MakeUppercase} will upcase the ligature of letters ech and yiwn to capital
995 ech and yiwn. This conforms to the output outside Armenian language selection.
996 By default (and with this option set to \xpgvalue{false}), \cmd{\MakeUppercase} upcases the ech and yiwn
997 ligature to capital ech and \emph{vew}, adhering to Armenian reformed spelling regulations.
998 Note that this feature requires \LaTeX\ kernel 2023/06 at least.
999 \end{itemize}
1000
1001 \subsection[belarusian]{belarusian\new{1.46}}\label{belarusian}
1002
1003 \paragraph*{Options:}
1004 \begin{itemize}
1005 \item \xpgboolkeyfalse{babelshorthands}
1006 If this is turned on, the following shorthands are activated:
1007 \begin{shorthands}
1008 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
1009 in the hyphenation patterns (as opposed to \cmd\-).
1010 \item[¦"=¦] adds an explicit hyphen with a breakpoint, allowing for hyphenation at the
1011 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
1012 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
1013 cases where the hyphen should stick at the following syllable.
1014 \item[¦"|¦] disables a ligature at this position.
1015 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
1016 \item[¦",¦] thinspace for initials with a breakpoint in following surname.
1017 \item[¦"‘¦] for German left double quotes (looks like ,,).
1018 \item[¦"’¦] for German right double quotes (looks like “).
1019 \item[¦"<¦] for French left double quotes (looks like <<).
1020 \item[¦">¦] for French right double quotes (looks like >>).
1021 \end{shorthands}
1022
1023 There are also three shorthands for the Cyrillic dash (\textrussian{тире}), which is shorter than the
1024 emdash but longer than the endash (namely 0.8\,em).
1025 Note that, since it is not covered by unicode, this character is faked by telescoping two endashes:
1026 \begin{shorthands}
1027 \item[¦"---¦] Cyrillic dash for the use in normal text. This requires preceding space
1028 in input (trailing space is optional) and prints with a non-breakable thin space before
1029 and after the dash.
1030 \item[¦"--\textasciitilde¦] Cyrillic dash for the use in compound names (surnames).
1031 As opposed to ¦"---¦ this removes any space before and after the dash.
1032 \item[¦"--*¦] Cyrillic dash for denoting direct speech. This adds a larger space after
1033 the dash. Space before the dash is output as is.
1034 \end{shorthands}
1035 \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
1036 Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
1037 \begin{itemize}
1038 \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
1039 \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
1040 \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
1041 It supports numbers up to 999\,999.
1042 \end{itemize}
1043 \item \xpgchoicekey{spelling}{\xpgpresetvalue{modern} or \xpgvalue{classic} (= \xpgvalue{tarask})}
1044 With ¦spelling=classic¦, captions and dates adhere to the Taraškievica (or
1045 Belarusian classical) orthography rather than the standard orthography.
1046 \end{itemize}
1047
1048 \condbreak{\baselineskip}
1049 \paragraph*{Commands:}
1050 \begin{itemize}
1051 \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
1052 It steps through the Cyrillic alphabet and thus it can only be used up to 30.
1053 The command takes a counter as argument, \eg ¦\textbelarusian{\Asbuk{page}}¦ produces \textrussian{\Asbuk{page}}.
1054 \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
1055 \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
1056 numbers up to 999\,999.\\
1057 \Eg ¦\textbelarusian{\AsbukTrad{page}}¦ produces \textrussian{\AsbukTrad{page}}.
1058 \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
1059 \end{itemize}
1060
1061 \subsection[bengali]{bengali\new{1.2.0}}\label{bengali}
1062 \paragraph*{Options:}
1063 \begin{itemize}
1064 \item \xpgchoicekey{numerals}{\xpgvalue{western}, \xpgvalue{bengali}, or \xpgpresetvalue{devanagari}}
1065 \item \xpgboolkeyfalse{changecounternumbering}
1066 Use specified numerals for headings and page numbers.
1067 \end{itemize}
1068
1069 \subsection{catalan}\label{catalan}
1070 \paragraph*{Options:}
1071 \begin{itemize}
1072 \item \xpgboolkeyfalse[1.1.1]{babelshorthands}
1073 Activates the shorthands \texttt{"l} and \texttt{"L} to type geminated l or L.
1074 \end{itemize}
1075
1076 \paragraph*{Commands:}
1077 \begin{itemize}
1078 \item \Cmd{\l.l} and \Cmd{\L.L}\new{1.1.1} can be used to type a geminated l, as in \textit{co\l.laborar},
1079 similar to \pkg{babel} (the glyph U+00B7 MIDDLE DOT is used as a geminating sign).
1080 \end{itemize}
1081
1082 \subsection[chinese]{chinese\new{1.59}}\label{chinese}
1083 \paragraph*{Options:}
1084 \begin{itemize}
1085 \item \xpgchoicekey{variant}{\xpgpresetvalue{simplified} (= \xpgvalue{cn}), or \xpgvalue{traditional} (= \xpgvalue{tw})}
1086 \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic} or \xpgvalue{chinese}}
1087 Uses either Arabic numerals or Chinese ideographic numbering.
1088 \end{itemize}
1089 \paragraph*{Commands:}
1090 \begin{itemize}
1091 \item \Cmd\chinesenumeral (see section \ref{abjad}).
1092 \end{itemize}
1093
1094 \subsection{croatian}\label{croatian}
1095 \paragraph*{Options:}
1096 \begin{itemize}
1097 \item \xpgboolkeyfalse[1.47]{babelshorthands}
1098 If this is turned on, the following shorthands for fine-tuning hyphenation and micro-typography
1099 of Croatian words are activated.
1100 \begin{shorthands}
1101 \item[¦"|¦] disables a ligature at this position.
1102 \item[¦"=¦] for an explicit hyphen with a breakpoint, allowing for hyphenation at the
1103 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
1104 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
1105 cases where the hyphen should stick at the following syllable.
1106 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
1107 in the hyphenation patterns (as opposed to \cmd\-).
1108 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
1109 \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash, hyphenation
1110 at the breakpoints preset in the hyphenation patterns is still allowed.
1111 \end{shorthands}
1112 Furthermore, the following shorthands generate easy access to Croatian digraphs:
1113 \begin{shorthands}
1114 \item[¦"dz¦] Generates the digraph \charifavailable{01C6}{dž}\ if the font provides it. If not,
1115 the two consecutive glyphs are output mimicking the digraph. Also available for
1116 ¦"Dz¦ (\charifavailable{01C5}{Dž}) and ¦"DZ¦ (\charifavailable{01C4}{DŽ}).
1117 \item[¦"lj¦] Generates the digraph \charifavailable{01C9}{lj}\ if the font provides it. If not,
1118 the two consecutive glyphs are output mimicking the digraph. Also available for
1119 ¦"Lj¦ (\charifavailable{01C8}{Lj}) and ¦"LJ¦ (\charifavailable{01C7}{LJ}).
1120 \item[¦"nj¦] Generates the digraph \charifavailable{01CC}{nj}\ if the font provides it. If not,
1121 the two consecutive glyphs are output mimicking the digraph. Also available for
1122 ¦"Nj¦ (\charifavailable{01CB}{Nj}) and ¦"NJ¦ (\charifavailable{01CA}{NJ}).
1123 \end{shorthands}
1124
1125 Finally, there are also four shorthands for quotation marks:
1126 \begin{shorthands}
1127 \item[¦"`¦] for Croatian left double quotes („).
1128 \item[¦"'¦] for Croatian right double quotes (”).
1129 \item[¦">¦] for Croatian left guillemets (»).
1130 \item[¦"<¦] for Croatian right guillemets («).
1131 \end{shorthands}
1132 \item \xpgboolkeyfalse[1.47]{disabledigraphs}[Up to version 1.53, the option was
1133 called \xpgvalue{disableligatures}. The old option is kept for backwards compatibility,
1134 but the use is discouraged.] If this is \xpgvalue{true}, all Croatian digraphs
1135 (such as \charifavailable{01C6}{dž}) will be replaced by the two consecutive letters,
1136 which is the most common way of typesetting them in Croatian. This can be useful if
1137 the Unicode digraphs in your font are broken (if the font does not have them,
1138 they are automatically mimicked by the two consecutive glyphs).
1139 \item \xpgboolkeytrue[1.53]{localalph}
1140 If \xpgvalue{true}, alphanumeric counters will use a locally established version which excludes
1141 the characters \meta{q}, \meta{w}, \meta{x} and \meta{y} from alphabetic counting.
1142 Obviously this limits the counting range to 22.
1143 \item \xpgboolkeytrue[1.51]{splithyphens}
1144 According to Croatian typesetting conventions, if a word with a hard hyphen (such as
1145 \emph{hrvatsko-engleski}) is hyphenated at this hyphen, a second hyphenation character is to be
1146 inserted at the beginning of the line that follows the hyphenation (\emph{hrvatsko-/-engleski}).
1147 By default, this is done automatically (if you are using \LuaTeX, the \pkg{luavlna} package is
1148 loaded to achieve this).
1149 Set this option to ¦false¦ to disable the feature.
1150 \end{itemize}
1151
1152 \subsection{czech}\label{czech}
1153
1154 \paragraph*{Options:}
1155 \begin{itemize}
1156 \item \xpgboolkeyfalse[1.45]{babelshorthands}
1157 If this is turned on, the following shorthands for Czech are activated:
1158 \begin{shorthands}
1159 \item[¦"=¦] for an explicit hyphen sign which is repeated at the beginning
1160 of the next line when hyphenated, as common in Czech typesetting
1161 (only needed with ¦splithyphens=false¦).
1162 \item[¦"‘¦] for Czech left double quotes („).
1163 \item[¦"’¦] for Czech right double quotes (“).
1164 \item[¦">¦] for Czech left double guillemets (»).
1165 \item[¦"<¦] for Czech right double guillemets («).
1166 \end{shorthands}
1167 \item \xpgboolkeytrue[1.45]{splithyphens}
1168 According to Czech typesetting conventions, if a word with a hard hyphen (such as \emph{je-li})
1169 is hyphenated at this hyphen, a second hyphenation character is to be inserted at the beginning
1170 of the line that follows the hyphenation (\emph{je-/-li}).
1171 By default, this is done automatically\new{1.46} (if you are using \LuaTeX, the \pkg{luavlna} package is
1172 loaded to achieve this).
1173 Set this option to ¦false¦ to disable the feature.
1174 \item \xpgboolkeytrue[1.45]{vlna}
1175 According to Czech typesetting conventions, single-letter words (non-syllable prepositions)
1176 must not occur at line ends.
1177 \pkg{Polyglossia} takes care of this automatically by default\new{1.46} (if you are using \LuaTeX, the
1178 \pkg{luavlna} package is loaded to achieve this).
1179 Set this option to ¦false¦ to disable the feature.
1180 \end{itemize}
1181
1182 \subsection{dutch}\label{dutch}
1183 \paragraph*{Options:}
1184 \begin{itemize}
1185 \item \xpgboolkeytrue[1.63]{tremahyphenation}
1186 Following Dutch orthography, words with tremata (such as \emph{geëxecuteerd}) lose the trema on hyphenation
1187 before the trematized letter (\emph{ge-executeerd}). This is achieved by \pkg{polyglossia} by making those
1188 letters active. If you set this option to false, this mechanism is deactivated (and the hyphenation wrong,
1189 but you can still use the babelshorthands mentioned below).
1190 \item \xpgboolkeyfalse[1.1.1]{babelshorthands}
1191 If this is turned on, the following shorthands defined for fine-tuning hyphenation and
1192 micro-typography of Dutch words are activated:
1193 \begin{shorthands}
1194 \item[¦"a¦]\new{1.63} an \meta{ä} (a with trema) which is hyphenated as \meta{-a} as required by the Dutch standards.
1195 Also implemented for the other vowels (e, i, o, u), both lower and uppercase.
1196 \item[¦"y¦]\new{1.63} the \ij\ ligature.
1197 \item[¦"Y¦]\new{1.63} the \IJ\ ligature.
1198 \item[¦"-¦] for an explicit hyphen with a breakpoint, allowing for hyphenation at the
1199 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
1200 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
1201 cases where the hyphen should stick at the following syllable.
1202 \item[¦"|¦] disables a ligature at this position.
1203 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
1204 \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash,
1205 hyphenation at the breakpoints preset in the hyphenation patterns is still allowed.
1206 \end{shorthands}
1207 In addition, the macro \Cmd\- is redefined to allow hyphens in the rest of the word (equivalent to ¦"-¦).
1208 \end{itemize}
1209
1210 \subsection{english}\label{english}
1211 \paragraph*{Options:}
1212 \begin{itemize}
1213 \item \xpgchoicekey{variant}{\xpgpresetvalue{american} (= \xpgvalue{us}), \xpgvalue{usmax} (same as \xpgvalue{american} but with additional hyphenation patterns),
1214 \xpgvalue{british} (= \xpgvalue{uk}), \xpgvalue{australian}, \xpgvalue{canadian}\new{1.45}, or \xpgvalue{newzealand}}
1215 \item \xpgboolkeyfalse{ordinalmonthday}
1216 The default value is true for \xpgvalue{variant=british}.
1217 \end{itemize}
1218
1219 \subsection{esperanto}\label{esperanto}
1220 \paragraph*{Commands:}
1221 \begin{itemize}
1222 \item \Cmd\hodiau\ and \Cmd\hodiaun are special forms of \cmd\today. The former produces the date in Esperanto
1223 preceded by the article (\emph{la}), which is the most common date format.
1224 The latter produces the same date format in accusative case.
1225 \end{itemize}
1226
1227 \subsection{finnish}\label{finnish}
1228 \paragraph*{Options:}
1229 \begin{itemize}
1230 \item \xpgboolkeyfalse[1.45]{babelshorthands}
1231 If this is turned on, the following shorthands for fine-tuning hyphenation
1232 and micro-typography of Finnish words are activated:
1233 \begin{shorthands}
1234 \item[¦"-¦] adds an explicit hyphen with a breakpoint, allowing for hyphenation at the
1235 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
1236 \item[\texttt{"=}] adds an explicit hyphen without a breakpoint, allowing for hyphenation at the
1237 other points preset in the hyphenation patterns. Useful for
1238 cases where the hyphen should stick at the following syllable
1239 (\eg ¦pakastekaapit ja "-arkut¦).
1240 \item[\texttt{"\textasciitilde}] functionally equivalent to ¦"=¦ (provided for backwards
1241 compatibility reasons).
1242 \item[¦"|¦] disables a ligature at this position.
1243 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
1244 \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash,
1245 hyphenation at the breakpoints preset in the hyphenation patterns is still allowed.
1246 \end{shorthands}
1247 \item \xpgchoicekey[2.0]{hyphens}{\xpgpresetvalue{default}, \xpgvalue{babel}, \xpgvalue{school}}
1248 Hyphenation in Finnish is peculiar since there are many rather long words. In order to select a suitable
1249 hyphenation pattern, three different options are provided:
1250 \begin{itemize}
1251 \item The \xpgvalue{default} patterns as used by \LaTeX\ are rather strict and try to prevent hyphenation
1252 at points which are valid but considered sub-optimal from an ortho-typographic point of view
1253 (\eg hyphenation between two vowels), with the drawback that simple words are sometimes not being
1254 hyphenated at points where this would be valid, and lines might become unevenly spaced.
1255 \item The \pkg{babel} support for Finnish by default tweaks some hyphenation-related values
1256 (such as \cmd\hyphenpenalty) for Finnish. If you want to replicate this with \pkg{polyglossia},
1257 select \xpgvalue{babel} (this still uses the default patterns).
1258 \item The \xpgvalue{school} setting, finally, employs alternative (experimental) hyphenation patterns
1259 rather than the default Finnish patterns. These (so-called `School') patterns allow hyphenation at
1260 all valid points, including hyphenation points that are considered sub-optimal from an
1261 ortho-typographic point of view.\footnote{This equals the previous boolean option \xpgoption{schoolhyphens},
1262 which is still supported for backwards compatibility.}
1263 See \url{https://github.com/hyphenation/basic-finnish} for details.
1264 \end{itemize}
1265 \end{itemize}
1266
1267 \subsection{french}\label{french}
1268 \paragraph*{Options:}
1269 \begin{itemize}
1270 \item \xpgchoicekey{variant}{\xpgpresetvalue{french}, \xpgvalue{canadian}, \xpgvalue{acadian}\new{1.45} or \xpgvalue{swiss}\new{1.47}}
1271 Currently, the only difference between the four variants is that \xpgvalue{swiss}
1272 uses \xpgvalue{thincolonspace=true} by default since this conforms to the Swiss
1273 conventions.
1274 \item \xpgboolkeytrue{autospacing}
1275 One of the most distinct features of French typography is the addition of
1276 extra spacing around punctuation and quotation marks (guillemets). By
1277 default, polyglossia adds these spaces automatically, so you don't need
1278 to enter them. This options allows you to switch this feature off
1279 globally.
1280 \item \xpgboolkeyfalse[1.46]{thincolonspace}
1281 With \xpgvalue{variant=swiss}, the default value is \xpgvalue{true}. If \xpgvalue{false}, a full
1282 (non-breaking) interword space is inserted before a colon. If \xpgvalue{true}, a
1283 thinner space -- as before \texttt{;}, \texttt{!}, and \texttt{?} -- is
1284 used. Note that this option must be set after the ¦variant¦ option.
1285 \item \xpgboolkeytrue{autospaceguillemets}[Up to version 1.44, the option was
1286 called \xpgvalue{automaticspacesaroundguillemets}. For backwards compatibility
1287 reasons, the more verbose old option is still supported.]
1288 If you only want to disable the automatic addition of spacing after
1289 opening and before closing guillemets (and not at punctuation), set this
1290 to \textit{false}. Note that the more general option \textit{autospacing}
1291 overrides this.
1292 \item \xpgboolkeyfalse[1.45]{autospacetypewriter}[Babel's syntax \xpgvalue{OriginalTypewriter}
1293 is also supported.]
1294 By default, automatic spacing is disabled in typewriter font. If this is
1295 enabled, spacing in typewriter context is the same as with roman and sans
1296 serif font, depending on the \xpgvalue{autospacing} and
1297 \xpgvalue{autospaceguillemets} settings (note that this was the default up
1298 to v.~1.44).
1299 \item \xpgboolkeyfalse{frenchfootnote}
1300 If \xpgvalue{true}, footnotes start with a non-superscripted number
1301 followed by a dot, as common in French typography. Note that this might
1302 interfere with the specific footnote handling of classes or packages.
1303 Also note that this option is only functional (by design) if French is
1304 the main language.
1305 \item \xpgboolkeyfalse[1.46]{frenchitemlabels}
1306 If \textit{true}, itemize item labels use em-dashes throughout, as common
1307 in French typography. Note that this option is only functional (by
1308 design) if French is the main language. Also, it might interfere with
1309 list packages such as \pkg{enumitem}.
1310 \item \xpgboolkeytrue[1.51]{frenchpart}
1311 By default, \pkg{polyglossia} modifies part headings to match French conventions
1312 (\emph{Première partie} rather than \emph{Partie I}). Next to the standard classes,
1313 specifics of \pkg{KOMA-script}, \pkg{memoir} and the \pkg{titlesec} package are
1314 taken into account. With other classes or packages, redefinition might fail if these
1315 have particular part settings.
1316 In such case, or if you don't want the redefinition, you can switch off the feature
1317 by passing \textit{false} to this option.
1318 \item \xpgcodekey[1.46]{itemlabels}¦\textemdash¦
1319 If \emph{frenchitemlabels} is true, you can customize here the used item
1320 label of all levels.
1321 \item \xpgcodekey[1.46]{itemlabeli}¦\textemdash¦
1322 If \emph{frenchitemlabels} is true, you can customize here the used item
1323 label of the first level.
1324 \item \xpgcodekey[1.46]{itemlabelii}¦\textemdash¦
1325 If \emph{frenchitemlabels} is true, you can customize here the used item
1326 label of the second level.
1327 \item \xpgcodekey[1.46]{itemlabeliii}¦\textemdash¦
1328 If \emph{frenchitemlabels} is true, you can customize here the used item
1329 label of the third level.
1330 \item \xpgcodekey[1.46]{itemlabeliv}¦\textemdash¦
1331 If \emph{frenchitemlabels} is true, you can customize here the used item
1332 label of the fourth level.
1333 \end{itemize}
1334 \paragraph*{Commands:}
1335 \begin{itemize}
1336 \item \Cmd\NoAutoSpacing\new{1.45} disables automatic spacing around punctuation and quotation marks in all following text. The command can also be used locally if braces are used for grouping: ¦{\NoAutoSpacing foo:bar}¦
1337 \item \Cmd\AutoSpacing\new{1.45} enables automatic spacing around punctuation and quotation marks in all following text. The command can also be used locally if braces are used for grouping: ¦{\AutoSpacing regarde!}¦
1338 \end{itemize}
1339
1340 \subsection[gaelic]{gaelic\new{1.45}}\label{gaelic}
1341 \paragraph*{Options:}
1342 \begin{itemize}
1343 \item \xpgchoicekey{variant}{\xpgpresetvalue{irish} or \xpgvalue{scottish}}
1344 \end{itemize}
1345
1346 \subsection[georgian]{georgian\new{1.46}}\label{georgian}
1347
1348 \paragraph*{Options:}
1349 \begin{itemize}
1350 \item \xpgboolkeyfalse{babelshorthands}
1351 If this is turned on, the following shorthands are activated:
1352 \begin{shorthands}
1353 \item[¦"-¦] adds a hyphenation point that does still allow for
1354 hyphenation at the points preset in the hyphenation patterns (as opposed to \cmd\-).
1355 \item[¦"=¦] adds an explicit hyphen with a breakpoint, allowing for hyphenation at the
1356 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
1357 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
1358 cases where the hyphen should stick at the following syllable.
1359 \item[¦"|¦] disables a ligature at this position.
1360 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
1361 \item[¦",¦] thinspace for initials with a breakpoint in following surname.
1362 \item[¦"‘¦] for German-style left double quotes (looks like ,,).
1363 \item[¦"’¦] for German-style right double quotes (looks like “).
1364 \item[¦"<¦] for French-style left double quotes (looks like <<).
1365 \item[¦">¦] for French-style right double quotes (looks like >>).
1366 \end{shorthands}
1367
1368 There are also three shorthands for the Cyrillic dash (\textrussian{тире}), which is shorter than the
1369 emdash but longer than the endash (namely 0.8\,em).
1370 Note that, since it is not covered by unicode, this character is faked by telescoping two endashes:
1371 \begin{shorthands}
1372 \item[¦"---¦] Cyrillic dash for the use in normal text. This requires preceding space
1373 in input (trailing space is optional) and prints with a non-breakable thin space before
1374 and after the dash.
1375 \item[¦"--\textasciitilde¦] Cyrillic dash for the use in compound names (surnames).
1376 As opposed to ¦"---¦ this removes any space before and after the dash.
1377 \item[¦"--*¦] Cyrillic dash for denoting direct speech. This adds a larger space after
1378 the dash. Space before the dash is output as is.
1379 \end{shorthands}
1380 \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic} or \xpgvalue{georgian}}
1381 Uses either Arabic numerals or Georgian alphanumerical numbering.
1382 \item \xpgboolkeyfalse{oldmonthnames}
1383 Uses traditional Georgian month names.
1384 \end{itemize}
1385
1386 \subsection{german}\label{german}
1387 \paragraph*{Options:}
1388 \begin{itemize}
1389 \item \xpgchoicekey{variant}{\xpgpresetvalue{german}, austrian, or swiss\new{1.33.4}}
1390 Setting \xpgvalue{variant=austrian} or \xpgvalue{variant=swiss} uses some lexical variants.
1391 With \xpgvalue{spelling=old}, \xpgvalue{variant=swiss} furthermore loads specific hyphenation
1392 patterns.
1393 \item \xpgchoicekey{spelling}{\xpgpresetvalue{new} (= \xpgvalue{1996}) or \xpgvalue{old} (= \xpgvalue{1901})}
1394 Indicates whether hyphenation patterns for traditional (1901) or reformed
1395 (1996) orthography should be used. The latter is the default.
1396 \item \xpgboolkeyfalse[1.63]{capitaleszett}
1397 If this is set to true, \cmd{\MakeUppercase} will upcase the eszett character ⟨ß⟩ to the
1398 capital counterpart ⟨\charifavailable{1E9E}{SS}⟩ that has been introduced to Unicode in 2008 and
1399 standardized in German regulations in 2017, rather than ⟨SS⟩. Note that this feature requires
1400 \LaTeX\ kernel 2023/06 at least and a font that contains the respective glyph.
1401 \item \xpgchoicekey[1.2.0]{script}{\xpgpresetvalue{latin} or \xpgvalue{blackletter}\new{1.46} (= \xpgvalue{fraktur})}
1402 Setting ¦script=blackletter¦ adapts the captions for typesetting German in blackletter type, using the `long s' ⟨ſ\kern1.5pt⟩
1403 where appropriate.
1404 \item \xpgboolkeyfalse[1.0.3]{babelshorthands}
1405 If this is turned on, all shorthands defined in \pkg{babel}
1406 for fine-tuning hyphenation and micro-typography of German words are activated.
1407 \begin{shorthands}
1408 \item[¦"ck¦] for ¦ck¦ to be hyphenated as ¦k-k¦ (1901 spelling).
1409 \item[¦"ff¦] for ¦ff¦ to be hyphenated as ¦ff-f¦ (1901 spelling); this is also available
1410 for the letters l, m, n, p, r and t.
1411 \item[¦"|¦] disables a ligature at this position (\eg ¦Auf"|lage¦).
1412 \item[¦"=¦] for an explicit hyphen with a breakpoint, allowing for hyphenation at the
1413 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
1414 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
1415 cases where the hyphen should stick at the following syllable, \eg ¦bergauf und "~ab¦.
1416 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
1417 in the hyphenation patterns (as opposed to \cmd\-).
1418 \item[¦""¦] allows for a line break at this position (without hyphenation sign);
1419 \eg ¦(pseudo"~)""wissenschaftlich¦.
1420 \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash, hyphenation at the breakpoints
1421 preset in the hyphenation patterns is still allowed.
1422 \item[¦".¦]\new{2.10} A dot with ensuing spacing appropriate for abbreviations, as in ¦u".a.¦ (= u.\,a.).
1423 By default this is a non-breakable thinspace, but it can be globally redefined by redefining the macro
1424 \cmd\germanabbrspace\ (see below).
1425 Note that the shorthand eats all preceding and following spaces, so ¦u".a.¦ and ¦u". a.¦ produce
1426 identical output.
1427 \item[¦"*¦]\new{2.0} An asterisk which assures the word can still be hyphenated at its defined breakpoints.
1428 Useful if you want to employ gender-sensitive writing (,gender star`).
1429 Similar shorthands are available for the alternative gender-sensitive spellings, ¦":¦ and ¦"_¦.
1430 \item[¦"x¦]\new{2.0} Inserts a gender mark which assures the word can still be hyphenated at its defined breakpoints.
1431 This is predefined to ¦*¦ but can be globally redefined by redefining the macro \cmd\mkgender\ (see below).
1432 \end{shorthands}
1433
1434 There are also four shorthands for quotation signs:
1435 \begin{shorthands}
1436 \item[¦"`¦] for German-style left double quotes („)
1437 \item[¦"'¦] for German-style right double quotes (“)
1438 \item[¦"<¦] for French-style left double quotes («)
1439 \item[¦">¦] for French-style right double quotes (»).
1440 \end{shorthands}
1441 \end{itemize}
1442 \paragraph*{Commands:}
1443 \begin{itemize}
1444 \item \Cmd\germanabbrspace\new{2.10} Defines the space used after the dot with the shorthand ¦".¦.
1445 Predefined to ¦\def\germanabbrspace{\,}¦.
1446 \item \Cmd\mkgender\new{2.0} Defines which gender mark is output by the babelshorthand ¦"x¦.
1447 Predefined to ¦\def\mkgender{*}¦.
1448 \end{itemize}
1449
1450 \subsection{greek}\label{greek}
1451 \paragraph*{Options:}
1452 \begin{itemize}
1453 \item \xpgchoicekey{variant}{\xpgpresetvalue{monotonic} (= \xpgvalue{mono}), \xpgvalue{polytonic} (= \xpgvalue{poly}), or \xpgvalue{ancient}}
1454 \item \xpgchoicekey{numerals}{\xpgpresetvalue{greek} or \xpgvalue{arabic}}
1455 \item \xpgboolkeyfalse[1.63]{capitaliota}
1456 If this is set to true, \cmd{\MakeUppercase} will upcase the \emph{ypogegrammeni} (subscript muted iota) to capital iota.
1457 By default (and with this option set to \xpgvalue{false}), \cmd{\MakeUppercase} retains the subscript versions.
1458 Note that this feature requires \LaTeX\ kernel 2023/06 at least.
1459 \item \xpgchoicekey[2.6]{koppa}{\xpgpresetvalue{modern} or \xpgvalue{archaic}}
1460 While modern Greek uses the letter koppa in its modern form (ϟ) to represent the number 90, classicists often prefer the
1461 archaic koppa variant (ϙ).
1462 \pkg{Polyglossia} uses by default the modern form in all variants (with \xpgoption{numerals=greek}).
1463 If you need the archaic form, use \xpgoption{koppa=archaic}.
1464 \end{itemize}
1465 \paragraph*{Commands:}
1466 \begin{itemize}
1467 \item \Cmd\Greeknumeral (= \Cmd\Greeknumber) and \Cmd\greeknumeral (= \Cmd\greeknumber) \ (see section \ref{abjad}).
1468 \item The command \Cmd\atticnumeral (= \Cmd\atticnum) displays numbers using the acrophonic
1469 numbering system (defined in the Unicode range
1470 \textsf{U+10140–U+10174}).
1471 Please refer to the documentation of the \pkg{xgreek} package for more details on Attic numbering.
1472 \item\new{2.6} The macros \Cmd\greeknumeralsix, \Cmd\greeknumeralSix, \Cmd\greeknumeralninety\ and
1473 \Cmd\greeknumeralNinety\ determine how the numbers 6 and 90 are represented in lower and
1474 uppercase output. By default, this is ϛ (lowercase 6), Ϛ (uppercase 6), ϟ (lowercase ninety),
1475 and \MakeUppercase{ϟ} (uppercase ninety) -- or, with \xpgoption{koppa=arachaic}, ϙ (lowercase ninety),
1476 and \MakeUppercase{Ϙ} (uppercase ninety). You can redefine the macros if you need other
1477 representations.
1478 \item The macros \Cmd\greektoday and \Cmd\Greektoday produce the current date with the month and the day
1479 represented as Greek numerals instead of Arabic. The former command produces lowercase, the
1480 latter uppercase Greek numerals.
1481 \end{itemize}
1482
1483 \subsection{hebrew}\label{hebrew}
1484 \paragraph*{Options:}
1485 \begin{itemize}
1486 \item \xpgchoicekey{numerals}{\xpgvalue{hebrew} or \xpgpresetvalue{arabic}}
1487 \item \xpgchoicekey{calendar}{\xpgvalue{hebrew} or \xpgpresetvalue{gregorian}}
1488 \item \xpgboolkeyfalse{marcheshvan}
1489 If \xpgvalue{true}, the second month of the civil year will be output as
1490 \texthebrew{מרחשון} (Marcheshvan) rather than \texthebrew{חשון} (Heshvan),
1491 which is the default.
1492 \item \xpgboolkeyfalse[1.57]{fullyear} causes years from the current millennium to be printed with the thousands digit
1493 (he-tav-shin-samekh-gimel). Without this option, thousands are not printed for the current millennium.
1494 \item \xpgchoicekey[1.57]{transliteration}{\xpgvalue{academy} or \xpgpresetvalue{alt}} With value \xpgvalue{academy}, transliteration
1495 follows the recommendations of the Hebrew Language Academy. The default (\xpgvalue{alt}) uses the received settings of
1496 \pkg{babel} (\pkg{hebcal}) and \pkg{polyglossia} (\pkg{hebrewcal}).
1497 \end{itemize}
1498 \paragraph*{Commands:}
1499 \begin{itemize}
1500 \item \Cmd\hebrewnumeral\ (= \Cmd\hebrewalph) (see section \ref{abjad}).
1501 \item \Cmd\aemph (see section \ref{arabic}).
1502 \end{itemize}
1503
1504 \subsection[hindi]{hindi\new{1.2.0}}\label{hindi}
1505 \paragraph*{Options:}
1506 \begin{itemize}
1507 \item \xpgchoicekey{numerals}{\xpgvalue{western} or \xpgpresetvalue{devanagari}}
1508 \end{itemize}
1509
1510 \subsection{hungarian}\label{hungarian}
1511 \paragraph*{Options:}
1512 \begin{itemize}
1513 \item \xpgchoicekey[1.46]{swapstrings}{\xpgdefaultvalue{\xpgpresetvalue{all}},
1514 \xpgvalue{captions}, \xpgvalue{headings}, \xpgvalue{headers}, \xpgvalue{hheaders}, or \xpgvalue{none}}
1515 In Hungarian, some caption strings need to be in a different order than in other languages
1516 (\eg \emph{1. fejezet} instead of \emph{Chapter 1}). By default, \pkg{polyglossia} tries hard to
1517 provide the correct order for different classes and packages (standard classes, \pkg{KOMA-script},
1518 \pkg{memoir}, and \pkg{titlesec} package should work, as well as \pkg{fancyhdr} and \pkg{caption}).
1519 However, since the definition of these strings is not standardized, the redefinitions might not work
1520 and even interfere badly if you use specific classes or packages that redefine the respective strings
1521 themselves. In this case, you can disable some or all changes.
1522 The possibilities are:
1523 \begin{itemize}
1524 \item ¦all¦: Redefine figure and table captions, part and chapter headings, and running headers (=~default setting)
1525 \item ¦captions¦: Redefine figure and table captions only
1526 \item ¦headings¦: Redefine part and chapter headings only
1527 \item ¦headers¦: Redefine running headers only
1528 \item ¦hheaders¦: Redefine part and chapter headings as well as running headers
1529 \item ¦none¦: Do not redefine anything
1530 \end{itemize}
1531 \item \xpgboolkeytrue[1.58]{forceheadingpunctuation}
1532 Section numbers always have a trailing punctuation in Hungarian (as in \emph{1.1.} as opposed to \emph{1.1}).
1533 For compatibility reasons, the default option is \xpgvalue{false}, thus \textsf{polyglossia}
1534 does not touch heading punctuation, so this will be whatever the class or a package determines.
1535 Set this option to \xpgvalue{true},
1536 and \textsf{polyglossia} appends a period after the section counters,
1537 and adjusts the header punctuation (as in \emph{1. fejezet.} as opposed to \emph{1. fejezet}).
1538 \end{itemize}
1539 \paragraph*{Commands:}
1540 \begin{itemize}
1541 \item \Cmd\ontoday\ (= \Cmd\ondatehungarian): special form of \cmd\today\ which produces a slightly different
1542 date format as used in prepositional phrases (such as ‘on February 10th’) in Hungarian.
1543 \end{itemize}
1544
1545 \subsection{italian}\label{italian}
1546 \paragraph*{Options:}
1547 \begin{itemize}
1548 \item \xpgboolkeyfalse[1.2.0cc]{babelshorthands}% TODO: check version
1549 Activates the ¦"¦ character as a switch to perform etymological
1550 hyphenation when followed by a letter. Furthermore, the following shorthands are activated:
1551 \begin{shorthands}
1552 \item[¦""¦] double raised open quotes (the Italian keyboard misses the backtick).
1553 \item[¦"<¦] open guillemet (looks like <<).
1554 \item[¦">¦] closing guillemet (looks like >>).
1555 \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash,
1556 hyphenation at the breakpoints preset in the hyphenation patterns is still allowed.
1557 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
1558 in the hyphenation patterns (as opposed to \cmd\-).
1559 \end{shorthands}
1560 \end{itemize}
1561
1562 \subsection[korean]{korean\new{1.40.0}}\label{korean}
1563 \paragraph*{Options:}
1564 \begin{itemize}
1565 \item \xpgchoicekey{variant}{\xpgpresetvalue{plain}, \xpgvalue{classic}, or \xpgvalue{modern}}
1566 These variants control spacing before/after CJK punctuations.
1567 \begin{itemize}
1568 \item ¦plain¦: Do nothing
1569 \item ¦classic¦: Suitable for text with no interword spaces.
1570 This option forces CJK punctuations to half-width, and
1571 inserts half-width glue around them.
1572 \item ¦modern¦: Suitable for text with interword spaces.
1573 This option forces CJK punctuations to half-width, and
1574 inserts small (half of interword space) glue around them.
1575 \end{itemize}
1576 \item \xpgchoicekey{captions}{\xpgpresetvalue{hangul} or \xpgvalue{hanja}}
1577 \item \xpgchoicekey[1.47]{swapstrings}{\xpgdefaultvalue{\xpgpresetvalue{all}},
1578 \xpgvalue{headers}, \xpgvalue{headings}, or \xpgvalue{none}}
1579 With this option, Korean-style part and chapter headings, and
1580 running headers are available.
1581 It is similar to Hungarian (see \ref{hungarian}) except that
1582 figure and table captions are not touched.
1583 \begin{itemize}
1584 \item ¦all¦: Redefine part and chapter headings, and running headers
1585 (=~default setting)
1586 \item ¦headings¦: Redefine part and chapter headings only
1587 \item ¦headers¦: Redefine running headers only
1588 \item ¦none¦: Do not redefine anything
1589 \end{itemize}
1590 \end{itemize}
1591 \paragraph*{Commands:}
1592 \begin{itemize}
1593 \def\josacmd#1{{\chinesefont\textbackslash#1}}
1594 \item \josacmd 은 \josacmd 는 \josacmd 이 \josacmd 가 \josacmd 을 \josacmd 를
1595 \josacmd 와 \josacmd 과 \josacmd 으 \josacmd 로 \josacmd 라:
1596 commands for automatic selection of \textit{Josa} ({\chinesefont 조사},
1597 a linguistic particle that depends on the pronunciation of previous character).
1598 Be aware that the space after these commands will be swallowed up by \TeX.
1599 To retain the space, you have to append \verb*!\ ! or \verb*!{} ! to the command.
1600 \item \cmd\jung\ \cmd\jong\ \cmd\rieul:
1601 when the automatic selection fails,
1602 you can force the selection of \textit{Josa} by appending one of these commands
1603 to the end of the text that will be referred to.
1604 \cmd\jung\ represents medial vowels;
1605 \cmd\rieul, the trailing consonant {\chinesefont ㄹ};
1606 \cmd\jong, other trailing consonants.
1607 \end{itemize}
1608
1609 \subsection[kurdish]{kurdish\new{1.45}}\label{kurdish}
1610
1611 \paragraph*{Options:}
1612 \begin{itemize}
1613 \item \xpgchoicekey{variant}{\xpgvalue{kurmanji} or \xpgpresetvalue{sorani}}
1614 \item \xpgchoicekey{script}{\xpgvalue{arabic} or \xpgvalue{latin}}
1615 Defaults are \xpgvalue{arabic} for Sorani and \xpgvalue{latin} for Kurmanji.
1616 \item \xpgchoicekey{numerals}{\xpgvalue{western} or \xpgvalue{eastern}}
1617 Defaults are \xpgvalue{western} for Latin and \xpgvalue{eastern} for Arabic script, depending
1618 on the selection above.
1619 \item \xpgcodekey[1.63]{sectionsep}¦.¦
1620 This option allows to customize the separator between chapters, sections, and subsections (a dot by default),
1621 \eg \xpgoption{sectionsep=-}.
1622 This might be useful particularly with \xpgoption{numerals=eastern}, as the dot looks too similar to the zero
1623 in many fonts.
1624 \item \xpgboolkeyfalse{abjadjimnotail}
1625 Set this to true if you want the \textit{abjad} form of the number three to
1626 be \textarabic{ج‍} – as in the manuscript tradition – instead of the
1627 modern usage \textarabic{ج}.
1628 % \item \xpgchoicekey{locale}{} (not yet implemented)
1629 % \item \xpgchoicekey{calendar}{} (not yet implemented)
1630 \end{itemize}
1631 \condbreak{2\baselineskip}
1632 \paragraph*{Commands:}
1633 \begin{itemize}
1634 \item \Cmd\ontoday: special form of \cmd\today\ which produces a slightly different
1635 date format as used in prepositional phrases (as in ‘on February 10th’). Only available for Latin script.
1636 \item \Cmd\abjad (see section \ref{abjad})
1637 \item \Cmd\aemph (see section \ref{arabic})
1638 \end{itemize}
1639
1640 \subsection[kyrgyz]{kyrgyz\new{2.10}}\label{kyrgyz}
1641 \paragraph*{Options:}
1642 \begin{itemize}
1643 \item \xpgboolkeyfalse{babelshorthands}
1644 If this is turned on, the following shorthands are activated:
1645 \begin{shorthands}
1646 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
1647 in the hyphenation patterns (as opposed to \cmd\-).
1648 \item[¦"=¦] adds an explicit hyphen with a breakpoint, allowing for hyphenation at the
1649 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
1650 \item[\texttt{"\textasciitilde}] adds an explicit hyphen without a breakpoint. Useful for
1651 cases where the hyphen should stick at the following syllable.
1652 \item[¦"|¦] disables a ligature at this position.
1653 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
1654 \item[¦",¦] thinspace for initials with a breakpoint in following surname.
1655 \end{shorthands}
1656
1657 There are also three shorthands for the Cyrillic dash (\textrussian{тире}), which is shorter than the
1658 emdash but longer than the endash (namely 0.8\,em).
1659 Note that, since it is not covered by unicode, this character is faked by telescoping two endashes:
1660 \begin{shorthands}
1661 \item[¦"---¦] Cyrillic dash for the use in normal text. This requires preceding space
1662 in input (trailing space is optional) and prints with a non-breakable thin space before
1663 and after the dash.
1664 \item[¦"--\textasciitilde¦] Cyrillic dash for the use in compound names (surnames).
1665 As opposed to ¦"---¦ this removes any space before and after the dash.
1666 \item[¦"--*¦] Cyrillic dash for denoting direct speech. This adds a larger space after
1667 the dash. Space before the dash is output as is.
1668 \end{shorthands}
1669 \item \xpgboolkeytrue{forceheadingpunctuation}
1670 By default, chapter and section numbers always have a trailing punctuation in Kyrgyz
1671 (as in \emph{1.1.} as opposed to \emph{1.1}). If this option is set to \xpgvalue{false}, \textsf{polyglossia}
1672 will not touch heading punctuation, so this will be whatever the class or a package determines.
1673 \item \xpgboolkeytrue{indentfirst}
1674 By default, all paragraphs are indented in Kyrgyz, also those after a
1675 chapter or section heading. If this option is \xpgvalue{false}, the latter paragraphs
1676 are not indented, as normal in \LaTeX.
1677 \item \xpgchoicekey{date}{\xpgvalue{short}, \xpgpresetvalue{long} or \xpgvalue{long-kymonths}}
1678 Determines how dates are represented with \cmd{\today}.
1679 \begin{itemize}
1680 \item \xpgvalue{short} results in short dates such as 30.01.2026.
1681 \item \xpgvalue{long} results in long dated such as \textkyrgyz{2026-жылдын 30-январь}
1682 \item \xpgvalue{long-kymonths} is a long variant that includes Kyrgyz month names,
1683 as in \textkyrgyz{2026-жылдын үчтүн айынын 30у}
1684 \end{itemize}
1685 \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
1686 Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
1687 \begin{itemize}
1688 \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
1689 \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
1690 \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
1691 It supports numbers up to 999\,999.
1692 \end{itemize}
1693 \end{itemize}
1694 %
1695 \paragraph*{Commands:}
1696 \begin{itemize}
1697 \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
1698 It steps through the Cyrillic alphabet and thus it can only be used up to 30.
1699 The command takes a counter as argument, \eg ¦\textkyrgyz{\Asbuk{section}}¦ produces \textkyrgyz{\Asbuk{section}}.
1700 \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
1701 \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
1702 numbers up to 999\,999.\\
1703 \Eg ¦\textkyrgyz{\AsbukTrad{page}}¦ produces \textkyrgyz{\AsbukTrad{page}}.
1704 \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
1705 \end{itemize}
1706
1707
1708 \subsection[lao]{lao\new{1.2.0}}\label{lao}
1709 \paragraph*{Options:}
1710 \begin{itemize}
1711 \item \xpgchoicekey{numerals}{\xpgvalue{lao} or \xpgpresetvalue{arabic}}
1712 \end{itemize}
1713
1714 \subsection{latin}\label{latin}
1715 \paragraph*{Options:}
1716 \begin{itemize}
1717 \item \xpgchoicekey{variant}{\xpgvalue{classic}, \xpgvalue{medieval}, \xpgpresetvalue{modern}, or \xpgvalue{ecclesiastic}\new{1.46}}
1718 These variants refer to different spelling conventions. The \xpgvalue{classic}
1719 and the \xpgvalue{medieval} variant do not use the letters \emph{U} and
1720 \emph{v}, but only \emph{V} and \emph{u}. This concerns predefined terms like
1721 month names as well as the behaviour of the \cmd\MakeUppercase\ and the
1722 \cmd\MakeLowercase\ command. The ¦medieval¦ and the
1723 ¦ecclesiastic¦ variant use the ligatures \emph{\ae} and \emph{\oe}.
1724 See table \ref{tab:latin-spelling} for examples.
1725
1726 Furthermore, the \xpgvalue{ecclesiastic} variant takes care for a punctuation
1727 spacing similar to French, but with smaller spaces, as provided for
1728 PDF\TeX\ by the \pkg{ecclesiastic} package.
1729 \begin{table}[!h]
1730 \centering
1731 \caption{\label{tab:latin-spelling}Spelling differences between the Latin
1732 language variants.\newline The capitalization of month names and the use of
1733 \emph{i/j} may be affected by the \xpgvalue{capitalizemonth} and the
1734 \xpgvalue{usej} option.}
1735 \begin{tabular}{llll}
1736 \toprule
1737 \textbf{classic} & \textbf{medieval} & \textbf{modern} & \textbf{ecclesiastic} \\
1738 \midrule
1739 Ianuarii & Ianuarii & Ianuarii & ianuarii \\
1740 Nouembris & Nouembris & Novembris & novembris \\
1741 Praefatio & Præfatio & Praefatio & Præfatio \\
1742 \addlinespace\multicolumn{4}{@{}l}{\cmd{\MakeUppercase\{Iulius\}} yields:} \\
1743 IVLIVS & IVLIVS & IULIUS & IULIUS \\
1744 \bottomrule
1745 \end{tabular}
1746 \end{table}
1747 \item \xpgchoicekey[1.46]{hyphenation}{\xpgvalue{classic}, \xpgvalue{modern}, or \xpgvalue{liturgical}}
1748 There are three different sets of hyphenation patterns for Latin. Separate
1749 documentation for them is available on the
1750 Internet.\footnote{Refer to \url{https://github.com/gregorio-project/hyphen-la/blob/master/doc/README.md\#hyphenation-styles}}
1751 Each of the four variants mentioned above has its default set of hyphenation
1752 patterns as indicated by table \ref{tab:latin-hyphenation}. Use the
1753 ¦hyphenation¦ option if the default style does not fit your needs.
1754 Note that the liturgical hyphenation patterns are the default of none of the
1755 language variants. To use them, you have to say
1756 \xpgvalue{hyphenation=liturgical} in any case.
1757 \begin{table}
1758 \caption{\label{tab:latin-hyphenation}Latin default hyphenation styles}
1759 \centering
1760 \begin{tabular}{ll}
1761 \toprule
1762 \textbf{Language variant} & \textbf{Default hyphenation style} \\
1763 \midrule
1764 classic & classic \\
1765 medieval & modern \\
1766 modern & modern \\
1767 ecclesiastic & modern \\
1768 \bottomrule
1769 \end{tabular}
1770 \end{table}
1771 \item \xpgboolkeyfalse[1.46]{ecclesiasticfootnotes}
1772 Use footnotes as provided by the \pkg{ecclesiastic} package, which typesets
1773 footnotes with ordinary instead of superior numbers and without indentation.
1774 As many ecclesiastic documents and liturgical books use footnotes that are
1775 very similar to the ordinary \LaTeX\ ones, we do not use this footnote style
1776 as default even for the ¦ecclesiastic¦ variant.
1777
1778 Note that this option is only possible if Latin is the main language of your
1779 document.
1780 \item \xpgboolkeyfalse[1.46]{usej}
1781 Use \emph{J/j} in predefined terms. The letter \emph{j} is not of ancient
1782 origin. In early modern times, it was used to distinguish the consonantic
1783 \emph{i} from the vocalic~\emph{i}. Nowadays, the use of \emph{j} has
1784 disappeared from most Latin publications. So ¦false¦ is the default
1785 value for all four language variants. Use this option if you prefer
1786 \emph{Januarii} and \emph{Maji} to \emph{Ianuarii} and \emph{Maii}.
1787 \item \xpgboolkey[1.46]{capitalizemonth}
1788 Capitalize the month name when printing dates (using the \cmd\today\
1789 command). Traditionally, month names are capitalized. However, in recent
1790 liturgical books they are lowercase. So ¦true¦ is the default value for
1791 the variants ¦classic¦, ¦medieval¦, and ¦modern¦,
1792 whereas ¦false¦ is the default value for the ¦ecclesiastic¦
1793 variant.
1794 \item \xpgboolkeyfalse{babelshorthands}
1795 Enable the following shorthands inherited from \pkg{babel-latin} and the
1796 \pkg{ecclesiastic} package.
1797 \begin{shorthands}
1798 \item[¦"<¦] for « (left guillemet)
1799 \item[¦">¦] for » (right guillemet)
1800 \item[¦"¦] If no other shorthand applies, ¦"¦ before any letter
1801 character defines an optional break point allowing further break points
1802 within the same word (as opposed to the \cmd\- command).
1803 \item[¦"|¦] the same as ¦"¦, but also possible before non-letter
1804 characters
1805 \item[¦'a¦] for á (a with acute), also available for é, í, ó, ú, ý, ǽ, and
1806 \'œ
1807 \item[¦'A¦] for Á (A with acute), also available for É, Í, Ó, Ú, \'V, Ý, Ǽ,
1808 and \'Œ
1809 \end{shorthands}
1810 The following shorthands are only available for the ¦medieval¦ and the
1811 ¦ecclesiastic¦ variant.
1812 \begin{shorthands}
1813 \item[¦"ae¦] for æ (ae ligature), also available for œ
1814 \item[¦"Ae¦] for Æ (AE ligature), also available for Œ
1815 \item[¦"AE¦] for Æ (AE ligature), also available for Œ
1816 \item[¦'ae¦] for ǽ (ae ligature with acute), also available for \'œ
1817 \item[¦'Ae¦] for Ǽ (AE ligature with acute), also available for \'Œ
1818 \item[¦'AE¦] for Ǽ (AE ligature with acute), also available for \'Œ
1819 \end{shorthands}
1820 \item \xpgboolkeyfalse[1.46]{prosodicshorthands}
1821 Enable shorthands for prosodic marks (macrons and breves) very similar to
1822 those provided by \pkg{babel-latin} using the ¦withprosodicmarks¦
1823 modifier.
1824 Note that the active ¦=¦ character used for macrons will cause problems with
1825 commands using \texttt{key=value} interfaces, such as the command
1826 ¦\includegraphics[scale=2]{...}¦. Use \cmd{\shorthandoff\{=\}} before
1827 such commands (and \cmd{\shorthandon\{=\}} thereafter) within every
1828 environment with prosodic shorthands enabled.
1829
1830 The following shorthands are available.
1831 \begin{shorthands}
1832 \item[¦=a¦] for ā (a with macron), also available for ē, ī, ō, ū, and ȳ
1833 \item[¦=A¦] for Ā (A with macron), also available for Ē, Ī, Ō, Ū, V̄, and Ȳ.
1834 Note that a macron above the letter V is only displayed if your font
1835 supports the Unicode character ¦0304¦ (\emph{combining macron}).
1836 \item[¦=ae¦] for a͞e (ae diphthong with macron, for the ¦classic¦ and
1837 the ¦modern¦ variant) or ǣ (ae ligature with macron, for the ¦medieval¦
1838 and the ¦ecclesiastic¦ variant), respectively; also available for a͞u,
1839 e͞u, and o͞e/œ̄. Note that macrons above diphthongs are only displayed if
1840 your font supports the Unicode character ¦035E¦ (\emph{combining double
1841 macron}).
1842 \item[¦=Ae¦] for A͞e (Ae diphthong with macron, for the ¦classic¦ and
1843 the ¦modern¦ variant) or Ǣ (AE ligature with macron, for the ¦medieval¦
1844 and the ¦ecclesiastic¦ variant), respectively; also available for A͞u,
1845 E͞u, and O͞e/Œ̄.
1846 \item[¦=AE¦] for A͞E (AE diphthong with macron, for the ¦classic¦ and
1847 the ¦modern¦ variant) or Ǣ (AE ligature with macron, for the ¦medieval¦
1848 and the ¦ecclesiastic¦ variant), respectively; also available for A͞U,
1849 E͞U, and O͞E/Œ̄.
1850 \item[¦\textasciicircum a¦] for ă (a with breve), also available for ĕ, ĭ,
1851 ŏ, ŭ, and y̆. Note that a breve above the letter y is only displayed if
1852 your font supports the Unicode character ¦0306¦ (\emph{combining
1853 breve}).
1854 \item[¦\textasciicircum A¦] Ă (A with breve), also available for Ĕ, Ĭ, Ŏ,
1855 Ŭ, V̆, and Y̆. Note that breves above the letters V and Y are only displayed
1856 if your font supports the Unicode character ¦0306¦ (\emph{combining
1857 breve}).
1858 \end{shorthands}
1859 \end{itemize}
1860
1861 \subsection{malay}\label{malay}
1862 \paragraph*{Options:}
1863 \begin{itemize}
1864 \item \xpgchoicekey[1.45]{variant}{\xpgvalue{indonesian} or \xpgpresetvalue{malaysian}}
1865 \end{itemize}
1866
1867 \subsection{marathi}\label{marathi}
1868 \paragraph*{Options:}
1869 \begin{itemize}
1870 \item \xpgchoicekey{numerals}{\xpgpresetvalue{devanagari} or \xpgvalue{western}}
1871 \end{itemize}
1872
1873 \subsection[mongolian]{mongolian\new{1.45}}\label{mongolian}
1874 Currently, only the Khalkha variety in Cyrillic script is supported.
1875
1876 \paragraph*{Options:}
1877 \begin{itemize}
1878 \item \xpgboolkeyfalse{babelshorthands}
1879 If this is turned on, the following shorthands are activated:
1880 \begin{shorthands}
1881 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
1882 in the hyphenation patterns (as opposed to \cmd\-).
1883 \item[¦"=¦] adds an explicit hyphen with a breakpoint, allowing for hyphenation at the
1884 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
1885 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
1886 cases where the hyphen should stick at the following syllable.
1887 \item[¦"|¦] disables a ligature at this position.
1888 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
1889 \item[¦",¦] thinspace for initials with a breakpoint in following surname.
1890 \item[¦"‘¦] for German-style left double quotes (looks like ,,).
1891 \item[¦"’¦] for German-style right double quotes (looks like “).
1892 \item[¦"<¦] for French-style left double quotes (looks like <<).
1893 \item[¦">¦] for French-style right double quotes (looks like >>).
1894 \end{shorthands}
1895
1896 There are also three shorthands for the Cyrillic dash (\textrussian{тире}), which is shorter than the
1897 emdash but longer than the endash (namely 0.8\,em).
1898 Note that, since it is not covered by unicode, this character is faked by telescoping two endashes:
1899 \begin{shorthands}
1900 \item[¦"---¦] Cyrillic dash for the use in normal text. This requires preceding space
1901 in input (trailing space is optional) and prints with a non-breakable thin space before
1902 and after the dash.
1903 \item[¦"--\textasciitilde¦] Cyrillic dash for the use in compound names (surnames).
1904 As opposed to ¦"---¦ this removes any space before and after the dash.
1905 \item[¦"--*¦] Cyrillic dash for denoting direct speech. This adds a larger space after
1906 the dash. Space before the dash is output as is.
1907 \end{shorthands}
1908 \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
1909 Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
1910 \begin{itemize}
1911 \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
1912 \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
1913 \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
1914 It supports numbers up to 999\,999.
1915 \end{itemize}
1916 \end{itemize}
1917 %
1918 \paragraph*{Commands:}
1919 \begin{itemize}
1920 \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
1921 It steps through the Cyrillic alphabet and thus it can only be used up to 30.
1922 The command takes a counter as argument, \eg ¦\textmongolian{\Asbuk{section}}¦ produces \textrussian{\Asbuk{section}}.
1923 \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
1924 \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
1925 numbers up to 999\,999.\\
1926 \Eg ¦\textmongolian{\AsbukTrad{section}}¦ produces \textrussian{\AsbukTrad{section}}.
1927 \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
1928 \end{itemize}
1929
1930 \subsection{norwegian}\label{norwegian}
1931 \paragraph*{Options:}
1932 \begin{itemize}
1933 \item \xpgchoicekey[1.45]{variant}{\xpgvalue{bokmal} or \xpgpresetvalue{nynorsk}}
1934 \end{itemize}
1935
1936 \subsection[odia]{odia\new{1.66}}\label{odia}
1937 \paragraph*{Options:}
1938 \begin{itemize}
1939 \item \xpgchoicekey{numerals}{\xpgvalue{western}, \xpgpresetvalue{devanagari}, or \xpgvalue{odia}}
1940 \item \xpgboolkeyfalse{changecounternumbering}
1941 Use specified numerals for headings and page numbers.
1942 \end{itemize}
1943
1944 \subsection{persian}\label{persian}
1945 \paragraph*{Options:}
1946 \begin{itemize}
1947 \item \xpgchoicekey{numerals}{\xpgvalue{western} or \xpgpresetvalue{eastern}}
1948 \item \xpgcodekey[1.63]{sectionsep}¦.¦
1949 This option allows to customize the separator between chapters, sections, and subsections (a dot by default),
1950 \eg \xpgoption{sectionsep=-}.
1951 This might be useful particularly with \xpgoption{numerals=eastern}, as the dot looks too similar to the zero
1952 in many fonts.
1953 \item \xpgboolkeyfalse[1.0.3]{abjadjimnotail}
1954 Set this to \xpgvalue{true} if you want the \textit{abjad} form of the number three to
1955 be \textarabic{ج‍} – as in the manuscript tradition – instead of the
1956 modern usage \textarabic{ج}.
1957 % \item \xpgchoicekey{locale}{} (not yet implemented)
1958 % \item \xpgchoicekey{calendar}{} (not yet implemented)
1959 \end{itemize}
1960 \paragraph*{Commands:}
1961 \begin{itemize}
1962 \item \Cmd\abjad (see section \ref{abjad})
1963 \item \Cmd\aemph (see section \ref{arabic}).
1964 \end{itemize}
1965
1966 \subsection{polish}\label{polish}
1967
1968 \paragraph*{Options:}
1969 \begin{itemize}
1970 \item \xpgboolkeyfalse[1.55]{babelshorthands}
1971 If this is turned on, the following shorthands for Polish are activated:
1972 \begin{shorthands}
1973 \item[¦"=¦] for an explicit hyphen sign which is repeated at the beginning
1974 of the next line when hyphenated, as common in Polish typesetting
1975 (also if ¦splithyphens=false¦). Unlike plain ¦-¦, this also allows
1976 for hyphenation at the other points preset in the hyphenation patterns.
1977 \item[¦"|¦] disables a ligature at this position.
1978 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
1979 cases where the hyphen should stick at the following syllable.
1980 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
1981 in the hyphenation patterns (as opposed to \cmd\-).
1982 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
1983 \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash, hyphenation at the breakpoints
1984 preset in the hyphenation patterns is still allowed.
1985 \item[¦"`¦] for Polish left double quotes (looks like ,,).
1986 \item[¦"'¦] for Polish right double quotes (looks like '').
1987 \item[¦"<¦] for French left double guillemets (looks like << -- used in Polish as second level quotes).
1988 \item[¦">¦] for French right double guillemets (looks like >>).
1989 \end{shorthands}
1990 \item \xpgboolkeytrue[1.55]{splithyphens}
1991 According to Polish typesetting conventions, if a word with a hard hyphen (such as \emph{czerwono-złote})
1992 is hyphenated at this hyphen, a second hyphenation character is to be inserted at the beginning
1993 of the line that follows the hyphenation (\emph{czerwono-/-złote}).
1994 By default, this is done automatically (if you are using \LuaTeX, the \pkg{luavlna} package is
1995 loaded to achieve this).
1996 Set this option to ¦false¦ to disable the feature.
1997 \item \xpgboolkeytrue[1.55]{vlna}
1998 According to Polish typesetting conventions, single-letter words (non-syllable prepositions)
1999 must not occur at line ends.
2000 \pkg{Polyglossia} takes care of this automatically by default (if you are using \LuaTeX, the
2001 \pkg{luavlna} package is loaded to achieve this).
2002 Set this option to ¦false¦ to disable the feature.
2003 \end{itemize}
2004
2005 \subsection{portuguese}\label{portuguese}
2006 \paragraph*{Options:}
2007 \begin{itemize}
2008 \item \xpgchoicekey[1.45]{variant}{\xpgvalue{brazilian} or \xpgpresetvalue{portuguese}}
2009 \item \xpgboolkeyfalse[1.54]{babelshorthands}
2010 If this is turned on, the following shorthands for fine-tuning hyphenation and micro-typography
2011 of Portuguese words are activated.
2012 \begin{shorthands}
2013 \item[¦"|¦] disables a ligature at this position.
2014 \item[¦"=¦] for an explicit hyphen sign which is repeated at the beginning
2015 of the next line when hyphenated, as common in Portuguese typesetting
2016 (also if ¦splithyphens=false¦). Unlike plain ¦-¦, this also allows
2017 for hyphenation at the other points preset in the hyphenation patterns.
2018 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
2019 cases where the hyphen should stick at the following syllable.
2020 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
2021 in the hyphenation patterns (as opposed to \cmd\-).
2022 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
2023 \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash, hyphenation
2024 at the breakpoints preset in the hyphenation patterns is still allowed.
2025 \item[¦"<¦] for French left guillemets («).
2026 \item[¦">¦] for French right guillemets (»).
2027 \end{shorthands}
2028 \item \xpgboolkeytrue[1.54]{splithyphens}
2029 According to Portuguese typesetting conventions, if a word with a hard hyphen (such as
2030 \emph{para-brisas}) is hyphenated at this hyphen, a second hyphenation character is to be
2031 inserted at the beginning of the line that follows the hyphenation (\emph{para-/-brisas}).
2032 By default, this is done automatically (if you are using \LuaTeX, the \pkg{luavlna} package is
2033 loaded to achieve this).
2034 Set this option to ¦false¦ to disable the feature.
2035 \end{itemize}
2036
2037 \subsection[punjabi]{punjabi\new{1.59}}\label{punjabi}
2038 \paragraph*{Options:}
2039 \begin{itemize}
2040 \item \xpgchoicekey{numerals}{\xpgvalue{western} or \xpgpresetvalue{gurmukhi}}
2041 \end{itemize}
2042
2043 \subsection{russian}\label{russian}
2044 \paragraph*{Options:}
2045 \begin{itemize}
2046 \item \xpgboolkeyfalse{babelshorthands}
2047 If this is turned on, the following shorthands are activated:
2048 \begin{shorthands}
2049 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
2050 in the hyphenation patterns (as opposed to \cmd\-).
2051 \item[¦"=¦] adds an explicit hyphen with a breakpoint, allowing for hyphenation at the
2052 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
2053 \item[\texttt{"\textasciitilde}] adds an explicit hyphen without a breakpoint. Useful for
2054 cases where the hyphen should stick at the following syllable.
2055 \item[¦"|¦] disables a ligature at this position.
2056 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
2057 \item[¦",¦] thinspace for initials with a breakpoint in following surname.
2058 \end{shorthands}
2059
2060 There are also three shorthands for the Cyrillic dash (\textrussian{тире}), which is shorter than the
2061 emdash but longer than the endash (namely 0.8\,em).
2062 Note that, since it is not covered by unicode, this character is faked by telescoping two endashes:
2063 \begin{shorthands}
2064 \item[¦"---¦] Cyrillic dash for the use in normal text. This requires preceding space
2065 in input (trailing space is optional) and prints with a non-breakable thin space before
2066 and after the dash.
2067 \item[¦"--\textasciitilde¦] Cyrillic dash for the use in compound names (surnames).
2068 As opposed to ¦"---¦ this removes any space before and after the dash.
2069 \item[¦"--*¦] Cyrillic dash for denoting direct speech. This adds a larger space after
2070 the dash. Space before the dash is output as is.
2071 % These are commented out in gloss-russian
2072 % \item[¦",¦] thinspace for initials with a breakpoint in following surname.
2073 % \item[¦"‘¦] for German left double quotes (looks like ,,).
2074 % \item[¦"’¦] for German right double quotes (looks like “).
2075 % \item[¦"<¦] for French left double quotes (looks like <<).
2076 % \item[¦">¦] for French right double quotes (looks like >>).
2077 \end{shorthands}
2078 \item \xpgboolkeytrue[1.50]{forceheadingpunctuation}
2079 By default, chapter and section numbers always have a trailing punctuation in Russian
2080 (as in \emph{1.1.} as opposed to \emph{1.1}). If this option is set to \xpgvalue{false}, \textsf{polyglossia}
2081 will not touch heading punctuation, so this will be whatever the class or a package determines.
2082 \item \xpgboolkeytrue[1.46]{indentfirst}
2083 By default, all paragraphs are indented in Russian, also those after a
2084 chapter or section heading. If this option is \xpgvalue{false}, the latter paragraphs
2085 are not indented, as normal in \LaTeX.
2086 \item \xpgboolkeytrue[1.52]{mathfunctions}
2087 By default, some specific math macros are defined for Russian (see below). In order to prevent command
2088 clashes (\eg with the \pkg{chemformula} package), you can switch these definitions off by passing \xpgvalue{false}
2089 to this option.
2090 \item \xpgchoicekey{spelling}{\xpgpresetvalue{modern} or \xpgvalue{old}}
2091 This option is for captions and date only, not for hyphenation.
2092 \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
2093 Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
2094 \begin{itemize}
2095 \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
2096 \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
2097 \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
2098 It supports numbers up to 999\,999.
2099 \end{itemize}
2100 \end{itemize}
2101 %
2102 \paragraph*{Commands:}
2103 \begin{itemize}
2104 \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
2105 It steps through the Cyrillic alphabet and thus it can only be used up to 30.
2106 The command takes a counter as argument, \eg ¦\textrussian{\Asbuk{section}}¦ produces \textrussian{\Asbuk{section}}.
2107 \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
2108 \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
2109 numbers up to 999\,999.\\
2110 \Eg ¦\textrussian{\AsbukTrad{page}}¦ produces \textrussian{\AsbukTrad{page}}.
2111 \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
2112 \end{itemize}
2113 If the \xpgoption{mathfunctions} option is \xpgvalue{true}, loading Russian defines a few macros than can be used
2114 independently of the current language. These are nine macros to be used in math mode to type the names of
2115 trigonometric functions common for Russian documents: \cmd\sh , \cmd\ch , \cmd\tg , \cmd\ctg , \cmd\arctg ,
2116 \cmd\arcctg , \cmd\th , \cmd\cth , and \cmd\cosec . Cyrillic letters in math mode can be typed with
2117 the aid of text commands such as \cmd\textbf , \cmd\textsf , \cmd\textit , \cmd\texttt , etc.
2118 The macros \cmd\Prob , \cmd\Variance , \cmd\NOD , \cmd\nod , \cmd\NOK , \cmd\nok , \cmd\Proj\ print some rare
2119 Russian mathematical symbols.
2120
2121 \subsection[sami]{sami\new{1.45}}\label{sami}
2122 Currently support for Sami is limited to Northern Sami.
2123
2124 \subsection{sanskrit}\label{sanskrit}
2125 \paragraph*{Options:}
2126 \begin{itemize}
2127 \item \xpgchoicekey[1.0.2]{script}{\xpgpresetvalue{devanagari}, \xpgvalue{gujarati},
2128 \xpgvalue{malayalam}, \xpgvalue{bengali}, \xpgvalue{kannada}, \xpgvalue{telugu}, \xpgvalue{latin}}
2129 The value is passed to \pkg{fontspec} should the respective
2130 \cmd{\⟨script⟩font} not be defined. This can be useful if you typeset Sanskrit
2131 texts in scripts other than Devanagari.
2132 \item \xpgchoicekey[1.45]{numerals}{\xpgpresetvalue{devanagari} or \xpgvalue{western}}
2133 \end{itemize}
2134
2135 \subsection{serbian}\label{serbian}
2136 \paragraph*{Options:}
2137 \begin{itemize}
2138 \item \xpgchoicekey[1.63]{variant}{\xpgpresetvalue{ekavian} or \xpgvalue{ijekavian}}
2139 With \xpgvalue{ijekavian}, the different spelling is reflected in some caption strings.
2140 \item \xpgchoicekey{script}{\xpgpresetvalue{cyrillic} or \xpgvalue{latin}}
2141 \item \xpgboolkeyfalse[1.63]{datei}
2142 If this is \xpgvalue{true}, the sixth and seventh month of the year are written in the date
2143 with the trailing \meta{i} or \meta{и} (\ie \emph{juni}, \emph{juli} or \emph{јуни}, \emph{јули}
2144 rather than \emph{jun}, \emph{jul} or \emph{јун}, \emph{јул}).
2145 \item \xpgboolkeytrue[1.54]{splithyphens}
2146 According to Serbian typesetting conventions, if a word with a hard hyphen (such as
2147 \emph{калцијум-карбонат}) is hyphenated at this hyphen, a second hyphenation character is to be
2148 inserted at the beginning of the line that follows the hyphenation (\emph{калцијум-/-карбонат}).
2149 By default, this is done automatically (if you are using \LuaTeX, the \pkg{luavlna} package is
2150 loaded to achieve this).
2151 Set this option to ¦false¦ to disable the feature.
2152 \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
2153 Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
2154 \begin{itemize}
2155 \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
2156 \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
2157 \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
2158 It supports numbers up to 999\,999.
2159 \end{itemize}
2160 \end{itemize}
2161 %
2162 \paragraph*{Commands:}
2163 \begin{itemize}
2164 \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
2165 It steps through the Cyrillic alphabet and thus it can only be used up to 30.
2166 The command takes a counter as argument, \eg ¦\textserbian{\Asbuk{section}}¦ produces \textrussian{\Asbuk{section}}.
2167 \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
2168 \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
2169 numbers up to 999\,999.\\
2170 \Eg ¦\textserbian{\AsbukTrad{page}}¦ produces \textrussian{\AsbukTrad{page}}.
2171 \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
2172 \item \Cmd{\today*}: as opposed to the unstarred counterpart, this does not end the date with a punctuation.
2173 \item \Cmd{\todayGen}: outputs the date with months in genitive inflection. This form is suggested when the date
2174 is integrated into a sentence (as opposed to a standalone date statement). The starred form \Cmd{\todayGen*}
2175 omits the trailing punctuation.
2176 \item \Cmd{\todayArabic}: outputs the date with months in Arabic number. The starred form \Cmd{\todayArabic*} omits
2177 the trailing punctuation.
2178 \item \Cmd{\todayRoman}: outputs the date with months in Roman number. The starred form \Cmd{\todayRoman*} omits
2179 the trailing punctuation.
2180 \end{itemize}
2181
2182
2183 \subsection{slovak}\label{slovak}
2184
2185 \paragraph*{Options:}
2186 \begin{itemize}
2187 \item \xpgboolkeyfalse[1.46]{babelshorthands}
2188 If this is turned on, the following shorthands for Slovak are activated:
2189 \begin{shorthands}
2190 \item[¦"=¦] for an explicit hyphen sign which is repeated at the beginning
2191 of the next line when hyphenated, as common in Slovak typesetting
2192 (also if ¦splithyphens=false¦). Unlike plain ¦-¦, this also allows
2193 for hyphenation at the other points preset in the hyphenation patterns.
2194 \item[¦"|¦] disables a ligature at this position.
2195 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
2196 cases where the hyphen should stick at the following syllable.
2197 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
2198 in the hyphenation patterns (as opposed to \cmd\-).
2199 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
2200 \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash, hyphenation at the breakpoints
2201 preset in the hyphenation patterns is still allowed.
2202 \item[¦"‘¦] for Slovak left double quotes (looks like ,,).
2203 \item[¦"’¦] for Slovak right double quotes (looks like “).
2204 \item[¦">¦] for Slovak left double guillemets (looks like >>).
2205 \item[¦"<¦] for Slovak right double guillemets (looks like <<).
2206 \end{shorthands}
2207 \item \xpgboolkeytrue[1.46]{splithyphens}
2208 According to Slovak typesetting conventions, if a word with a hard hyphen (such as \emph{je-li})
2209 is hyphenated at this hyphen, a second hyphenation character is to be inserted at the beginning
2210 of the line that follows the hyphenation (\emph{je-/-li}).
2211 By default, this is done automatically (if you are using \LuaTeX, the \pkg{luavlna} package is
2212 loaded to achieve this).
2213 Set this option to ¦false¦ to disable the feature.
2214 \item \xpgboolkeytrue[1.46]{vlna}
2215 According to Slovak typesetting conventions, single-letter words (non-syllable prepositions)
2216 must not occur at line ends.
2217 \pkg{Polyglossia} takes care of this automatically by default (if you are using \LuaTeX, the
2218 \pkg{luavlna} package is loaded to achieve this).
2219 Set this option to ¦false¦ to disable the feature.
2220 \end{itemize}
2221
2222 \subsection{slovenian}\label{slovenian}
2223 \paragraph*{Options:}
2224 \begin{itemize}
2225 \item \xpgboolkeyfalse{localalph}
2226 If \xpgvalue{true}, alphanumeric counters will use a localized version including characters with caron
2227 (\emph{a, b, c, č, d, \ldots}) and excluding the characters \meta{q}, \meta{w}, \meta{x} and \meta{y}
2228 from alphabetic counting.
2229 \end{itemize}
2230
2231 \subsection{sorbian}\label{sorbian}
2232 \paragraph*{Options:}
2233 \begin{itemize}
2234 \item \xpgchoicekey[1.45]{variant}{\xpgvalue{lower} or \xpgpresetvalue{upper}}
2235 \item \xpgboolkeyfalse[1.45]{olddate}
2236 If \xpgvalue{true}, \cmd\today\ will use traditional Sorbian month names (\ie it will be
2237 synonymous to \cmd\oldtoday\ below).
2238 \end{itemize}
2239 \paragraph*{Commands:}
2240 \begin{itemize}
2241 \item \Cmd\oldtoday: outputs the current date using traditional Sorbian month names, even if
2242 \xpgvalue{olddate} is \xpgvalue{false}.
2243 \end{itemize}
2244
2245 \subsection{spanish}\label{spanish}
2246 \paragraph*{Options:}
2247 \begin{itemize}
2248 \item \xpgchoicekey[1.46]{variant}{\xpgpresetvalue{spanish} or \xpgvalue{mexican}}
2249 \item \xpgchoicekey[1.46]{spanishoperators}{\xpgdefaultvalue{all}, \xpgvalue{accented},
2250 \xpgvalue{spaced}, \xpgvalue{none}, or \xpgpresetvalue{false}}
2251 Determines of and how math operators are localized to Spanish.
2252 \begin{itemize}
2253 \item ¦accented¦ causes some math operators to use accents where usual in Spanish (\emph{lím},
2254 \emph{lím\,sup}, \emph{lím\,inf}, \emph{máx}, \emph{mín}, \emph{ínf}, \emph{mód}).
2255 \item ¦spaced¦ causes some math operators to use spaces where usual in Spanish (\emph{arc\,cos},
2256 \emph{arc\,sen}, \emph{arc\,tg}).
2257 \item ¦all¦ activates ¦accented¦ and ¦spaced¦ and furthermore provides Spanish localizations of
2258 \cmd\sin\ (\emph{sen}), \cmd\tan\ (\emph{tg}), \cmd\sinh\ (\emph{senh}), and \cmd\tanh\ (\emph{tgh}).
2259 \item ¦none¦ does no localization at all (default setting).
2260 \end{itemize}
2261 \end{itemize}
2262 \paragraph*{\color{black}Commands:}\new{1.46}
2263 \begin{itemize}
2264 \item \Cmd\arcsen: alias to \cmd\arcsin\ (\pkg{babel} compatibility)
2265 \item \Cmd\arctg: alias to \cmd\arctan\ (\pkg{babel} compatibility)
2266 \item \Cmd\sen: alias to \cmd\sin\ (\pkg{babel} compatibility)
2267 \item \Cmd\senh: alias to \cmd\sinh\ (\pkg{babel} compatibility)
2268 \item \Cmd\tg: alias to \cmd\tan\ (\pkg{babel} compatibility)
2269 \item \Cmd\tgh: alias to \cmd\tanh\ (\pkg{babel} compatibility)
2270 \item \Cmd\spanishoperator: allows you to define further localized operators. For instance, ¦\spanishoperator{cotg}¦
2271 defines a command \cmd\cotg\ that outputs \emph{cotg} in math. The optional argument of the command lets you specify the
2272 spelling, if needed, \eg ¦\spanishoperator[arc\,ctg]{arcctg}¦.
2273 \end{itemize}
2274
2275 \subsection{syriac}\label{syriac}
2276 \paragraph*{Options:}
2277 \begin{itemize}
2278 \item \xpgchoicekey[1.0.1]{numerals}{\xpgpresetvalue{western} (\ie 1234567890), \xpgvalue{eastern}
2279 (for which the Oriental Arabic numerals are used: \textarabic{١٢٣٤٥٦٧٨٩٠}), or
2280 \xpgvalue{abjad}}
2281 \item \xpgcodekey[1.63]{sectionsep}¦.¦
2282 This option allows to customize the separator between chapters, sections, and subsections (a dot by default),
2283 \eg \xpgoption{sectionsep=-}.
2284 This might be useful particularly with \xpgoption{numerals=eastern}, as the dot looks too similar to the zero
2285 in many fonts.
2286 \end{itemize}
2287 \paragraph*{Commands:}
2288 \begin{itemize}
2289 \item \Cmd\abjadsyriac (see section \ref{abjad})
2290 \item \Cmd\aemph (see section \ref{arabic}).
2291 \end{itemize}
2292
2293 \subsection{thai}\label{thai}
2294 \paragraph*{Options:}
2295 \begin{itemize}
2296 \item \xpgchoicekey{numerals}{\xpgvalue{thai} or \xpgpresetvalue{arabic}}
2297 \end{itemize}
2298 %
2299 To insert word breaks, you need to use an external processor.
2300 See the documentation to \pkg{thai-latex} and the file \file{testthai.tex}
2301 that comes with this package.
2302
2303 \subsection{tibetan}\label{tibetan}
2304 \paragraph*{Options:}
2305 \begin{itemize}
2306 \item \xpgchoicekey{numerals}{\xpgvalue{tibetan} or \xpgpresetvalue{arabic}}
2307 \end{itemize}
2308
2309 \subsection{ukrainian}\label{ukrainian}
2310
2311 \paragraph*{Options:}
2312 \begin{itemize}
2313 \item \xpgboolkeyfalse{babelshorthands}
2314 If this is turned on, the following shorthands are activated:
2315 \begin{shorthands}
2316 \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
2317 in the hyphenation patterns (as opposed to \cmd\-).
2318 \item[¦"=¦] adds an explicit hyphen with a breakpoint, allowing for hyphenation at the
2319 other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
2320 \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
2321 cases where the hyphen should stick at the following syllable.
2322 \item[¦"|¦] disables a ligature at this position.
2323 \item[¦""¦] allows for a line break at this position (without hyphenation sign).
2324 \item[¦",¦] thinspace for initials with a breakpoint in following surname.
2325 % These are commented out in gloss-ukrainian
2326 % \item[¦",¦] thinspace for initials with a breakpoint in following surname.
2327 % \item[¦"‘¦] for German left double quotes (looks like ,,).
2328 % \item[¦"’¦] for German right double quotes (looks like “).
2329 % \item[¦"<¦] for French left double quotes (looks like <<).
2330 % \item[¦">¦] for French right double quotes (looks like >>).
2331 \end{shorthands}
2332
2333 There are also three shorthands for the Cyrillic dash (\textrussian{тире}), which is shorter than the
2334 emdash but longer than the endash (namely 0.8\,em).
2335 Note that, since it is not covered by unicode, this character is faked by telescoping two endashes:
2336 \begin{shorthands}
2337 \item[¦"---¦] Cyrillic dash for the use in normal text. This requires preceding space
2338 in input (trailing space is optional) and prints with a non-breakable thin space before
2339 and after the dash.
2340 \item[¦"--\textasciitilde¦] Cyrillic dash for the use in compound names (surnames).
2341 As opposed to ¦"---¦ this removes any space before and after the dash.
2342 \item[¦"--*¦] Cyrillic dash for denoting direct speech. This adds a larger space after
2343 the dash. Space before the dash is output as is.
2344 \end{shorthands}
2345 \item \xpgboolkeytrue[1.52]{mathfunctions}
2346 By default, some specific math macros are defined for Ukrainian (see below). In order to prevent command
2347 clashes (\eg with the \pkg{chemformula} package), you can switch these definitions off by passing \xpgvalue{false}
2348 to this option.
2349 \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
2350 Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
2351 \begin{itemize}
2352 \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
2353 \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
2354 \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
2355 It supports numbers up to 999\,999.
2356 \end{itemize}
2357 \end{itemize}
2358 %
2359 \paragraph*{Commands:}
2360 \begin{itemize}
2361 \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
2362 It steps through the Cyrillic alphabet and thus it can only be used up to 30.
2363 The command takes a counter as argument, \eg ¦\textukrainian{\Asbuk{section}}¦ produces \textrussian{\Asbuk{section}}.
2364 \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
2365 \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
2366 numbers up to 999\,999.\\
2367 \Eg ¦\textukrainian{\AsbukTrad{page}}¦ produces \textrussian{\AsbukTrad{page}}.
2368 \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
2369 \end{itemize}
2370 %
2371 If the \xpgoption{mathfunctions} option is \xpgvalue{true}, loading Ukrainian defines a few macros than can be used
2372 independently of the current language. These are nine macros to be used in math mode to type the names of
2373 trigonometric functions common for Ukrainian documents: \cmd\sh , \cmd\ch , \cmd\tg , \cmd\ctg , \cmd\arctg ,
2374 \cmd\arcctg , \cmd\th , \cmd\cth , and \cmd\cosec . Cyrillic letters in math mode can be typed with
2375 the aid of text commands such as \cmd\textbf , \cmd\textsf , \cmd\textit , \cmd\texttt , etc.
2376 The macros \cmd\Prob , \cmd\Variance , \cmd\NOD , \cmd\nod , \cmd\NOK , \cmd\nok , \cmd\NSD , \cmd\nsd , \cmd\NSK ,
2377 \cmd\nsk , \cmd\Proj\ print some rare
2378 Ukrainian mathematical symbols.
2379
2380 \subsection{urdu}\label{urdu}
2381 \paragraph*{Options:}
2382 \begin{itemize}
2383 \item \xpgchoicekey{calendar}{\xpgpresetvalue{gregorian} or \xpgvalue{hijri}}
2384 \item \xpgoptkey{hijricorrection}{integer}[0]
2385 If \xpgvalue{calendar=hijri} is selected, \cmd{\today} will output the date
2386 according to the lunar Islamic (Hijra) calendar. This option allows to shift the day of the output with respect
2387 to the current date. Both positive and negative integer values are allowed (negative decrease the day value).
2388 This corresponds to the optional argument of the \cmd{\Hijritoday} command which can be used to output Hijri
2389 dates irrespective of the \xpgvalue{calendar} option (see sec.~\ref{sec:hijrical}).
2390 \item \xpgchoicekey{numerals}{\xpgvalue{western} or \xpgpresetvalue{eastern}}
2391 \item \xpgcodekey[1.63]{sectionsep}¦.¦
2392 This option allows to customize the separator between chapters, sections, and subsections (a dot by default),
2393 \eg \xpgoption{sectionsep=-}.
2394 This might be useful particularly with \xpgoption{numerals=eastern}, as the dot looks too similar to the zero
2395 in many fonts.
2396 \item \xpgboolkeyfalse{abjadjimnotail}
2397 Set this to \xpgvalue{true} if you want the \textit{abjad} form of the number three to
2398 be \textarabic{ج‍} – as in the manuscript tradition – instead of the
2399 modern usage \textarabic{ج}.
2400 \end{itemize}
2401
2402 \subsection{uyghur}\label{uyghur}
2403 \paragraph*{Options:}
2404 \begin{itemize}
2405 \item \xpgchoicekey[1.53]{chapterformat}{\xpgdefaultvalue{\xpgpresetvalue{ordinal}},
2406 \xpgvalue{roman}, \xpgvalue{arabic}}
2407 In Uyghur, chapter and part headings usually use ordinals rather than numbers. Alternatively Roman numbers
2408 are common as well. By default, \pkg{polyglossia} uses ordinals.
2409 This option allows to change this. Choices are:
2410 \begin{itemize}
2411 \item ¦ordinal¦: Use ordinals for chapter and part headings (=~default setting)
2412 \item ¦roman¦: Use Roman numbering for chapter and part heading.
2413 \item ¦arabic¦: Use Arabic numbering for chapter and part heading (=~LaTeX default).
2414 \end{itemize}
2415 Note that this option only works if \xpgoption{swapstrings} is set to \xpgvalue{all}, \xpgvalue{headings} or
2416 \xpgvalue{hheaders}. The caveats for that options (see below) apply.
2417 \item \xpgchoicekey[1.53]{swapstrings}{\xpgdefaultvalue{\xpgpresetvalue{all}},
2418 \xpgvalue{captions}, \xpgvalue{headings}, \xpgvalue{headers}, \xpgvalue{hheaders}, or \xpgvalue{none}}
2419 In Uyghur, table and figure caption strings need to be in a different order and format than in other languages.
2420 By default, \pkg{polyglossia} provides the correct for different classes and packages (standard classes, \pkg{KOMA-script},
2421 \pkg{memoir}, and \pkg{titlesec} package should work, as well as \pkg{fancyhdr} and \pkg{caption}).
2422 However, since the definition of these strings is not standardized, the redefinitions might not work
2423 and even interfere badly if you use specific classes or packages that redefine the respective strings
2424 themselves. In this case, you can disable some or all changes.
2425 The possibilities are:
2426 \begin{itemize}
2427 \item ¦all¦: Redefine figure and table captions, part and chapter headings, and running headers (=~default setting)
2428 \item ¦captions¦: Redefine figure and table captions only
2429 \item ¦headings¦: Redefine part and chapter headings only
2430 \item ¦headers¦: Redefine running headers only
2431 \item ¦hheaders¦: Redefine part and chapter headings as well as running headers
2432 \item ¦none¦: Do not redefine anything
2433 \end{itemize}
2434 \end{itemize}
2435 %
2436 \paragraph*{Commands:}
2437 \begin{itemize}
2438 \item \Cmd\uyghurordinal: outputs Uyghur ordinals. Supported input: integer numbers in the range of 1--100.
2439 \item \Cmd\uyghurord: same as \cmd\uyghurordinal\ but with counter as input (\eg ¦\textuyghur{\uyghurord{page}}¦).
2440 \end{itemize}
2441
2442 \subsection{welsh}\label{welsh}
2443 \paragraph*{Options:}
2444 \begin{itemize}
2445 \item \xpgchoicekey{date}{\xpgvalue{long} or \xpgpresetvalue{short}}
2446 \end{itemize}
2447
2448
2449 \section{Modifying or extending captions, date formats and language settings}
2450
2451 \pkg{Polyglossia} uses the following macros to define language-specific captions
2452 (\ie strings such as ``chapter''), date formats and additional language settings
2453 (\meta{lang} is to be replaces with the respective language name):
2454
2455 \begin{itemize}
2456 \item \Cmd{\captions\meta{lang}} stores definitions of caption strings
2457 (such as, in the case of English, ¦\def\chaptername{Chapter}¦)
2458 \item \Cmd{\date\meta{lang}} stores definitions of date formats (usually redefinitions
2459 of \cmd\today, in some cases also definitions of additional date commands)
2460 \item \Cmd{\blockextras@\meta{lang}} stores macros that are to be executed when the language
2461 \meta{lang} is activated via \cmd\selectlanguage\ command or the \meta{lang} environment
2462 \item \Cmd{\inlineextras@\meta{lang}} stores macros that are to be executed when the language
2463 \meta{lang} is activated locally via \cmd\text\meta{lang} command
2464 \item \Cmd{\noextras@\meta{lang}} stores macros that are to be executed when the language
2465 \meta{lang} is closed
2466 \item \Cmd{\nestedextras@\meta{lang}}\new{2.3} stores macros that are to be executed when a nested language
2467 is closed and \meta{lang} is the active language again. This is useful
2468 for settings that are only possible on global scale.
2469 \end{itemize}
2470 %
2471 In order to redefine internal macros, we recommend to use the command \cmd\addto.
2472 For instance, to change the \cmd\chaptername\ for language ¦lingua¦, you can do this:
2473 \begin{verbatim}
2474 \addto\captionslingua{\def\chaptername{Caput}}
2475 \end{verbatim}
2476 %
2477 Note that this needs to be done after the respective language has been loaded with
2478 \cmd\setmainlanguage\ or \cmd\setotherlanguage.
2479
2480 Specifically for package authors, analogous commands are provided which are only executed
2481 if a specific language \emph{variety} is used. As opposed to the macros above, these refer
2482 to babel names. Other than that, the function is identical:
2483
2484 \begin{itemize}
2485 \item \Cmd{\captions@bbl@\meta{babelname}}
2486 \item \Cmd{\date@bbl@\meta{babelname}}
2487 \item \Cmd{\blockextras@bbl@\meta{babelname}}
2488 \item \Cmd{\inlineextras@bbl@\meta{babelname}}
2489 \item \Cmd{\noextras@bbl@\meta{babelname}}
2490 \end{itemize}
2491 %
2492 By default, these macros are undefined. If they are defined (\eg by an external package),
2493 they will be executed after their respective \meta{lang} counterpart and thus can be used to
2494 overwrite definitions of the former. Again, use \cmd\gappto\ to define\slash modify these macros.
2495 For instance, to add a new caption \cmd\footnotename\ to the Swiss variety of German (babel name
2496 ¦nswissgerman¦), you can do this:
2497 \begin{verbatim}
2498 \gappto\captions@bbl@nswissgerman{\def\footnotename{Fussnote}}
2499 \end{verbatim}
2500 %
2501 If you do this in a document preamble rather than in a package, you need to embrace the redefinition
2502 by \cmd\makeatletter\ and \cmd\makeatother\ due to the ¦@¦ in the macro names.
2503
2504 Finally, as soon as the language has been switched (either inline or as a block), \pkg{polyglossia}
2505 executes the (by default empty) hook
2506 \begin{itemize}
2507 \item \cmd{\polyglossia@language@switched}\DescribeMacroCust{\scriptsize}{\polyglossia@language@switched}
2508 \end{itemize}
2509 to which you can append arbitrary code (via \cmd\gappto) that should be executed if (a particular)
2510 language is being activated. This is done before any of the above
2511 macros are issued (so you can still alter them), but at a point where \cmd\languagename, \cmd\babelname\
2512 and \cmd\languageid\ are already set, so you can condition on specific languages in your code.
2513 This hook is particularly provided for package authors.
2514
2515 \section{Script-specific numbering}
2516
2517 Languages and scripts have specific numbering conventions. Some use decimal digits
2518 (\eg Arabic numerals), some use alphabetic or alphanumerical notation (\eg Roman numbering).
2519 In some cases, different conventions are available (\eg Mashriq or Maghrib numbering
2520 in Arabic script, Arabic or Hebrew [=~alphanumeric] numbering in Hebrew).
2521
2522 If the latter is the case, \pkg{polyglossia} provides language options which allow you to select
2523 or switch to the suitable convention. With the appropriate language option set, \pkg{polyglossia}
2524 will automatically convert the output of internal \LaTeX\ counters to their
2525 localized forms, for instance to display page, chapter and section numbers.
2526
2527 For manual input of numbers, macros are provided. These convert Arabic numeric input to the respective
2528 local decimal digit (see sec.~\ref{sec:decdigit}), alphanumeric representation (see sec.~\ref{abjad})
2529 or whatever is appropriate (see sec.~\ref{sec:localnumber}). The possibilities are described in turn.
2530
2531 \subsection{General localization of numbering}\label{sec:localnumber}
2532
2533 As of 1.45,\new{1.45} \pkg{polyglossia} provides a generic macro \Cmd\localnumeral\ which converts numbers
2534 to the current local form (which might be script-specific decimal digit, an alphabetic numbering or something else).
2535 For instance in an Arabic environment
2536 ¦\localnumeral{42}¦ yields \textarabic{\localnumeral{42}}, whereas in an Hebrew environment, it
2537 results in \texthebrew[numerals=hebrew]{\localnumeral{42}} with ¦numerals=hebrew¦, and \texthebrew{\localnumeral{42}}
2538 with ¦numerals=arabic¦. Note that, as opposed to the various ¦digits¦ macros (described in sec.~\ref{sec:decdigit}),
2539 the argument of \cmd\localnumeral\ must consist of numbers only.
2540
2541 For\new{1.45} the conversion of counters, the starred version \Cmd{\localnumeral*} is provided. This takes a counter as argument.
2542 For instance in an Arabic environment ¦\localnumeral*{page}¦ yields \textarabic{\localnumeral*{page}}.
2543
2544 For scripts with alphanumeric numbering, the variants \Cmd{\Localnumeral} and \Cmd{\Localnumeral*} provide the uppercased
2545 versions.\medskip
2546
2547 \noindent All these macros provide the following options:
2548
2549 \begin{itemize}
2550 \item \DescribeMacro{[lang=]}\xpgchoicekey{lang}{\xpgpresetvalue{local}, \xpgvalue{main},
2551 or \xpgvalue{\meta{language}}}
2552 Output number in the local form of the currently active language for
2553 ¦local¦, the main language of the document for ¦main¦, and any (loaded)
2554 language for \meta{language} (\eg ¦\localnumeral[lang=arabic]{42}}¦).
2555 \end{itemize}
2556
2557 \subsection{Non-Western decimal digits}\label{sec:decdigit}
2558
2559 In addition\new{1.1.1} to the generic macros described above, \pkg{polyglossia} provides language-specific conversion macros
2560 which can be used if the generic ones do not suit the need.\footnote{%
2561 A third method are so-called TECKit fontmappings.
2562 Those can be activated with the \pkg{fontspec} ¦Mapping¦ option,
2563 using ¦arabicdigits¦, ¦farsidigits¦ or ¦thaidigits¦.
2564 For instance if \cmd\arabicfont\ is defined with the option ¦Mapping=arabicdigits¦,
2565 typing \cmd{\textarabic\{2010\}} results in \textarabic{٢٠١٠}. Note that this method has some drawbacks, though,
2566 for instance when the value of a counter has to be written and read from auxiliary files.
2567 So please use this with care.}
2568 The macros have the form \cmd{\⟨script⟩digits}. They convert Arabic numerical input and leave every other input untouched.
2569 In an Arabic context, for instance, ¦\arabicdigits{9182/738543-X}¦ yields \textarabic{\arabicdigits{9182/738543-X}}.
2570
2571 Currently, the following macros are provided:
2572
2573 \begin{itemize}
2574 \item \Cmd\arabicdigits
2575 \item \Cmd\bengalidigits
2576 \item \Cmd\devanagaridigits
2577 \item \Cmd\farsidigits
2578 \item \Cmd\gurmukhidigits
2579 \item \Cmd\kannadadigits
2580 \item \Cmd\khmerdigits
2581 \item \Cmd\laodigits
2582 \item \Cmd\nkodigits
2583 \item \Cmd\odiadigits
2584 \item \Cmd\thaidigits
2585 \item \Cmd\tibetandigits
2586 \end{itemize}
2587
2588
2589 \subsection{Non-Latin alphabetic numbering}\label{abjad}
2590
2591 For languages which use special (non-Latin) alphanumerical notation\footnote{%
2592 For instance, see \url{http://en.wikipedia.org/wiki/Greek_numerals},
2593 \url{http://en.wikipedia.org/wiki/Abjad_numerals},
2594 \url{http://en.wikipedia.org/wiki/Hebrew_numerals},
2595 and \url{http://en.wikipedia.org/wiki/Syriac_alphabet}.}, dedicated macros are provided.
2596
2597 They work in a similar way than the \cmd{\⟨script⟩digits} macros described above: They take Arabic numerical input
2598 and output the respective value in the local alphabetic numbering scheme (most of these macros are equivalent
2599 to \cmd\localnumeral\ and \cmd\Localnumeral\ in the respective context).
2600
2601 The following macros are provided:
2602
2603 \begin{itemize}
2604 \item \Cmd\abjad outputs Arabic \textit{abjad} numbers according to the Mashriq varieties.
2605 Example: ¦\abjad{1863}¦ yields \textarabic{\abjad{1863}}.
2606
2607 \item \Cmd\abjadmaghribi outputs Arabic \textit{abjad} numbers according to the Maghrib varieties.
2608 Example: ¦\abjadmaghribi{1863}¦ yields \textarabic{\abjadmaghribi{1863}}.
2609
2610 \item \Cmd\abjadsyriac outputs Syriac abjad numerals.\footnote{%
2611 A fine guide to numerals in Syriac can be found at \link{http://www.garzo.co.uk/documents/syriac-numerals.pdf}.}\\
2612 Example: ¦\abjadsyriac{463}¦ yields \textsyriac{\abjadsyriac{463}}.
2613
2614 \item \Cmd\armeniannumeral produces Armenian alphabetic numbering.
2615 Example: ¦\armeniannumeral{1863}¦ yields \textarmenian{\armeniannumeral{1863}}.
2616
2617 \item \Cmd\belarusiannumeral produces Belarusian numbering, with uppercased variant (for alphanumerical variant) via \Cmd\Belarusiannumeral.
2618 Depending on the ¦numerals¦ option in the Belarusian language selection, this is either Arabic digit or Cyrillic
2619 alphanumercial output.\\
2620 Example: With ¦numerals=latin¦ ¦\belarusiannumeral{19}¦ yields \textrussian{\russiannumeral{19}},
2621 with ¦numerals=cyrillic-trad¦ ¦\belarusiannumeral{19}¦ results in \textrussian[numerals=cyrillic-trad]{\russiannumeral{19}},\\
2622 with ¦numerals=cyrillic-alph¦ ¦\belarusiannumeral{19}¦ results in \textrussian[numerals=cyrillic-alph]{\russiannumeral{19}}.
2623
2624 \item \Cmd\chinesenumeral produces Chinese numbering which, depending on the ¦numerals¦ option in the Chinese language selection,
2625 produces is either Arabic digit or Chinese ideographic output.\\
2626 Example: With ¦numerals=arabic¦ ¦\chinesenumeral{753}¦ yields \textchinese[numerals=arabic]{\chinesenumeral{753}},
2627 with ¦numerals=chinese¦ ¦\chinesenumeral{753}¦ results in \textchinese[numerals=chinese]{\chinesenumeral{753}}.
2628
2629 \item \Cmd\georgiannumeral produces Georgian alphabetic numbering.\\
2630 Example: ¦\georgiannumeral{1863}¦ yields \textgeorgian{\georgiannumeral{1863}}.
2631
2632 \item \Cmd\greeknumeral produces Greek alphabetic numbering, \Cmd\Greeknumeral outputs uppercased variants.
2633 Example: ¦\greeknumeral{1863}¦ yields \textgreek{\greeknumeral{1863}},
2634 ¦\Greeknumeral{1863}¦ results in \textgreek{\Greeknumeral{1863}}.
2635
2636 \item \Cmd\hebrewnumeral, \Cmd\Hebrewnumeral and \Cmd\Hebrewnumeralfinal produce variants of Hebrew alphanumeric numerals.
2637 The commands behave identical as in \pkg{babel}: \cmd\hebrewnumeral\ outputs the numbers without any decoration at all,
2638 \cmd\Hebrewnumeral\ adds \textit{gereshayim} before the last letter, and \cmd\Hebrewnumeralfinal\ uses in addition the final
2639 forms of Hebrew letters.
2640 Examples:
2641 ¦\hebrewnumeral{1750}¦ yields \texthebrew{\hebrewnumeral{1750}},
2642 ¦\Hebrewnumeral{1750}¦ yields \texthebrew{\Hebrewnumeral{1750}},
2643 and ¦\Hebrewnumeralfinal{1750}¦ yields \texthebrew{\Hebrewnumeralfinal{1750}}.
2644
2645 \item \Cmd\mongoliannumeral produces Mongolian numbering, with uppercased variant (for alphanumerical variant) via \Cmd\Mongoliannumeral.
2646 Depending on the ¦numerals¦ option in the Mongolian language selection, this is either Arabic digit or Cyrillic
2647 alphanumercial output.\\
2648 Example: With ¦numerals=latin¦ ¦\mongoliannumeral{19}¦ yields \textrussian{\russiannumeral{19}},
2649 with ¦numerals=cyrillic-trad¦ ¦\mongoliannumeral{19}¦ results in \textrussian[numerals=cyrillic-trad]{\russiannumeral{19}},\\
2650 with ¦numerals=cyrillic-alph¦ ¦\mongoliannumeral{19}¦ results in \textrussian[numerals=cyrillic-alph]{\russiannumeral{19}}.
2651
2652 \item \Cmd\punjabinumeral produces Punjabi numbering, depending on the setting of the ¦numerals¦ option in the Punjabi language
2653 selection, this is either Gurmukhi or Arabic (Western).
2654
2655 \item \Cmd\russiannumeral produces Russian numbering, with uppercased variant (for alphanumerical variant) via \Cmd\Russiannumeral.
2656 Depending on the ¦numerals¦ option in the Russian language selection, this is either Arabic digit or Cyrillic
2657 alphanumercial output.\\
2658 Example: With ¦numerals=latin¦ ¦\russiannumeral{19}¦ yields \textrussian{\russiannumeral{19}},
2659 with ¦numerals=cyrillic-trad¦ ¦\russiannumeral{19}¦ results in \textrussian[numerals=cyrillic-trad]{\russiannumeral{19}},\\
2660 with ¦numerals=cyrillic-alph¦ ¦\russiannumeral{19}¦ results in \textrussian[numerals=cyrillic-alph]{\russiannumeral{19}}.
2661
2662 \item \Cmd\serbiannumeral produces Serbian numbering, with uppercased variant (for alphanumerical variant) via \Cmd\Serbiannumeral.
2663 Depending on the ¦numerals¦ option in the Serbian language selection, this is either Arabic digit or Cyrillic
2664 alphanumercial output.\\
2665 Example: With ¦numerals=latin¦ ¦\serbiannumeral{19}¦ yields \textrussian{\serbiannumeral{19}},
2666 with ¦numerals=cyrillic-trad¦ ¦\serbiannumeral{19}¦ results in \textrussian[numerals=cyrillic-trad]{\serbiannumeral{19}},\\
2667 with ¦numerals=cyrillic-alph¦ ¦\serbiannumeral{19}¦ results in \textrussian[numerals=cyrillic-alph]{\serbiannumeral{19}}.
2668
2669 \item \Cmd\ukrainiannumeral produces Ukrainian numbering, with uppercased variant (for alphanumerical variant) via \Cmd\Ukrainiannumeral.
2670 Depending on the ¦numerals¦ option in the Ukrainian language selection, this is either Arabic digit or Cyrillic
2671 alphanumercial output.\\
2672 Example: With ¦numerals=latin¦ ¦\ukrainiannumeral{19}¦ yields \textrussian{\russiannumeral{19}},
2673 with ¦numerals=cyrillic-trad¦ ¦\ukrainiannumeral{19}¦ results in \textrussian[numerals=cyrillic-trad]{\russiannumeral{19}},\\
2674 with ¦numerals=cyrillic-alph¦ ¦\ukrainiannumeral{19}¦ results in \textrussian[numerals=cyrillic-alph]{\russiannumeral{19}}.
2675 \end{itemize}
2676
2677
2678 \section{Footnotes in right-to-left context}
2679
2680 With languages that use right-to-left scripts, footnote apparatuses are usually placed at the right side of the page bottom.
2681 Consequently, the footnote rule also is to be placed right. Things get more tricky, though, if right-to-left and left-to-right
2682 scripts are mixed. Then you might want to put the footnotes on some pages left, on some right, or even mix positions on a page.
2683 Thus, footnote handling in right-to-left context sometimes needs manual intervention. This is described in what follows.
2684
2685 \subsection{Horizontal footnote position}
2686
2687 When right-to-left languages are used, the \cmd\footnote\ command becomes sensitive to the text directionality. The footnote is
2688 always placed on the side that is currently the origin of direction: on the left side of the page in LTR paragraphs and
2689 on the right in RTL paragraphs.
2690
2691 For cases where this is not desired, two additional footnote commands are provided: \Cmd\RTLfootnote and \Cmd\LTRfootnote.
2692 \cmd\LTRfootnote\ always places the footnote on the left side, notwithstanding the current
2693 directionality. Likewise, \cmd\RTLfootnote\ always places it on the right side. Like \cmd\footnote, \cmd\RTLfootnote\
2694 and \cmd\LTRfootnote\ provide an optional argument to customize the number.
2695
2696
2697 \subsection{Footnote rule length and position}
2698
2699 The default placement of the footnote rule differs in \XeTeX\ and \LuaTeX\ output (this is due to differences in the \textsf{bidi}
2700 and \textsf{luabidi} packages). With \XeTeX, footnote rules are always placed left, which is often wrong in RTL context.
2701 With \LuaTeX, by contrast, the rule is placed always right if the main language is a right-to-left language, and always left
2702 if the main language is a left-to-right language, which is the right thing in many cases.
2703
2704 In both cases, you can change the default behavior as follows:
2705 \begin{itemize}
2706 \item Put \Cmd\leftfootnoterule in the preamble to have all rules left-aligned.
2707 \item Put \Cmd\rightfootnoterule in the preamble to have all rules right-aligned.
2708 \item Put \Cmd\autofootnoterule in the preamble to have automatic placement depending on the context (see below for elaboration).
2709 \item Put \Cmd\textwidthfootnoterule in the preamble to have a rule that spans the whole text width.
2710 \end{itemize}
2711 With \cmd\autofootnoterule, the first footnote on the current page determines the placement. Note that this automatic can fail with
2712 footnotes at page boundaries that differ in directionality from the first footnote on the page. You can work around such cases by switching to \cmd\rightfootnoterule\ or \cmd\leftfootnoterule\ on these pages.
2713
2714 Note also that the rule switches might interfere in bad ways with packages or classes that redefine footnotes themselves. This is also the reason
2715 why \cmd\autofootnoterule\ is not used by default.
2716
2717
2718 \section{Calendars}
2719
2720 \subsection{Hebrew calendar (hebrewcal.sty)}
2721 The package \file{hebrewcal.sty} is almost a verbatim copy of \file{hebcal.sty}
2722 that comes with \pkg{babel}.
2723 The command \Cmd\Hebrewtoday\ formats the current date in the Hebrew calendar
2724 (depending of the current writing direction this will automatically set either
2725 in Hebrew script or in roman transliteration).
2726
2727 \subsection{Islamic calendar (hijrical.sty)}\label{sec:hijrical}
2728 This package computes dates in the lunar Islamic (Hijra) calendar.\footnote{ %
2729 It makes use of the arithmetical algorithm in chapter 6 of
2730 Reingold \& Gershowitz, \textit{Calendrical calculation: the Millennium edition}
2731 (Cambridge University Press, 2001).\label{reingold}}
2732 It provides two macros for the end-user.
2733 The command
2734 \displaycmd{\HijriFromGregorian\marg{year}\marg{month}\marg{day}}{\HijriFromGregorian}
2735 sets the counters ¦Hijriday¦, ¦Hijrimonth¦ and ¦Hijriyear¦.
2736 \Cmd\Hijritoday\ formats the Hijri date for the current day.
2737 This command is now locale-aware\new{1.1.1}: its output will differ depending on the
2738 currently active language. Presently \pkg{polyglossia}’s language definition files
2739 for Arabic, Farsi, Urdu, Turkish and Malay provide a localized version of \cmd\Hijritoday.
2740 If the formatting macro for the current language is undefined, the Hijri date will be formatted
2741 in Arabic or in roman transliteration, depending of the current writing direction.
2742 You can define a new format or redefine one with the command
2743 \displaycmd{\DefineHijriDateFormat\marg{lang}\marg{code}.}{\DefineHijriDateFormat}
2744
2745 The command \cmd\Hijritoday\ also accepts an optional argument to add or subtract a correction
2746 (in days) to the date computed by the arithmetical algorithm.\footnote{ %
2747 The Islamic calendar is indeed a purely lunar calendar based on the observation
2748 of the first visibility of the lunar crescent at the beginning of the lunar month,
2749 so there can be differences between different localities, as well as between
2750 civil and religious authorities.}
2751 For instance if \cmd\Hijritoday\ yields the date “7 Rajab 1429” (which is the date that was
2752 displayed on the front page of \href{http://www.aljazeera.net}{aljazeera.net} on
2753 11th July 2008), ¦\Hijritoday[1]¦ would rather print “8 Rajab 1429” (the date
2754 indicated the same day on the site \href{http://www.gulfnews.com}{gulfnews.com}).
2755
2756 \subsection{Farsi (jalālī) calendar (farsical.sty)}
2757 This package is an almost verbatim copy of ¦Arabiftoday.sty¦ (in the \pkg{Arabi} package),
2758 itself a slight modification of ¦ftoday.sty¦ in Farsi\TeX.\footnote{ %
2759 One day we may rewrite \pkg{farsical} from scratch using the algorithm in
2760 Reingold \& Gershowitz (ref.~n.\,\ref{reingold}).}
2761 Here we have renamed the command \cmd\ftoday\ to
2762 \Cmd\Jalalitoday.
2763 Example: today is \Jalalitoday.
2764
2765
2766 \section{Auxiliary commands}
2767
2768 The macro\new{1.47} \displaycmd{\charifavailable\marg{char code}\marg{substitution}}{\charifavailable} checks whether
2769 the character with the specified \meta{char code} (\ie unicode utf-16 code without preceding ¦0x¦) exists in
2770 the current font. If so, the character is printed, if not, the \meta{substitution} is printed.
2771
2772 Example: ¦\charifavailable{1E9E}{SS}¦ prints the capital version of the German letter ⟨ß⟩ if available
2773 (\ie \charifavailable{1E9E}{SS}), else it prints the substitution digraph SS.
2774
2775 With the test\new{1.66} \displaycmd{\IfCharIsAvailableTF\marg{char code}\marg{true condition}\marg{false condition}}{\IfCharIsAvailableTF}
2776 you can test for the availability of a character and execute different code depending whether or not this is the case
2777 (this replaces the undocument internal command \cmd{\xpg@if@char@available}).
2778
2779
2780 \section{Accessing language information}\label{sec:langinfo}
2781
2782 The following is specifically relevant to package authors who need information about the languages in use
2783 and the details of the respective locale.
2784 In order to get such information, the recommended way is to use the \Cmd{\BCPdata\marg{type}}\new{1.61}
2785 command to get (parts of) the BCP-47 language tag. This command is used by the \LaTeX\ kernel as of 6/2023,
2786 and the syntax is standardized at least between \pkg{babel} and \pkg{polyglossia}.
2787
2788 \cmd\BCPdata\ supports the following \marg{type} arguments:
2789 \begin{itemize}
2790 \item \xpgoption{language} The language subtag (\eg \texttt{de})
2791 \item \xpgoption{region} The region subtag (\eg \texttt{AT})
2792 \item \xpgoption{script} The script subtag (\eg \texttt{Latn})
2793 \item \xpgoption{variant} The variant subtag (\eg \texttt{1901} for German old spelling)
2794 \item \xpgoption{extension.t} The subtag indicating transformation between languages or scripts
2795 (\eg \texttt{ja} as in \texttt{en-t-ja}: English transformed to Japanese)
2796 \item \xpgoption{extension.u} The subtag indicating additional locale information (\eg \texttt{nu-latn} as in \texttt{ar-u-nu-latn}:
2797 Arabic with Latin Numbering)
2798 \item \xpgoption{extension.x} The private usespace subtag (\eg \texttt{classic} as in \texttt{la-x-classic} for classic Latin)
2799 \item \xpgoption{casing} is a special semantic value which returns whatever is considered suitable
2800 for casing commands such as \cmd\MakeUppercase. In many cases, this is identical to \texttt{language} but
2801 it could also be something more specific such as \texttt{el-x-iota} or \texttt{ckb-Latn} if this is
2802 needed for proper casing. Note that this information is retrieved by the \LaTeX\ kernel for casing as
2803 of 06/2023.
2804 \item \xpgoption{tag} returns the registered full tag (identical to \cmd\languageid\ below). This however omits
2805 certain subtags if these are considered obvious (\eg for German, only \texttt{de-DE} is returned, although
2806 script [\texttt{Latn}] and variant [\texttt{1996}] are defined as well).
2807 \end{itemize}
2808 If a subtag is not defined for a given language, an empty string is returned.
2809
2810 The values above return information for the language currently in use. If you need to access information for the
2811 main language of the document, prepend \xpgoption{main.} to the respective argument (\eg \xpgoption{main.language}). This works
2812 for all supported arguments.
2813
2814 Next to \cmd\BCPdata, \pkg{polyglossia} provides the following legacy macros which are partly unique to \pkg{polyglossia},
2815 partly re-implementations of legacy \pkg{babel} commands:
2816
2817 \begin{itemize}
2818 \item \Cmd\languagename\ stores the currently active (polyglossia) language name.
2819 \item \Cmd\mainlanguagename\ stores the (polyglossia) language name of the main document language.
2820 \item \Cmd\languagevariant\ stores the language variant if set. The macro is empty if no variant has been set.
2821 \item \Cmd\mainlanguagevariant\ stores the language variant of the main document language if set.
2822 The macro is empty if no variant has been set.
2823 \item \Cmd\babelname\ stores the corresponding name of the currently active language (variant) in \pkg{babel}.
2824 This might not only be useful if you want to support both \pkg{babel} and \pkg{polyglossia}, but also
2825 since this name is unique for a given language variety (\eg ngerman, german, swissgerman etc.).
2826 Note that this macro is also defined for languages that are not supported in \pkg{babel}. In that
2827 case, they are equal to the polyglossia language name.
2828 \item \Cmd\mainbabelname\ analogously stores the name of document's main language (variant) in \pkg{babel}.
2829 \item \Cmd{\languageid\marg{type}}\new{1.47} stores the identifier tag of the current language. Currently supported \meta{types}:
2830 \begin{itemize}
2831 \item ¦bcp-47¦ (alias ¦bcp47¦): IETF BCP-47 language identifier
2832 \end{itemize}
2833 \item \Cmd{\mainlanguageid\marg{type}}\new{1.47} stores identifier tag of the main language. Currently supported \meta{types}:
2834 see \cmd\languageid.
2835 \end{itemize}
2836 \bigskip
2837
2838 \noindent If you want to have a full list of loaded languages/variants, use the following macros:
2839 \begin{itemize}
2840 \item \Cmd{\xpg@loaded}\ stores a comma-separated list of all loaded languages (polyglossia name)
2841 \item \Cmd{\xpg@vloaded}\ stores a comma-separated list of all loaded variants
2842 \item \Cmd{\xpg@bloaded}\ stores a comma-separated list of \pkg{babel} names of all language variants
2843 \item \Cmd{\xpg@bcp@loaded}\new{1.47}\ stores a comma-separated list of the BCP-47 IDs of all language variants
2844 \end{itemize}
2845 \bigskip
2846
2847 \noindent Whether a language is loaded can be tested by
2848 \displaycmd{\iflanguageloaded\marg{lang}\marg{true}\marg{false}}{\iflanguageloaded}
2849 where \texttt{\meta{lang}} is a \pkg{polyglossia} language name, by
2850 \displaycmd{\ifbabellanguageloaded\marg{lang}\marg{true}\marg{false}}{\ifbabellanguageloaded}
2851 where \texttt{\meta{lang}} is a \pkg{babel} language name (see table~\ref{tab:bbllang} on p.~\pageref{tab:bbllang}), or by\new{1.47}
2852 \displaycmd{\iflanguageidloaded\marg{type}\marg{id}\marg{true}\marg{false}}{\iflanguageidloaded}
2853 where \meta{type} is a supported language id type (such as ¦bcp-47¦) and \meta{id} is a language id
2854 (such as ¦en-US¦; see table~\ref{tab:BCP47-polyglossia} on p.~\pageref{tab:BCP47-polyglossia}).
2855 \bigskip
2856
2857 \noindent Finally, if you want to know whether a specific language option has been set, you can use\new{1.47}
2858 \displaycmd{\iflanguageoption\marg{lang}\marg{key}\marg{value}\marg{true}\marg{false}}{\iflanguageoption}
2859
2860
2861 \section{Revision history}
2862
2863 \bgroup\footnotesize
2864
2865 \subsection*{2.10 (2026/04/18)}
2866
2867 \subsubsection*{Bug fixes}
2868 \begin{itemize}
2869 \item Do not assign patterns to a variety more than once.
2870 \item Optimize linebreaking with babelshorthands.
2871 \item Fix the output of ¦"/¦ babelshorthand in math.
2872 \item Fix math mode output of some German babelshorthands for new spelling.
2873 \item Fix spacing issues in some gloss files.
2874 \end{itemize}
2875
2876 \subsubsection*{New Features}
2877 \begin{itemize}
2878 \item Add basic support for Kyrgyz (Cyrillic writing).
2879 \item Support legacy (LICR) macros for Cyrillic characters (\cmd{\cyra} etc.).
2880 This requires the file \file{cyrl2uni.def} shipped with \pkg{babel}
2881 as of version 26.7.
2882 \item Add \xpgoption{metadata} to use the language provided in
2883 \cmd\DocumentMetaData\ \meta{lang} key as the default language.
2884 \item Add \xpgoption{unibidi-lua} option for \pkg{unibidi-lua} integration.
2885 \item Add \xpgoption{bidi} option to control the loading of \pkg{bidi} or \pkg{luabidi}.
2886 \item The language selected in the lang key in \cmd\DocumentMetaData\ is now used
2887 as the default language. You can suppress this with the \xpgoption{metadata} option.
2888 \item Add aliases for \pkg{babel-german}'s new language names.
2889 \item Add ¦".¦ shorthand to German.
2890 \end{itemize}
2891
2892 \subsection*{2.9 (2025/12/01)}
2893
2894 \subsubsection*{Bug fixes}
2895 \begin{itemize}
2896 \item Allow linebreak between a non-glyph box and CJK characters (\TXI{690}).
2897 This fix partly restores the functionality of v.\,2.7.
2898 \item Fix and document the \textit{Josa} selection function in Korean language module (\TXI{691}).
2899 \item Suppress orphan character in CJK languages (\TXI{693}).
2900 \textit{Orphan Character} here means a paragraph whose last line contains single character only.
2901 \item Issue \cmd{\iflanguageloaded} (and related) tests earlier so packages can be loaded conditionally (\TXI{696}).
2902 \item Fix \cmd{\xpg@loaded} missing the main language in the preamble.
2903 \end{itemize}
2904
2905 \subsubsection*{Documentation improvements}
2906 \begin{itemize}
2907 \item Document the previously hidden Greek commands \cmd\greektoday\ and \cmd\Greektoday\ (part of \TXI{695}).
2908 \end{itemize}
2909
2910 \subsection*{2.8 (2025/09/22)}
2911
2912 \subsubsection*{Bug fixes}
2913 \begin{itemize}
2914 \item Fix spacing between a box and CJK characters (\TXI{688}).
2915 This fixes a regression introduced in v.\,2.7.
2916 \end{itemize}
2917
2918 \subsection*{2.7 (2025/09/11)}
2919
2920 \subsubsection*{Bug fixes}
2921 \begin{itemize}
2922 \item Fix PDF strings with captions (\TXI{685}).
2923 \item Fix spacing issue in List of Table/Figures (\TXI{686}).
2924 \item Fix a bug with spacing after CJK punctuations and introduce \cmd{\inhibitglue}
2925 for \LuaLaTeX\ (\TXI{687}).
2926 \end{itemize}
2927
2928 \subsection*{2.6 (2025/06/30)}
2929
2930 \subsubsection*{Bug fixes}
2931 \begin{itemize}
2932 \item Reset splithyphens and vlna state of embedding language after embedded language
2933 has been closed (\TXI{682}).
2934 \item Fix space after \cmd{\greeknumeral} with numbers > 100 (\TXI{684}).
2935 \item Adapt \xpgoption{localmarks} to work with \LaTeX\ 6/2025.
2936 \end{itemize}
2937
2938 \subsubsection*{New Features}
2939 \begin{itemize}
2940 \item Add \xpgoption{koppa} option to Greek (\TXI{683}).
2941 \item Add possibility to customize the numbers 6 and 90 in Greek (\TXI{683}).
2942 \end{itemize}
2943
2944 \subsection*{2.5 (2025/05/12)}
2945
2946 \subsubsection*{Interface and defaults changes}
2947 \begin{itemize}
2948 \item The babelnames ¦classiclatin¦ and ¦ecclesiasticlatin¦ are changed to
2949 ¦classicallatin¦ and ¦ecclesiasticallatin¦. This reflects a change in the
2950 \pkg{babel-latin} package.
2951 \end{itemize}
2952
2953 \subsubsection*{Bug fixes}
2954 \begin{itemize}
2955 \item Fix a bug with linebreaking in CJK languages (\TXP{675}).
2956 \item Fix global setting of \xpgoption{babelshorthands} (\TXP{680}).
2957 \item Fix mapping between upper and lower case for classic and medieval
2958 Latin: \emph{u/V, ú/V́, ū/V̄, ŭ/V̆}.
2959 \end{itemize}
2960
2961 \subsection*{2.4 (2025/01/31)}
2962
2963 \subsubsection*{Bug fixes}
2964 \begin{itemize}
2965 \item Fix \xpgoption{changecounternumbering} option of Bengali (\TXI{672}).
2966 \item Fix testing of languages in groups (\TXI{669}).
2967 \item Fix error with undefined internal command (¦\xpg_pop_language:¦) that should be defined (\TXI{671}).
2968 \item The command \cmd\familytype\ is now predefined again independent of font settings, and its
2969 name was changed to ¦\l_xpg_familytype_tl¦.
2970 \item A warning is now issued if \pkg{babel} is loaded in parallel with \pkg{polyglossia}.
2971 \end{itemize}
2972
2973 \subsection*{2.3 (2024/09/23)}
2974
2975 \subsubsection*{Bug fixes}
2976 \begin{itemize}
2977 \item Line-breaking for Japanese and Chinese has been implemented. This is still
2978 considered experimental, please test and report any issues (\TXI{635}).
2979 \item Prevent the Latin gloss from writing undefined commands
2980 to the aux file (\TXI{643}).
2981 \item Fix use of \cmd\pghyphenation\ in preamble (\TXI{654}).
2982 \item Fix handling of current language options in lists of figures/tables (\TXI{657}).
2983 \item Fix definition of \cmd\cyrdash\ so that no linebreak is added when it is used at
2984 paragraph begin.
2985 \item Fix test for KOMA class in Hungarian and Russian glosses (\TXP{447}).
2986 \item Fix display of font name in package error.
2987 \item Remove spurious spaces from Korean, Sanskrit, and Serbian glosses (\TXI{659}, \TXI{660})
2988 \end{itemize}
2989
2990 \subsection*{2.2 (2024/07/15)}
2991
2992 \subsubsection*{Bug fixes}
2993 \begin{itemize}
2994 \item Fix \texttt{lang} environment (\TXI{633}).
2995 \item Fix first number of Maghrib abjad numbering for Algeria, Morocco and
2996 Tunisia (\TXI{640}).
2997 \item Fix some captions strings in Bulgarian, Chinese, Esperanto, Estonian, Hindi,
2998 Latvian, and Slovak (\TXP{651})
2999 \item Improve performance with multilingual documents that have a TOC (\TXI{641}).
3000 \end{itemize}
3001
3002 \subsubsection*{New Features}
3003 \begin{itemize}
3004 \item Add possibility to associate a font to a language/variant with reference to
3005 a BCP-47 script tag (\TXI{636}).
3006 \end{itemize}
3007
3008 \subsubsection*{Internal work}
3009 \begin{itemize}
3010 \item The major rewrite of the package code has been finished. More code has been cleaned up,
3011 and \pkg{polyglossia} employs modern concepts (\pkg{latex3} and modern \LaTeXe).
3012 All key-val handling uses \pkg{l3keys} now rather than \pkg{xkeyval}.
3013 \end{itemize}
3014
3015 \subsection*{2.1 (2024/03/07)}
3016
3017 \subsubsection*{Bug fixes}
3018 \begin{itemize}
3019 \item Make \cmd{\foreignlanguage} \cmd{\long} again (\TXI{622}).
3020 \item Fix \texttt{otherlanguage*} environment (\TXI{622}).
3021 \end{itemize}
3022
3023 \subsection*{2.0 (2024/02/17)}
3024
3025 \subsubsection*{Bug fixes}
3026 \begin{itemize}
3027 \item Fix error with undefined property list that unhides with
3028 \pkg{l3kernel} version 2024-02-13 (\TXI{626}).
3029 \item Fix \xpgoption{frenchfootnote} option (\TXI{620}).
3030 \item The error message on improper font setting is now
3031 correct if the main script is non-Latin, for
3032 non-Roman fonts (\TXI{571}), and specifically for
3033 the CJK case (\TXI{621}).
3034 \item Fix expansion of localnumeral (\TXI{622}).
3035 \end{itemize}
3036
3037 \subsubsection*{New Features}
3038 \begin{itemize}
3039 \item Add \cmd{\inheritbabelshorthands} (\TXI{604}).
3040 \item Add \cmd{\usebabelshorthands}.
3041 \item Add shorthands for German gender-sensitive writing.
3042 \item Implement \pkg{babel}-style hyphenation for Finnish.
3043 \end{itemize}
3044
3045 \subsubsection*{Documentation improvements}
3046 \begin{itemize}
3047 \item Fix documentation of Finnish shorthands (\TXI{623}).
3048 \end{itemize}
3049
3050 \subsubsection*{Internal work}
3051 \begin{itemize}
3052 \item The package code has been subjected to a major rewrite.
3053 Code has been cleaned up, and in general, \pkg{polyglossia}
3054 more consistently employs \pkg{latex3} now. Note that this is
3055 an ongoing and yet unfinished project that will continue over
3056 the next releases.
3057 \end{itemize}
3058
3059
3060 \subsection*{1.66 (2023/12/11)}
3061
3062 \subsubsection*{Bug fixes}
3063 \begin{itemize}
3064 \item Fix OpenType language and script tags in Chinese (\TXI{606}).
3065 \item Fix resetting of language specifications at the end of a local font
3066 set with \pkg{babel} legacy means (\cmd{\foreignlanguage} or \texttt{otherlanguage*}
3067 environment) (\TXI{607}).
3068 \item Fix lowercasing of \cmd{\textlang}'s first mandatory argument.
3069 Now the casing does not change (language tag was lower-cased always) (\TXI{608}).
3070 \item Add missing BCP-47 alias for Khmer (\TXI{611}).
3071 \item Stop \cmd{\charifavailable} from looking ahead for more numbers or gobbling a space (\TXI{613}).
3072 \end{itemize}
3073
3074 \subsubsection*{New Features}
3075 \begin{itemize}
3076 \item Add support for Odia, provided by \TA{Avisek Jena} and \TA{Ashok Das}.
3077 \item New auxiliary package ¦odiadigits¦
3078 \item Add auxiliary command \cmd{\IfCharIsAvailableTF} to complement \cmd{\charifavailable}.
3079 \end{itemize}
3080
3081 \subsection*{1.65 (2023/10/01)}
3082
3083 \subsubsection*{Bug fixes}
3084 \begin{itemize}
3085 \item Fix spurious space in Hebrew captions (\TXP{601}).
3086 \item Fix resetting of language specifications at end of inline switch
3087 (\TXI{603}).
3088 \end{itemize}
3089
3090 \subsubsection*{Documentation improvements}
3091 \begin{itemize}
3092 \item Refer to \cmd{\greeknumeral} and \cmd{\Greeknumeral} rather than to
3093 the synonyms \cmd{\greeknumber} and \cmd{\Greeknumber} (\TXI{602}).
3094 \end{itemize}
3095
3096
3097 \subsection*{1.64 (2023/07/21)}
3098
3099 \subsubsection*{Bug fixes}
3100 \begin{itemize}
3101 \item Fix conflict of \pkg{soul} with \xpgoption{splithyphens} on \XeLaTeX\ (\TXI{600}).
3102 \end{itemize}
3103
3104 \subsection*{1.63 (2023/06/10)}
3105
3106 \subsubsection*{Bug fixes}
3107 \begin{itemize}
3108 \item Language options are now lowercased before they are handled. This fixes errors when
3109 using the options in \cmd{\MakeUppercase} context (\eg in headings).
3110 \item Fix casing value for medieval Latin (this concerns ⟨u⟩ and ⟨V⟩ casing).
3111 \item Remove hacks in some gloss files where \cmd\MakeUppercase\ has been redefined to a no-op
3112 since the respective scripts do not have uppercasing. As \cmd\MakeUppercase\ is now locale-aware,
3113 these hacks are no longer needed. This concerns Arabic, Divehi, Hebrew, Hindi, Kurdish,
3114 Persian, Punjabi, Syriac, and Urdu.
3115 \item Fix Eastern (Mashriq) Arabic numbering direction with \LuaLaTeX\ for Arabic, Kurdish, Persian,
3116 Syriac, and Urdu (amends previous fix to \TXI{213}).
3117 \item French \xpgoption{variant=acadian} refers to the Canadian French subvariety as spoken in the Acadian
3118 region (as opposed to Quebec French). To differentiate it we now use a dedicated subtag
3119 which can also be used to access the language (\texttt{fr-CA-u-sd-canb}).
3120 Note that Quebec French is currently connected with \texttt{fr-CA}, not the more specific
3121 \texttt{fr-CA-u-sd-caqc}, although the u extension is returned if requested via \cmd\BCPdata.
3122 In practice, the Canadian subvarieties of French are identical currently, anyway.
3123 \item Do not blindly de-activate the quote character in languages that provide shorthands if the
3124 shorthands are not used. This allows to activate the character with other packages such as
3125 \pkg{csquotes} (\TXI{592}).
3126 \item Do not flood the \LaTeX\ hooks with redundant French itemlabels and footnote settings (\TXI{593}).
3127 \item Fix Korean patching of part format with hyperref (\TXP{595}).
3128 \item Make Hebrew numerals expandable (\TXP{596}).
3129 \item Avoid superfluous writing of language switches to aux file (\TXI{593}).
3130 \end{itemize}
3131
3132 \subsubsection*{New features}
3133 \begin{itemize}
3134 \item New option \xpgoption{capitalyiwn} for Armenian.
3135 \item New option \xpgoption{capitaleszett} for German.
3136 \item New option \xpgoption{capitaliota} for Greek.
3137 \item New option \xpgoption{datei} for Serbian.
3138 \item New option \xpgoption{sectionsep} for Arabic, Kurdish, Persian,
3139 Syriac, and Urdu (\TXI{589}).
3140 \item Add aliases \xpgvalue{eastern} (=~\xpgvalue{mashriq}) and \xpgvalue{western} (=~\xpgvalue{maghrib})
3141 to Arabic \xpgoption{numerals}.
3142 \item New date commands \cmd{\today*}, \cmd{\todayGen}, \cmd{\todayArabic}, and \cmd{\todayRoman} (all with
3143 starred counterparts) for Serbian (\TXI{524}).
3144 \item Implement basic support for \xpgoption{variant=ijekavian} in Serbian.
3145 \item Dutch now hyphenates properly on letters with tremata. The new option, \xpgoption{tremahyphenation},
3146 is provided to opt-out this feature.
3147 \item Add shorthands ¦"a¦, ¦"e¦, ¦"i¦, ¦"o¦, ¦"u¦, ¦"A¦, ¦"E¦, ¦"I¦, ¦"O¦, ¦"U¦, ¦"y¦, and ¦"Y¦ to Dutch.
3148 \end{itemize}
3149
3150 \subsubsection*{Interface changes}
3151 \begin{itemize}
3152 \item All language options are now lowercase by default (though the mechanism is case-insensitive anyway).
3153 Changes cover Kurdish, Sanskrit, Serbian.
3154 \end{itemize}
3155
3156 \subsection*{1.62 (2023/04/22)}
3157
3158 \subsubsection*{Bug fixes}
3159 \begin{itemize}
3160 \item \cmd\BCPdata\ was not fully expandable as required. Now it is.
3161 \end{itemize}
3162
3163 \subsection*{1.61 (2023/04/16)}
3164
3165 \subsubsection*{Bug fixes}
3166 \begin{itemize}
3167 \item Properly reset fonts on change to Latin-script other language (\TXI{580})
3168 \item Turn ¦^¦ shorthand off in aux file for Latin (\TXI{582})
3169 \item Fix stacking of nested languages and resulting bug in TOC language assignment (\TXI{585})
3170 \item Fix ¦\greeknumeral{6}¦ (\TXI{587})
3171 \item Fix (re)setting of scripts in inline language commands.
3172 \end{itemize}
3173
3174 \subsubsection*{New features}
3175 \begin{itemize}
3176 \item Introduce \cmd\BCPdata, a standardized way to gather localization information
3177 (see sec.~\ref{sec:langinfo}).
3178 \end{itemize}
3179
3180 \subsection*{1.60 (2023/02/11)}
3181
3182 \subsubsection*{Bug fixes}
3183 \begin{itemize}
3184 \item Remove stray \texttt{U+FEFF} glyphs in gloss files (\TXI{574})
3185 \item Fix vertical whitespace in captions (\TXI{575})
3186 \item Fix whitespace in dutch with shorthands.
3187 \end{itemize}
3188
3189 \subsection*{1.59 (2022/11/29)}
3190
3191 \subsubsection*{Bug fixes}
3192 \begin{itemize}
3193 \item Do not error, but warn, after language change due to non-updated aux file (\TXI{565}).
3194 \item Fix catcode issue for Latin (\TXI{566}).
3195 \item Improve error message with missing fonts (\TXI{571})
3196 \end{itemize}
3197
3198 \subsubsection*{New features}
3199 \begin{itemize}
3200 \item Add support for (simplified and traditional) Chinese (\TXI{65}, provided by \TA{Takuji Tanaka}).
3201 \item Add support for Punjabi (\TXP{572}), provided by \TA{Arvinder Singh}.
3202 \end{itemize}
3203
3204 \subsection*{1.58 (2022/10/26)}
3205
3206 \subsubsection*{Bug fixes}
3207 \begin{itemize}
3208 \item The option \xpgoption{forceheadingpunctuation} is introduced
3209 for correct running headers in Hungarian documents (\TXI{557}).
3210 \item Fix language setting in list of figure and table if captions float to different
3211 language areas (\TXI{542}).
3212 \item Make Croatian digraphs robust (\TXI{552}).
3213 \item Fix definition of some Finnish shorthands (\TXI{554}).
3214 \item Re-fix Hungarian patching of parts with hyperref (\TXI{555}).
3215 \item Correct running headers in Hungarian documents (\TXI{557}).
3216 \item Fix option expansion issue (\TXI{559}).
3217 \end{itemize}
3218
3219 \subsection*{1.57 (2022/07/18)}
3220
3221 \subsubsection*{Bug fixes}
3222 \begin{itemize}
3223 \item Fix passing of macros to \cmd\setmainlanguage\ and \cmd\setotherlanguage\ (\TXI{543}).
3224 \item Fix ¦otherlanguage*¦ environment with bidi text (\TXP{544}).
3225 \item Re-fix patching of French part headings with hyperref (\TXI{546}).
3226 \item Fix Latin prosodic shorthand issues (\TXI{547}, \href{https://github.com/latex3/babel/issues/126}{Babel/\#126},
3227 \href{https://github.com/latex3/babel/issues/129}{Babel/\#129}).
3228 \end{itemize}
3229
3230 \subsubsection*{New features}
3231 \begin{itemize}
3232 \item New option \xpgoption{transliteration} to Hebrew and hebrewcal (\TXI{540}).
3233 \item New option \xpgoption{fullyear} to Hebrew.
3234 \end{itemize}
3235
3236 \subsection*{1.56 (2022/04/20)}
3237
3238 \subsubsection*{Bug fixes}
3239 \begin{itemize}
3240 \item Fix English setup via aliases (\TXI{539}).
3241 \end{itemize}
3242
3243
3244 \subsection*{1.55a (2022/04/10)}
3245
3246 \subsubsection*{Bug fixes}
3247 \begin{itemize}
3248 \item Fix \cmd\foreignlanguage\ command (\TXI{538}).
3249 \end{itemize}
3250
3251 \subsection*{1.55 (2022/04/09)}
3252
3253 \subsubsection*{New features}
3254 \begin{itemize}
3255 \item New option \xpgoption{splithyphens} and \xpgoption{vlna} for Polish (\TXI{535}).
3256 \item Add \xpgoption{babelshorthands} to Polish.
3257 \end{itemize}
3258
3259 \subsubsection*{Bug fixes}
3260 \begin{itemize}
3261 \item Add missing \texttt{gloss-latex.lde} file to release (\TXI{537}).
3262 \end{itemize}
3263
3264 \subsection*{1.54 (2022/03/27)}
3265
3266 \subsubsection*{New features}
3267 \begin{itemize}
3268 \item New option \xpgoption{splithyphens} for Serbian (\TXI{496}) and Portuguese (\TXI{534}).
3269 \item Add \xpgoption{babelshorthands} to Portuguese.
3270 \item Add \xpgoption{schoolhyphens} option to Finnish (\TXI{525}).
3271 \end{itemize}
3272
3273 \subsubsection*{Interface and defaults changes}
3274 \begin{itemize}
3275 \item Rename \xpgoption{disableligatures} to \xpgoption{disabledigraphs} for Croatian (\TXI{497}, \TXP{500}).
3276 \item Fix output with \xpgoption{numerals=cyrillic-alph} (part of \TXI{503}).
3277 \item Standardize February and November in Indonesian according to the Great Dictionary of the Indonesian Language
3278 of the Language Center (\emph{Kamus Besar Bahasa Indonesia}) (\TXP{526}).
3279 \end{itemize}
3280
3281 \subsubsection*{Bug fixes}
3282 \begin{itemize}
3283 \item Fix robustification of font family switches (\TXI{428}).
3284 \item Preserve font family switches across languages (\TXI{519}).
3285 \item Fix \TeX\ dash ligatures with \xpgoption{splithyphens} (\TXI{502}).
3286 \item Prevent \emph{missing hyphenmins value} \LaTeX\ error with unknown languages (\TXI{513}).
3287 \item Fix global \xpgoption{babelshorthands}, \xpgoption{localmarks} and \xpgoption{verbose}
3288 options (\TXI{515}).
3289 \item Fix Latin shorthands (\TXI{516}).
3290 \item Remove spurious space in Bosnian date (\TXP{528}).
3291 \item Fix \cmd\languagevariant\ and \cmd\mainlanguagevariant\ macros (\TXI{530}, \TXI{531}).
3292 \item Make \cmd\iflanguageloaded\ and friends work in preamble (\TXI{532}).
3293 \item Fix deactivation of shorthands (\TXI{320}).
3294 \item Fix deactivation of numerals.
3295 \item Update deprecated \LaTeX\ hooks (\TXI{523}).
3296 \item Fix \xpgoption{luatexrenderer} option which was not considered appropriately (\TXI{533}).
3297 \item Turn warning about \texttt{totalhyphenmin} to info, which is more appropriate (\TXI{111}).
3298 \end{itemize}
3299
3300 \subsubsection*{Documentation improvements}
3301 \begin{itemize}
3302 \item Document in this manual where to report bugs (\TXI{512}).
3303 \end{itemize}
3304
3305
3306 \subsection*{1.53 (2021/04/12)}
3307
3308 \subsubsection*{New features}
3309 \begin{itemize}
3310 \item New option \xpgoption{localalph} for Croatian (\TXI{486}).
3311 \item Use ordinals in part and chapter headings. A new option \xpgoption{chapterformat} has been
3312 added to disable this or change format to Roman numbering (\TXI{479}).
3313 \item New command \cmd\uyghurordinal\ and \cmd\uyghurord\ to produce Uyghur ordinals from 1--100.
3314 \end{itemize}
3315
3316 \subsubsection*{Bug fixes}
3317 \begin{itemize}
3318 \item Fix typo in Uyghur language definition file (\TXI{479}).
3319 \item Fix Uyghur date format (\TXI{479}).
3320 \item Fix Uyghur caption format and add \xpgoption{swapstrings} option (\TXI{479}).
3321 \item Add overlooked digraphs in Croatian (\TXP{484}).
3322 \item Fix typo in Serbian ¦\thepart¦ (\TXP{485}).
3323 \item Fix part modifications in Hungarian with \pkg{hyperref} (\TXI{493}).
3324 \end{itemize}
3325
3326 \subsection*{1.52 (2021/03/16)}
3327
3328 \subsubsection*{New features}
3329 \begin{itemize}
3330 \item Adaptations to \LaTeX\ 2021/05/01 pre-release 2 for Korean (\TXI{477}).
3331 \item Add support for Uyghur (\TXI{475}).
3332 \item New option \xpgoption{mathfunctions} for Russian and Ukrainian allows to disable the definitions
3333 of math macros that might clash with other packages (\TXI{465}).
3334 \item Support LaTeX's new NFSS hooks (\TXI{471}).
3335 \end{itemize}
3336
3337 \subsubsection*{Bug fixes}
3338 \begin{itemize}
3339 \item Fix French part modifications with \pkg{hyperref} (\TXI{469}).
3340 \item Fix markup of French ¦\see¦ and ¦\alsoname¦ (\TXI{468}).
3341 \end{itemize}
3342
3343 \subsection*{1.51 (2020/12/08)}
3344
3345 \subsubsection*{New features}
3346 \begin{itemize}
3347 \item New option \xpgoption{frenchpart} for French (\TXI{458}).
3348 \item New option \xpgoption{splithyphens} for Croatian (\TXI{454}).
3349 \end{itemize}
3350
3351 \subsubsection*{Bug fixes}
3352 \begin{itemize}
3353 \item Use new LaTeX core hooks rather than \pkg{filehook} package. This fixes
3354 a recent breakage of \pkg{filehook} with other external packages (\TXI{453}).
3355 \item Remove very old code that pretends \pkg{polyglossia} is \pkg{babel} (\TXI{455}).
3356 \item Fix spelling of Albanian contentsname (\TXI{456}).
3357 \item Fix part heading modification in French (\TXI{458}).
3358 \item Fix extra space in Hebrew (\TXI{459}).
3359 \item Register main polyglossia language earlier (\TXI{461}).
3360 \item Allow for hyphenations in words following opening guillemet in French with XeTeX (\TXI{462}).
3361 \end{itemize}
3362
3363
3364 \subsection*{1.50a (2020/10/15)}
3365
3366 \subsubsection*{Bug fixes}
3367 \begin{itemize}
3368 \item Assure ¦\autodot¦ is defined with ¦\KOMAScript¦ in Russian.
3369 \end{itemize}
3370
3371 \subsection*{1.50 (2020/10/09)}
3372
3373 \subsubsection*{New features}
3374 \begin{itemize}
3375 \item Polyglossia now uses the Harfbuzz renderer by default with LuaTeX
3376 output. This brings LuaTeX on par with XeTeX for all scripts (\TXI{337}).
3377 The renderer can be changed via the new global \xpgoption{luatexrenderer} option.
3378 \item The (previously inadvertently working) ¦hyphenrules¦ environment that ceased
3379 to work after a recent \pkg{babel} update is back and now officially supported.
3380 The environment now also supports language options and aliases (\TXI{427}).
3381 \item New command ¦\setlanghyphenmins¦ to adapt hyphenation thresholds of languages
3382 and varieties.
3383 \item New command ¦\abjadalph¦ for Arabic with corresponding option (\TXI{431}).
3384 \item Replace consecutive glues around punctuation by the correct amount of space
3385 with lualatex for French, ecclesiastic Latin, and Sanskrit (\TXI{437}).
3386 \end{itemize}
3387
3388 \subsubsection*{Bug fixes}
3389 \begin{itemize}
3390 \item Remove warning about missing Brazil patterns (\TXI{404}).
3391 \item Fix incompatibility with recent \pkg{babel} release (\TXI{408}).
3392 \item Fixed some spellings in Marathi (\TXI{409}).
3393 \item Fix spacing of geminating dot in Catalan (\TXI{410}).
3394 \item Fix incompatibility of Marathi with \pkg{beamer}.
3395 \item Correct ¦\partname¦ in Hindi (\TXI{416}).
3396 \item Updates and improvements to Kurdish (\TXI{418}).
3397 \item Only activate shorthand character if \xpgoption{babelshorthands} is \xpgvalue{true} (\TXI{421}).
3398 \item Fix whitespace issue in Czech and Slovak with \xpgvalue{vlna=true} (\TXI{423}).
3399 \item Fix whitespace issue in Danish (\TXI{424}).
3400 \item Fix catcode conflicts that might occur in language definition files
3401 f.\,ex.\ when loaded from a LaTeX3 class (\TXI{67}, \TXI{425}).
3402 \item Robustify font family switches (\TXI{428}).
3403 \item Fix whitespace issue in Russian \xpgoption{indentfirst} option (\TXI{433}).
3404 \item In Russian, \xpgoption{indentfirst} is now again default (\TXI{434}).
3405 \item Fix LaTeX error with arabic numbering in Ukrainian (\TXI{440}).
3406 \item Fix directionality after Hebrew decimal numbers (\TXI{441}).
3407 \item Fix ¦babelname¦ of Latin Serbian (\TXI{442}).
3408 \item Fix recording of secondary languages in ¦\xpg@bloaded¦ and ¦\xpg@bcp@loaded¦
3409 lists (\TXI{443}).
3410 \item Simplify and robustify section heading modification in Russian
3411 and introduce option \xpgoption{forceheadingpunctuation} (\TXI{444}).
3412 \item Fix Cyrillic dash (via babelshorthand ¦"---¦) when TeX ligatures
3413 are disabled (\TXI{445}).
3414 \item Fix problem with large character indices in Lua module for punctuation
3415 spacing
3416 \end{itemize}
3417
3418 \subsubsection*{Interface and defaults changes}
3419 \begin{itemize}
3420 \item Polyglossia now uses the Harfbuzz renderer by default with LuaTeX
3421 output. See new features section.
3422 \end{itemize}
3423
3424 \subsubsection*{Build fixes}
3425 \begin{itemize}
3426 \item Fix an embarrassing bug in the dtx build script which was the reason for an utterly
3427 incomplete ¦polyglossia.dtx¦ file (\TXI{420}).
3428 \end{itemize}
3429
3430 \subsubsection*{Documentation improvements}
3431 \begin{itemize}
3432 \item Document how to change ¦\lefthyphenmin¦ and ¦\righthyphenmin¦ for a language
3433 (\TXI{435}).
3434 \end{itemize}
3435
3436
3437 \subsection*{1.49 (2020/04/08)}
3438
3439 \subsubsection*{New features}
3440 \begin{itemize}
3441 \item Add hook ¦\polyglossia@language@switched¦ to the external package interface (\TXI{398}).
3442 \item Real fix for \TXI{400}, that wasn’t properly taken care of in 1.48.
3443 \end{itemize}
3444
3445 \subsubsection*{Bug fixes}
3446 \begin{itemize}
3447 \item Fix compilation error with some \xpgoption{swapstring} options in Hungarian (\TXI{373}).
3448 \item Fix whitespace problem in Greek language.
3449 \end{itemize}
3450
3451 \subsubsection*{Interface and defaults changes}
3452 \begin{itemize}
3453 \item Changed Finnish caption for ``Table of Contents'' to ``Sisällys'' (\TXI{403}).
3454 \end{itemize}
3455
3456
3457 \subsection*{1.48 (2020/03/25)}
3458
3459 \begin{itemize}
3460 \item No new features
3461 \end{itemize}
3462
3463 \subsubsection*{Bug fixes}
3464 \begin{itemize}
3465 \item Fix use of Hebrew with LuaLaTeX (\TXI{389}).
3466 \item Do not overwrite footnote redefinitions of other packages
3467 with Latin and French (\TXI{391}).
3468 \item Fix Serbian cyrillic numerals code (\TXI{392}).
3469 \item Fix \xpgoption{[no]localmarks} option, whose logic was swapped (part of \TXI{395}).
3470 \item Protect \xpgoption{localmarks} function against uppercased language names (part of \TXI{395}).
3471 \item Fix buggy redefinition of ¦\@markright¦ with option localmarks (\TXI{396}).
3472 \item Fix incompatibility between Latin and unicode-math (\TXI{394}).
3473 \item Make (undocumented) ¦\defineshorthand¦ command (imported from babel) work.
3474 \item Fix usage of \xpgoption{localmarks} option without value.
3475 \item Emergency fixes for bugs caused by updates in \pkg{babel}’s ¦switch.def¦ (\TXI{399} and \TXI{400}).
3476 \end{itemize}
3477
3478 \subsubsection*{Interface and defaults changes}
3479 \begin{itemize}
3480 \item Use private macros in keyval choice keys (\TXI{390}).
3481 \end{itemize}
3482
3483 \subsection*{1.47 (2020/01/29)}
3484
3485 \subsubsection*{New features}
3486 \begin{itemize}
3487 \item IETF BCP-47 compliant language tags can now be used for loading and switching
3488 languages alternatively to language names (\TXI{226}).
3489 \item New commands ¦\languageid{<type>}¦ and ¦\mainlanguageid{<type>}¦.
3490 \item New test ¦\iflanguageidloaded¦.
3491 \item New list ¦\xpg@bcp@loaded¦.
3492 \item New environment ¦{lang}{<lang>}¦ (this is equivalent to ¦{<lang>}¦, but also available with
3493 ¦\setlanguagealias*¦ which does not define dedicated alias environments).
3494 \item New gloss option ¦totalhyphenmin¦ (corresponds to LuaTeX's ¦\hyphenationmin¦) (\TXI{111}).
3495 \item New test ¦\iflanguageoption{<lang>}{<key>}{<val>}¦ (\TXI{364}).
3496 \item Restore simple alphabetic numbering for ¦\asbuk¦ and ¦\Asbuk¦ in Belarusian, Mongolian,
3497 Russian, Serbian, and Ukrainian (\TXI{377}).
3498 \item New command ¦\AsbukTrad¦ and ¦\asbukTrad¦ for Belarusian, Mongolian, Russian, Serbian,
3499 and Ukrainian which uses traditional alphanumerical numbering.
3500 \item New numerals option ¦cyrillic-trad¦ and ¦cyrillic-alph¦ to differentiate simple
3501 alphabetic and traditional alphanumerical Cyrillic numbering.
3502 \item ¦\selectbackgroundlanguage¦ and ¦\resetdefaultlanguage¦ now also support language
3503 aliases.
3504 \item New macro ¦\charifavailable{<char code>}{<substitution>}¦.
3505 \item Add French language variant ¦swiss¦.
3506 \item Implement \xpgoption{babelshorthands} for Croatian.
3507 \item Implement ¦\localnumeral¦ for Japanese.
3508 \end{itemize}
3509
3510 \subsubsection*{Bug fixes}
3511 \begin{itemize}
3512 \item Fix font family issue in headers (\TXI{355}).
3513 \item Fix whitespace issues in ¦\text<lang>¦ (\TXI{356}).
3514 \item Fix option-less ¦\babelname¦ in multi-variant languages (\TXI{357}).
3515 \item Fix some spacing inconsistencies with French, Latin, and Sanskrit (\TXI{358}).
3516 \item Fix issues with \xpgoption{babelshorthands} and \pkg{graphics} package (\TXI{368}).
3517 \item Fix some captions and improve numbering in Marathi (\TXI{370}).
3518 \item Fix Hungarian \xpgoption{swapstrings} feature (\TXI{373}).
3519 \item Fix lua punctuation code problem (\TXI{374}).
3520 \item Fix Bengali changecounternumbering option (\TXI{381}).
3521 \item Fix whitespace issue in Japanese (\TXI{387}).
3522 \item Fix ¦\text<lang>¦ command with multiple paragraphs.
3523 \item Actually implement documented german spelling variant ¦1996¦ (= ¦new¦).
3524 \item Fix Slovenian \xpgoption{localalph} option.
3525 \item Fix Czech and Slovak \xpgoption{splithyphens} with typewriter fonts.
3526 \item ¦farsical.sty¦: fix spacing issue with some month names.
3527 \item Fix directionalty of numbers in Hebrew with XeTeX.
3528 \item Improve interoperatability with \pkg{biblatex} (some language variants did not work yet).
3529 \end{itemize}
3530
3531 \subsubsection*{Interface and defaults changes}
3532 \begin{itemize}
3533 \item Some boolean options had ¦false¦ value by default, which meant if you passed
3534 them without value, the logic was reversed. This has been changed, leading to
3535 change of behavior should you have used one of these options without value (\TXI{363}).
3536 Concerned are the following options:
3537 \begin{itemize}
3538 \item \xpgoption{babelshorthands} in language Belarusian, Mongolian, Ukrainian, and Russian
3539 (now \xpgoption{babelshorthands} equals \xpgoption{babelshorthand=true}, no longer \xpgoption{babelshorthands=false}).
3540 \item \xpgoption{localalph} in language Slovenian (\xpgoption{localalph} now equals \xpgoption{localalph=true}).
3541 \item \xpgoption{fullyear} in package \pkg{hebrewcal} (\xpgoption{fullyear} now equals \xpgoption{fullyear=true}).
3542 \end{itemize}
3543 \item The option \xpgoption{latesthyphen} in language German is deprecated. \XeTeX\ and \LuaTeX\ nowadays
3544 always use the latest German hyphens.
3545 \item The command ¦\setlanguagealias*¦ (introduced in v1.46) does no longer define
3546 dedicated alias environments.
3547 \item The babelnames for Latin variants are now changed to ¦classiclatin¦, ¦ecclesiasticlatin¦
3548 and ¦medievallatin¦. This is how the hyphenation patterns and \pkg{babel} ¦\extras¦ are named, even
3549 though the variants can currently be selected in \pkg{babel} only via appended ``dot modifier''.
3550 \item In accordance with the respective \pkg{l3kernel} change, ¦\str_lower_case:n¦ has been renamed to
3551 ¦\str_lowercase:n¦ where used in ¦polyglossia.sty¦. Thus \pkg{polyglossia} 1.47 requires \pkg{l3kernel}
3552 2020-01-12 at least.
3553 \end{itemize}
3554
3555 \subsection*{1.46 (2019/11/15)}
3556
3557 \subsubsection*{New features}
3558 \begin{itemize}
3559 \item Add option \xpgoption{indentfirst} to Russian (\TXI{78}).
3560 \item Add options to set and customize French-style itemize item labels to French (\TXI{89}).
3561 \item \pkg{Polyglossia} now decodes all supported \pkg{babel} language names in ¦\setdefaultlanguage¦,
3562 ¦\setotherlanguage¦ and the language switching commands (\TXI{112}, \TXI{132}).
3563 \item Add optional localized math operators to Spanish (\TXI{123}).
3564 \item Swap section headings in Hungarian (\TXI{344}). New option \xpgoption{swapstrings} provides control
3565 over this.
3566 \item Introduce macro ¦\setlanguagealias¦ and ¦\setlanguagealias*¦.
3567 \item Introduce language switching command ¦\textlang{lang}{...}¦ (these are equivalent to ¦\text<lang>¦,
3568 but also available with ¦\setlanguagealias*¦ which does not define ¦\text<alias>¦).
3569 \item Add support for Afrikaans.
3570 \item Add support for Belarusian.
3571 \item Add support for Bosnian.
3572 \item Add support for Georgian.
3573 \item Add Spanish variant ¦mexican¦.
3574 \item Add babelshorthands as well as options \xpgoption{splithyphens} and \xpgoption{vlna} to Slovak.
3575 \item Add Latin language variant ¦ecclesiastic¦.
3576 \item Add Latin language options ¦capitalizemonth¦, ¦ecclesiasticfootnotes¦, ¦hyphenation¦,
3577 ¦prosodicshorthands¦, and ¦usej¦.
3578 \item Add Latin shorthands for «, », æ, Æ, œ, and Œ.
3579 \item Add French language option \xpgoption{thincolonspace}.
3580 \end{itemize}
3581
3582 \subsubsection*{Bug fixes}
3583 \begin{itemize}
3584 \item Fix problems with fragile font settings (\TXI{24}).
3585 \item Fix clash of French punctuation spacing with the \pkg{soul} package (\TXI{52}).
3586 \item Re-enable the possibility to pass a macro as main argument to ¦\setmainlanguage¦ and
3587 ¦\setotherlanguage¦ (\TXI{331}).
3588 \item Fix detection of default ¦\languagevariant¦ (\TXI{332}).
3589 \item Fix LaTeX error with undefined hyphenation pattern (\TXI{346}).
3590 \item Fix some babel shorthand issues by updating the shorthand code from recent \pkg{babel}.
3591 \item Fix some problems with French and Latin auto-spacing (\TXI{345}, \TXI{352}).
3592 \item Fix an \pkg{expl3} declaration (\TXI{348}).
3593 \end{itemize}
3594
3595 \subsubsection*{Interface and defaults changes}
3596 \begin{itemize}
3597 \item The sub-package ¦cyrillicnumbers.sty¦ has been renamed to
3598 ¦xpg-cyrillicnumbers.sty¦ (per TeXLive request).
3599 \item In Russian, all paragraphs are now indented by default, as common in Russian typography.
3600 The behavior can be opted out by \xpgoption{indentfirst=false}.
3601 \item In Czech, \xpgoption{splithyphens} and \xpgoption{lvna} are enabled by default.
3602 Also, the option does now work as well with LuaTeX.
3603 \item Changed option name ¦fraktur¦ to ¦blackletter¦ in German (the former is still available
3604 as an alias).
3605 \item In French, high punctuation characters and guillemets are spaced by half an interword
3606 space now instead of a ¦\thinspace¦ (cf. \TXI{345}).
3607 \end{itemize}
3608
3609 \subsection*{1.45 (2019/10/27)}
3610
3611 \subsubsection*{New features}
3612 \begin{itemize}
3613 \item Introduce a framework for external packages to access language variants. This fixes,
3614 among other things, long-standing problems in the interaction of \pkg{biblatex} and \pkg{polyglossia}.
3615 \item Add new macros ¦\languagevariant¦ and ¦\mainlanguagevariant¦ as well as ¦\babelname¦ and ¦\mainbabelname¦
3616 for package authors to access language information.
3617 \item Add new test ¦\iflanguageloaded{<language>}{<true>}{<false>}¦ where <language>
3618 can be a \pkg{polyglossia} or \pkg{babel} language name.
3619 \item Add new macros ¦\localnumeral,¦ ¦\localnumeral*,¦ ¦\Localnumeral¦ and
3620 ¦\Localnumeral*¦ that convert Arabic digitals to the local number scheme.
3621 \item Add new macro ¦\pghyphenation¦ to add language-specific hyphenation exceptions (\TXI{18}).
3622 \item Add support form (Khalkha \& Cyrillic) Mongolian in line with \pkg{babel-mongolian} (\TXI{23}).
3623 \item Add option \xpgoption{splithyphens} and \xpgoption{vlna} to Czech (XeTeX only; for LuaTeX, use the package
3624 \pkg{luavlna} to get these features) (\TXI{32}).
3625 \item Add support for Kurdish, both Kurmanji and Sorani (\TXI{277}).
3626 \item Implement proper Cyrillic (alphanumeric) numbering (\TXI{285}).
3627 \item Add new language ¦friulian¦.
3628 This deprecates ¦friulan¦ (which is still supported for backwards compatibility).
3629 \item Add new language ¦malay¦ with variants ¦indonesian¦ and ¦malaysian¦.
3630 This deprecates ¦bahasai¦ and ¦bahasam¦ (which are still supported for
3631 backwards compatibility).
3632 \item Add new language ¦gaelic¦ with variants ¦irish¦ and ¦scottish¦.
3633 This deprecates ¦irish¦ and ¦scottish¦ as own \pkg{polyglossia} languages (which
3634 are still supported for backwards compatibility).
3635 \item Add new language ¦hungarian¦.
3636 This deprecates ¦magyar¦ (which is still supported for backwards compatibility).
3637 \item Add new language ¦sorbian¦ with variants ¦lower¦ and ¦upper¦.
3638 This deprecates ¦lsorbian¦ and ¦usorbian¦ (which are still supported for
3639 backwards compatibility).
3640 \item Add new language ¦portuguese¦ with variants ¦portuguese¦ and ¦brazilian¦.
3641 This deprecates ¦brazil¦ and ¦portuges¦ (which are still supported for
3642 backwards compatibility).
3643 \item Add new language ¦norwegian¦ with variants ¦nynorsk¦ and ¦bokmal¦.
3644 This deprecates ¦nynorsk¦ and ¦norsk¦ (which are still supported for
3645 backwards compatibility).
3646 \item Add new language ¦persian¦.
3647 This deprecates ¦farsi¦ (which is still supported for backwards compatibility).
3648 \item Add new language ¦sami¦. Currently only Northern Sami is supported.
3649 This deprecates ¦samin¦ (which is still supported for backwards compatibility).
3650 \item ¦gloss-serbian¦: add \xpgoption{numerals=cyrillic} option. Add ¦\asbuk¦ and ¦\Asbuk¦ (\TXI{285}).
3651 \item Implement basic support for (French) ¦canadien¦ and (English) ¦canadian¦ (\TXI{22}).
3652 \item Improve support for Armenian (\TXI{79}): Add captions, Eastern month names
3653 (accessible via variant=eastern) and Armenian alphabetic numbering
3654 (via \xpgoption{numerals=armenian} and ¦\armenicnumeral¦).
3655 \item Add french option \xpgoption{autospacing} and commands ¦\AutoSpacing,¦ ¦\NoAutoSpacing¦
3656 This allows to switch off autospacing globally or locally (\TXI{113}).
3657 \item Fixup ¦\normalfont¦ (\TXI{203}).
3658 \item Fix directionality issues in mixed RTL/LTR paragraphs (\TXI{204}).
3659 \item Implement \xpgoption{babelshorthands} for Finnish (\TXI{212}) and Czech.
3660 \item Implement access to current language via Lua (\TXI{243}).
3661 \item Introduce french option option \xpgoption{autospacetypewriter}
3662 alias \xpgoption{OriginalTypewriter}.
3663 \item Support ¦\aemph¦ with lualatex
3664 \item Rename \xpgoption{automaticspacesaroundguillemets} to \xpgoption{autospaceguillemets}
3665 The old option is kept for backwards compatibility.
3666 \end{itemize}
3667
3668 \subsubsection*{Bug fixes}
3669 \begin{itemize}
3670 \item Fix equation number in Arabic and Farsi (\TXI{7}).
3671 \item Simplify and document Hebrew \xpgoption{marcheshvan} option (\TXI{16}).
3672 \item Fix hyphenation of Greek with LuaTeX (\TXI{55}).
3673 \item Fix N'ko date format (\TXI{63}).
3674 \item Disable the extras of a language when a nested language starts (\TXI{66}, \TXI{169}).
3675 \item Properly implement Bengali numbers (\TXI{69}, \TXI{184}).
3676 \item Fix conflicts with other packages caused by premature shorthand activation
3677 in preamble (\TXI{81}, \TXI{200}).
3678 \item Fix kerning in math with French (\TXI{92}).
3679 \item Fix expansion issue in Hebrew (\TXI{93}).
3680 \item Fix numbering expansion issue in Greek (\TXI{110}).
3681 \item Postpone ¦\disablehyphenation¦ in preamble until after setting of
3682 document language (\TXI{125}).
3683 \item Postpone the assignment of defaultfamily to ¦\AtBeginDocument¦,
3684 thus do not overwrite ¦\familydefault¦ redefinitions in the preamble (\TXI{127}).
3685 \item Reset number settings when switching language (\TXI{133}).
3686 \item Hebrew: Properly store ¦\MakeUppercase¦ for later restoration (\TXI{152}).
3687 \item Fix whitespace issue in ¦\datewelsh¦ (\TXI{158}).
3688 \item When switching language, set the language/script specific font families (\TXI{164}).
3689 \item Correct some Bengali captions (\TXI{165}).
3690 \item Fix documentation of Serbian (\TXI{168}).
3691 \item Reset ucl codes in Latin only if the respective variant is used (\TXI{172}).
3692 \item Fix ¦\disablehyphenation¦ with LuaTeX (\TXI{187}).
3693 \item Fix typos in Hindi captions (\TXI{202}).
3694 \item Pass language options to the aux files (\TXI{205}).
3695 \item Rewrite and fix English variant handling (\TXI{208}).
3696 \item Define magyar caption formats in ¦\blockextras¦ and undef them in ¦\noextras¦ (\TXI{209}).
3697 \item Ensure proper direction with arabic digits in Arabic and Farsi (\TXI{213}).
3698 \item Fix ¦\linespread¦ with Korean (\TXI{218}).
3699 \item Define Russian caption before key allocation (\TXI{219}).
3700 \item Register current language in \pkg{polyglossia} lua module after selection (\TXI{234}).
3701 \item Fix \pkg{babel} language switching commands (\TXI{239}):
3702 ¦\foreignlanguage¦ and the starred ¦otherlanguage*¦ environment are not
3703 supposed to change dates.
3704 \item Fix French spacing leaking beyond French (\TXI{270}).
3705 \item Redefine font families for French only if language is loaded (\TXI{270}).
3706 \item ¦gloss-russian¦:
3707 \begin{itemize}
3708 \item Check whether command exist before redefining (\TXI{280}).
3709 \item Fix some whitespace issues.
3710 \end{itemize}
3711 \item Fix and simplify ¦\frenchfootnote¦ definition (\TXI{294}).
3712 \item Fix footnote numbering in Farsi.
3713 \item Fix Latin footnotes in Arabic documents.
3714 \item Set the correct main direction with \pkg{luabidi}.
3715 \item Fix \xpgoption{autospaceguillemets} option in French.
3716 \item Fix grouping in ¦gloss-danish.ldf¦.
3717 \item Properly store ¦\MakeUppercase¦ and ¦\@arabic¦ for later restoration.
3718 \end{itemize}
3719
3720 \subsubsection*{Documentation}
3721 \begin{itemize}
3722 \item Add documentation about footnotes in RTL context
3723 \item Document Tibetan numerals option (\TXI{109}).
3724 \item Improve ¦\frenchfootnote¦ documentation.
3725 \item Mention Japanese support in the docs.
3726 \end{itemize}
3727
3728 \subsection*{1.44 (2019/04/04)}
3729 \begin{itemize}
3730 \item Correction to Russian language file, by \TA{Maksim Zholudev} (commit d2f383e).
3731 \item Added Macedonian language file, by \TA{Stefan Zlatinov} (commit cd379e1).
3732 \end{itemize}
3733
3734 \subsection*{1.43 (2019/03/05)}
3735 \begin{itemize}
3736 \item Correction to Hindi language file, by \TA{Zdenĕk Wagner}.
3737 \end{itemize}
3738
3739 \subsection*{1.42.5 (2017/04/13)}
3740 \begin{itemize}
3741 \item Many changes to the French language file, by \TA{Maïeul Rouquette}.
3742 \end{itemize}
3743
3744 \subsection*{1.42.4 (February, March 2016)}
3745 \begin{itemize}
3746 \item Remedial actions for the \pkg{babel} changes.
3747 \item Fixed side effect of pull request \TXI{122} (see commit d2a34ff).
3748 \item Added automatic Josa selection, variant, and captions options to Korean, by \TA{Dohyun Kim} (pull request \TXI{128}).
3749 \item Updated ¦gloss-occitan¦ from CTAN.
3750 \end{itemize}
3751
3752 \subsection*{18-01-2016}
3753 \begin{itemize}
3754 \item Fixed issue \TXI{124} (minor typo in ¦polyglossia-frpt.lua¦)
3755 \item Merged pull request \TXI{117} for more French guillemet spacing
3756 \item Merged pull request \TXI{121} to add ¦\bbl@loaded¦; fixes issue \TXI{120}
3757 \item Merged pull request \TXI{122} that build on \TXI{121}
3758 \item Merged pull request \TXI{116} for French (spacing around guillemets)
3759 \item Fixed issue \TXI{115} (spurious spaces in Arabic)
3760 \end{itemize}
3761
3762 \subsection*{19-08-2015}
3763 \begin{itemize}
3764 \item Fixed issue \TXI{107} for Marathi (labels and month names)
3765 \end{itemize}
3766
3767 \subsection*{1.42.0 (2015/08/06)}
3768 \begin{itemize}
3769 \item Add Bengali digits package, and option to reset all numbering functions.
3770 \item Add ¦long¦ option for Welsh date.
3771 \item Add local alphabet in Slovenian, for enumerations and such.
3772 \item Fix long-standing bug with Welsh: date should use ordinals.
3773 \item Fix for Latin with LuaTeX: all variants had same problems as Classic.
3774 \item Fixed error with British variant of English and LuaTeX (issue \TXI{86}).
3775 \end{itemize}
3776
3777 \subsection*{1.41.0 (2015/07/16)}
3778 \begin{itemize}
3779 \item Added support for Khmer, by \TA{Say Ol} (private email)
3780 \end{itemize}
3781
3782 \subsection*{1.40.1 (2015/07/14)}
3783 \begin{itemize}
3784 \item Bugfix for Korean, by \TA{Dohyun Kim} (pull request \TXI{103})
3785 \end{itemize}
3786
3787 \subsection*{1.40.0 (2015/07/07)}
3788 \begin{itemize}
3789 \item ¦gloss-korean.ldf¦ contributed by \TA{Dohyun Kim} (pull request \TXI{102})
3790 \end{itemize}
3791
3792 \subsection*{1.33.7 (2015/07/04)}
3793 \begin{itemize}
3794 \item Release to CTAN, no code change
3795 \item Fixed extraneous space in code for Swiss German (pull request \TXI{101})
3796 \item Fixed a typo in Ukrainian alphabet, for ¦\Asbuk¦ (pull request \TXI{99})
3797 \item Fix for Classic Latin: load patterns for LuaTeX
3798 \item Made ¦\rmfamily¦, ¦\sffamily¦ and ¦\ttfamily¦ robust again
3799 \item Merged fix for Hebrew date format, by \TA{Guy Rutenberg} (pull request \TXI{94})
3800 \item Merged fix for spurious space, by \TA{Caleb McKennan} (pull request \TXI{91})
3801 \item Merged pull request \TXI{84} by \TA{Élie Roux} for Tibetan
3802 \item Added support for Swiss German (pull request \TXI{75})
3803 \item Added commands ¦\Asbuk¦ and ¦\asbuk¦ for Ukrainian (pull request \TXI{76}), similar to Russian
3804 \item Documented changes to Latin from last year.
3805 \item Be friendlier to right-to-left languages with LuaTeX
3806 \item Enhanced Latin support by \TA{Claudio Beccari}
3807 \end{itemize}
3808
3809 \subsection*{1.33.6 (2015/05/15)}
3810 \begin{itemize}
3811 \item Introduce a ¦classical¦ and ¦medieval¦ variant of Latin
3812 \item Add ¦\asbuk¦ and ¦\Asbuk¦ for Ukrainian (after their Russian counterpart)
3813 \item Fix a number of bugs
3814 \end{itemize}
3815
3816 \subsection*{1.33.5 (2014/05/21)}
3817 \begin{itemize}
3818 \item Option to disable hyphenation entirely, by \TA{Élie Roux}
3819 \item Fix spurious spaces in gloss-russian.ldf, by \TA{Oleg Domanov}
3820 \item Support for the Austrian variant of German, by \TA{Jürgen Spitzmüller}
3821 \item Changes to the Croatian translations, by \TA{Ivan Kokan}
3822 \item Correction to the Lithuanian translations, by \TA{Ignas Anikevičius}
3823 \end{itemize}
3824
3825 \subsection*{1.33.4 (2013/06/27)}
3826 \begin{itemize}
3827 \item Emergency release for a bug introduced in ¦babelsh.def¦
3828 \end{itemize}
3829
3830 \subsection*{1.33.3 (2013/05/28)}
3831 \begin{itemize}
3832 \item Changed formatting of some error messages (emergency fixes for TeX Live 2013)
3833 \end{itemize}
3834
3835 \subsection*{1.33.2 (2013/05/26)}
3836 \begin{itemize}
3837 \item Added ¦\disablehyphenation¦ and ¦\enablehyphenation¦, contributed by
3838 \TA{Élie Roux}.
3839 \item Fixed bug related to package inclusion. \pkg{Polyglossia} would break if
3840 we loaded ¦breqn.sty¦, and then called ¦\setmainlanguage{english}¦, this
3841 is no longer the case.
3842 \item Removed spurious space introduced by ¦\captionswedish¦.
3843 \end{itemize}
3844
3845 \subsection*{1.33.1 (2013/05/23)}
3846 \begin{itemize}
3847 \item Editorial changes to the documentation
3848 \item Hunted and documented bugs
3849 \end{itemize}
3850
3851 \subsection*{1.33.0 (2013/05/20)}
3852 \begin{itemize}
3853 \item Added support for N’Ko.
3854 \item Bugfixes for LuaTeX
3855 \item More work in progress on Bidi in LuaTeX.
3856 \end{itemize}
3857
3858 \subsection*{1.32.0 (2013/05/15)}
3859 \begin{itemize}
3860 \item Transitional version to support right-to-left languages with LuaTeX.
3861 \end{itemize}
3862
3863 \subsection*{1.31 (2013/05/10) / 1.3 (2013/05/11)}
3864 \begin{itemize}
3865 \item Several bugfixes.
3866 \item Sync with \pkg{babel} 3.9.
3867 \item Consolidated support for LuaTeX for all languages but the ones using
3868 South and South-East Asian scripts, and languages written from right
3869 to left. Many thanks to \TA{Élie Roux} for his help.
3870 \item Added support for Tibetan, contributed by \TA{Élie Roux} (end of lines are experimental).
3871 \end{itemize}
3872
3873 \subsection*{1.30 (2012/08/06)}
3874 \begin{itemize}
3875 \item Added support for LuaTeX. Many languages don’t work yet. Please be patient.
3876 \end{itemize}
3877
3878 \subsection*{1.2.0e (2012/04/28)}
3879 \begin{itemize}
3880 \item Fixed a number of outstanding and not very interesting bugs.
3881 \item Added gloss files for Romansh and Friulan, contributed by \TA{Claudio Beccari}.
3882 \end{itemize}
3883
3884 \subsection*{1.2.0d (2012/01/12)}
3885 \begin{itemize}
3886 \item Removed ¦\makeatletter¦ and ¦\makeother¦ from gloss files entirely.
3887 \end{itemize}
3888
3889 \subsection*{1.2.0c (2011/10/12) [First update by Arthur Reutenauer]}
3890 \begin{itemize}
3891 \item Update to ¦gloss-italian.ldf¦ by \TA{Claudio Beccari}, incorporating changes
3892 by \TA{Enrico Gregorio}.
3893 \item Conclude every gloss file with ¦\makeatother¦ to match the initial
3894 ¦\makeatletter¦. (Not necessary from a technical point of vue, because of one
3895 of the changes by Enrico reported below, but I like it better that way :-)
3896 \item Conclude ¦polyglossia.sty¦ with ¦\ExplSyntaxOff¦ to match the initial
3897 ¦\ExplSyntaxOn¦.
3898 \item Added gloss file for Kannada, contributed by \TA{Aravinda VK} and others.
3899 \item Corrections to the gloss-dutch.ldf thanks to \TA{Wouter Bolsterlee}.
3900 \item Several patches by \TA{Enrico Gregorio}, fixing long-standing bugs.
3901 From the git log:
3902 \begin{itemize}
3903 \item Deleted setup for right-to-left writing direction, see \url{http://tug.org/pipermail/xetex/2011-April/020319.html}
3904 \item Changed three appearances of ¦\newcommand¦ to ¦\newrobustcmd,¦ as the commands needs to be protected.
3905 Bug reported by \TA{kamensky}.
3906 \item Corrected ¦\datepolish¦ as suggested by \TA{Piotr Kempa}
3907 \item Changed ¦\lccode"¦ into ¦\lccode\string",¦ because it might come into action at wrong times when ¦"¦ is active
3908 \item Changed definition of key ¦\xpg@setup¦, as ¦\@tmpfirst¦ and ¦\@tmpsecond¦ were not expanded, causing dependence
3909 of ¦\lefthyphenmin¦ and ¦\righthyphenmin¦ to the last loaded language.
3910 Raised by \TA{Vadim Rodionov} on the XeTeX mailing list.
3911 \item Deleted ¦\bgroup¦ and ¦\egroup¦ tokens from the definition of ¦otherlanguage*¦; they serve no purpose
3912 (we are already inside an environment) and conflict with \pkg{csquotes}. Noticed by \TA{P. Lehman}.
3913 \item Changed the calls of \verb|\input| to ¦\xpg@input¦, which inputs the required file and resets the catcode
3914 of ¦@¦ to the same value as it had before the input. Since each ¦.ldf¦ file starts with ¦\makeatletter¦,
3915 the old behaviour would leave a category 11 @, which is wrong.
3916 \item Added ¦\csuse{date#2}¦ to the definition of ¦otherlanguage*¦.
3917 \end{itemize}
3918 \end{itemize}
3919
3920 \subsection*{1.2.0b (2011/10/03) [Update by Philipp Stephani]}
3921 \begin{itemize}
3922 \item Load \pkg{xkeyval} package explicitly since newer versions
3923 of \pkg{fontspec} don't load it any more.
3924 \end{itemize}
3925
3926 \subsection*{1.2.0a (2010/07/27) [Last update by François Charette]}
3927 \begin{itemize}
3928 \item Initialize ¦\fontfamily¦ acc to value of ¦\familydefault¦
3929 (Fixes a bug when using \pkg{polyglossia} with beamer)
3930 \item Remove spurious space in def of ¦\dateenglish¦
3931 \item Add missing English variant ¦american¦
3932 \item Serbian: fix date format and captions (Latin+Cyrillic)
3933 \item Fix ¦\atticnumeral¦ in ¦gloss-greek¦
3934 \item Small improvements and fixes in documentation
3935 \end{itemize}
3936
3937
3938 \subsection*{1.2.0 (2010/07/15)}
3939 \begin{itemize}
3940 \item Adapted for \pkg{fontspec} 2.0 (will not work with earlier versions!)
3941 \item Implementation of a ¦\PolyglossiaSetup¦ interface
3942 that simplifies writing ¦gloss-*.ldf¦ files
3943 \item Many internal enhancements and refactoring
3944 (including a patch by \TA{Dirk Ulrich})
3945 \item Improved automatic font setup when ¦\<lang>font¦ is not defined
3946 \item New environment \texttt{otherlanguage*} (equivalent to ¦\foreignlanguage¦
3947 (\TA{Enrico Gregorio})
3948 \item Bugfix to prevent bogus expansion of ¦\{rm,sf,tt}family¦ even in aux files (\TA{Enrico Gregorio})
3949 \item New gloss files for Armenian, Bengali, Occitan, Bengali, Lao,
3950 Malayalam, Marathi, Tamil, Telugu, and Turkmen.
3951 \item New auxiliary packages ¦devanagaridigits¦ and ¦bengalidigits¦
3952 \item \pkg{hijrical} no longer loads \pkg{bidi} and checks for incompatible \pkg{l3calc}
3953 \item Add \pkg{babel} shorthands for Russian (based on a patch by \TA{Vladimir Lomov})
3954 \item Fix ¦\fnum@{table,figure}¦ for Lithuanian
3955 \item Various improvements in ¦gloss-russian¦ (provided by \TA{Vladimir Lomov} and
3956 others)
3957 \item Corrected captions for Bahasai, Lithuanian, Russian, Croatian
3958 \item Add option \xpgoption{indentfirst=true} for Spanish, Croatian and other languages
3959 (\xpgoption{indentfirst} was previously named \xpgoption{frenchindent})
3960 \item New option \xpgoption{script} for German: Setting \xpgoption{script=fraktur} modifies the
3961 captions for typesetting in Fraktur.
3962 \item New command ¦\aemph¦ for Arabic, Farsi, Urdu, etc. to mark emphasis through
3963 overlining.
3964 \item Package option \xpgoption{nolocalmarks} is now true by default: to activate it the
3965 option \xpgoption{localmarks} must be passed instead.
3966 \item Loading languages à la \pkg{babel} as package options is no longer possible (this
3967 feature was deprecated since v1.1.0).
3968 \end{itemize}
3969
3970 \subsection*{1.1.1 (2010/03/23)}
3971 \begin{itemize}
3972 \item Bugfix for French: explicit spaces before/after double punctuation
3973 signs (Par exemple : les grands « espaces » du Canada !) are
3974 now replaced by the appropriate non-breaking spaces, as in \pkg{babel}.
3975 \item Bugfix for font switching mechanism within Latin script
3976 (pending a complete re-implemen\-tation in v1.2):
3977 the font shape and series are no longer reset when switching language.
3978 \item New macros for non-Western decimal digits
3979 (instead of fontmappings)
3980 \item New gloss files for Asturian, Lithuanian and Urdu
3981 \item ¦hijrical.sty¦ is now locale-aware: ¦\hijritoday¦ is
3982 formatted differently in Arabic, Farsi, Urdu, Turkish
3983 and Bahasa Indonesia.
3984 \item Enable \xpgoption{babelshorthands} for Dutch
3985 \item Add missing macro ¦\allowhyphens¦
3986 \item Add global option \xpgoption{babelshorthands}
3987 \item Support Catalan geminated l
3988 \item Bugfix when declaring more than one pkg option
3989 \item Protect ¦\reset@font¦
3990 \item Add missing requirement \pkg{makecmds}
3991 \item Bugfix for smallcaps in captions
3992 \item Typo for ¦ccname¦ in Hebrew
3993 \item Add option \xpgoption{numerals} to ¦gloss-russian¦
3994 \item Provide ¦\newXeTeXintercharclass¦ when undefined
3995 \item Bugfix for Russian ¦\alph¦
3996 \item Remove superfluous level of ¦{}¦ in definition of ¦\markright¦
3997 \item Bugfix for ¦\datecatalan¦
3998 \item Change ¦hyphenmins¦ for Sanskrit
3999 \end{itemize}
4000
4001 \subsection*{1.1.0b (2009/11/22)}
4002 \begin{itemize}
4003 \item Modify ¦\hyphenmins¦ for Sanskrit (\TA{Yves Codet})
4004 \item Bugfixes for Serbian and Bulgarian (\TA{Enrico Gregorio})
4005 \end{itemize}
4006
4007 \subsection*{1.1.0a (2009/11/22)}
4008 \begin{itemize}
4009 \item Bugfix for interchar tokens
4010 \end{itemize}
4011
4012 \subsection*{1.1.0 (2009/11/20)}
4013 \begin{itemize}
4014 \item Use ¦\newXeTeXintercharclass¦ (thanks to \TA{Enrico Gregorio})
4015 \item Fixed implementation of shorthands for German (\pkg{babel} code in file ¦babelsh.def¦)
4016 \item Arabic (\TA{Khaled Hosny}):
4017 \begin{itemize}
4018 \item Fix abjad form for 3 and 5 and add option ¦\abjadjimnotail¦
4019 \item bugfix for ¦\arabicnumber¦
4020 \item make Gregorian calendar the default
4021 \item fixed typos in the sample text
4022 \end{itemize}
4023 \item Turkish (\TA{S. Ö. Yıldız}):
4024 \begin{itemize}
4025 \item fix white-space before : and !
4026 \item also check if the font specified TRK for language
4027 \item added missing Turkish translation of ``Glossary''
4028 \end{itemize}
4029 \item Suppress ¦nopattern¦ warning for non-hyphenated scripts
4030 \item Changed U+0163 to U+021B for Romanian (\TA{Elie Roux})
4031 \item Stylistic fixes and use macro ¦\xpg@option¦ for package options (\TA{E. Gregorio})
4032 \item Fix month names in Dutch (\TA{A. Ledda})
4033 \item Add Brazilian translation for ``glossary''
4034 \item Remove spurious space generated by ¦gloss-spanish¦
4035 \item Fix ¦ldf¦ file for brazilian
4036 \item Various improvements in the code communicated by \TA{E. Gregorio}:
4037 \begin{itemize}
4038 \item remove superfluous ¦\protect\language¦
4039 \item change default language from ¦0¦ to ¦\l@nohyphenation=255¦
4040 \item localize ¦lccode¦ handling of apostrophe in French; add it to Italian
4041 \end{itemize}
4042 \item Fix ¦frenchspacing¦ for Vietnamese
4043 \item Other minor bugfixes
4044 \end{itemize}
4045
4046 \subsection*{1.0.2 (2009/01/27)}
4047 \begin{itemize}
4048 \item Captions corrected in Hebrew, Russian and Spanish
4049 \item Removed all ¦\text<lang>¦ wrappers within caption definitions
4050 \item Improved compatibility with \pkg{babel}
4051 \item New option \xpgoption{babelshorthands} for German
4052 \item New option \xpgoption{Script} for Sanskrit
4053 \end{itemize}
4054
4055 \subsection*{1.0.1 (2008/07/31)}
4056 \begin{itemize}
4057 \item Improved documentation (added sections on font setup and numeration mappings)
4058 \item Improvements and bug fixes for English and German
4059 \item Bugfix in ¦gloss-syriac.ldf¦ (spurious space after ¦\textsyriac{...}¦)
4060 \item Extended the scope of ¦\syriacabjad¦
4061 \item Added ¦gloss-amharic.ldf¦ (ported from ¦ethiop.ldf¦ in the package \pkg{ethiop})
4062 \end{itemize}
4063
4064 \subsection*{1.0 (2008/07/13)}
4065 \begin{itemize}
4066 \item Initial release on CTAN.
4067 \end{itemize}
4068 \egroup
4069
4070 \section{Acknowledgements (by François Charette)}
4071 \pkg{Polyglossia} is notable for being a recycle box of previous contributions
4072 by other people. I take this opportunity to thank the following individuals,
4073 whose splendid work has made my task almost trivial in comparison: \TA{Johannes
4074 Braams} and the numerous contributors to the \pkg{babel} package (in particular
4075 \TA{Boris Lavva} and others for its Hebrew support), \TA{Alexej Kryukov} (\pkg{antomega}),
4076 \TA{Will Robertson} (\pkg{fontspec}), \TA{Apostolos Syropoulos} (\pkg{xgreek}), \TA{Youssef Jabri}
4077 (\pkg{arabi}), and \TA{Vafa Khalighi} (\pkg{xepersian} and \pkg{bidi}).
4078 The work of \TA{Mojca Miklavec} and \TA{Arthur Reutenauer} on hyphenation patterns with their package
4079 \pkg{hyph-utf8} is of course invaluable. I should also thank other
4080 individuals for their assistance in supporting specific languages: \TA{Yves Codet}
4081 (Sanskrit), \TA{Zdenĕk Wagner} (Hindi), \TA{Mikhal Oren} (Hebrew), \TA{Sergey Astanin} (Russian),
4082 \TA{Khaled Hosny} (Arabic), \TA{Sertaç Ö. Yıldız} (Turkish), \TA{Kamal Abdali} (Urdu),
4083 and several other members of the \XeTeX\ user community, notably \TA{Enrico Gregorio}, who
4084 has sent me many useful suggestions and corrections and contributed the \cmd\newXeTeXintercharclass\
4085 mechanism in xelatex.ini which is now used by polyglossia.
4086 More recently, \TA{Kevin Godby} of the \href{http://ubuntu-manual.org}{Ubuntu Manual} project has
4087 contributed very useful feedback, bug hunting and, with the help of translators,
4088 new language definition files for Asturian, Lithuanian, Occitan, Bengali, Malayalam, Marathi, Tamil, and Telugu.
4089 It is particularly heartening to realize that this package is used to typeset a widely-read
4090 document in dozens of different languages!
4091 Support for Lao was also added thanks to \TA{Brian Wilson}.
4092 I also thank \TA{Alan Munn} for kindly proof-reading the penultimate version of this documentation.
4093 And of course my gratitude also goes to \TA{Jonathan Kew}, the formidable author of \XeTeX!
4094
4095 \section{More acknowledgements (by the current development team)}
4096 Many thanks to all the people who have contributed bugfixes and new features to \pkg{polyglossia}
4097 since we took over.
4098 In alphabetical order: \TA{Ignas Anikevicius}, \TA{Sina Ahmadi}, \TA{Matthew Bertucci}, \TA{Wouter Bolsterlee}, \TA{Christian Buhtz},
4099 \TA{Ashok Das}, \TA{Oleg Domanov}, user \TA{fakhriaunur}, \TA{Philipp Gesang}, \TA{Kevin Godby},
4100 \TA{Enrico Gregorio}, \TA{Khaled Hosny}, \TA{Stephen Huan}, \TA{Najib Idrissi}, user \TA{julroy67}, \TA{Dohyun Kim}, \TA{Phil Kime},
4101 \TA{Mike Kroutikov}, \TA{Ivan Kokan}, \TA{Caleb Maclennan}, \TA{Gyula Magyarkuti}, \TA{José Mancera}, \TA{Miquel Ortega},
4102 \TA{Yevgen Pogribnyi}, \TA{Will Robertson}, \TA{Maïeul Rouquette}, \TA{Elie Roux}, \TA{Hugo Roy}, \TA{Guy Rutenberg},
4103 \TA{Marcin Serwin}, \TA{Arvinder Singh}, \TA{SpecialCharacter}, \TA{Avisek Jena}, \TA{Philipp Stephani}, \TA{Niranjan Tambe}, \TA{Takuji Tanaka},
4104 \TA{Osman Tursun}, \TA{Keno Wehr}, \TA{Dominik Wujastyk}, \TA{Sertaç Ö. Yıldız}, \TA{Andrey Zgarbul}, \TA{Maksim Zholudev},
4105 \TA{Yan Zhou}, and \TA{Stefan Zlatinov}.
4106 Their respective contributions can be identified from the contributor statistics on
4107 \href{https://codeberg.org/polyglossia/polyglossia/activity/contributors}{the reporitory}.
4108
4109 Among the ones who sent contributions directly to us we would like to especially thank
4110 \TA{Claudio Beccari}, the indefatigable champion of Romance languages, and beyond! Furthermore,
4111 kudos go to \TA{Moritz Wemheuer} (of \pkg{biblatex}) who has helped a lot to improve \pkg{polyglossia} interaction
4112 with \pkg{biblatex} and \pkg{csquotes}.
4113
4114 Not at least, we are very grateful for all bug reports and feature enhancement requests we received from
4115 the numerous users we cannot list all here (but again, you can find all names on \href{https://codeberg.org/polyglossia/polyglossia/issues?q=&type=all&sort=&state=all&labels=&milestone=0&project=0&assignee=0&poster=0&archived=false}{the issue tracker}).
4116 Please go on with that, you are keeping \pkg{polyglossia} running!
4117
4118 \end{document}
4119