summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex')
-rw-r--r--Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex703
1 files changed, 555 insertions, 148 deletions
diff --git a/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex b/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
index 77c48d2d118..fd7d8722ec0 100644
--- a/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
+++ b/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
@@ -4,6 +4,7 @@
\usepackage{color}
\usepackage{xspace,fancyvrb,booktabs}
\usepackage[neverdecrease]{paralist}
+\usepackage[format=hang,labelfont=bf,labelsep=period]{caption}
\definecolor{myblue}{rgb}{0.02,0.04,0.48}
\definecolor{lightblue}{rgb}{0.61,.8,.8}
\definecolor{myred}{rgb}{0.65,0.04,0.07}
@@ -26,7 +27,7 @@
\usepackage[babelshorthands]{polyglossia}
\usepackage{farsical}
\setmainlanguage[variant=british,ordinalmonthday=false]{english}
-\setotherlanguages{arabic,armenian,hebrew,syriac,greek,russian,serbian,catalan}
+\setotherlanguages{arabic,armenian,hebrew,syriac,greek,russian,serbian,catalan,georgian}
\usepackage[protrusion]{microtype}
\newcommand*\Cmd[1]{\cmd{#1}\DescribeMacro{#1}\xspace}
\newcommand*\pkg[1]{\textsf{\color{myblue}#1}}
@@ -77,6 +78,7 @@
\newfontfamily\armenianfont[Script=Armenian]{DejaVu Sans}
\newfontfamily\syriacfont[Script=Syriac]{Serto Jerusalem}
\newfontfamily\hebrewfont[Script=Hebrew]{Ezra SIL}
+\newfontfamily\georgianfont{DejaVu Serif}
\linespread{1.05}
\frenchspacing
@@ -102,6 +104,8 @@
\maketitle
\tableofcontents
+\condbreak{4\baselineskip}
+
\DeleteShortVerb{\|}
\MakeShortVerb{\¦}
@@ -132,8 +136,8 @@ tasks automatically:
calendars are supported).
\item For languages that have their own numbering system, modifying the formatting
of numbers appropriately (this also includes redefining the alphabetic sequence
- for non-Latin alphabets).\footnote{ %
- For the Arabic script this is now done by the bundled package \pkg{arabicnumbers}.}
+ for non-Latin alphabets).\footnote{%
+ This is done by bundled sub-packages such as \pkg{arabicnumbers}.}
\item Ensuring proper directionality if the document contains languages
that are written from right to left (via the package \pkg{bidi},
available separately).
@@ -182,48 +186,47 @@ or languages with babel shorthands.
\subsection{Supported languages}
Table~\ref{tab:lang} lists all languages currently supported.
-Those in red have specific options and/or commands
+Those in \TR{red} have specific options and/or commands
that are explained in section \ref{specific} below.
\begin{table}[ht]\centering
-\label{tab:lang}
-% Produced with tools/insert-language-list.rb -- JS, 2019-10-18
-% Edited by hand -- JS, 2019-10-18
+\caption{\label{tab:lang}Languages currently supported in \pkg{polyglossia}}
+% Produced with tools/insert-language-list.rb -- JS, 2019-11-01
+% Edited by hand -- JS, 2019-11-01
\begin{tabular}{lllll}
\toprule
-albanian & \TX{dutch} & interlingua & \TX{mongolian} & \TX{slovenian}\\
-amharic & \TX{english} & \TX{italian} & nko & \TX{sorbian}\\
-\TX{arabic} & \TX{esperanto} & japanese & \TX{norwegian} & spanish\\
-\TX{armenian}& estonian & kannada & occitan & swedish\\
-asturian & \TX{finnish} & khmer & \TX{persian} & \TX{syriac}\\
-basque & \TX{french} & \TX{korean} & piedmontese & tamil\\
-\TX{bengali} & friulian & \TX{kurdish} & polish & telugu\\
-breton & \TX{gaelic} & \TX{lao} & \TX{portuguese} & \TX{thai}\\
-bulgarian & galician & \TX{latin} & romanian & \TX{tibetan}\\
-\TX{catalan} & \TX{german} & latvian & romansh & turkish\\
-coptic & \TX{greek} & lithuanian & \TX{russian} & turkmen\\
-croatian & \TX{hebrew} & macedonian & \TX{sami} & \TX{ukrainian}\\
-\TX{czech} & \TX{hindi} & \TX{malay} & \TX{sanskrit} & urdu\\
-danish & \TX{hungarian} & malayalam & \TX{serbian} & vietnamese\\
-divehi & icelandic & marathi & slovak & \TX{welsh}\\
+\TX{afrikaans} & danish & \TX{hungarian} & marathi & \TX{slovenian} \\
+albanian & divehi & icelandic & \TX{mongolian} & \TX{sorbian} \\
+amharic & \TX{dutch} & interlingua & nko & \TX{spanish} \\
+\TX{arabic} & \TX{english} & \TX{italian} & \TX{norwegian} & swedish \\
+\TX{armenian} & \TX{esperanto} & japanese & occitan & \TX{syriac} \\
+asturian & estonian & kannada & \TX{persian} & tamil \\
+basque & \TX{finnish} & khmer & piedmontese & telugu \\
+\TX{belarusian} & \TX{french} & \TX{korean} & polish & \TX{thai} \\
+\TX{bengali} & friulian & \TX{kurdish} & \TX{portuguese} & \TX{tibetan} \\
+bosnian & \TX{gaelic} & \TX{lao} & romanian & turkish \\
+breton & galician & \TX{latin} & romansh & turkmen \\
+bulgarian & \TX{georgian} & latvian & \TX{russian} & \TX{ukrainian} \\
+\TX{catalan} & \TX{german} & lithuanian & \TX{sami} & urdu \\
+coptic & \TX{greek} & macedonian & \TX{sanskrit} & vietnamese \\
+croatian & \TX{hebrew} & \TX{malay} & \TX{serbian} & \TX{welsh} \\
+\TX{czech} & \TX{hindi} & malayalam & \TX{slovak} & \\
\bottomrule
\end{tabular}
-
-\caption{Languages currently supported in \pkg{polyglossia}}
\end{table}
\paragraph{Version Notes} The support for Amharic\new{v1.0.1} should be considered an experimental attempt to
-port the package \pkg{ethiop}.\footnote{Feedback is welcome.}
+port the package \pkg{ethiop}; feedback is welcome.
Version 1.1.1\new{v1.1.1} added support for Asturian, %\footnote{ Provided by Kevin Godby and Xuacu Saturio.},
Lithuanian, %\footnote{ Provided by Kevin Godby and Paulius Sladkevičius.},
and Urdu. %\footnote{ Provided by Kamal Abdali.}
%
-Version 1.2\new{v1.2.0} adds support for Armenian, Occitan, Bengali,
+Version 1.2\new{v1.2.0} introduced Armenian, Occitan, Bengali,
Lao, Malayalam, Marathi, Tamil, Telugu, and Turkmen.\footnote{%
See acknowledgements at the end for due credit to the various contributors.}
-Version 1.43\new{v1.43} silently introduced basic support for Japanese. This
-is considered experimental, and feedback is appreciated.
+Version 1.43\new{v1.43} brought basic support for Japanese (this
+is considered experimental, feedback is appreciated).
In version 1.45\new{v1.45}, support for Kurdish and Mongolian as well as some new
variants (Canadian French and English) have been added. Furthermore, for consistency reasons, some language have
been renamed (\emph{farsi}\textrightarrow\emph{persian}, \emph{friulan}\textrightarrow\emph{friulian},
@@ -233,67 +236,83 @@ been renamed (\emph{farsi}\textrightarrow\emph{persian}, \emph{friulan}\textrigh
\emph{lsorbian}\slash\emph{usorbian}\textrightarrow\emph{sorbian},
\emph{irish}\slash\emph{scottish}\textrightarrow\emph{gaelic},
\emph{norsk}\slash\emph{nynorsk}\textrightarrow\emph{norwegian}). The old names are still supported for backwards
-compatibility reasons, but they might not give access to newer language features.
+compatibility reasons.
+Version 1.46\new{v1.46} introduces support for Afrikaans, Belarusian, Bosnian and Georgian.
-\subsection{Relation to Babel languages}
+\subsection{Relation to and use of Babel language names}
If you are familiar with the \pkg{babel} package, you will note that \pkg{polyglossia}'s language naming
slightly differs. Whereas \pkg{babel} has a unique name for each language variety (\eg\emph{american} and \emph{british}),
-\pkg{polyglossia} differentiates language varieties via language options.
+\pkg{polyglossia} differentiates language varieties via language options (\eg \emph{english}, ¦variant=american¦).
-Furthermore, \pkg{babel} uses sometimes abbreviations for language names (\eg\emph{bahasam} for Bahasa Malayu) as well
+Furthermore, \pkg{babel} sometimes uses abbreviated language names (\eg\emph{bahasam} for Bahasa Malayu) as well
as endonyms, \ie language names coming from the designated languages (such as \emph{bahasa}, \emph{canadien} or \emph{magyar}).
As opposed to this, \pkg{polyglossia} always uses spelled-out (lower-cased) English language names.
-
-Table~\ref{tab:bbllang} lists the language names that differ in both packages. \pkg{Babel} names marked in red can also be used
-in \pkg{polyglossia} as an alias.\footnote{This is for historical reasons, since earlier versions of \pkg{polyglossia} used
- those names as well. Note, however, that you need to use the matching language switching commands, then, as
- well, \eg \cmd\textportuges\ with \emph{portuges} (rather than \cmd\textportuguese).}
+Please refer to table~\ref{tab:bbllang} for the differing language names in both packages.
\begin{table}
-\label{tab:bbllang}
+\caption{\label{tab:bbllang}Babel-polyglossia language name matching}
+
+\begin{minipage}[t]{1\columnwidth}
+\small\centering
\begin{tabular}{lll}
\toprule
\textbf{Babel name} & \textbf{Polyglossia name} & \textbf{Polyglossia options}\tabularnewline
\midrule
-acadien & french & variant=acadian \\
-american & english & \emph{(default)} \\
-australian & english & variant=australian \\
-austrian & german & variant=austrian, spelling=old \\
-bahasa & malay & \emph{(default)} \\
-\TR{bahasam} & malay & variant=malaysian \\
-\TR{brazil} & portuguese & variant=brazilian \\
-british & english & variant=british \\
-canadian & english & variant=canadian \\
-canadien & french & variant=canadian \\
-\TR{farsi} & persian & \\
-\TR{friulan} & friulian & \\
-german & german & spelling=old \\
-\TR{irish} & gaelic & variant=irish \\
-kurmanji & kurdish & variant=kurmanji \\
-lowersorbian & sorbian & variant=lower \\
-\TR{magyar} & hungarian & \\
-naustrian & german & variant=austrian \\
-newzealand & english & variant=newzealand \\
-ngerman & german & \emph{(default)} \\
-\TR{norsk} & norwegian & variant=bokmal \\
-nswissgerman & german & variant=swiss \\
-\TR{nynorsk} & norwegian & \emph{(default)} \\
-polutonikogreek & greek & variant=polytonic \\
-\TR{portuges} & portuguese & \emph{(default)} \\
-\TR{samin} & sami & \\
-\TR{scottish} & gaelic & variant=scottish \\
-serbianc & serbian & script=Cyrillic \\
-slovene & slovenian & \\
-swissgerman & german & variant=swiss, spelling=old \\
-uppersorbian & sorbian & variant=upper \\
+acadien & french & variant=acadian \\
+american & english & variant=american [\emph{default}] \\
+australian & english & variant=australian \\
+austrian & german & variant=austrian, spelling=old \\
+bahasa & malay & variant=indonesian [\emph{default}] \\
+bahasam & malay & variant=malaysian \\
+brazil & portuguese & variant=brazilian \\
+british & english & variant=british \\
+canadian & english & variant=canadian \\
+canadien & french & variant=canadian \\
+farsi & persian & \\
+friulan & friulian & \\
+german\footnote{Due to the name conflict only available in \pkg{polyglossia} as \emph{germanb} (which is a \pkg{babel} synonym).}
+ & german & spelling=old \\
+irish & gaelic & variant=irish [\emph{default}] \\
+kurmanji & kurdish & variant=kurmanji \\
+latin.classic\footnote{Available in \pkg{polyglossia} as \emph{latinclassic} (as dots are invalid in command names).}
+ & latin & variant=classic \\
+latin.ecclesiastic\footnote{Available in \pkg{polyglossia} as \emph{latinecclesiastic} (as dots are invalid in command names).}
+ & latin & variant=ecclesiastic \\
+latin.medieval\footnote{Available in \pkg{polyglossia} as \emph{latinmedieval} (as dots are invalid in command names).}
+ & latin & variant=medieval \\
+lowersorbian & sorbian & variant=lower \\
+magyar & hungarian & \\
+naustrian & german & variant=austrian \\
+newzealand & english & variant=newzealand \\
+ngerman & german & variant=german [\emph{default}] \\
+norsk & norwegian & variant=bokmal \\
+nswissgerman & german & variant=swiss \\
+nynorsk & norwegian & variant=nynorsk [\emph{default}] \\
+polutonikogreek & greek & variant=polytonic \\
+portuges & portuguese & variant=portuguese [\emph{default}] \\
+samin & sami & \\
+scottish & gaelic & variant=scottish \\
+serbianc & serbian & script=Cyrillic \\
+slovene & slovenian & \\
+spanishmx & spanish & variant=mexican \\
+swissgerman & german & variant=swiss, spelling=old \\
+uppersorbian & sorbian & variant=upper \\
\bottomrule
\end{tabular}
+\end{minipage}
-\caption{Babel-polyglossia language name matching}
\end{table}
+For convenience reasons, \pkg{polyglossia} also supports the use of babel names\new{v1.46} (for the few justified
+exceptions, please refer to the notes in table~\ref{tab:bbllang}).
+The babel names listed in table~\ref{tab:bbllang} can be used instead of the corresponding polyglossia
+name\slash options in \cmd\setdefaultlanguage\ and \cmd\setotherlanguage\ as well as in the \pkg{polyglossia} and
+\pkg{babel} language switching commands\slash environments documented in section~\ref{sec:langcmds} and
+\ref{sec:babelcmds} (\eg \cmd\textaustrian\ is synonymous to \cmd{\textgerman[variant=austrian,spelling=old]}).
+However, unless you have special reasons, we strongly encourage you to use the \pkg{polyglossia} names.
+
\subsection{Global options}
@@ -301,65 +320,75 @@ uppersorbian & sorbian & variant=upper \\
\begin{itemize}
\item \TB{babelshorthands}\new{v1.1.1} globally activates \pkg{babel}
- shorthands whenever available. Currently shorthands are implemented for
- Catalan, Czech, Dutch, Finnish, German, Italian, Mongolian, and Russian.
- Please refer to the respective language descriptions (sec.~\ref{specific}) for details.
-
- \item \TB{localmarks} redefines the internal \LaTeX\ macros \cmd\markboth\ and \cmd\markright.
- In earlier versions of \pkg{polyglossia},\new{v1.2.0} this option was set by default, but we
- now realize that it causes more problems than it helps, so it is now off by default.
- For backwards-compatibility, the option \TB{nolocalmarks} which used to switch off the previous
- default, and now does nothing, is still available.
-
- \item \TB{quiet} turns off most info messages and some of the warnings issued by \LaTeX,
- \pkg{fontspec} and \pkg{polyglossia}.
+ shorthands whenever available. Currently shorthands are implemented for
+ Afrikaans, Belarusian, Catalan, Czech, Dutch, Finnish, Georgian, German,
+ Italian, Latin, Mongolian, Russian, and Slovak. Please refer to the respective
+ language descriptions (sec.~\ref{specific}) for details.
+
+ \item \TB{localmarks} redefines the internal \LaTeX\ macros \cmd\markboth\ and
+ \cmd\markright. In earlier versions of \pkg{polyglossia},\new{v1.2.0} this
+ option was set by default, but we now realize that it causes more problems
+ than it helps, so it is now off by default. For backwards-compatibility, the
+ option \TB{nolocalmarks} which used to switch off the previous default, and
+ now does nothing, is still available.
+
+ \item \TB{quiet} turns off most info messages and some of the warnings issued
+ by \LaTeX, \pkg{fontspec} and \pkg{polyglossia}.
\end{itemize}
\section{Language-switching commands}\label{languageswitching}
-\subsection{Recommended commands}
+\subsection{Recommended commands}\label{sec:langcmds}
For each activated language the command
\cmd{\text⟨lang⟩[⟨options⟩]\{…\}} \DescribeMacro{\text⟨lang⟩}
+(as well as the synonymous \DescribeMacro{\textlang}%
+\cmd{\textlang[⟨options⟩]\{⟨lang⟩\}\{…\}}\new{1.46})
becomes available for short insertions of text in that language.
-For example ¦\textrussian{\today}¦ yields \textrussian{\today}
-This command switches to the correct hyphenation patterns, it activates
+For example ¦\textrussian{\today}¦ and ¦\textlang{russian}{\today}¦ yield \textrussian{\today}
+The commands switch to the correct hyphenation patterns, they activate
some extra features for the selected language (such as extra spacing before
-punctuation in French), and it translates the date when using ¦\today¦.
-It does not, however, translate so-called \textit{caption strings}, i.\,e.
+punctuation in French), and they translate the date when using ¦\today¦.
+They do not, however, translate so-called \textit{caption strings},\ie
``chapter'', ``figure'' etc., to the local language (these remain in the main
language).
The\DescribeEnv{⟨lang⟩}\ environment ¦⟨lang⟩¦, which is also available for any activated language,
-is meant for longer passages of text. It behaves slightly different than the \cmd{\text⟨lang⟩\{…\}}
-command: It does everything the latter does, but additionally, the caption strings are translated
-as well, and the language is also passed to auxiliary files, the table of contents and the lists of
-figures/tables.
-Like the command, the environment provides the possibility of setting language options locally.
+is meant for longer passages of text. It behaves slightly different than the \cmd{\text⟨lang⟩} and
+\cmd\textlang\ commands: It does everything the latter do, but additionally, the caption strings
+are translated as well, and the language is also passed to auxiliary files, the table of contents
+and the lists of figures/tables.
+Like the commands, the environment provides the possibility of setting language options locally.
For instance the following allows us to quote the beginning
of Homer’s \textit{Iliad}:
\begin{Verbatim}[formatcom=\color{myblue}]
-\begin{greek}[variant=ancient]
-μῆνιν ἄειδε θεὰ Πηληϊάδεω Ἀχιλῆος οὐλομένην, ἣ μυρί' Ἀχαιοῖς ἄλγε'
-ἔθηκε, πολλὰς δ' ἰφθίμους ψυχὰς Ἄϊδι προί̈αψεν ἡρώων, αὐτοὺς δὲ ἑλώρια
-τεῦχε κύνεσσιν οἰωνοῖσί τε πᾶσι, Διὸς δ' ἐτελείετο βουλή, ἐξ οὗ δὴ τὰ
-πρῶτα διαστήτην ἐρίσαντε Ἀτρεί̈δης τε ἄναξ ἀνδρῶν καὶ δῖος Ἀχιλλεύς.
-\end{greek}
+ \begin{quote}
+ \begin{greek}[variant=ancient]
+ μῆνιν ἄειδε θεὰ Πηληϊάδεω Ἀχιλῆος οὐλομένην, ἣ μυρί' Ἀχαιοῖς
+ ἄλγε' ἔθηκε, πολλὰς δ' ἰφθίμους ψυχὰς Ἄϊδι προί̈αψεν ἡρώων,
+ αὐτοὺς δὲ ἑλώρια τεῦχε κύνεσσιν οἰωνοῖσί τε πᾶσι, Διὸς δ'
+ ἐτελείετο βουλή, ἐξ οὗ δὴ τὰ πρῶτα διαστήτην ἐρίσαντε Ἀτρεί̈δης
+ τε ἄναξ ἀνδρῶν καὶ δῖος Ἀχιλλεύς.
+ \end{greek}
+ \end{quote}
\end{Verbatim}
+\vspace{-.5\baselineskip}
+
+\begin{quote}
\begin{greek}[variant=ancient]
μῆνιν ἄειδε θεὰ Πηληϊάδεω Ἀχιλῆος οὐλομένην, ἣ μυρί' Ἀχαιοῖς ἄλγε' ἔθηκε,
πολλὰς δ' ἰφθίμους ψυχὰς Ἄϊδι προί̈αψεν ἡρώων, αὐτοὺς δὲ ἑλώρια τεῦχε κύνεσσιν
οἰωνοῖσί τε πᾶσι, Διὸς δ' ἐτελείετο βουλή, ἐξ οὗ δὴ τὰ πρῶτα διαστήτην ἐρίσαντε
Ἀτρεί̈δης τε ἄναξ ἀνδρῶν καὶ δῖος Ἀχιλλεύς.
\end{greek}
-\bigskip
+\end{quote}
\noindent\DescribeEnv{Arabic} Note that for Arabic one cannot use the environment ¦arabic¦,
as \cmd\arabic\ is defined internally by \LaTeX. In this case
we need to use the environment ¦Arabic¦ instead.
-\subsection{Babel commands}
+\subsection{Babel commands}\label{sec:babelcmds}
Some macros defined in \pkg{babel}’s \file{hyphen.cfg} (and thus usually
compiled into the \XeLaTeX\ and \LuaLaTeX\ format) are redefined, but keep a
similar behaviour.
@@ -373,7 +402,7 @@ similar behaviour.
¦\selectlanguage{⟨lang⟩}¦ and the ¦otherlanguage¦ environment are identical to the
the ¦⟨lang⟩¦ environment, except that ¦\selectlanguage{⟨lang⟩}¦
does not need to be explicitly closed. The command ¦\foreinlanguage{⟨lang⟩}{…}¦ and the ¦otherlanguage*¦
-environment are identical with the use of the ¦\text⟨lang⟩¦ command, with the one
+environment are identical with the use of the ¦\text⟨lang⟩¦ or ¦\textlang¦ command, with the one
notable exception that they do not translate the date with ¦\today¦.
Since the \XeLaTeX\ and \LuaLaTeX\ format incorporate \pkg{babel}’s \file{hyphen.cfg},
@@ -382,12 +411,13 @@ defined there are also accessible.
\subsection{Other commands}
The following commands are probably of lesser interest to the end user, but
-ought to be mentioned here.
+ought to be mentioned here.\footnote{Note that these commands require polyglossia
+language names; they do not support language\slash babel aliases.}
\begin{itemize}
-\item \Cmd\selectbackgroundlanguage: this selects the global font setup and
- the numbering definitions for the default language.
+\item \DescribeMacro{\selectbackgroundlanguage}\cmd{\selectbackgroundlanguage\{⟨lang⟩\}}:
+ this selects the global font setup and the numbering definitions for the default language.
-\item \Cmd\resetdefaultlanguage\ (experimental):
+\item \DescribeMacro{\resetdefaultlanguage}\cmd{\resetdefaultlanguage[⟨options⟩]\{⟨lang⟩\}} (experimental):
completely switches the default language
to another one in the middle of a document: \textit{this may have adverse effects}!
@@ -398,9 +428,34 @@ ought to be mentioned here.
\item \Cmd\latinalph: Representation of counter as a lower-case letter: 1 = a, 2 = b, etc.
-\item \Cmd\latinAlph: Representation of counter as a uper-case letter: 1 = A, 2 = B, etc.
+\item \Cmd\latinAlph: Representation of counter as a upper-case letter: 1 = A, 2 = B, etc.
\end{itemize}
+
+\subsection{Setting up alias commands}
+
+By means of the macro
+\displaycmd{\setlanguagealias[⟨options⟩]\{⟨language⟩\}\{⟨alias⟩\}}{\setlanguagealias}\new{v1.46}
+you can define alias commands for specific language (variants). \Eg
+
+\begin{quote}
+\begin{verbatim}
+\setlanguagealias[variant=austrian]{german}{deAT}
+\end{verbatim}
+\end{quote}
+%
+will define a command \cmd{\textdeAT} as well as an environment ¦{deAT}¦ which will link towards
+the command \cmd{\textgerman[variant=austrian]} and the environment ¦{german}[variant=austrian]¦,
+respectively. The aliases can also be used in the language switching commands described in
+section~\ref{sec:langcmds} and \ref{sec:babelcmds}.
+Note, though, that the usual restrictions for command names apply, so something such as
+¦de-AT¦ or ¦de_AT¦ will not work since ¦-¦ and ¦_¦ are not allowed in command names.
+
+For the latter case, and for the case where an alias would clash with an existing \cmd{\text⟨...⟩}
+command (\eg ¦\textit¦), a starred version \Cmd{\setlanguagealias*} is provided which does not define
+a \cmd{\text⟨alias⟩} command (but which will set up the alias for everything else, including
+\cmd{\textlang\{⟨alias⟩\}}).
+
\section{Font setup}
With polyglossia it is possible to associate a specific font with any script or language
@@ -409,11 +464,12 @@ that occurs in the document. That font should always be defined as
For instance, if the default font defined by \cmd\setmainfont\
does not support Greek, then one can define the font used to display Greek with:\\
\centerline{ \cmd\newfontfamily\cmd{\greekfont[Script=Greek,⟨…⟩]\{⟨font⟩\}}. }
-Note that polyglossia will use the font thus defined as is.
-for instance if ¦\arabicfont¦ is explicitly defined, then one should take care of
-including the option ¦Script=Arabic¦ in that definition.
-See the \pkg{fontspec} documentation for more information.
-If a specific sans or monospace font is needed for a particular script or language,
+Note that polyglossia will use the font defined as is, so assure to do all necessary settings
+(please refer to the \pkg{fontspec} documentation for details).
+For instance, if ¦\arabicfont¦ is explicitly defined, then the option ¦Script=Arabic¦ should
+be included in that definition.
+
+If a specific sans serif or monospace (`teletype') font is needed for a particular script or language,
it can be defined by means of \new{v1.2.0}
¦\⟨script⟩fontsf¦\ or ¦\⟨language⟩fontsf¦ and ¦\⟨script⟩fonttt¦\ or ¦\⟨language⟩fonttt¦, respectively.
@@ -442,7 +498,7 @@ hyphenated at all):
\end{Verbatim}
%
These exceptions, however, apply to all languages. In addition to this, \pkg{polyglossia} provides
-the command\new{v.1.45}
+the command\new{v1.45}
\displaycmd{\pghyphenation[⟨options⟩]\{⟨lang⟩\}\{⟨exceptions⟩\}}{\pghyphenation}
which can be used to define exceptions that only apply to a specific language or language variant,
respectively.
@@ -463,6 +519,24 @@ The default value of each option is given in italic.
%\subsection{amharic}\label{amharic}
+\subsection{afrikaans}\label{afikaans}
+\paragraph*{Options:}
+\begin{itemize}
+ \item \TB{babelshorthands} = \textit{false} or true. \new{v1.1.1}
+ if this is turned on, the following shorthands defined for fine-tuning hyphenation and
+ micro-typography of Afrikaans words are activated:
+ \begin{shorthands}
+ \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
+ in the hyphenation patterns (as opposed to ¦\-¦ in default \TeX).
+ \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
+ cases where the hyphen should stick at the following syllable.
+ \item[¦"|¦] disables a ligature at this position.
+ \item[¦""¦] allows for a line break at this position (without hyphenation sign).
+ \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to ¦\slash¦,
+ hyphenation at the breakpoints preset in the hyphenation patterns is still allowed.
+ \end{shorthands}
+\end{itemize}
+
\subsection{arabic}\label{arabic}
\paragraph*{Options:}
\begin{itemize}
@@ -494,6 +568,42 @@ The default value of each option is given in italic.
\item \TB{numerals}\new{v1.45} = armenian or \textit{arabic}
\end{itemize}
+\subsection[belarusian]{belarusian\new{v1.46}}\label{belarusian}
+
+\paragraph*{Options:}
+\begin{itemize}
+ \item \TB{babelshorthands} = \textit{false} or true.
+ If this is turned on, the following shorthands are activated:
+ \begin{shorthands}
+ \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
+ in the hyphenation patterns (as opposed to ¦\-¦).
+ \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
+ cases where the hyphen should stick at the following syllable.
+ \item[¦"|¦] disables a ligature at this position.
+ \item[¦""¦] allows for a line break at this position (without hyphenation sign).
+ \item[¦"---¦] Cyrillic emdash in plain text.
+ \item[¦"--~¦] Cyrillic emdash in compound names (surnames).
+ \item[¦"--*¦] Cyrillic emdash for denoting direct speech.
+ \item[¦",¦] thinspace for initials with a breakpoint in following surname.
+ \item[¦"‘¦] for German left double quotes (looks like ,,).
+ \item[¦"’¦] for German right double quotes (looks like “).
+ \item[¦"<¦] for French left double quotes (looks like <<).
+ \item[¦">¦] for French right double quotes (looks like >>).
+ \end{shorthands}
+ \item \TB{numerals} = \textit{arabic} or cyrillic. Uses either Arabic numerals or Cyrillic
+ alphanumerical numbering.
+ \item \TB{spelling} = \textit{modern} or classic (=~tarask). With ¦spelling=classic¦, captions and dates
+ adhere to the Taraškievica (or Belarusian classical) orthography rather than the standard orthography.
+\end{itemize}
+%
+\paragraph*{Commands:}
+\begin{itemize}
+ \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for
+ environments such as ¦enumerate¦. The command takes a counter as argument,
+ \eg ¦\textbelarusian{\Asbuk{page}}¦ produces \textrussian{\Asbuk{page}}.
+ \item \Cmd\asbuk: same in lowercase
+\end{itemize}
+
\subsection[bengali]{bengali\new{v1.2.0}}\label{bengali}
\paragraph*{Options:}
\begin{itemize}
@@ -524,25 +634,25 @@ The default value of each option is given in italic.
\begin{shorthands}
\item[¦"=¦] for an explicit hyphen sign which is repeated at the beginning
of the next line when hyphenated, as common in Czech typesetting
- (also see option ¦splithyphens¦).
+ (only needed with ¦splithyphens=false¦).
\item[¦"‘¦] for Czech left double quotes (looks like ,,).
\item[¦"’¦] for Czech right double quotes (looks like “).
\item[¦">¦] for Czech left double guillemets (looks like >>).
\item[¦"<¦] for Czech right double guillemets (looks like <<).
\end{shorthands}
- \item \TB{splithyphens} = \textit{false} or true. \new{v1.45}
+ \item \TB{splithyphens} = false or \textit{true}.\new{v1.45}
According to Czech typesetting conventions, if a word with a hard hyphen (such as \emph{je-li})
is hyphenated at this hyphen, a second hyphenation character is to be inserted at the beginning
- of the line that follows the hyphenation (\emph{je-/-li}).\\
- If this option is true, this is done automatically (so the shorthand ¦"=¦ is not needed).
- Note, however, that the option is only available for \XeTeX. If you are using \LuaTeX,
- load the \pkg{luavlna} package to the same effect.
- \item \TB{vlna} = \textit{false} or true. \new{v1.45}
+ of the line that follows the hyphenation (\emph{je-/-li}).
+ By default, this is done automatically\new{v1.46} (if you are using \LuaTeX, the \pkg{luavlna} package is
+ loaded to achieve this).
+ Set this option to ¦false¦ to disable the feature.
+ \item \TB{vlna} = false or \textit{true}. \new{v1.45}
According to Czech typesetting conventions, single-letter words (non-syllable prepositions)
- must not occur at line ends.\\
- If this option is true, this is taken care of. Note, however, that the option
- is only available for \XeTeX. If you are using \LuaTeX, load the \pkg{luavlna} package
- to the same effect.
+ must not occur at line ends.
+ \pkg{Polyglossia} takes care of this automatically by default\new{v1.46} (if you are using \LuaTeX, the
+ \pkg{luavlna} package is loaded to achieve this).
+ Set this option to ¦false¦ to disable the feature.
\end{itemize}
\subsection{dutch}\label{dutch}
@@ -603,14 +713,31 @@ The default value of each option is given in italic.
\begin{itemize}
\item\TB{variant} = \textit{french} or canadian (=~acadian).\new{v1.45}
Currently, the three variants do not differ; they are supported for compatibility with \pkg{babel} (where they do not differ either).
- \item \TB{autospacing} = true or \textit{false} (default value = true). One of the most distinct features of French typography is the addition
+ \item \TB{autospacing} = \textit{true} or false. One of the most distinct features of French typography is the addition
of extra spacing around punctuation and quotation marks (guillemets). By default, polyglossia adds these spaces automatically, so you don't need
to enter them. This options allows you to switch this feature off globally.
- \item \TB{autospaceguillemets}\footnote{Up to version 1.44, the option was called \textit{automaticspacesaroundguillemets}. For backards compatibility reasons, the more verbose old option is still supported.} = true or \textit{false} (default value = true). If you only want to disable the automatic addition of spacing after opening and before closing guillemets (and not at punctuation), set this to \textit{false}. Note
- that the more general option \textit{autospacing} overrides this.
+ \item \TB{thincolonspace}\new{v1.46} = true or \textit{false}. Normally, a
+ full (non-breaking) interword space is inserted before a colon. Use this
+ option if you prefer a thinner space as used before \texttt{;}, \texttt{!},
+ and \texttt{?}.
+ \item \TB{autospaceguillemets}\footnote{Up to version 1.44, the option was
+ called \textit{automaticspacesaroundguillemets}. For backards compatibility
+ reasons, the more verbose old option is still supported.} = \textit{true}
+ or false. If you only want to disable the automatic addition of spacing
+ after opening and before closing guillemets (and not at punctuation), set
+ this to \textit{false}. Note that the more general option
+ \textit{autospacing} overrides this.
\item \TB{autospacetypewriter}\footnote{Babel's syntax \textit{OriginalTypewriter} is also supported.}\new{1.45} = true or \textit{false} (default value = true). By default, automatic spacing is disabled in typewriter font. If this is enabled, spacing in typewriter context is the same as with roman and sans serif font, depending on the \textit{autospacing} and \textit{autospaceguillemets} settings (note that this was the default up to v.~1.44).
\item \TB{frenchfootnote} = true or \textit{false} (default value = true). If \textit{true}, footnotes start with a non-superscripted number followed by a dot, as common in French typography. Note that this might interfere with the specific footnote handling of classes or packages.
Also note that this option is only functional (by design) if French is the main language.
+ \item \TB{frenchitemlabels}\new{v.1.46} = true or \textit{false} (default value = true). If \textit{true}, itemize item labels use em-dashes throughout,
+ as common in French typography.
+ Note that this option is only functional (by design) if French is the main language. Also, it might interfere with list packages such as \pkg{enumitem}.
+ \item \TB{itemlabels}\new{v.1.46} = ¦⟨cmd⟩¦ (default value = ¦\textemdash¦). If \emph{frenchitemlabels} is true, you can customize here the used item label of all levels.
+ \item \TB{itemlabeli}\new{v.1.46} = ¦⟨cmd⟩¦ (default value = ¦\textemdash¦). If \emph{frenchitemlabels} is true, you can customize here the used item label of the first level.
+ \item \TB{itemlabelii}\new{v.1.46} = ¦⟨cmd⟩¦ (default value = ¦\textemdash¦). If \emph{frenchitemlabels} is true, you can customize here the used item label of the second level.
+ \item \TB{itemlabeliii}\new{v.1.46} = ¦⟨cmd⟩¦ (default value = ¦\textemdash¦). If \emph{frenchitemlabels} is true, you can customize here the used item label of the third level.
+ \item \TB{itemlabeliv}\new{v.1.46} = ¦⟨cmd⟩¦ (default value = ¦\textemdash¦). If \emph{frenchitemlabels} is true, you can customize here the used item label of the fourth level.
\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
@@ -624,6 +751,34 @@ The default value of each option is given in italic.
\item \TB{variant} = \textit{irish} or scottish
\end{itemize}
+\subsection[georgian]{georgian\new{v1.46}}\label{georgian}
+
+\paragraph*{Options:}
+\begin{itemize}
+ \item \TB{babelshorthands} = \textit{false} or true.
+ If this is turned on, the following shorthands are activated:
+ \begin{shorthands}
+ \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
+ in the hyphenation patterns (as opposed to ¦\-¦).
+ \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
+ cases where the hyphen should stick at the following syllable.
+ \item[¦"|¦] disables a ligature at this position.
+ \item[¦""¦] allows for a line break at this position (without hyphenation sign).
+ \item[¦"---¦] Cyrillic emdash in plain text.
+ \item[¦"--~¦] Cyrillic emdash in compound names (surnames).
+ \item[¦"--*¦] Cyrillic emdash for denoting direct speech.
+ \item[¦",¦] thinspace for initials with a breakpoint in following surname.
+ \item[¦"‘¦] for German left double quotes (looks like ,,).
+ \item[¦"’¦] for German right double quotes (looks like “).
+ \item[¦"<¦] for French left double quotes (looks like <<).
+ \item[¦">¦] for French right double quotes (looks like >>).
+ \end{shorthands}
+ \item \TB{numerals} = \textit{arabic} or georgian. Uses either Arabic numerals or Georgian
+ alphanumerical numbering.
+ \item \TB{oldmonthnames} = \textit{true} or false (default: false). Uses traditional Georgian
+ month names.
+\end{itemize}
+
\subsection{german}\label{german}
\paragraph*{Options:}
\begin{itemize}
@@ -665,8 +820,9 @@ The default value of each option is given in italic.
\item[¦"<¦] for French left double quotes («)
\item[¦">¦] for French right double quotes (»).
\end{shorthands}
- \item\TB{script} = \textit{latin} or fraktur.\new{v1.2.0}
- Setting script=fraktur modifies the captions for typesetting German in Fraktur.
+ \item\TB{script} = \textit{latin} or blackletter\new{v1.46} (=~fraktur\new{v1.2.0}).
+ Setting ¦script=blackletter¦ adapts the captions for typesetting German in blackletter type (using the long s (ſ)
+ where appropriate).
\end{itemize}
\subsection{greek}\label{greek}
@@ -707,6 +863,27 @@ The default value of each option is given in italic.
\end{itemize}
\subsection{hungarian}\label{hungarian}
+\paragraph*{Options:}
+\begin{itemize}
+ \item \TB{swapstrings} = \textit{all}, captions, headings, headers, hheaders or none\new{v1.46}
+
+ In Hungarian, some caption strings need to be in a different order than in other languages
+ (\eg \emph{1. fejezet} instead of \emph{Chapter 1}). By default, \pkg{polyglossia} tries hard to
+ provide the correct order for different classes and packages (standard classes, \pkg{KOMA-script},
+ \pkg{memoir}, and \pkg{titlesec} package should work, as well as \pkg{fancyhdr} and \pkg{caption}).
+ However, since the definition of these strings is not standardized, the redefinitions might not work
+ and even interfere badly if you use specific classes or packages that redefine the respective strings
+ themselves. In this case, you can disable some or all changes.
+ The possibilities are:
+ \begin{itemize}
+ \item ¦all¦: Redefine figure and table captions, part and chapter headings, and running headers (=~default setting)
+ \item ¦captions¦: Redefine figure and table captions only
+ \item ¦headings¦: Redefine part and chapter headings only
+ \item ¦headers¦: Redefine running headers only
+ \item ¦hheaders¦: Redefine part and chapter headings as well as running headers
+ \item ¦none¦: Do not redefine anything
+ \end{itemize}
+\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
\item \Cmd\ontoday\ (= \Cmd\ondatehungarian): special form of \cmd\today\ which produces a slightly different
@@ -741,7 +918,6 @@ The default value of each option is given in italic.
\end{itemize}
\subsection[kurdish]{kurdish\new{v1.45}}\label{kurdish}
-Kurdish support includes Sorani Kurdish and Kurmanji Kurdish, both in either Arabic or Latin script.
\paragraph*{Options:}
\begin{itemize}
@@ -750,9 +926,10 @@ Kurdish support includes Sorani Kurdish and Kurmanji Kurdish, both in either Ara
\item \TB{numerals} = western or eastern. Defaults are ¦western¦ for Latin and ¦eastern¦ for Arabic script, depending on the selection above.
\item \TB{abjadjimnotail} = \textit{false} or true.
Set this to true if you want the \textit{abjad} form of the number three to be \textarabic{ج‍} – as in the manuscript tradition – instead of the modern usage \textarabic{ج}.
- \item \TB{locale} (not yet implemented)
- \item \TB{calendar} (not yet implemented)
+% \item \TB{locale} (not yet implemented)
+% \item \TB{calendar} (not yet implemented)
\end{itemize}
+\condbreak{2\baselineskip}
\paragraph*{Commands:}
\begin{itemize}
\item \Cmd\ontoday: special form of \cmd\today\ which produces a slightly different
@@ -769,9 +946,152 @@ Kurdish support includes Sorani Kurdish and Kurmanji Kurdish, both in either Ara
\subsection{latin}\label{latin}
\paragraph*{Options:}
- \begin{itemize}
- \item \TB{variant} = classic, medieval or \textit{modern}
- \end{itemize}
+\begin{itemize}
+ \item \TB{variant} = classic, medieval, \emph{modern}, or ecclesiastic\new{v.1.46}
+
+ These variants refer to different spelling conventions. The ¦classic¦
+ and the ¦medieval¦ variant do not use the letters \emph{U} and
+ \emph{v}, but only \emph{V} and \emph{u}. This concerns predefined terms like
+ month names as well as the behaviour of the \cmd\MakeUppercase\ and the
+ \cmd\MakeLowercase\ command. The ¦medieval¦ and the
+ ¦ecclesiastic¦ variant use the ligatures \emph{\ae} and \emph{\oe}.
+ See table \ref{tab:latin-spelling} for examples.
+
+ Furthermore, the \texttt{ecclesiastic} variant takes care for a punctuation
+ spacing similar to French, but with smaller spaces, as provided for
+ PDF\TeX\ by the \pkg{ecclesiastic} package.
+ \begin{table}
+ \centering
+ \caption{\label{tab:latin-spelling}Spelling differences between the Latin
+ language variants.\newline The capitalization of month names and the use of
+ \emph{i/j} may be affected by the \texttt{capitalizemonth} and the
+ \texttt{usej} option.}
+ \begin{tabular}{llll}
+ \toprule
+ \textbf{classic} & \textbf{medieval} & \textbf{modern} & \textbf{ecclesiastic} \\
+ \midrule
+ Ianuarii & Ianuarii & Ianuarii & ianuarii \\
+ Nouembris & Nouembris & Novembris & novembris \\
+ Praefatio & Præfatio & Praefatio & Præfatio \\
+ \addlinespace\multicolumn{4}{@{}l}{\cmd{\MakeUppercase\{Iulius\}} yields:} \\
+ IVLIVS & IVLIVS & IULIUS & IULIUS \\
+ \bottomrule
+ \end{tabular}
+ \end{table}
+ \item \TB{hyphenation}\new{v.1.46} = classic, modern, or liturgical
+
+ There are three different sets of hyphenation patterns for Latin. Separate
+ documention for them is available on the
+ Internet.\footnote{\url{https://github.com/gregorio-project/hyphen-la/blob/master/doc/README.md\#hyphenation-styles}}
+ Each of the four variants mentioned above has its default set of hyphenation
+ patterns as indicated by table \ref{tab:latin-hyphenation}. Use the
+ ¦hyphenation¦ option if the default style does not fit your needs.
+ Note that the liturgical hyphenation patterns are the default of none of the
+ language variants. To use them, you have to say
+ ¦hyphenation=liturgical¦ in any case.
+ \begin{table}
+ \caption{\label{tab:latin-hyphenation}Latin default hyphenation styles}
+ \centering
+ \begin{tabular}{ll}
+ \toprule
+ \textbf{Language variant} & \textbf{Default hyphenation style} \\
+ \midrule
+ classic & classic \\
+ medieval & modern \\
+ modern & modern \\
+ ecclesiastic & modern \\
+ \bottomrule
+ \end{tabular}
+ \end{table}
+ \item \TB{ecclesiasticfootnotes}\new{v.1.46} = true or \emph{false}
+
+ Use footnotes as provided by the \pkg{ecclesiastic} package, which typesets
+ footnotes with ordinary instead of superior numbers and without indentation.
+ As many ecclesiastic documents and liturgical books use footnotes that are
+ very similar to the ordinary \LaTeX\ ones, we do not use this footnote style
+ as default even for the ¦ecclesiastic¦ variant.
+
+ Note that this option is only possible if Latin is the main language of your
+ document.
+ \item \TB{usej}\new{v.1.46} = true or \emph{false}
+
+ Use \emph{J/j} in predefined terms. The letter \emph{j} is not of ancient
+ origin. In early modern times, it was used to distinguish the consonantic
+ \emph{i} from the vocalic~\emph{i}. Nowadays, the use of \emph{j} has
+ disappeared from most Latin publications. So ¦false¦ is the default
+ value for all four language variants. Use this option if you prefer
+ \emph{Januarii} and \emph{Maji} to \emph{Ianuarii} and \emph{Maii}.
+ \item \TB{capitalizemonth}\new{v.1.46} = true or false
+
+ Capitalize the month name when printing dates (using the \cmd\today\
+ command). Traditionally, month names are capitalized. However, in recent
+ liturgical books they are lowercase. So ¦true¦ is the default value for
+ the variants ¦classic¦, ¦medieval¦, and ¦modern¦,
+ whereas ¦false¦ is the default value for the ¦ecclesiastic¦
+ variant.
+ \item \TB{babelshorthands} = true or \emph{false}
+
+ Enable the following shorthands inherited from \pkg{babel-latin} and the
+ \pkg{ecclesiastic} package.
+ \begin{shorthands}
+ \item[¦"<¦] for « (left guillemet)
+ \item[¦">¦] for » (right guillemet)
+ \item[¦"¦] If no other shorthand applies, ¦"¦ before any letter
+ character defines an optional break point allowing further break points
+ within the same word (as opposed to the \cmd\- command).
+ \item[¦"|¦] the same as ¦"¦, but also possible before non-letter
+ characters
+ \item[¦'a¦] for á (a with acute), also available for é, í, ó, ú, ý, ǽ, and
+ \'œ
+ \item[¦'A¦] for Á (A with acute), also available for É, Í, Ó, Ú, \'V, Ý, Ǽ,
+ and \'Œ
+ \end{shorthands}
+ The following shorthands are only available for the ¦medieval¦ and the
+ ¦ecclesiastic¦ variant.
+ \begin{shorthands}
+ \item[¦"ae¦] for æ (ae ligature), also available for œ
+ \item[¦"Ae¦] for Æ (AE ligature), also available for Œ
+ \item[¦"AE¦] for Æ (AE ligature), also available for Œ
+ \item[¦'ae¦] for ǽ (ae ligature with acute), also available for \'œ
+ \item[¦'Ae¦] for Ǽ (AE ligature with acute), also available for \'Œ
+ \item[¦'AE¦] for Ǽ (AE ligature with acute), also available for \'Œ
+ \end{shorthands}
+ \item \TB{prosodicshorthands}\new{v.1.46} = true or \emph{false}
+
+ Enable shorthands for prosodic marks (macrons and breves) very similiar to
+ those provided by \pkg{babel-latin} using the ¦withprosodicmarks¦
+ modifier.
+
+ Note that the active ¦=¦ character used for macrons will cause problems with
+ commands using \texttt{key=value} interfaces, \eg
+ ¦\includegraphics[scale=2]{...}¦. Use \cmd{\shorthandoff\{=\}} before
+ such commands (and \cmd{\shorthandon\{=\}} thereafter) within every
+ environment with prosodic shorthands enabled.
+
+ The following shorthands are available.
+ \begin{shorthands}
+ \item[¦=a¦] for ā (a with macron), also available for ē, ī, ō, ū, and ȳ
+ \item[¦=A¦] for Ā (A with macron), also available for Ē, Ī, Ō, Ū, V̄, and Ȳ.
+ Note that a macron above the letter V is only displayed if your font
+ supports the Unicode character ¦0304¦ (\emph{combining macron}).
+ \item[¦=ae¦] for a͞e (ae diphthong with macron), also available for a͞u, e͞u,
+ and o͞e. Note that macrons above diphthongs are only displayed if your font
+ supports the Unicode character ¦035E¦ (\emph{combining double
+ macron}).
+ \item[¦=Ae¦] for A͞e (Ae diphthong with macron), also available for A͞u, E͞u,
+ and O͞e.
+ \item[¦=AE¦] for A͞E (AE diphthong with macron), also available for A͞U, E͞U,
+ and O͞E.
+ \item[¦\textasciicircum a¦] for ă (a with breve), also available for ĕ, ĭ,
+ ŏ, ŭ, and y̆. Note that a breve above the letter y is only displayed if
+ your font supports the Unicode character ¦0306¦ (\emph{combining
+ breve}).
+ \item[¦\textasciicircum A¦] Ă (A with breve), also available for Ĕ, Ĭ, Ŏ,
+ Ŭ, V̆, and Y̆. Note that breves above the letters V and Y are only displayed
+ if your font supports the Unicode character ¦0306¦ (\emph{combining
+ breve}).
+ \end{shorthands}
+\end{itemize}
\subsection{malay}\label{malay}
\paragraph*{Options:}
@@ -811,7 +1131,7 @@ Currently, only the Khalkha variety in Cyrillic script is supported.
\begin{itemize}
\item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for
environments such as ¦enumerate¦. The command takes a counter as argument,
- \eg ¦\textrussian{\Asbuk{page}}¦ produces \textrussian{\Asbuk{page}}.
+ \eg ¦\textmongolian{\Asbuk{page}}¦ produces \textrussian{\Asbuk{page}}.
\item \Cmd\asbuk: same in lowercase
\end{itemize}
@@ -827,8 +1147,8 @@ Currently, only the Khalkha variety in Cyrillic script is supported.
\item \TB{numerals} = western or \textit{eastern}
\item \TB{abjadjimnotail} = \textit{false} or true. \new{v1.0.3}
Set this to true if you want the \textit{abjad} form of the number three to be \textarabic{ج‍} – as in the manuscript tradition – instead of the modern usage \textarabic{ج}.
- \item \TB{locale} (not yet implemented)
- \item \TB{calendar} (not yet implemented)
+% \item \TB{locale} (not yet implemented)
+% \item \TB{calendar} (not yet implemented)
\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
@@ -864,6 +1184,9 @@ Currently, only the Khalkha variety in Cyrillic script is supported.
% \item[¦"<¦] for French left double quotes (looks like <<).
% \item[¦">¦] for French right double quotes (looks like >>).
\end{shorthands}
+ \item \TB{indentfirst}\new{v1.46} = \textit{true} or false. By default, all paragraphs are indented in Russian,
+ also those after a chapter or section heading. If this option is false, the latter paragraphs
+ are not indented, as normal in \LaTeX.
\item \TB{spelling} = \textit{modern} or old (for captions and date only, not for hyphenation)
\item \TB{numerals} = \textit{arabic} or cyrillic. Uses either Arabic numerals or Cyrillic
alphanumerical numbering.
@@ -883,17 +1206,17 @@ Currently support for Sami is limited to Northern Sami.
\subsection{sanskrit}\label{sanskrit}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{Script} = \textit{Devanagari}\new{v1.0.2}, Gujarati, Malayalam, Bengali, Kannada,
+ \item \TB{script} = \textit{Devanagari}\new{v1.0.2}, Gujarati, Malayalam, Bengali, Kannada,
Telugu or Latin.
- The value is passed to \pkg{fontspec} in cases where the respective ¦\<script>font¦ is not defined.
+ The value is passed to \pkg{fontspec} in cases where the respective ¦\⟨script⟩font¦ is not defined.
This can be useful if you typeset Sanskrit texts in scripts other than Devanagari.
- \item \TB{Numerals} = \textit{Devanagari}\new{v1.45} or Western
+ \item \TB{numerals} = \textit{Devanagari}\new{v1.45} or Western
\end{itemize}
\subsection{serbian}\label{serbian}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{Script} = \textit{Cyrillic} or Latin. Will likely go to a variant.
+ \item \TB{script} = \textit{Cyrillic} or Latin.
\item \TB{numerals} = \textit{arabic} or cyrillic. Uses either Arabic numerals or Cyrillic
alphanumerical numbering.
\end{itemize}
@@ -906,6 +1229,44 @@ Currently support for Sami is limited to Northern Sami.
\end{itemize}
+\subsection{slovak}\label{slovak}
+
+\paragraph*{Options:}
+\begin{itemize}
+ \item \TB{babelshorthands} = \textit{false} or true. \new{v1.46}
+ if this is turned on, the following shorthands for Slovak are activated:
+ \begin{shorthands}
+ \item[¦"=¦] for an explicit hyphen sign which is repeated at the beginning
+ of the next line when hyphenated, as common in Slovak typesetting
+ (only needed with ¦splithyphens=false¦).
+ \item[¦"|¦] disables a ligature at this position.
+ \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
+ cases where the hyphen should stick at the following syllable.
+ \item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
+ in the hyphenation patterns (as opposed to ¦\-¦).
+ \item[¦""¦] allows for a line break at this position (without hyphenation sign).
+ \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to ¦\slash¦, hyphenation at the breakpoints
+ preset in the hyphenation patterns is still allowed.
+ \item[¦"‘¦] for Slovak left double quotes (looks like ,,).
+ \item[¦"’¦] for Slovak right double quotes (looks like “).
+ \item[¦">¦] for Slovak left double guillemets (looks like >>).
+ \item[¦"<¦] for Slovak right double guillemets (looks like <<).
+ \end{shorthands}
+ \item \TB{splithyphens} = \textit{false} or true. \new{v1.46}
+ According to Slovak typesetting conventions, if a word with a hard hyphen (such as \emph{je-li})
+ is hyphenated at this hyphen, a second hyphenation character is to be inserted at the beginning
+ of the line that follows the hyphenation (\emph{je-/-li}).
+ By default, this is done automatically (if you are using \LuaTeX, the \pkg{luavlna} package is
+ loaded to achieve this).
+ Set this option to ¦false¦ to disable the feature.
+ \item \TB{vlna} = \textit{false} or true. \new{v1.46}
+ According to Slovak typesetting conventions, single-letter words (non-syllable prepositions)
+ must not occur at line ends.
+ \pkg{Polyglossia} takes care of this automatically by default (if you are using \LuaTeX, the
+ \pkg{luavlna} package is loaded to achieve this).
+ Set this option to ¦false¦ to disable the feature.
+\end{itemize}
+
\subsection{slovenian}\label{slovenian}
\paragraph*{Options:}
\begin{itemize}
@@ -924,6 +1285,35 @@ Currently support for Sami is limited to Northern Sami.
\item \Cmd\oldtoday: outputs the current date using traditional Sorbian month names, even if \TB{olddate} is false.
\end{itemize}
+\subsection{spanish}\label{spanish}
+\paragraph*{Options:}
+\begin{itemize}
+ \item \TB{variant} = \textit{spanish} or mexican.\new{v1.46}
+ \item \TB{spanishoperators} = all, accented, spaced or none or \textit{false} (default value = all).\new{v1.46}
+ Determines of and how math operators are localized to Spanish.
+ \begin{itemize}
+ \item ¦accented¦ causes some math operators to use accents where usual in Spanish (\emph{lím},
+ \emph{lím\,sup}, \emph{lím\,inf}, \emph{máx}, \emph{mín}, \emph{ínf}, \emph{mód}).
+ \item ¦spaced¦ causes some math operators to use spaces where usual in Spanish (\emph{arc\,cos},
+ \emph{arc\,sen}, \emph{arc\,tg}).
+ \item ¦all¦ activates ¦accented¦ and ¦spaced¦ and furthermore provides Spanish localizations of
+ ¦\sin¦ (\emph{sen}), ¦\tan¦ (\emph{tg}), ¦\sinh¦ (\emph{senh}), and ¦\tanh¦ (\emph{tgh}).
+ \item ¦none¦ does no localization at all (default setting).
+ \end{itemize}
+\end{itemize}
+\paragraph*{\color{black}Commands:}\new{v1.46}
+\begin{itemize}
+ \item \Cmd\arcsen: alias to ¦\arcsin¦ (\pkg{babel} compatibility)
+ \item \Cmd\arctg: alias to ¦\arctan¦ (\pkg{babel} compatibility)
+ \item \Cmd\sen: alias to ¦\sin¦ (\pkg{babel} compatibility)
+ \item \Cmd\senh: alias to ¦\sinh¦ (\pkg{babel} compatibility)
+ \item \Cmd\tg: alias to ¦\tan¦ (\pkg{babel} compatibility)
+ \item \Cmd\tgh: alias to ¦\tanh¦ (\pkg{babel} compatibility)
+ \item \Cmd\spanishoperator: allows you to define further localized operators. For instance, ¦\spanishoperator{cotg}¦
+ defines a command ¦\cotg¦ that outputs \emph{cotg} in math. The optional argument of the command lets you specify the
+ spelling, if needed, \eg ¦\spanishoperator[arc\,ctg]{arcctg}¦.
+\end{itemize}
+
\subsection{syriac}\label{syriac}
\paragraph*{Options:}
\begin{itemize}
@@ -1120,6 +1510,9 @@ The following macros are provided:
\item \Cmd\armeniannumeral produces Armenian alphabetic numbering.
Example: ¦\armeniannumeral{1863}¦ yields \textarmenian{\armeniannumeral{1863}}.
+ \item \Cmd\georgiannumeral produces Georgian alphabetic numbering.\\
+ Example: ¦\georgiannumeral{1863}¦ yields \textgeorgian{\georgiannumeral{1863}}.
+
\item \Cmd\greeknumeral produces Greek alphabetic numbering, \Cmd\Greeknumeral outputs uppercased variants.
Example: ¦\greeknumeral{1863}¦ yields \textgreek{\greeknumeral{1863}},
¦\Greeknumeral{1863}¦ results in \textgreek{\Greeknumeral{1863}}.
@@ -1273,7 +1666,7 @@ where \texttt{⟨lang⟩} is a \pkg{babel} language name.
by other people. I take this opportunity to thank the following individuals,
whose splendid work has made my task almost trivial in comparision: \TA{Johannes
Braams} and the numerous contributors to the \pkg{babel} package (in particular
-\TA{Boris Lavva} and others for its Hebrew support), \TA{Alexej Kryuko}v (\pkg{antomega}),
+\TA{Boris Lavva} and others for its Hebrew support), \TA{Alexej Kryukov} (\pkg{antomega}),
\TA{Will Robertson} (\pkg{fontspec}), \TA{Apostolos Syropoulos} (\pkg{xgreek}), \TA{Youssef Jabri}
(\pkg{arabi}), and \TA{Vafa Khalighi} (\pkg{xepersian} and \pkg{bidi}).
The work of \TA{Mojca Miklavec} and \TA{Arthur Reutenauer} on hyphenation patterns with their package
@@ -1293,12 +1686,26 @@ Support for Lao was also added thanks to \TA{Brian Wilson}.
I also thank \TA{Alan Munn} for kindly proof-reading the penultimate version of this documentation.
And of course my gratitude also goes to \TA{Jonathan Kew}, the formidable author of \XeTeX!
-\section{More acknowledgements (by Arthur Reutenauer)}
-Many thanks to all the people who have contributed bugfixes and new features to
-Polyglossia since I took over. Most of them can be identified from the contributor statistics on \href{https://github.com/reutenauer/polyglossia/graphs/contributors}{GitHub} and I won’t try to name them
-all (maybe, one day ...); among the ones who sent contributions directly to me
-I would like to especially thank \TA{Claudio Beccari}, the indefatigable champion of
-Romance languages, and beyond!
+\section{More acknowledgements (by the current development team)}
+Many thanks to all the people who have contributed bugfixes and new features to \pkg{polyglossia}
+since we took over.
+In alphabetical order: \TA{Ignas Anikevicius}, \TA{Sina Ahmadi}, \TA{Wouter Bolsterlee}, \TA{Christian Buhtz},
+\TA{Zgarbul Andrey}, \TA{Oleg Domanov}, \TA{Philipp Gesang}, \TA{Kevin Godby}, \TA{Enrico Gregorio},
+\TA{Khaled Hosny}, \TA{Najib Idrissi}, user \TA{julroy67}, \TA{Dohyun Kim}, \TA{Phil Kime}, \TA{Mike Kroutikov},
+\TA{Ivan Kokan}, \TA{Caleb Maclennan}, \TA{José Mancera}, \TA{Yevgen Pogribnyi}, \TA{Maïeul Rouquette},
+\TA{Elie Roux}, \TA{Hugo Roy}, \TA{Guy Rutenberg}, \TA{Philipp Stephani}, \TA{Keno Wehr}, \TA{Dominik Wujastyk},
+\TA{Sertaç Ö. Yıldız}, \TA{Maksim Zholudev}, \TA{Yan Zhou}, and \TA{Stefan Zlatinov}.
+Their respective contributions can be identified from the contributor statistics on
+\href{https://github.com/reutenauer/polyglossia/graphs/contributors}{GitHub}.
+
+Among the ones who sent contributions directly to us we would like to especially thank
+\TA{Claudio Beccari}, the indefatigable champion of Romance languages, and beyond! Furthermore,
+kudos go to \TA{Moritz Wemheuer} (of \pkg{biblatex}) who has helped a lot to improve \pkg{polyglossia} interaction
+with \pkg{biblatex} and \pkg{csquotes}.
+
+Not at least, we are very grateful for all bug reports and feature enhancement requests we received from
+the numerous users we cannot list all here (but again, you can find all names on \href{https://github.com/reutenauer/polyglossia/issues?utf8=%E2%9C%93&q=is%3Aissue}{GitHub}).
+Please go on with that, you are keeping \pkg{polyglossia} running!
\end{document}