summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-01-29 22:37:53 +0000
committerKarl Berry <karl@freefriends.org>2020-01-29 22:37:53 +0000
commit015c5f064b14e4a79f151b46a6dd46b150520c81 (patch)
treecc3434d0ae73900950b37bc952816286d4d76d5c /Master/texmf-dist/doc/latex
parente9549ffe43d42fda4e5d3778e1d26fbd95e4ae9f (diff)
polyglossia (29jan20)
git-svn-id: svn://tug.org/texlive/trunk@53592 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/polyglossia/README6
-rw-r--r--Master/texmf-dist/doc/latex/polyglossia/example-arabic.pdfbin63924 -> 70425 bytes
-rw-r--r--Master/texmf-dist/doc/latex/polyglossia/example-korean.pdfbin17275 -> 17083 bytes
-rw-r--r--Master/texmf-dist/doc/latex/polyglossia/example-thai.pdfbin23876 -> 23443 bytes
-rw-r--r--Master/texmf-dist/doc/latex/polyglossia/examples.pdfbin151775 -> 151269 bytes
-rw-r--r--Master/texmf-dist/doc/latex/polyglossia/polyglossia.pdfbin224709 -> 267795 bytes
-rw-r--r--Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex1302
7 files changed, 881 insertions, 427 deletions
diff --git a/Master/texmf-dist/doc/latex/polyglossia/README b/Master/texmf-dist/doc/latex/polyglossia/README
index 18b2c4746ae..b2864ae1d11 100644
--- a/Master/texmf-dist/doc/latex/polyglossia/README
+++ b/Master/texmf-dist/doc/latex/polyglossia/README
@@ -1,7 +1,7 @@
¦----------------------------------------------¦
¦ ¦
- ¦ THE POLYGLOSSIA PACKAGE v1.46 ¦
+ ¦ THE POLYGLOSSIA PACKAGE v1.47 ¦
¦ ¦
¦ Modern multilingual typesetting ¦
¦ with XeLaTeX and LuaLaTeX ¦
@@ -34,8 +34,8 @@ Polyglossia makes it possible to automate the following tasks:
LICENSE
-Copyright (c) 2008-2010 François Charette, 2013 Élie Roux, 2011-2019 Arthur Reutenauer,
-Copyright (c) 2019 Bastien Roucariès, 2019 Jürgen Spitzmüller
+Copyright (c) 2008-2010 François Charette, 2013 Élie Roux, 2011-2020 Arthur Reutenauer,
+Copyright (c) 2019-2020 Bastien Roucariès, 2019-2020 Jürgen Spitzmüller
Except where otherwise noted, Polyglossia is placed under the terms of the MIT licence
(https://opensource.org/licenses/MIT).
diff --git a/Master/texmf-dist/doc/latex/polyglossia/example-arabic.pdf b/Master/texmf-dist/doc/latex/polyglossia/example-arabic.pdf
index b25a8459f61..f214903dd4c 100644
--- a/Master/texmf-dist/doc/latex/polyglossia/example-arabic.pdf
+++ b/Master/texmf-dist/doc/latex/polyglossia/example-arabic.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/polyglossia/example-korean.pdf b/Master/texmf-dist/doc/latex/polyglossia/example-korean.pdf
index 5cbffe37ef6..ac3be5e42c9 100644
--- a/Master/texmf-dist/doc/latex/polyglossia/example-korean.pdf
+++ b/Master/texmf-dist/doc/latex/polyglossia/example-korean.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/polyglossia/example-thai.pdf b/Master/texmf-dist/doc/latex/polyglossia/example-thai.pdf
index ee1dea23f29..2d7abc7300b 100644
--- a/Master/texmf-dist/doc/latex/polyglossia/example-thai.pdf
+++ b/Master/texmf-dist/doc/latex/polyglossia/example-thai.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/polyglossia/examples.pdf b/Master/texmf-dist/doc/latex/polyglossia/examples.pdf
index 9b28e4e3f30..bbe78342e23 100644
--- a/Master/texmf-dist/doc/latex/polyglossia/examples.pdf
+++ b/Master/texmf-dist/doc/latex/polyglossia/examples.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/polyglossia/polyglossia.pdf b/Master/texmf-dist/doc/latex/polyglossia/polyglossia.pdf
index 0698550579e..94b595acc66 100644
--- a/Master/texmf-dist/doc/latex/polyglossia/polyglossia.pdf
+++ b/Master/texmf-dist/doc/latex/polyglossia/polyglossia.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex b/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
index fd7d8722ec0..e4ca9770215 100644
--- a/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
+++ b/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
@@ -2,19 +2,19 @@
% !TeX TS-program = xelatex
\documentclass[11pt]{ltxdoc}
\usepackage{color}
-\usepackage{xspace,fancyvrb,booktabs}
+\usepackage{xspace,fancyvrb,longtable,booktabs}
\usepackage[neverdecrease]{paralist}
\usepackage[format=hang,labelfont=bf,labelsep=period]{caption}
-\definecolor{myblue}{rgb}{0.02,0.04,0.48}
+\definecolor{xpgblue}{rgb}{0.02,0.04,0.48}
\definecolor{lightblue}{rgb}{0.61,.8,.8}
-\definecolor{myred}{rgb}{0.65,0.04,0.07}
+\definecolor{xpgred}{rgb}{0.65,0.04,0.07}
\usepackage[
unicode=true,
bookmarks=true,
colorlinks=true,
- linkcolor=myblue,
- urlcolor=myblue,
- citecolor=myblue,
+ linkcolor=xpgblue,
+ urlcolor=xpgblue,
+ citecolor=xpgblue,
hyperindex=false,
hyperfootnotes=false,
pdftitle={Polyglossia: Modern multilingual typesetting with XeLaTeX and LuaLaTeX},
@@ -30,13 +30,13 @@
\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}}
-\newcommand*\file[1]{\texttt{\color{myblue}#1}}
-\newcommand*\TR[1]{\textcolor{myred}{#1}}
-\newcommand*\TX[1]{\hyperref[#1]{\textcolor{myred}{#1}}}
-\newcommand*\TB[1]{\textcolor{myblue}{\bf #1}}
-\newcommand*\TA[1]{\textsc{\color{myblue}#1}}
+\newcommand*\pkg[1]{\textsf{\color{xpgblue}#1}}
+\newcommand*\file[1]{\texttt{\color{xpgblue}#1}}
+\newcommand*\TR[1]{\textcolor{xpgred}{#1}}
+\newcommand*\TX[1]{\hyperref[#1]{\textcolor{xpgred}{#1}}}
+\newcommand*\TA[1]{\textsc{\color{xpgblue}#1}}
\newcommand*\link[1]{\href{#1}{#1}}
+\renewcommand*\meta[1]{\texttt{⟨#1⟩}}
\def\eg{\textit{e.g.,}\xspace}
\def\ie{\textit{i.e.,}\xspace}
\def\ca{\textit{ca.}\@\xspace}
@@ -44,14 +44,37 @@
\def\Ie{\textit{I.e.,}\xspace}
\def\etc{\@ifnextchar.{\textit{etc}}{\textit{etc.}\@\xspace}}
+%% Commands for documenting options
+\newcommand*\xpgoption[1]{\textcolor{xpgblue}{\ttfamily\bfseries #1}}
+\newcommand*\xpgvalue[1]{\texttt{#1}}
+\newcommand*\xpgpresetvalue[1]{\texttt{\textit{#1}}}
+\newcommand*\xpgdefaultvalue[1]{\texttt{*#1}}
+
+% arguments: #1 version number, #2 key name, #3 footnote, #4 possible values
+\NewDocumentCommand\xpgchoicekey{omom}{%
+ \xpgoption{#2}\IfValueT{#3}{\footnote{#3}}%
+ \IfValueT{#1}{\new{#1}} \xpgvalue{=} #4\par%
+}
+
+% arguments: #1 version number, #2 key name, #3 footnote
+\NewDocumentCommand\xpgboolkey{omo}{\xpgchoicekey[#1]{#2}[#3]{\xpgdefaultvalue{true} or \xpgvalue{false}}}
+\NewDocumentCommand\xpgboolkeytrue{omo}{\xpgchoicekey[#1]{#2}[#3]{\xpgdefaultvalue{\xpgpresetvalue{true}} or \xpgvalue{false}}}
+\NewDocumentCommand\xpgboolkeyfalse{omo}{\xpgchoicekey[#1]{#2}[#3]{\xpgdefaultvalue{true} or \xpgpresetvalue{false}}}
+
+% arguments: #1 version number, #2 key name, #3 default code
+\NewDocumentCommand\xpgcodekey{omv}{%
+ \xpgoption{#2}\IfValueT{#1}{\new{#1}}
+ \xpgvalue{=} \meta{code} (default value: \texttt{#3})\par%
+}
+
%% Sidenotes << copied from fontspec.dtx
\newcommand\new[1]{%
- \edef\thisversion{#1}%
+ \edef\thisversion{v#1}%
\ifhmode\unskip~\fi{\ifx\thisversion\fileversion\color{blue}\else\color[gray]{0.5}\fi
$\leftarrow$}%
\marginpar{\centering
\small\ifx\thisversion\fileversion\color{blue}\else\color[gray]{0.5}\fi
- \textsf{#1}}}
+ \textsf{v#1}}}
\newcommand\displaycmd[2]{%
\\\DescribeMacro{#2}\centerline{\cmd{#1}}}
\renewenvironment{itemize}{\begin{compactitem}[\char"2023]}%[{\fontspec{DejaVu Sans}\char"25BB}]}%
@@ -71,7 +94,7 @@
\pretocmd{\subsection}{\condbreak{2\baselineskip}}{}{}
%% fontspec declarations:
-\setmainfont{Linux Libertine O}
+\setmainfont{Linux Libertine O}[Numbers=OldStyle]
\setsansfont{Linux Biolinum O}
\setmonofont[Scale=MatchLowercase]{DejaVu Sans Mono}
\newfontfamily\arabicfont[Script=Arabic]{Amiri}
@@ -90,12 +113,12 @@
\begin{document}
-\hyphenation{Kha-li-ghi Reu-ten-auer}
+\hyphenation{Kha-li-ghi Reu-ten-auer new-zea-land}
\GetFileInfo{polyglossia.sty}
\title{\textcolor{lightblue}{\Huge\fontspec[LetterSpace=40]{GFS Ambrosia} Πολυγλωσσια}
\\[16pt]
-\color{myblue}Polyglossia: Modern multilingual typesetting with \XeLaTeX\ and \LuaLaTeX}
+\color{xpgblue}Polyglossia: Modern multilingual typesetting with \XeLaTeX\ and \LuaLaTeX}
\author{\TA{François Charette} \and \TA{Arthur Reutenauer}\thanks{Current maintainer}
\and \TA{Bastien Roucariès} \and \TA{Jürgen Spitzmüller}}
\date{\filedate \qquad \fileversion\\
@@ -118,7 +141,7 @@
\section{Introduction}
\pkg{Polyglossia} is a package for facilitating multilingual typesetting with
-\XeLaTeX\ and (with some exceptions) \LuaLaTeX. Basically, it
+\XeLaTeX\ and (with some exceptions) \LuaLaTeX. Basically, it
can be used as an alternative to \pkg{babel} for performing the following
tasks automatically:
@@ -142,7 +165,7 @@ tasks automatically:
that are written from right to left (via the package \pkg{bidi},
available separately).
\end{enumerate}
-
+%
Several features of \pkg{babel} that do not make sense in the \XeTeX\ world (like font
encodings, shorthands, etc.) are not supported.
Generally speaking, \pkg{polyglossia} aims to remain as compatible as possible
@@ -154,7 +177,7 @@ reach this objective.
macros defined in the \pkg{etoolbox} package by \TA{Philipp Lehmann} and \TA{Joseph Wright}.
Being designed for \XeLaTeX\ and \LuaLaTeX, it obviously also relies on \pkg{fontspec} by
\TA{Will Robertson}. For languages written from right to left, it needs the package \pkg{bidi}
-(for \XeTeX) or \pkg{luabidi} (for \LuaTeX) by \TA{Vafa Khalighi} (\textarabic{وفا خليقي}) and
+(for \XeTeX) or \pkg{luabidi} (for \LuaTeX) by \TA{Vafa Khalighi} (\textarabic{وفا خليقي}) and
the \pkg{bidi-tex GitHub Organisation}.
Polyglossia also bundles three packages for calendaric computations (\pkg{hebrewcal},
\pkg{hijrical}, and \pkg{farsical}).
@@ -165,16 +188,16 @@ Polyglossia also bundles three packages for calendaric computations (\pkg{hebrew
\subsection{Activating languages}
The default language of a document is specified by means of the command
- \displaycmd{\setdefaultlanguage[⟨options⟩]\{⟨lang⟩\}}{\setdefaultlanguage}
+ \displaycmd{\setdefaultlanguage\oarg{options}\marg{lang}}{\setdefaultlanguage}
(or, equivalently, \Cmd\setmainlanguage).
Secondary languages are specified with
- \displaycmd{\setotherlanguage[⟨options⟩]\{⟨lang⟩\}.}{\setotherlanguage}
+ \displaycmd{\setotherlanguage\oarg{options}\marg{lang}.}{\setotherlanguage}
All these commands allow you to set language-specific options.\footnote{%
Section~\ref{specific} documents these options for the respective languages.}
It is also possible to load a series of secondary languages at once (but without options)
using
- \displaycmd{\setotherlanguages\{⟨lang1⟩,⟨lang2⟩,⟨lang3⟩,…\}.}{\setotherlanguages}
-
+ \displaycmd{\setotherlanguages\marg{lang1⟩,⟨lang2⟩,⟨lang3⟩,⟨…}.}{\setotherlanguages}
+%
All language-specific options can be modified locally by means of the
language-switching commands described in section \ref{languageswitching}.
@@ -195,7 +218,7 @@ that are explained in section \ref{specific} below.
% Edited by hand -- JS, 2019-11-01
\begin{tabular}{lllll}
\toprule
-\TX{afrikaans} & danish & \TX{hungarian} & marathi & \TX{slovenian} \\
+\TX{afrikaans} & danish & \TX{hungarian} & \TX{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 \\
@@ -209,26 +232,26 @@ 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{croatian} & \TX{hebrew} & \TX{malay} & \TX{serbian} & \TX{welsh} \\
\TX{czech} & \TX{hindi} & malayalam & \TX{slovak} & \\
\bottomrule
\end{tabular}
\end{table}
-\paragraph{Version Notes} The support for Amharic\new{v1.0.1} should be considered an experimental attempt to
+\paragraph{Version Notes} The support for Amharic\new{1.0.1} should be considered an experimental attempt to
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.},
+Version 1.1.1\new{1.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} introduced Armenian, Occitan, Bengali,
+Version 1.2\new{1.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} brought basic support for Japanese (this
+Version 1.43\new{1.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
+In version 1.45\new{1.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},
\emph{magyar}\textrightarrow\emph{hungarian}, \emph{portuges}\textrightarrow\emph{portuguese},
\emph{samin}\textrightarrow\emph{sami}) or merged (\emph{bahasai}\slash\emph{bahasam}\textrightarrow\emph{malay},
@@ -237,10 +260,10 @@ been renamed (\emph{farsi}\textrightarrow\emph{persian}, \emph{friulan}\textrigh
\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.
-Version 1.46\new{v1.46} introduces support for Afrikaans, Belarusian, Bosnian and Georgian.
+Version 1.46\new{1.46} introduces support for Afrikaans, Belarusian, Bosnian and Georgian.
-\subsection{Relation to and use of Babel language names}
+\subsection{Relation to and use of Babel language names}\label{sec:babelnames}
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}),
@@ -249,7 +272,7 @@ slightly differs. Whereas \pkg{babel} has a unique name for each language variet
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.
-Please refer to table~\ref{tab:bbllang} for the differing language names in both packages.
+Please refer to table~\ref{tab:bbllang} for the differing language names in both packages.
\begin{table}
\caption{\label{tab:bbllang}Babel-polyglossia language name matching}
@@ -257,7 +280,7 @@ Please refer to table~\ref{tab:bbllang} for the differing language names in both
\begin{minipage}[t]{1\columnwidth}
\small\centering
\begin{tabular}{lll}
-\toprule
+\toprule
\textbf{Babel name} & \textbf{Polyglossia name} & \textbf{Polyglossia options}\tabularnewline
\midrule
acadien & french & variant=acadian \\
@@ -270,20 +293,20 @@ brazil & portuguese & variant=brazilian \\
british & english & variant=british \\
canadian & english & variant=canadian \\
canadien & french & variant=canadian \\
+classiclatin\footnote{In \pkg{babel} currently only selectable via dot modifier (\emph{latin.classic}).}
+ & latin & variant=classic \\
farsi & persian & \\
+ecclesiasticlatin\footnote{In \pkg{babel} currently only selectable via dot modifier (\emph{latin.ecclesiastic}).}
+ & latin & variant=ecclesiastic \\
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 & \\
+medievallatin\footnote{In \pkg{babel} currently only selectable via dot modifier (\emph{latin.medieval}).}
+ & latin & variant=medieval \\
naustrian & german & variant=austrian \\
newzealand & english & variant=newzealand \\
ngerman & german & variant=german [\emph{default}] \\
@@ -298,62 +321,247 @@ serbianc & serbian & script=Cyrillic \\
slovene & slovenian & \\
spanishmx & spanish & variant=mexican \\
swissgerman & german & variant=swiss, spelling=old \\
-uppersorbian & sorbian & variant=upper \\
+uppersorbian & sorbian & variant=upper [\emph{default}] \\
\bottomrule
\end{tabular}
\end{minipage}
\end{table}
-For convenience reasons, \pkg{polyglossia} also supports the use of babel names\new{v1.46} (for the few justified
+For convenience reasons, \pkg{polyglossia} also supports the use of babel names\new{1.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]}).
+\ref{sec:babelcmds} (\eg \cmd\textaustrian\ is synonymous to ¦\textgerman[variant=austrian,spelling=old]¦).
However, unless you have special reasons, we strongly encourage you to use the \pkg{polyglossia} names.
+\subsection{Using IETF language tags}\label{sec:langtags}
+
+\pkg{Polyglossia}\new{1.47} also supports the use of language tags that conform to the IETF BCP-47
+\emph{Best Current Practice}.\footnote{Please refer to \url{https://tools.ietf.org/html/bcp47} and
+ \url{https://en.wikipedia.org/wiki/IETF_language_tag} for details.}
+Thus, you can use tags such as ¦en-GB¦ (for British English) or ¦de-AT-1901¦ (for Austrian German, old spelling)
+in \cmd\setdefaultlanguage\ and \cmd\setotherlanguage\ as well as in the language switching command
+\cmd{\textlang\marg{tag}}, the environment \cmd{\begin\{lang\}\marg{tag}} \ldots\ \cmd{\end\{lang\}} and the \pkg{babel}
+language switching commands\slash environments documented in section~\ref{sec:babelcmds}.
+Table~\ref{tab:BCP47-polyglossia} lists the currently supported tags.
+
+\bgroup\small\addfontfeatures{Numbers={Monospaced,Lining}}
+\begin{longtable}[c]{lll}
+ \caption{\label{tab:BCP47-polyglossia}BCP47-polyglossia language name matching}\\
+ \toprule
+ \textbf{BCP-47 tag} & \textbf{Polyglossia name} & \textbf{Polyglossia options}\\
+ \midrule
+ \endfirsthead
+ \caption[]{BCP47-polyglossia language name matching (\emph{continued})}\\
+ \toprule
+ \textbf{BCP-47 tag} & \textbf{Polyglossia name} & \textbf{Polyglossia options}\\
+ \midrule
+ \endhead
+ aeb & arabic & locale=tunisia \\
+ af & afrikaans & \\
+ afb & arabic & locale=default \\
+ am & amharic & \\
+ apd & arabic & locale=default \\
+ ar & arabic & \\
+ ar-IQ & arabic & locale=mashriq \\
+ ar-JO & arabic & locale=mashriq \\
+ ar-LB & arabic & locale=mashriq \\
+ ar-MR & arabic & locale=mauritania \\
+ ar-PS & arabic & locale=mashriq \\
+ ar-SY & arabic & locale=mashriq \\
+ ar-YE & arabic & locale=default \\
+ arq & arabic & locale=algeria \\
+ ary & arabic & locale=morocco \\
+ arz & arabic & locale=default \\
+ ast & asturian & \\
+ ayl & arabic & locale=libya \\
+ be & belarusian & \\
+ be-tarask & belarusian & spelling=classic \\
+ bg & bulgarian & \\
+ bn & bengali & \\
+ bo & tibetan & \\
+ br & breton & \\
+ bs & bosnian & \\
+ ca & catalan & \\
+ ckb & kurdish & variant=sorani [\emph{default}] \\
+ ckb-Arab & kurdish & variant=sorani, script=Arabic [\emph{default}] \\
+ ckb-Latn & kurdish & variant=sorani, script=Latin \\
+ cop & coptic & \\
+ cy & welsh & \\
+ cz & czech & \\
+ da & danish & \\
+ de & german & \\
+ de-AT & german & variant=austrian, spelling=new \\
+ de-AT-1901 & german & variant=austrian, spelling=old \\
+ de-AT-1996 & german & variant=austrian, spelling=new \\
+ de-CH & german & variant=swiss, spelling=new \\
+ de-CH-1901 & german & variant=swiss, spelling=old \\
+ de-CH-1996 & german & variant=swiss, spelling=new \\
+ de-DE & german & variant=german, spelling=new \\
+ de-DE-1901 & german & variant=german, spelling=old \\
+ de-DE-1996 & german & variant=german, spelling=new [\emph{default}] \\
+ de-Latf & german & script=blackletter \\
+ de-Latf-AT & german & variant=austrian, spelling=new, script=blackletter \\
+ de-Latf-AT-1901 & german & variant=austrian, spelling=old, script=blackletter \\
+ de-Latf-AT-1996 & german & variant=austrian, spelling=new, script=blackletter \\
+ de-Latf-CH & german & variant=swiss, spelling=new, script=blackletter \\
+ de-Latf-CH-1901 & german & variant=swiss, spelling=old, script=blackletter \\
+ de-Latf-CH-1996 & german & variant=swiss, spelling=new, script=blackletter \\
+ de-Latf-DE & german & variant=german, spelling=new, script=blackletter \\
+ de-Latf-DE-1901 & german & variant=german, spelling=old, script=blackletter \\
+ de-Latf-DE-1996 & german & variant=german, spelling=new, script=blackletter \\
+ dsb & sorbian & variant=lower \\
+ dv & divehi & \\
+ el & greek & \\
+ el-monoton & greek & variant=monotonic [\emph{default}] \\
+ el-polyton & greek & varant=polytonic \\
+ en & english & \\
+ en-AU & english & variant=australian \\
+ en-CA & english & variant=canadian \\
+ en-GB & english & variant=british \\
+ en-NZ & english & variant=newzealand \\
+ en-US & english & variant=us [\emph{default}] \\
+ eo & esperanto & \\
+ es & spanish & \\
+ es-ES & spanish & variant=spanish [\emph{default}] \\
+ es-MX & spanish & variant=mexican \\
+ et & estonian & \\
+ eu & basque & \\
+ fa & persian & \\
+ fi & finnish & \\
+ fr & french & \\
+ fr-CA & french & variant=canadian \\
+ fr-CH & french & variant=swiss \\
+ fr-FR & french & variant=french [\emph{default}] \\
+ fur & friulian & \\
+ ga & gaelic & variant=irish [\emph{default}] \\
+ gd & gaelic & variant=scottish \\
+ gl & galician & \\
+ grc & greek & variant=ancient \\
+ he & hebrew & \\
+ hi & hindi & \\
+ hr & croatian & \\
+ hsb & sorbian & variant=upper [\emph{default}] \\
+ hu & hungarian & \\
+ hy & armenian & \\
+ ia & interlingua & \\
+ id & malay & variant=indonesian \\
+ is & icelandic & \\
+ it & italian & \\
+ ja & japanese & \\
+ ka & georgian & \\
+ km & khmer & \\
+ kmr & kurdish & variant=kurmanji \\
+ kmr-Arab & kurdish & variant=kurmanji, script=Arabic \\
+ kmr-Latn & kurdish & variant=kurmanji, script=Latin \\
+ kn & kannada & \\
+ ko & korean & \\
+ ku & kurdish & \\
+ ku-Arab & kurdish & script=Arabic \\
+ ku-Latn & kurdish & script=Latin \\
+ la & latin & \\
+ la-x-classic & latin & variant=classic \\
+ la-x-ecclesia & latin & variant=ecclesiastic \\
+ la-x-medieval & latin & variant=medieval \\
+ lo & lao & \\
+ lt & lithuanian & \\
+ lv & latvian & \\
+ mk & macedonian & \\
+ ml & malayalam & \\
+ mn & mongolian & \\
+ mr & marathi & \\
+ nb & norwegian & variant=bokmal \\
+ nko & nko & \\
+ nl & dutch & \\
+ nn & norwegian & variant=nynorsk [\emph{default}] \\
+ oc & occitan & \\
+ pl & polish & \\
+ pms & piedmontese & \\
+ pt & portuguese & \\
+ pt-BR & portuguese & variant=brazilian \\
+ pt-PT & portuguese & variant=portuguese [\emph{default}] \\
+ rm & romansh & \\
+ ro & romanian & \\
+ ru & russian & \\
+ ru-luna1918 & russian & spelling=modern [\emph{default}] \\
+ ru-petr1708 & russian & spelling=old \\
+ sa & sanskrit & \\
+ sa-Beng & sanskrit & script=Bengali \\
+ sa-Deva & sanskrit & script=Devanagari [\emph{default}] \\
+ sa-Gujr & sanskrit & script=Gujarati \\
+ sa-Knda & sanskrit & script=Kannada \\
+ sa-Mlym & sanskrit & script=Malayalam \\
+ sa-Telu & sanskrit & script=Telugu \\
+ se & sami & \\
+ sk & slovak & \\
+ sl & slovenian & \\
+ sq & albanian & \\
+ sr & serbian & \\
+ sr-Cyrl & serbian & script=Cyrillic \\
+ sr-Latn & serbian & script=Latin [\emph{default}] \\
+ sv & swedish & \\
+ syr & syriac & \\
+ ta & tamil & \\
+ te & telugu & \\
+ th & thai & \\
+ tk & turkmen & \\
+ tr & turkish & \\
+ uk & ukrainian & \\
+ ur & urdu & \\
+ vi & vietnamese & \\
+ zsm & malay & variant=malaysian [\emph{default}] \\
+ \bottomrule
+\end{longtable}
+\egroup
+
\subsection{Global options}
\pkg{Polyglossia} can be loaded with the following global package options:
\begin{itemize}
- \item \TB{babelshorthands}\new{v1.1.1} globally activates \pkg{babel}
- 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
+ \item \xpgboolkeyfalse[1.1.1]{babelshorthands}
+ Globally activates \pkg{babel} shorthands whenever available. Currently
+ shorthands are implemented for Afrikaans, Belarusian, Catalan, Croatian,
+ Czech, Dutch, Finnish, Georgian, German, Italian, Latin, Mongolian,
+ Russian, Slovak, and Ukrainian. Please refer to the respective language descriptions
+ (sec.~\ref{specific}) for details.
+
+ \item \xpgoption{localmarks} redefines the internal \LaTeX\ macros \cmd\markboth\ and
+ \cmd\markright. In earlier versions of \pkg{polyglossia},\new{1.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
+ option \xpgoption{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
+ \item \xpgoption{quiet} turns off most info messages and some of the warnings issued
by \LaTeX, \pkg{fontspec} and \pkg{polyglossia}.
\end{itemize}
+\condbreak{5\baselineskip}
\section{Language-switching commands}\label{languageswitching}
\subsection{Recommended commands}\label{sec:langcmds}
For each activated language the command
-\cmd{\text⟨lang⟩[⟨options⟩]\{…\}} \DescribeMacro{\text⟨lang⟩}
+\cmd{\text\meta{lang}\oarg{options}\marg{…}} \DescribeMacro{\text\meta{lang}}
(as well as the synonymous \DescribeMacro{\textlang}%
-\cmd{\textlang[⟨options⟩]\{⟨lang⟩\}\{…\}}\new{1.46})
+\cmd{\textlang\oarg{options}\marg{lang}\marg{…}}\new{1.46})
becomes available for short insertions of text in that language.
+
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 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
+punctuation in French), and they translate the date when using \cmd\today.
+They do not, however, translate so-called \textit{caption strings}, \ie
+``chapter'', ``figure'' etc., to the local language (these remain in the currently active `outer'
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⟩} and
+The\DescribeEnv{\meta{lang}}\ environment \meta{lang}, which is also available for any activated language
+(as well as the equivalent \DescribeMacro{lang}%
+\cmd{\begin\{lang\}\oarg{options}\marg{lang}} \dots{} \cmd{\end\{lang\}}\new{1.47}),
+is meant for longer passages of text. It behaves slightly different than the \cmd{\text\meta{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.
@@ -361,7 +569,7 @@ Like the commands, the environment provides the possibility of setting language
For instance the following allows us to quote the beginning
of Homer’s \textit{Iliad}:
-\begin{Verbatim}[formatcom=\color{myblue}]
+\begin{Verbatim}[formatcom=\color{xpgblue}]
\begin{quote}
\begin{greek}[variant=ancient]
μῆνιν ἄειδε θεὰ Πηληϊάδεω Ἀχιλῆος οὐλομένην, ἣ μυρί' Ἀχαιοῖς
@@ -393,17 +601,17 @@ 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.
\begin{itemize}
-\item \DescribeMacro{\selectlanguage}\cmd{\selectlanguage[⟨options⟩]\{⟨lang⟩\}}
-\item \DescribeMacro{\foreignlanguage}\cmd{\foreignlanguage[⟨options⟩]\{⟨lang⟩\}\{…\}}
-\item \DescribeEnv{otherlanguage}\cmd{\begin\{otherlanguage\}[⟨options⟩]\{⟨lang⟩\}} \dots{} \cmd{\end\{otherlanguage\}}
-\item \DescribeEnv{otherlanguage*}\cmd{\begin\{otherlanguage*\}[⟨options⟩]\{⟨lang⟩\}} \dots{} \cmd{\end\{otherlanguage*\}}
+\item \DescribeMacro{\selectlanguage}\cmd{\selectlanguage\oarg{options}\marg{lang}}
+\item \DescribeMacro{\foreignlanguage}\cmd{\foreignlanguage\oarg{options}\marg{lang}\marg{…}}
+\item \DescribeEnv{otherlanguage}\cmd{\begin\{otherlanguage\}\oarg{options}\marg{lang}} \dots{} \cmd{\end\{otherlanguage\}}
+\item \DescribeEnv{otherlanguage*}\cmd{\begin\{otherlanguage*\}\oarg{options}\marg{lang}} \dots{} \cmd{\end\{otherlanguage*\}}
\end{itemize}
%
-¦\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⟩¦ or ¦\textlang¦ command, with the one
-notable exception that they do not translate the date with ¦\today¦.
+\cmd\selectlanguage\marg{lang} and the ¦otherlanguage¦ environment are identical to the
+the \meta{lang} environment, except that \cmd\selectlanguage\marg{lang}
+does not need to be explicitly closed. The command \cmd\foreinlanguage\marg{lang}\marg{…} and the ¦otherlanguage*¦
+environment are identical with the use of the \cmd\text\meta{lang} or \cmd\textlang\ command, with the one
+notable exception that they do not translate the date with \cmd\today.
Since the \XeLaTeX\ and \LuaLaTeX\ format incorporate \pkg{babel}’s \file{hyphen.cfg},
the low-level commands for hyphenation and language switching
@@ -411,13 +619,12 @@ 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.\footnote{Note that these commands require polyglossia
-language names; they do not support language\slash babel aliases.}
+ought to be mentioned here.
\begin{itemize}
-\item \DescribeMacro{\selectbackgroundlanguage}\cmd{\selectbackgroundlanguage\{⟨lang⟩\}}:
+\item \DescribeMacro{\selectbackgroundlanguage}\cmd{\selectbackgroundlanguage\marg{lang}}:
this selects the global font setup and the numbering definitions for the default language.
-\item \DescribeMacro{\resetdefaultlanguage}\cmd{\resetdefaultlanguage[⟨options⟩]\{⟨lang⟩\}} (experimental):
+\item \DescribeMacro{\resetdefaultlanguage}\cmd{\resetdefaultlanguage\oarg{options}\marg{lang}} (experimental):
completely switches the default language
to another one in the middle of a document: \textit{this may have adverse effects}!
@@ -435,43 +642,49 @@ language names; they do not support language\slash babel aliases.}
\subsection{Setting up alias commands}
By means of the macro
-\displaycmd{\setlanguagealias[⟨options⟩]\{⟨language⟩\}\{⟨alias⟩\}}{\setlanguagealias}\new{v1.46}
+\displaycmd{\setlanguagealias\oarg{options}\marg{language}\marg{alias}}{\setlanguagealias}\new{1.46}
you can define alias commands for specific language (variants). \Eg
\begin{quote}
\begin{verbatim}
-\setlanguagealias[variant=austrian]{german}{deAT}
+\setlanguagealias[variant=austrian]{german}{AT}
\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]¦,
+will define a command \cmd{\textAT} as well as an environment ¦{AT}¦ which will link towards
+the command ¦\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.
+¦de-AT¦ or ¦de_AT¦ will not work since ¦-¦ and ¦_¦ are not allowed in command names (the same
+holds true for any non-ASCII character and for digits).
+
+For the latter case, and for the case where an alias would clash with an existing command
+(\eg ¦\fi¦) or a \cmd{\text\meta{\ldots}} command (\eg \cmd\textit), a starred version \Cmd{\setlanguagealias*}
+is provided which does neither define a \cmd{\text\meta{alias}} command nor an \meta{alias} environment,
+but which will set up the alias for everything else, including \cmd{\textlang\marg{alias}}
+and \cmd{\begin\{lang\}\marg{alias}}.
-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⟩\}}).
+\pkg{Polyglossia} comes with some aliases predefined, namely aliases for \pkg{babel} language names
+(see sec.~\ref{sec:babelnames}) and for IETF BCP-47 language tags (the latter via \cmd{\setlanguagealias*};
+see sec.~\ref{sec:langtags}).
\section{Font setup}
With polyglossia it is possible to associate a specific font with any script or language
that occurs in the document. That font should always be defined as
-¦\⟨script⟩font¦\ or ¦\⟨language⟩font¦.
+\cmd{\⟨script⟩font}\ or \cmd{\⟨language⟩font}.
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⟩\}}. }
+\centerline{ \cmd\newfontfamily\cmd{\greekfont[Script=Greek,\meta{…}]\marg{font}}. }
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
+For instance, if \cmd\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.
+it can be defined by means of \new{1.2.0}
+\cmd{\⟨script⟩fontsf} or \cmd{\⟨language⟩fontsf} and \cmd{\⟨script⟩fonttt} or \cmd{\⟨language⟩fonttt}, respectively.
Whenever a new language is activated, \pkg{polyglossia} will first check whether
a font has been defined for that language or – for languages in non-Latin scripts –
@@ -486,7 +699,7 @@ displayed.
\subsection{Hyphenation exceptions}
-\TeX\ provides the command ¦\hyphenation{⟨exceptions⟩}¦ to globally define hyphenation exceptions
+\TeX\ provides the command \cmd\hyphenation\marg{exceptions} to globally define hyphenation exceptions
which override the hyphenation patterns for specified words. The command takes as argument a space-separated
list of words where hyphenation points are marked by a dash (if no dash is used, the respective word is not
hyphenated at all):
@@ -498,8 +711,8 @@ hyphenated at all):
\end{Verbatim}
%
These exceptions, however, apply to all languages. In addition to this, \pkg{polyglossia} provides
-the command\new{v1.45}
-\displaycmd{\pghyphenation[⟨options⟩]\{⟨lang⟩\}\{⟨exceptions⟩\}}{\pghyphenation}
+the command\new{1.45}
+\displaycmd{\xpghyphenation\oarg{options}\marg{lang}\marg{exceptions}}{\xpghyphenation}
which can be used to define exceptions that only apply to a specific language or language variant,
respectively.
@@ -514,25 +727,33 @@ will be activated.
\section{Language-specific options and commands}\label{specific}
-This section gives a list of all languages for which options and end-user commands are defined.
-The default value of each option is given in italic.
-
-%\subsection{amharic}\label{amharic}
+This section gives a list of all languages for which options and end-user
+commands are defined. Note the following conventions:
+\begin{itemize}
+ \item The preset value of each option (\ie the setting that applies by default,
+ if the option is not explicitly set) is given in \xpgpresetvalue{italics}.
+ \item If an option key may be used without a value, the value that applies
+ for value-less keys is marked by a preceding \xpgdefaultvalue{asterisk}.
+\end{itemize}
+For instance, \texttt{babelshorthands = *true} or \texttt{\textit{false}} means that
+\xpgvalue{babelshorthands} is \xpgvalue{false} by default in the respective language,
+and that passing \xpgvalue{babelshorthands} (without value) is equivalent to passing
+\xpgvalue{babelshorthands=true}.
-\subsection{afrikaans}\label{afikaans}
+\subsection{afrikaans}\label{afrikaans}
\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
+ \item \xpgboolkeyfalse[1.1.1]{babelshorthands}
+ 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).
+ in the hyphenation patterns (as opposed to \cmd\- 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¦,
+ \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash,
hyphenation at the breakpoints preset in the hyphenation patterns is still allowed.
\end{shorthands}
\end{itemize}
@@ -540,23 +761,23 @@ The default value of each option is given in italic.
\subsection{arabic}\label{arabic}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{calendar} = \textit{gregorian} or islamic (= hijri)
- \item \TB{locale} = \textit{default},\footnote{ %
- For Egypt, Sudan, Yemen and the Gulf states.}
- mashriq,\footnote{ %
- For Iraq, Syria, Jordan, Lebanon and Palestine.}
- libya, algeria, tunisia, morocco, or mauritania.
+ \item \xpgchoicekey{calendar}{\xpgpresetvalue{gregorian} or \xpgvalue{islamic} (= \xpgvalue{hijri})}
+ \item \xpgchoicekey{locale}{\xpgpresetvalue{default}\footnote{ %
+ For Egypt, Sudan, Yemen and the Gulf states.},
+ \xpgvalue{mashriq}\footnote{ %
+ For Iraq, Syria, Jordan, Lebanon and Palestine.},
+ \xpgvalue{libya}, \xpgvalue{algeria}, \xpgvalue{tunisia}, \xpgvalue{morocco}, \xpgvalue{mauritania}}
This setting influences the spelling of the month names for the Gregorian calendar,
as well as the form of the numerals (unless overriden by the following option).
- \item \TB{numerals} = \textit{mashriq} or maghrib
- (the latter is the default when locale = algeria, tunisia or morocco)
- \item \TB{abjadjimnotail} = \textit{false} or true. \new{v1.0.3}
+ \item \xpgchoicekey{numerals}{\xpgpresetvalue{mashriq} or \xpgvalue{maghrib}}
+ The latter is the default when \xpgvalue{locale=algeria}, \xpgvalue{tunisia}, or \xpgvalue{morocco}.
+ \item \xpgboolkeyfalse[1.0.3]{abjadjimnotail}
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{ج}.
\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
\item \Cmd\abjad and \Cmd\abjadmaghribi (see section \ref{abjad})
- \item \Cmd\aemph to emphasize text with ¦\overline¦.\new{v1.2.0}
+ \item \Cmd\aemph to emphasize text with \cmd\overline.\new{1.2.0}
¦\textarabic{\aemph{اب}}¦ yields \textarabic{\aemph{اب}}.
This command is also available for Farsi, Urdu, etc.
\end{itemize}
@@ -564,19 +785,19 @@ The default value of each option is given in italic.
\subsection{armenian}\label{armenian}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{variant}\new{v1.45} = eastern or \textit{western}
- \item \TB{numerals}\new{v1.45} = armenian or \textit{arabic}
+ \item \xpgchoicekey[1.45]{variant}{\xpgvalue{eastern} or \xpgpresetvalue{western}}
+ \item \xpgchoicekey[1.45]{numerals}{\xpgvalue{armenian} or \xpgpresetvalue{arabic}}
\end{itemize}
-\subsection[belarusian]{belarusian\new{v1.46}}\label{belarusian}
+\subsection[belarusian]{belarusian\new{1.46}}\label{belarusian}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{babelshorthands} = \textit{false} or true.
+ \item \xpgboolkeyfalse{babelshorthands}
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 ¦\-¦).
+ in the hyphenation patterns (as opposed to \cmd\-).
\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.
@@ -590,67 +811,123 @@ The default value of each option is given in italic.
\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.
+ \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
+ Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
+ \begin{itemize}
+ \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
+ \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
+ \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
+ It supports numbers up to 999\,999.
+ \end{itemize}
+ \item \xpgchoicekey{spelling}{\xpgpresetvalue{modern} or \xpgvalue{classic} (= \xpgvalue{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
+ \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
+ It steps through the Cyrillic alphabet and thus it can only be used up to 30.
+ The command takes a counter as argument, \eg ¦\textbelarusian{\Asbuk{page}}¦ produces \textrussian{\Asbuk{page}}.
+ \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
+ \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
+ numbers up to 999\,999.\\
+ \Eg ¦\textbelarusian{\AsbukTrad{page}}¦ produces \textrussian{\AsbukTrad{page}}.
+ \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
\end{itemize}
-\subsection[bengali]{bengali\new{v1.2.0}}\label{bengali}
+\subsection[bengali]{bengali\new{1.2.0}}\label{bengali}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{numerals} = Western, Bengali or \textit{Devanagari}
- \item \TB{changecounternumbering} = true or \textit{false} (use specified
- numerals for headings and page numbers)
+ \item \xpgchoicekey{numerals}{\xpgvalue{Western}, \xpgvalue{Bengali}, or \xpgpresetvalue{Devanagari}}
+ \item \xpgboolkeyfalse{changecounternumbering}
+ Use specified numerals for headings and page numbers.
\end{itemize}
\subsection{catalan}\label{catalan}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{babelshorthands} = \textit{false} or true. \new{v1.1.1}
- Activates the shorthands \texttt{"l} and \texttt{"L} to type geminated l’s.
+ \item \xpgboolkeyfalse[1.1.1]{babelshorthands}
+ Activates the shorthands \texttt{"l} and \texttt{"L} to type geminated l or L.
\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
- \item \Cmd{\l.l} and \Cmd{\L.L}\new{v1.1.1} can be used to type a geminated l, as in \textit{co\l.laborar},
+ \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},
similar to \pkg{babel} (the glyph U+00B7 MIDDLE DOT is used as a geminating sign).
\end{itemize}
+\subsection{croatian}\label{croatian}
+\paragraph*{Options:}
+\begin{itemize}
+ \item \xpgboolkeyfalse[1.47]{babelshorthands}
+ If this is turned on, the following shorthands for fine-tuning hyphenation and micro-typography
+ of Croatian words are activated.
+ \begin{shorthands}
+ \item[¦"|¦] disables a ligature at this position.
+ \item[¦"=¦] for an explicit hyphen with a breakpoint, allowing for hyphenation at the
+ other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
+ \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 \cmd\-).
+ \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 \cmd\slash, hyphenation
+ at the breakpoints preset in the hyphenation patterns is still allowed.
+ \end{shorthands}
+ Furthermore, the following shorthands generate easy access to Croatian digraphs (ligatures):
+ \begin{shorthands}
+ \item[¦"dz¦] Generates the ligature \charifavailable{01C6}{dž}\ if the font provides it. If not, the
+ two characters are output separately. Also available for ¦"Dz¦ (\charifavailable{01C5}{Dž})
+ and ¦"DZ¦ (\charifavailable{01C4}{DŽ}).
+ \item[¦"lj¦] Generates the ligature \charifavailable{01C9}{lj}\ if the font provides it. If not, the
+ two characters are output separately. Also available for ¦"Lj¦ (\charifavailable{01C8}{Lj})
+ and ¦"LJ¦ (\charifavailable{01C7}{LJ}).
+ \item[¦"nj¦] Generates the ligature \charifavailable{01CC}{nj}\ if the font provides it. If not, the
+ two characters are output separately. Also available for ¦"Nj¦ (\charifavailable{01CB}{Nj})
+ and ¦"NJ¦ (\charifavailable{01CA}{NJ}).
+ \end{shorthands}
+
+ Finally, there are also four shorthands for quotation marks:
+ \begin{shorthands}
+ \item[¦"`¦] for Croatian left double quotes („).
+ \item[¦"'¦] for Croatian right double quotes (”).
+ \item[¦">¦] for Croatian left guillemets (»).
+ \item[¦"<¦] for Croatian right guillemets («).
+ \end{shorthands}
+ \item \xpgboolkeyfalse[1.47]{disableligatures}
+ If this is \xpgvalue{true}, all Croatian ligatures (for digraphs such as
+ \charifavailable{01C6}{dž}) will be replaced by single characters. This can
+ be useful if the ligatures on your font are broken (if the font does not
+ have them, they are automatically replaced).
+\end{itemize}
+
\subsection{czech}\label{czech}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{babelshorthands} = \textit{false} or true. \new{v1.45}
- if this is turned on, the following shorthands for Czech are activated:
+ \item \xpgboolkeyfalse[1.45]{babelshorthands}
+ If this is turned on, the following shorthands for Czech 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 Czech typesetting
(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 <<).
+ \item[¦"‘¦] for Czech left double quotes („).
+ \item[¦"’¦] for Czech right double quotes (“).
+ \item[¦">¦] for Czech left double guillemets (»).
+ \item[¦"<¦] for Czech right double guillemets («).
\end{shorthands}
- \item \TB{splithyphens} = false or \textit{true}.\new{v1.45}
+ \item \xpgboolkeytrue[1.45]{splithyphens}
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}).
- By default, this is done automatically\new{v1.46} (if you are using \LuaTeX, the \pkg{luavlna} package is
+ By default, this is done automatically\new{1.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}
+ \item \xpgboolkeytrue[1.45]{vlna}
According to Czech typesetting conventions, single-letter words (non-syllable prepositions)
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{Polyglossia} takes care of this automatically by default\new{1.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}
@@ -658,17 +935,17 @@ The default value of each option is given in italic.
\subsection{dutch}\label{dutch}
\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
+ \item \xpgboolkeyfalse[1.1.1]{babelshorthands}
+ If this is turned on, the following shorthands defined for fine-tuning hyphenation and
micro-typography of Dutch 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).
+ in the hyphenation patterns (as opposed to \cmd\- 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¦,
+ \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash,
hyphenation at the breakpoints preset in the hyphenation patterns is still allowed.
\end{shorthands}
In addition, the macro \Cmd\- is redefined to allow hyphens in the rest of the word (equivalent to ¦"-¦).
@@ -677,9 +954,10 @@ The default value of each option is given in italic.
\subsection{english}\label{english}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{variant} = \textit{american} (= us), usmax (same as ‘american’ but with additional hyphenation patterns),
- british (= uk), australian, canadian\new{v1.45} or newzealand
- \item \TB{ordinalmonthday} = true/\textit{false} (true by default only when variant = british)
+ \item \xpgchoicekey{variant}{\xpgpresetvalue{american} (= \xpgvalue{us}), \xpgvalue{usmax} (same as \xpgvalue{american} but with additional hyphenation patterns),
+ \xpgvalue{british} (= \xpgvalue{uk}), \xpgvalue{australian}, \xpgvalue{canadian}\new{1.45}, or \xpgvalue{newzealand}}
+ \item \xpgboolkeyfalse{ordinalmonthday}
+ The default value is true for \xpgvalue{variant=british}.
\end{itemize}
\subsection{esperanto}\label{esperanto}
@@ -693,17 +971,17 @@ The default value of each option is given in italic.
\subsection{finnish}\label{finnish}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{babelshorthands} = \textit{false} or true. \new{v1.45}
- if this is turned on, the following shorthands for fine-tuning hyphenation and micro-typography
- of Finnish words are activated:
+ \item \xpgboolkeyfalse[1.45]{babelshorthands}
+ If this is turned on, the following shorthands for fine-tuning hyphenation
+ and micro-typography of Finnish 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 the hyphenation patterns (as opposed to \cmd\-).
\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¦,
+ \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash,
hyphenation at the breakpoints preset in the hyphenation patterns is still allowed.
\end{shorthands}
\end{itemize}
@@ -711,90 +989,115 @@ The default value of each option is given in italic.
\subsection{french}\label{french}
\paragraph*{Options:}
\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} = \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{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.
+ \item \xpgchoicekey{variant}{\xpgpresetvalue{french} or \xpgvalue{canadian} (=~\xpgvalue{acadian})\new{1.45}, \xpgvalue{swiss}\new{1.47}}
+ Currently, the only difference between the four variants is that \xpgvalue{swiss}
+ uses \xpgvalue{thincolonspace=true} by default since this conforms to the Swiss
+ conventions.
+ \item \xpgboolkeytrue{autospacing}
+ 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 \xpgboolkeyfalse[1.46]{thincolonspace}
+ With \xpgvalue{variant=swiss}, the default value is \xpgvalue{true}. If \xpgvalue{false}, a full
+ (non-breaking) interword space is inserted before a colon. If \xpgvalue{true}, a
+ thinner space -- as before \texttt{;}, \texttt{!}, and \texttt{?} -- is
+ used. Note that this option must be set after the ¦variant¦ option.
+ \item \xpgboolkeytrue{autospaceguillemets}[Up to version 1.44, the option was
+ called \xpgvalue{automaticspacesaroundguillemets}. For backwards compatibility
+ reasons, the more verbose old option is still supported.]
+ 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 \xpgboolkeyfalse[1.45]{autospacetypewriter}[Babel's syntax \xpgvalue{OriginalTypewriter}
+ is also supported.]
+ 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 \xpgvalue{autospacing} and
+ \xpgvalue{autospaceguillemets} settings (note that this was the default up
+ to v.~1.44).
+ \item \xpgboolkeyfalse{frenchfootnote}
+ If \xpgvalue{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 \xpgboolkeyfalse[1.46]{frenchitemlabels}
+ 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 \xpgcodekey[1.46]{itemlabels}¦\textemdash¦
+ If \emph{frenchitemlabels} is true, you can customize here the used item
+ label of all levels.
+ \item \xpgcodekey[1.46]{itemlabeli}¦\textemdash¦
+ If \emph{frenchitemlabels} is true, you can customize here the used item
+ label of the first level.
+ \item \xpgcodekey[1.46]{itemlabelii}¦\textemdash¦
+ If \emph{frenchitemlabels} is true, you can customize here the used item
+ label of the second level.
+ \item \xpgcodekey[1.46]{itemlabeliii}¦\textemdash¦
+ If \emph{frenchitemlabels} is true, you can customize here the used item
+ label of the third level.
+ \item \xpgcodekey[1.46]{itemlabeliv}¦\textemdash¦
+ If \emph{frenchitemlabels} is true, you can customize here the used item
+ label of the fourth level.
\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
- \item \Cmd\NoAutoSpacing\new{v1.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}¦
- \item \Cmd\AutoSpacing\new{v1.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!}¦
+ \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}¦
+ \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!}¦
\end{itemize}
-\subsection[gaelic]{gaelic\new{v1.45}}\label{gaelic}
+\subsection[gaelic]{gaelic\new{1.45}}\label{gaelic}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{variant} = \textit{irish} or scottish
+ \item \xpgchoicekey{variant}{\xpgpresetvalue{irish} or \xpgvalue{scottish}}
\end{itemize}
-\subsection[georgian]{georgian\new{v1.46}}\label{georgian}
+\subsection[georgian]{georgian\new{1.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.
+ \item \xpgboolkeyfalse{babelshorthands}
+ 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 \cmd\-).
+ \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 \xpgchoicekey{numerals}{\xpgpresetvalue{arabic} or \xpgvalue{georgian}}
+ Uses either Arabic numerals or Georgian alphanumerical numbering.
+ \item \xpgboolkeyfalse{oldmonthnames}
+ Uses traditional Georgian month names.
\end{itemize}
\subsection{german}\label{german}
\paragraph*{Options:}
\begin{itemize}
- \item\TB{variant} = \textit{german}, austrian or swiss.\new{v1.33.4}
- Setting variant=austrian or variant=swiss uses some lexical variants.
- With spelling=old, variant=swiss furthermore loads specific hyphenation
+ \item \xpgchoicekey{variant}{\xpgpresetvalue{german}, austrian, or swiss\new{1.33.4}}
+ Setting \xpgvalue{variant=austrian} or \xpgvalue{variant=swiss} uses some lexical variants.
+ With \xpgvalue{spelling=old}, \xpgvalue{variant=swiss} furthermore loads specific hyphenation
patterns.
- \item \TB{spelling} = \textit{new} (= 1996) or old (= 1901):
- indicates whether hyphenation patterns for traditional (1901) or reformed
+ \item \xpgchoicekey{spelling}{\xpgpresetvalue{new} (= \xpgvalue{1996}) or \xpgvalue{old} (= \xpgvalue{1901})}
+ Indicates whether hyphenation patterns for traditional (1901) or reformed
(1996) orthography should be used. The latter is the default.
- \item \TB{latesthyphen} = \textit{false} or true: if this option is set to true,
- the latest (experimental) hyphenation patterns ‘(n)german-x-latest’
- will be loaded instead of ‘german’ or ‘ngerman’. NB: This is based on
- the file \texttt{language.dat} that comes with \TeX Live 2008 and later.
- \item\TB{babelshorthands} = \textit{false} or true: \new{v1.0.3}
- if this is turned on, all shorthands defined in \pkg{babel}
+ \item \xpgboolkeyfalse[1.0.3]{babelshorthands}
+ If this is turned on, all shorthands defined in \pkg{babel}
for fine-tuning hyphenation and micro-typography of German words are activated.
\begin{shorthands}
\item[¦"ck¦] for ¦ck¦ to be hyphenated as ¦k-k¦ (1901 spelling).
@@ -804,12 +1107,12 @@ The default value of each option is given in italic.
\item[¦"=¦] for an explicit hyphen with a breakpoint, allowing for hyphenation at the
other points preset in the hyphenation patterns (as opposed to plain ¦-¦).
\item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
- cases where the hyphen should stick at the following syllable,\eg ¦bergauf und "~ab¦.
+ cases where the hyphen should stick at the following syllable, \eg ¦bergauf und "~ab¦.
\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);
+ in the hyphenation patterns (as opposed to \cmd\-).
+ \item[¦""¦] allows for a line break at this position (without hyphenation sign);
\eg ¦(pseudo"~)""wissenschaftlich¦.
- \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to ¦\slash¦, hyphenation at the breakpoints
+ \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash, hyphenation at the breakpoints
preset in the hyphenation patterns is still allowed.
\end{shorthands}
@@ -820,7 +1123,7 @@ 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 blackletter\new{v1.46} (=~fraktur\new{v1.2.0}).
+ \item \xpgchoicekey[1.2.0]{script}{\xpgpresetvalue{latin} or \xpgvalue{blackletter}\new{1.46} (= \xpgvalue{fraktur})}
Setting ¦script=blackletter¦ adapts the captions for typesetting German in blackletter type (using the long s (ſ)
where appropriate).
\end{itemize}
@@ -828,9 +1131,9 @@ The default value of each option is given in italic.
\subsection{greek}\label{greek}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{variant} = \textit{monotonic} (= mono), polytonic (= poly), or ancient
- \item \TB{numerals} = \textit{greek} or arabic
- \item \TB{attic} = \textit{false}/true
+ \item \xpgchoicekey{variant}{\xpgpresetvalue{monotonic} (= \xpgvalue{mono}), \xpgvalue{polytonic} (= \xpgvalue{poly}), or \xpgvalue{ancient}}
+ \item \xpgchoicekey{numerals}{\xpgpresetvalue{greek} or \xpgvalue{arabic}}
+ \item \xpgboolkeyfalse{attic}
\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
@@ -845,10 +1148,12 @@ The default value of each option is given in italic.
\subsection{hebrew}\label{hebrew}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{numerals} = hebrew or \textit{arabic}
- \item \TB{calendar} = hebrew or \textit{gregorian}
- \item \TB{marcheshvan} = true or \textit{false} (default value = true). If true, the second month of the civil year will be output as \texthebrew{מרחשון} (Marcheshvan)
- rather than \texthebrew{חשון} (Heshvan), which is the default.
+ \item \xpgchoicekey{numerals}{\xpgvalue{hebrew} or \xpgpresetvalue{arabic}}
+ \item \xpgchoicekey{calendar}{\xpgvalue{hebrew} or \xpgpresetvalue{gregorian}}
+ \item \xpgboolkeyfalse{marcheshvan}
+ If \xpgvalue{true}, the second month of the civil year will be output as
+ \texthebrew{מרחשון} (Marcheshvan) rather than \texthebrew{חשון} (Heshvan),
+ which is the default.
\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
@@ -856,17 +1161,17 @@ The default value of each option is given in italic.
\item \Cmd\aemph (see section \ref{arabic}).
\end{itemize}
-\subsection[hindi]{hindi\new{v1.2.0}}\label{hindi}
+\subsection[hindi]{hindi\new{1.2.0}}\label{hindi}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{numerals} = Western or \textit{Devanagari}
+ \item \xpgchoicekey{numerals}{\xpgvalue{Western} or \xpgpresetvalue{Devanagari}}
\end{itemize}
\subsection{hungarian}\label{hungarian}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{swapstrings} = \textit{all}, captions, headings, headers, hheaders or none\new{v1.46}
-
+ \item \xpgchoicekey[1.46]{swapstrings}{\xpgdefaultvalue{\xpgpresetvalue{all}},
+ \xpgvalue{captions}, \xpgvalue{headings}, \xpgvalue{headers}, \xpgvalue{hheaders}, or \xpgvalue{none}}
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},
@@ -893,41 +1198,66 @@ The default value of each option is given in italic.
\subsection{italian}\label{italian}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{babelshorthands} = \textit{false} or true. \new{v1.2.0cc}% TODO: check version
+ \item \xpgboolkeyfalse[1.2.0cc]{babelshorthands}% TODO: check version
Activates the ¦"¦ character as a switch to perform etymological
hyphenation when followed by a letter. Furthermore, the following shorthands are activated:
\begin{shorthands}
\item[¦""¦] double raised open quotes (the Italian keyboard misses the backtick).
\item[¦"<¦] open guillemet (looks like <<).
\item[¦">¦] closing guillemet (looks like >>).
- \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to ¦\slash¦,
+ \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\slash,
hyphenation at the breakpoints preset in the hyphenation patterns is still allowed.
\item[¦"-¦] adds a hyphenation point that does still allow for hyphenation at the points preset
- in the hyphenation patterns (as opposed to ¦\-¦).
+ in the hyphenation patterns (as opposed to \cmd\-).
\end{shorthands}
\end{itemize}
-\subsection[korean]{korean\new{v1.40.0}}\label{korean}
+\subsection[korean]{korean\new{1.40.0}}\label{korean}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{variant} = \textit{plain}, classic or modern:
- for spacing before/after CJK punctuations.
- `classic' is suitable for text with no interword spaces,
- `modern' for text with interword spaces.
- \item \TB{captions} = \textit{hangul} or hanja
+ \item \xpgchoicekey{variant}{\xpgpresetvalue{plain}, \xpgvalue{classic}, or \xpgvalue{modern}}
+ These variants control spacing before/after CJK punctuations.
+ \begin{itemize}
+ \item ¦plain¦: Do nothing
+ \item ¦classic¦: Suitable for text with no interword spaces.
+ This option forces CJK punctuations to half-width, and
+ inserts half-width glue around them.
+ \item ¦modern¦: Suitable for text with interword spaces.
+ This option forces CJK punctuations to half-width, and
+ inserts small (half of interword space) glue around them.
+ \end{itemize}
+ \item \xpgchoicekey{captions}{\xpgpresetvalue{hangul} or \xpgvalue{hanja}}
+ \item \xpgchoicekey[1.47]{swapstrings}{\xpgdefaultvalue{\xpgpresetvalue{all}},
+ \xpgvalue{headers}, \xpgvalue{headings}, or \xpgvalue{none}}
+ With this option, Korean-style part and chapter headings, and
+ running headers are available.
+ It is similar to Hungarian (see \ref{hungarian}) except that
+ figure and table captions are not touched.
+ \begin{itemize}
+ \item ¦all¦: Redefine part and chapter headings, and running headers
+ (=~default setting)
+ \item ¦headings¦: Redefine part and chapter headings only
+ \item ¦headers¦: Redefine running headers only
+ \item ¦none¦: Do not redefine anything
+ \end{itemize}
\end{itemize}
-\subsection[kurdish]{kurdish\new{v1.45}}\label{kurdish}
+\subsection[kurdish]{kurdish\new{1.45}}\label{kurdish}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{variant} = kurmanji or \textit{sorani}
- \item \TB{script} = Arabic or Latin. Defaults are ¦Arabic¦ for Sorani and ¦Latin¦ for Kurmanji.
- \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 \xpgchoicekey{variant}{\xpgvalue{kurmanji} or \xpgpresetvalue{sorani}}
+ \item \xpgchoicekey{script}{\xpgvalue{Arabic} or \xpgvalue{Latin}}
+ Defaults are \xpgvalue{Arabic} for Sorani and \xpgvalue{Latin} for Kurmanji.
+ \item \xpgchoicekey{numerals}{\xpgvalue{western} or \xpgvalue{eastern}}
+ Defaults are \xpgvalue{western} for Latin and \xpgvalue{eastern} for Arabic script, depending
+ on the selection above.
+ \item \xpgboolkeyfalse{abjadjimnotail}
+ 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 \xpgchoicekey{locale}{} (not yet implemented)
+% \item \xpgchoicekey{calendar}{} (not yet implemented)
\end{itemize}
\condbreak{2\baselineskip}
\paragraph*{Commands:}
@@ -938,34 +1268,33 @@ The default value of each option is given in italic.
\item \Cmd\aemph (see section \ref{arabic})
\end{itemize}
-\subsection[lao]{lao\new{v1.2.0}}\label{lao}
+\subsection[lao]{lao\new{1.2.0}}\label{lao}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{numerals} = lao or \textit{arabic}
+ \item \xpgchoicekey{numerals}{\xpgvalue{lao} or \xpgpresetvalue{arabic}}
\end{itemize}
\subsection{latin}\label{latin}
\paragraph*{Options:}
\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
+ \item \xpgchoicekey{variant}{\xpgvalue{classic}, \xpgvalue{medieval}, \xpgpresetvalue{modern}, or \xpgvalue{ecclesiastic}\new{1.46}}
+ These variants refer to different spelling conventions. The \xpgvalue{classic}
+ and the \xpgvalue{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
+ Furthermore, the \xpgvalue{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.}
+ \emph{i/j} may be affected by the \xpgvalue{capitalizemonth} and the
+ \xpgvalue{usej} option.}
\begin{tabular}{llll}
\toprule
\textbf{classic} & \textbf{medieval} & \textbf{modern} & \textbf{ecclesiastic} \\
@@ -978,8 +1307,7 @@ The default value of each option is given in italic.
\bottomrule
\end{tabular}
\end{table}
- \item \TB{hyphenation}\new{v.1.46} = classic, modern, or liturgical
-
+ \item \xpgchoicekey[1.46]{hyphenation}{\xpgvalue{classic}, \xpgvalue{modern}, or \xpgvalue{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}}
@@ -988,7 +1316,7 @@ The default value of each option is given in italic.
¦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.
+ \xpgvalue{hyphenation=liturgical} in any case.
\begin{table}
\caption{\label{tab:latin-hyphenation}Latin default hyphenation styles}
\centering
@@ -1003,8 +1331,7 @@ The default value of each option is given in italic.
\bottomrule
\end{tabular}
\end{table}
- \item \TB{ecclesiasticfootnotes}\new{v.1.46} = true or \emph{false}
-
+ \item \xpgboolkeyfalse[1.46]{ecclesiasticfootnotes}
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
@@ -1013,24 +1340,21 @@ The default value of each option is given in italic.
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}
-
+ \item \xpgboolkeyfalse[1.46]{usej}
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
-
+ \item \xpgboolkey[1.46]{capitalizemonth}
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}
-
+ \item \xpgboolkeyfalse{babelshorthands}
Enable the following shorthands inherited from \pkg{babel-latin} and the
\pkg{ecclesiastic} package.
\begin{shorthands}
@@ -1056,14 +1380,12 @@ The default value of each option is given in italic.
\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}
-
+ \item \xpgboolkeyfalse[1.46]{prosodicshorthands}
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
+ commands using \texttt{key=value} interfaces, such as the command
¦\includegraphics[scale=2]{...}¦. Use \cmd{\shorthandoff\{=\}} before
such commands (and \cmd{\shorthandon\{=\}} thereafter) within every
environment with prosodic shorthands enabled.
@@ -1096,20 +1418,25 @@ The default value of each option is given in italic.
\subsection{malay}\label{malay}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{variant}\new{v1.45} = \textit{indonesian} (=~bahasai in \pkg{babel}) or
- malaysian (=~bahasam in \pkg{babel})
+ \item \xpgchoicekey[1.45]{variant}{\xpgpresetvalue{indonesian} or \xpgvalue{malaysian}}
\end{itemize}
-\subsection[mongolian]{mongolian\new{v1.45}}\label{mongolian}
+\subsection{marathi}\label{marathi}
+\paragraph*{Options:}
+\begin{itemize}
+ \item \xpgchoicekey{numerals}{\xpgpresetvalue{Devanagari} or \xpgvalue{Western}}
+\end{itemize}
+
+\subsection[mongolian]{mongolian\new{1.45}}\label{mongolian}
Currently, only the Khalkha variety in Cyrillic script is supported.
\paragraph*{Options:}
\begin{itemize}
- \item \TB{babelshorthands} = \textit{false} or true.
+ \item \xpgboolkeyfalse{babelshorthands}
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 ¦\-¦).
+ in the hyphenation patterns (as opposed to \cmd\-).
\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.
@@ -1123,32 +1450,44 @@ 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{numerals} = \textit{arabic} or cyrillic. Uses either Arabic numerals or Cyrillic
- alphanumerical numbering.
+ \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
+ Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
+ \begin{itemize}
+ \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
+ \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
+ \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
+ It supports numbers up to 999\,999.
+ \end{itemize}
\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 ¦\textmongolian{\Asbuk{page}}¦ produces \textrussian{\Asbuk{page}}.
- \item \Cmd\asbuk: same in lowercase
+ \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
+ It steps through the Cyrillic alphabet and thus it can only be used up to 30.
+ The command takes a counter as argument, \eg ¦\textmongolian{\Asbuk{section}}¦ produces \textrussian{\Asbuk{section}}.
+ \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
+ \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
+ numbers up to 999\,999.\\
+ \Eg ¦\textmongolian{\AsbukTrad{section}}¦ produces \textrussian{\AsbukTrad{section}}.
+ \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
\end{itemize}
\subsection{norwegian}\label{norwegian}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{variant}\new{v1.45} = bokmal (=~`norsk' in \pkg{babel}) or \textit{nynorsk}
+ \item \xpgchoicekey[1.45]{variant}{\xpgvalue{bokmal} or \xpgpresetvalue{nynorsk}}
\end{itemize}
\subsection{persian}\label{persian}
\paragraph*{Options:}
\begin{itemize}
- \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 \xpgchoicekey{numerals}{\xpgvalue{western} or \xpgpresetvalue{eastern}}
+ \item \xpgboolkeyfalse[1.0.3]{abjadjimnotail}
+ Set this to \xpgvalue{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 \xpgchoicekey{locale}{} (not yet implemented)
+% \item \xpgchoicekey{calendar}{} (not yet implemented)
\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
@@ -1159,17 +1498,17 @@ Currently, only the Khalkha variety in Cyrillic script is supported.
\subsection{portuguese}\label{portuguese}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{variant}\new{v1.45} = brazilian or \textit{portuguese}
+ \item \xpgchoicekey[1.45]{variant}{\xpgvalue{brazilian} or \xpgpresetvalue{portuguese}}
\end{itemize}
\subsection{russian}\label{russian}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{babelshorthands} = \textit{false} or true.
+ \item \xpgboolkeyfalse{babelshorthands}
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 ¦\-¦).
+ in the hyphenation patterns (as opposed to \cmd\-).
\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.
@@ -1184,48 +1523,72 @@ 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.
+ \item \xpgboolkeytrue[1.46]{indentfirst}
+ 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 \xpgchoicekey{spelling}{\xpgpresetvalue{modern} or \xpgvalue{old}}
+ This option is for captions and date only, not for hyphenation.
+ \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
+ Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
+ \begin{itemize}
+ \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
+ \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
+ \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
+ It supports numbers up to 999\,999.
+ \end{itemize}
\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 ¦\textrussian{\Asbuk{page}}¦ produces \textrussian{\Asbuk{page}}.
- \item \Cmd\asbuk: same in lowercase
+ \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
+ It steps through the Cyrillic alphabet and thus it can only be used up to 30.
+ The command takes a counter as argument, \eg ¦\textrussian{\Asbuk{section}}¦ produces \textrussian{\Asbuk{section}}.
+ \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
+ \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
+ numbers up to 999\,999.\\
+ \Eg ¦\textrussian{\AsbukTrad{page}}¦ produces \textrussian{\AsbukTrad{page}}.
+ \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
\end{itemize}
-\subsection[sami]{sami\new{v1.45}}\label{sami}
+\subsection[sami]{sami\new{1.45}}\label{sami}
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,
- Telugu or Latin.
- 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 \xpgchoicekey[1.0.2]{script}{\xpgpresetvalue{Devanagari}, \xpgvalue{Gujarati},
+ \xpgvalue{Malayalam}, \xpgvalue{Bengali}, \xpgvalue{Kannada}, \xpgvalue{Telugu}, or \xpgvalue{Latin}}
+ The value is passed to \pkg{fontspec} in cases where the respective
+ \cmd{\⟨script⟩font} is not defined. This can be useful if you typeset Sanskrit
+ texts in scripts other than Devanagari.
+ \item \xpgchoicekey[1.45]{numerals}{\xpgpresetvalue{Devanagari} or \xpgvalue{Western}}
\end{itemize}
-
+
\subsection{serbian}\label{serbian}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{script} = \textit{Cyrillic} or Latin.
- \item \TB{numerals} = \textit{arabic} or cyrillic. Uses either Arabic numerals or Cyrillic
- alphanumerical numbering.
- \end{itemize}
+ \item \xpgchoicekey{script}{\xpgpresetvalue{Cyrillic} or \xpgvalue{Latin}}
+ \item \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
+ Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
+ \begin{itemize}
+ \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
+ \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
+ \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
+ It supports numbers up to 999\,999.
+ \end{itemize}
+\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,\\
- Example: ¦\textserbian[numerals=cyrillic]{\Asbuk{page}}¦ produces \textserbian[numerals=cyrillic]{\Asbuk{page}}.
- \item \Cmd\asbuk: same in lowercase
+ \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
+ It steps through the Cyrillic alphabet and thus it can only be used up to 30.
+ The command takes a counter as argument, \eg ¦\textserbian{\Asbuk{section}}¦ produces \textrussian{\Asbuk{section}}.
+ \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
+ \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
+ numbers up to 999\,999.\\
+ \Eg ¦\textserbian{\AsbukTrad{page}}¦ produces \textrussian{\AsbukTrad{page}}.
+ \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
\end{itemize}
@@ -1233,9 +1596,9 @@ Currently support for Sami is limited to Northern Sami.
\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 \xpgboolkeyfalse[1.46]{babelshorthands}
+ 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¦).
@@ -1243,23 +1606,23 @@ Currently support for Sami is limited to Northern Sami.
\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 ¦\-¦).
+ in the hyphenation patterns (as opposed to \cmd\-).
\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
+ \item[¦"/¦] a slash that allows for a subsequent line break. As opposed to \cmd\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}
+ \end{shorthands}
+ \item \xpgboolkeytrue[1.46]{splithyphens}
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}
+ \item \xpgboolkeytrue[1.46]{vlna}
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
@@ -1270,26 +1633,31 @@ Currently support for Sami is limited to Northern Sami.
\subsection{slovenian}\label{slovenian}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{localalph} = true or \textit{false}
+ \item \xpgboolkeyfalse{localalph}
+ If \xpgvalue{true}, alpha-numeric counters will use a localized version including characters with caron
+ (a, b, c, č, d, \ldots).
\end{itemize}
\subsection{sorbian}\label{sorbian}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{variant}\new{v1.45} = lower or \textit{upper}
- \item \TB{olddate}\new{v1.45} = true or \textit{false} (default value = true). If true, ¦\today¦
- will use traditional Sorbian month names (\ie it will be synonymous to ¦\oldtoday¦ below)
+ \item \xpgchoicekey[1.45]{variant}{\xpgvalue{lower} or \xpgpresetvalue{upper}}
+ \item \xpgboolkeyfalse[1.45]{olddate}
+ If \xpgvalue{true}, \cmd\today\ will use traditional Sorbian month names (\ie it will be
+ synonymous to \cmd\oldtoday\ below).
\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
- \item \Cmd\oldtoday: outputs the current date using traditional Sorbian month names, even if \TB{olddate} is false.
+ \item \Cmd\oldtoday: outputs the current date using traditional Sorbian month names, even if
+ \xpgvalue{olddate} is \xpgvalue{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}
+ \item \xpgchoicekey[1.46]{variant}{\xpgpresetvalue{spanish} or \xpgvalue{mexican}}
+ \item \xpgchoicekey[1.46]{spanishoperators}{\xpgdefaultvalue{all}, \xpgvalue{accented},
+ \xpgvalue{spaced}, \xpgvalue{none}, or \xpgpresetvalue{false}}
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},
@@ -1297,29 +1665,29 @@ Currently support for Sami is limited to Northern Sami.
\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).
+ \cmd\sin\ (\emph{sen}), \cmd\tan\ (\emph{tg}), \cmd\sinh\ (\emph{senh}), and \cmd\tanh\ (\emph{tgh}).
+ \item ¦none¦ does no localization at all (default setting).
\end{itemize}
\end{itemize}
-\paragraph*{\color{black}Commands:}\new{v1.46}
+\paragraph*{\color{black}Commands:}\new{1.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\arcsen: alias to \cmd\arcsin\ (\pkg{babel} compatibility)
+ \item \Cmd\arctg: alias to \cmd\arctan\ (\pkg{babel} compatibility)
+ \item \Cmd\sen: alias to \cmd\sin\ (\pkg{babel} compatibility)
+ \item \Cmd\senh: alias to \cmd\sinh\ (\pkg{babel} compatibility)
+ \item \Cmd\tg: alias to \cmd\tan\ (\pkg{babel} compatibility)
+ \item \Cmd\tgh: alias to \cmd\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
+ defines a command \cmd\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}
- \item \TB{numerals} = \textit{western} (i.e., 1234567890), eastern
- (for which the Oriental Arabic numerals are used: \textarabic{١٢٣٤٥٦٧٨٩٠}),
- or abjad. \new{v1.0.1}.
+ \item \xpgchoicekey[1.0.1]{numerals}{\xpgpresetvalue{western} (\ie 1234567890), \xpgvalue{eastern}
+ (for which the Oriental Arabic numerals are used: \textarabic{١٢٣٤٥٦٧٨٩٠}), or
+ \xpgvalue{abjad}}
\end{itemize}
\paragraph*{Commands:}
\begin{itemize}
@@ -1330,7 +1698,7 @@ Currently support for Sami is limited to Northern Sami.
\subsection{thai}\label{thai}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{numerals} = thai or \textit{arabic}
+ \item \xpgchoicekey{numerals}{\xpgvalue{thai} or \xpgpresetvalue{arabic}}
\end{itemize}
%
To insert word breaks, you need to use an external processor.
@@ -1340,21 +1708,58 @@ that comes with this package.
\subsection{tibetan}\label{tibetan}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{numerals} = tibetan or \textit{arabic}
+ \item \xpgchoicekey{numerals}{\xpgvalue{tibetan} or \xpgpresetvalue{arabic}}
\end{itemize}
\subsection{ukrainian}\label{ukrainian}
-\paragraph*{Commands:}
+
+\paragraph*{Options:}
+\begin{itemize}
+ \item \xpgboolkeyfalse{babelshorthands}
+ 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 \cmd\-).
+ \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.
+ % These are commented out in gloss-ukrainian
+ % \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 \xpgchoicekey{numerals}{\xpgpresetvalue{arabic}, \xpgvalue{cyrillic-alph} or \xpgvalue{cyrillic-trad}}
+ Uses either Arabic numerals or Cyrillic alphanumerical numbering. The two Cyrillic variants differ as follows:
\begin{itemize}
- \item \Cmd\Asbuk: produces the uppercase Ukrainian alphabet, for
- environments such as ¦enumerate¦
- \item \Cmd\asbuk: same in lowercase
+ \item \xpgvalue{cyrillic-alph} steps through the Cyrillic alphabet. Thus it can only be used up to 30.
+ \item \xpgvalue{cyrillic-trad} (= \xpgvalue{cyrillic}) uses a traditional Cyrillic alphanumeric system.%
+ \footnote{See \url{https://en.wikipedia.org/wiki/Cyrillic_numerals}.}
+ It supports numbers up to 999\,999.
\end{itemize}
+\end{itemize}
+%
+\paragraph*{Commands:}
+\begin{itemize}
+ \item \Cmd\Asbuk: produces uppercased Cyrillic alphanumerals, for environments such as ¦enumerate¦.
+ It steps through the Cyrillic alphabet and thus it can only be used up to 30.
+ The command takes a counter as argument, \eg ¦\textukrainian{\Asbuk{section}}¦ produces \textrussian{\Asbuk{section}}.
+ \item \Cmd\asbuk: same as \cmd\Asbuk\ but in lowercase.
+ \item \Cmd\AsbukTrad: same as \cmd\Asbuk\ but using the traditional Cyrillic alphanumeric numbering which supports
+ numbers up to 999\,999.\\
+ \Eg ¦\textukrainian{\AsbukTrad{page}}¦ produces \textrussian{\AsbukTrad{page}}.
+ \item \Cmd\asbukTrad: same as \cmd\AsbukTrad\ but in lowercase.
+\end{itemize}
\subsection{welsh}\label{welsh}
\paragraph*{Options:}
\begin{itemize}
- \item \TB{date} = long or \textit{short}
+ \item \xpgchoicekey{date}{\xpgvalue{long} or \xpgpresetvalue{short}}
\end{itemize}
@@ -1362,55 +1767,55 @@ that comes with this package.
\pkg{Polyglossia} uses the following macros to define language-specific captions
(\ie strings such as ``chapter''), date formats and additional language settings
-(¦⟨lang⟩¦ is to be replaces with the respective language name):
+(\meta{lang} is to be replaces with the respective language name):
\begin{itemize}
- \item \Cmd{\captions⟨lang⟩} stores definitions of caption strings
+ \item \Cmd{\captions\meta{lang}} stores definitions of caption strings
(such as, in the case of English, ¦\def\chaptername{Chapter}¦)
- \item \Cmd{\date⟨lang⟩} stores definitions of date formats (usually redefinitions
- of ¦\today¦, in some cases also definitions of additional date commands)
- \item \Cmd{\blockextras⟨lang⟩} stores macros that are to be executed when the language
- ⟨lang⟩ is activated via ¦\selectlanguage¦ command or the ¦⟨lang⟩¦ environment
- \item \Cmd{\inlineextras⟨lang⟩} stores macros that are to be executed when the language
- ⟨lang⟩ is activated locally via ¦\text⟨lang⟩¦ command
- \item \Cmd{\noextras⟨lang⟩} stores macros that are to be executed when the language
- ¦⟨lang⟩¦ is closed
-\end{itemize}
+ \item \Cmd{\date\meta{lang}} stores definitions of date formats (usually redefinitions
+ of \cmd\today, in some cases also definitions of additional date commands)
+ \item \Cmd{\blockextras\meta{lang}} stores macros that are to be executed when the language
+ \meta{lang} is activated via \cmd\selectlanguage command or the \meta{lang} environment
+ \item \Cmd{\inlineextras\meta{lang}} stores macros that are to be executed when the language
+ \meta{lang} is activated locally via \cmd\text\meta{lang} command
+ \item \Cmd{\noextras\meta{lang}} stores macros that are to be executed when the language
+ \meta{lang} is closed
+\end{itemize}
%
-In order to redefine internal macros, we recommend to use the command ¦\gappto¦.
-For compatibility with \pkg{babel} the command ¦\addto¦ is also available
-to the same effect. For instance, to change the ¦\chaptername¦ for language ¦lingua¦,
+In order to redefine internal macros, we recommend to use the command \cmd\gappto.
+For compatibility with \pkg{babel} the command \cmd\addto\ is also available
+to the same effect. For instance, to change the \cmd\chaptername\ for language ¦lingua¦,
you can do this:
\begin{verbatim}
\gappto\captionslingua{\def\chaptername{Caput}}
\end{verbatim}
%
Note that this needs to be done after the respective language has been loaded with
-¦\setmainlanguage¦ or ¦\setotherlanguage¦.
+\cmd\setmainlanguage\ or \cmd\setotherlanguage.
Specifically for package authors, analogous commands are provided which are only executed
if a specific language \emph{variety} is used. As opposed to the macros above, these refer
to babel names. Other than that, the function is identical:
\begin{itemize}
- \item \Cmd{\captions@bbl@⟨babelname⟩}
- \item \Cmd{\date@bbl@⟨babelname⟩}
- \item \Cmd{\blockextras@bbl@⟨babelname⟩}
- \item \Cmd{\inlineextras@bbl@⟨babelname⟩}
- \item \Cmd{\noextras@bbl@⟨babelname⟩}
+ \item \Cmd{\captions@bbl@\meta{babelname}}
+ \item \Cmd{\date@bbl@\meta{babelname}}
+ \item \Cmd{\blockextras@bbl@\meta{babelname}}
+ \item \Cmd{\inlineextras@bbl@\meta{babelname}}
+ \item \Cmd{\noextras@bbl@\meta{babelname}}
\end{itemize}
%
By default, these macros are undefined. If they are defined (\eg by an external package),
-they will be executed after their respective ¦⟨lang⟩¦ counterpart and thus can be used to
-overwrite definitions of the former. Again, use ¦\gappto¦ to define\slash modify these macros.
-For instance, to add a new caption ¦\footnotename¦ to the Swiss variety of German (babel name
+they will be executed after their respective \meta{lang} counterpart and thus can be used to
+overwrite definitions of the former. Again, use \cmd\gappto\ to define\slash modify these macros.
+For instance, to add a new caption \cmd\footnotename\ to the Swiss variety of German (babel name
¦nswissgerman¦), you can do this:
\begin{verbatim}
\gappto\captions@bbl@nswissgerman{\def\footnotename{Fussnote}}
\end{verbatim}
%
If you do this in a document preamble rather than in a package, you need to embrace the redefinition
-by ¦\makeatletter¦ and ¦\makeatother¦ due to the ¦@¦ in the macro names.
+by \cmd\makeatletter\ and \cmd\makeatother\ due to the ¦@¦ in the macro names.
\section{Script-specific numbering}
@@ -1436,25 +1841,27 @@ For instance in an Arabic environment
¦\localnumeral{42}¦ yields \textarabic{\localnumeral{42}}, whereas in an Hebrew environment, it
results in \texthebrew[numerals=hebrew]{\localnumeral{42}} with ¦numerals=hebrew¦, and \texthebrew{\localnumeral{42}}
with ¦numerals=arabic¦. Note that, as opposed to the various ¦digits¦ macros (described in sec.~\ref{sec:decdigit}),
-the argument of ¦\localnumeral¦ must consist of numbers only.
+the argument of \cmd\localnumeral\ must consist of numbers only.
For\new{1.45} the conversion of counters, the starred version \Cmd{\localnumeral*} is provided. This takes a counter as argument.
For instance in an Arabic environment ¦\localnumeral*{page}¦ yields \textarabic{\localnumeral*{page}}.
-For scripts with alphanumeric numbering, the variants \Cmd{\Localnumeral} and \Cmd{\Localnumeral*} provide the uppercased
+For scripts with alphanumeric numbering, the variants \Cmd{\Localnumeral} and \Cmd{\Localnumeral*} provide the uppercased
versions.\medskip
\noindent All these macros provide the following options:
\begin{itemize}
- \item \TB{lang} =\DescribeMacro{[lang=]}\ \textit{local}, main, or <language>.\\
- Output number in the local form of the currently active language for ¦local¦, the main language of the document for ¦main¦,
- and any (loaded) language for ¦<language>¦ (\eg ¦\localnumeral[lang=arabic]{42}}¦).
+ \item \DescribeMacro{[lang=]}\xpgchoicekey{lang}{\xpgpresetvalue{local}, \xpgvalue{main},
+ or \xpgvalue{\meta{language}}}
+ Output number in the local form of the currently active language for
+ ¦local¦, the main language of the document for ¦main¦, and any (loaded)
+ language for \meta{language} (\eg ¦\localnumeral[lang=arabic]{42}}¦).
\end{itemize}
\subsection{Non-Western decimal digits}\label{sec:decdigit}
-In addition\new{v1.1.1} to the generic macros described above, \pkg{polyglossia} provides language-specific conversion macros
+In addition\new{1.1.1} to the generic macros described above, \pkg{polyglossia} provides language-specific conversion macros
which can be used if the generic ones do not suit the need.\footnote{%
A third method are so-called TECKit fontmappings.
Those can be activated with the \pkg{fontspec} ¦Mapping¦ option,
@@ -1463,7 +1870,7 @@ For instance if \cmd\arabicfont\ is defined with the option ¦Mapping=arabicdigi
typing \cmd{\textarabic\{2010\}} results in \textarabic{٢٠١٠}. Note that this method has some drawbacks, though,
for instance when the value of a counter has to be written and read from auxiliary files.
So please use this with care.}
-The macros have the form ¦\<script>digits¦. They convert Arabic numerical input and leave every other input untouched.
+The macros have the form \cmd{\⟨script⟩digits}. They convert Arabic numerical input and leave every other input untouched.
In an Arabic context, for instance, ¦\arabicdigits{9182/738543-X}¦ yields \textarabic{\arabicdigits{9182/738543-X}}.
Currently, the following macros are provided:
@@ -1490,9 +1897,9 @@ For languages which use special (non-Latin) alphanumerical notation\footnote{%
\url{http://en.wikipedia.org/wiki/Hebrew_numerals},
and \url{http://en.wikipedia.org/wiki/Syriac_alphabet}.}, dedicated macros are provided.
-They work in a similar way than the ¦\<script>digits¦ macros described above: They take Arabic numerical input
+They work in a similar way than the \cmd{\⟨script⟩digits} macros described above: They take Arabic numerical input
and output the respective value in the local alphabetic numbering scheme (most of these macros are equivalent
-to ¦\localnumeral¦ and ¦\Localnumeral¦ in the respective context).
+to \cmd\localnumeral\ and \cmd\Localnumeral\ in the respective context).
The following macros are provided:
@@ -1509,6 +1916,13 @@ The following macros are provided:
\item \Cmd\armeniannumeral produces Armenian alphabetic numbering.
Example: ¦\armeniannumeral{1863}¦ yields \textarmenian{\armeniannumeral{1863}}.
+
+ \item \Cmd\belarusiannumeral produces Belarusian numbering, with uppercased variant (for alphanumerical variant) via \Cmd\Belarusiannumeral.
+ Depending on the ¦numerals¦ option in the Belarusian language selection, this is either Arabic digit or Cyrillic
+ alphanumercial output.\\
+ Example: With ¦numerals=latin¦ ¦\belarusiannumeral{19}¦ yields \textrussian{\russiannumeral{19}},
+ with ¦numerals=cyrillic-trad¦ ¦\belarusiannumeral{19}¦ results in \textrussian[numerals=cyrillic-trad]{\russiannumeral{19}},\\
+ with ¦numerals=cyrillic-alph¦ ¦\belarusiannumeral{19}¦ results in \textrussian[numerals=cyrillic-alph]{\russiannumeral{19}}.
\item \Cmd\georgiannumeral produces Georgian alphabetic numbering.\\
Example: ¦\georgiannumeral{1863}¦ yields \textgeorgian{\georgiannumeral{1863}}.
@@ -1518,24 +1932,40 @@ The following macros are provided:
¦\Greeknumeral{1863}¦ results in \textgreek{\Greeknumeral{1863}}.
\item \Cmd\hebrewnumeral, \Cmd\Hebrewnumeral and \Cmd\Hebrewnumeralfinal generate variants of Hebrew alphanumeric numerals.
- The commands behave exactly as they do in \pkg{babel}: ¦\hebrewnumeral¦ outputs the numbers without any decoration,
- ¦\Hebrewnumeral¦ adds \textit{gereshayim} before the last letter, ¦\Hebrewnumeralfinal¦ uses in addition the final forms of Hebrew letters.
+ The commands behave exactly as they do in \pkg{babel}: \cmd\hebrewnumeral\ outputs the numbers without any decoration,
+ \cmd\Hebrewnumeral\ adds \textit{gereshayim} before the last letter, \cmd\Hebrewnumeralfinal\ uses in addition the final forms of Hebrew letters.
Examples:
¦\hebrewnumeral{1750}¦ yields \texthebrew{\hebrewnumeral{1750}},
¦\Hebrewnumeral{1750}¦ yields \texthebrew{\Hebrewnumeral{1750}},
and ¦\Hebrewnumeralfinal{1750}¦ yields \texthebrew{\Hebrewnumeralfinal{1750}}.
+
+ \item \Cmd\mongoliannumeral produces Mongolian numbering, with uppercased variant (for alphanumerical variant) via \Cmd\Mongoliannumeral.
+ Depending on the ¦numerals¦ option in the Mongolian language selection, this is either Arabic digit or Cyrillic
+ alphanumercial output.\\
+ Example: With ¦numerals=latin¦ ¦\mongoliannumeral{19}¦ yields \textrussian{\russiannumeral{19}},
+ with ¦numerals=cyrillic-trad¦ ¦\mongoliannumeral{19}¦ results in \textrussian[numerals=cyrillic-trad]{\russiannumeral{19}},\\
+ with ¦numerals=cyrillic-alph¦ ¦\mongoliannumeral{19}¦ results in \textrussian[numerals=cyrillic-alph]{\russiannumeral{19}}.
\item \Cmd\russiannumeral produces Russian numbering, with uppercased variant (for alphanumerical variant) via \Cmd\Russiannumeral.
Depending on the ¦numerals¦ option in the Russian language selection, this is either Arabic digit or Cyrillic
alphanumercial output.\\
Example: With ¦numerals=latin¦ ¦\russiannumeral{19}¦ yields \textrussian{\russiannumeral{19}},
- with ¦numerals=cyrillic¦ ¦\russiannumeral{19}¦ results in \textrussian[numerals=cyrillic]{\russiannumeral{19}}.
+ with ¦numerals=cyrillic-trad¦ ¦\russiannumeral{19}¦ results in \textrussian[numerals=cyrillic-trad]{\russiannumeral{19}},\\
+ with ¦numerals=cyrillic-alph¦ ¦\russiannumeral{19}¦ results in \textrussian[numerals=cyrillic-alph]{\russiannumeral{19}}.
\item \Cmd\serbiannumeral produces Serbian numbering, with uppercased variant (for alphanumerical variant) via \Cmd\Serbiannumeral.
Depending on the ¦numerals¦ option in the Serbian language selection, this is either Arabic digit or Cyrillic
alphanumercial output.\\
- Example: With ¦numerals=latin¦ ¦\serbiannumeral{19}¦ yields \textserbian{\serbiannumeral{19}},
- with ¦numerals=cyrillic¦ ¦\serbiannumeral{19}¦ results in \textserbian[numerals=cyrillic]{\serbiannumeral{19}}.
+ Example: With ¦numerals=latin¦ ¦\serbiannumeral{19}¦ yields \textrussian{\serbiannumeral{19}},
+ with ¦numerals=cyrillic-trad¦ ¦\serbiannumeral{19}¦ results in \textrussian[numerals=cyrillic-trad]{\serbiannumeral{19}},\\
+ with ¦numerals=cyrillic-alph¦ ¦\serbiannumeral{19}¦ results in \textrussian[numerals=cyrillic-alph]{\serbiannumeral{19}}.
+
+ \item \Cmd\ukrainiannumeral produces Ukrainian numbering, with uppercased variant (for alphanumerical variant) via \Cmd\Ukrainiannumeral.
+ Depending on the ¦numerals¦ option in the Ukrainian language selection, this is either Arabic digit or Cyrillic
+ alphanumercial output.\\
+ Example: With ¦numerals=latin¦ ¦\ukrainiannumeral{19}¦ yields \textrussian{\russiannumeral{19}},
+ with ¦numerals=cyrillic-trad¦ ¦\ukrainiannumeral{19}¦ results in \textrussian[numerals=cyrillic-trad]{\russiannumeral{19}},\\
+ with ¦numerals=cyrillic-alph¦ ¦\ukrainiannumeral{19}¦ results in \textrussian[numerals=cyrillic-alph]{\russiannumeral{19}}.
\end{itemize}
@@ -1548,14 +1978,14 @@ Thus, footnote handling in right-to-left context sometimes needs manual interven
\subsection{Horizontal footnote position}
-When right-to-left languages are used, the ¦\footnote¦ command becomes sensitive to the text directionality. The footnote is
+When right-to-left languages are used, the \cmd\footnote\ command becomes sensitive to the text directionality. The footnote is
always placed on the side that is currently the origin of direction: on the left side of the page in LTR paragraphs and
on the right in RTL paragraphs.
For cases where this is not desired, two additional footnote commands are provided: \Cmd\RTLfootnote and \Cmd\LTRfootnote.
-¦\LTRfootnote¦ always places the footnote on the left side, notwithstanding the current
-directionality. Likewise, ¦\RTLfootnote¦ always places it on the right side. Like ¦\footnote¦, ¦\RTLfootnote¦
-and ¦\LTRfootnote¦ provide an optional argument to customize the number.
+\cmd\LTRfootnote\ always places the footnote on the left side, notwithstanding the current
+directionality. Likewise, \cmd\RTLfootnote\ always places it on the right side. Like \cmd\footnote, \cmd\RTLfootnote\
+and \cmd\LTRfootnote\ provide an optional argument to customize the number.
\subsection{Footnote rule length and position}
@@ -1572,12 +2002,13 @@ In both cases, you can change the default behavior as follows:
\item Put \Cmd\autofootnoterule in the preamble to have automatic placement depending on the context (see below for elaboration).
\item Put \Cmd\textwidthfootnoterule in the preamble to have a rule that spans the whole text width.
\end{itemize}
-With ¦\autofootnoterule¦, the first footnote on the current page determines the placement. Note that this automatic can fail with
-footnotes at page boundaries that differ in directionality from the first footnote on the page. You can work around such cases by switching to ¦\rightfootnoterule¦ or ¦\leftfootnoterule¦ on these pages.
+With \cmd\autofootnoterule, the first footnote on the current page determines the placement. Note that this automatic can fail with
+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.
Note also that the rule switches might interfere in bad ways with packages or classes that redefine footnotes themselves. This is also the reason
-why ¦\autofootnoterule¦ is not used by default.
+why \cmd\autofootnoterule\ is not used by default.
+\condbreak{5\baselineskip}
\section{Calendars}
\subsection{Hebrew calendar (hebrewcal.sty)}
@@ -1594,24 +2025,24 @@ This package computes dates in the lunar Islamic (Hijra) calendar.\footnote{ %
(Cambridge University Press, 2001).\label{reingold}}
It provides two macros for the end-user.
The command
- \displaycmd{\HijriFromGregorian\{⟨year⟩\}\{⟨month⟩\}\{⟨day⟩\}}{\HijriFromGregorian}
+ \displaycmd{\HijriFromGregorian\marg{year}\marg{month}\marg{day}}{\HijriFromGregorian}
sets the counters ¦Hijriday¦, ¦Hijrimonth¦ and ¦Hijriyear¦.
\Cmd\Hijritoday\ formats the Hijri date for the current day.
-This command is now locale-aware\new{v1.1.1}: its output will differ depending on the
+This command is now locale-aware\new{1.1.1}: its output will differ depending on the
currently active language. Presently \pkg{polyglossia}’s language definition files
-for Arabic, Farsi, Urdu, Turkish and Malay provide a localized version of ¦\Hijritoday¦.
+for Arabic, Farsi, Urdu, Turkish and Malay provide a localized version of \cmd\Hijritoday.
If the formatting macro for the current language is undefined, the Hijri date will be formatted
in Arabic or in roman transliteration, depending of the current writing direction.
You can define a new format or redefine one with the command
- \displaycmd{\DefineHijriDateFormat\{<lang>\}\{<code>\}.}{\DefineHijriDateFormat}
+ \displaycmd{\DefineHijriDateFormat\marg{lang}\marg{code}.}{\DefineHijriDateFormat}
-The command ¦\Hijritoday¦ also accepts an optional argument to add or subtract a correction
+The command \cmd\Hijritoday\ also accepts an optional argument to add or subtract a correction
(in days) to the date computed by the arithmetical algorithm.\footnote{ %
The Islamic calendar is indeed a purely lunar calendar based on the observation
of the first visibility of the lunar crescent at the beginning of the lunar month,
so there can be differences between different localities, as well as between
civil and religious authorities.}
-For instance if ¦\Hijritoday¦ yields the date “7 Rajab 1429” (which is the date that was
+For instance if \cmd\Hijritoday\ yields the date “7 Rajab 1429” (which is the date that was
displayed on the front page of \href{http://www.aljazeera.net}{aljazeera.net} on
11th July 2008), ¦\Hijritoday[1]¦ would rather print “8 Rajab 1429” (the date
indicated the same day on the site \href{http://www.gulfnews.com}{gulfnews.com}).
@@ -1619,19 +2050,26 @@ indicated the same day on the site \href{http://www.gulfnews.com}{gulfnews.com})
\subsection{Farsi (jalālī) calendar (farsical.sty)}
This package is an almost verbatim copy of ¦Arabiftoday.sty¦ (in the \pkg{Arabi} package),
itself a slight modification of ¦ftoday.sty¦ in Farsi\TeX.\footnote{ %
- One day I may rewrite \pkg{farsical} from scratch using the algorithm in
- Reingold \& Gershowitz (ref.~n.~\ref{reingold}).}
+ One day we may rewrite \pkg{farsical} from scratch using the algorithm in
+ Reingold \& Gershowitz (ref.~n.\,\ref{reingold}).}
Here we have renamed the command \cmd\ftoday\ to
\Cmd\Jalalitoday.
Example: today is \Jalalitoday.
-%\section{Varia}
+\section{Auxiliary commands}
+
+The macro \displaycmd{\charifavailable\marg{char code}\marg{substitution}}{\charifavailable}\new{1.47} checks whether
+the character with the specified \meta{char code} (\ie unicode utf-16 code without preceding ¦0x¦) exists in
+the current font. If so, the character is printed, if not, the \meta{substitution} is printed.
+
+Example: ¦\charifavailable{1E9E}{SS}¦ prints the capital version of the German letter ⟨ß⟩ if available
+(\ie \charifavailable{1E9E}{SS}), else it prints the substitution digraph SS.
+
\section{Accessing language information}
The following is specifically relevant to package authors who need information about the languages in use.
-
In order to get such information, \pkg{polyglossia} provides the following macros:
\begin{itemize}
@@ -1646,20 +2084,36 @@ In order to get such information, \pkg{polyglossia} provides the following macro
Note that this macro is also defined for languages that are not supported in \pkg{babel}. In that
case, they are equal to the polyglossia language name.
\item \Cmd\mainbabelname\ analogously stores the name of document's main language (variant) in \pkg{babel}.
+ \item \Cmd{\languageid\marg{type}}\new{1.47} stores the identifier tag of the current language. Currently supported \meta{types}:
+ \begin{itemize}
+ \item ¦bcp-47¦ (alias ¦bcp47¦): IETF BCP-47 language identifier
+ \end{itemize}
+ \item \Cmd{\mainlanguageid\marg{type}}\new{1.47} stores identifier tag of the main language. Currently supported \meta{types}:
+ see \cmd\languageid.
\end{itemize}
-%
-If you want to have a full list of loaded languages/variants, use the following macros:
+\bigskip
+
+\noindent If you want to have a full list of loaded languages/variants, use the following macros:
\begin{itemize}
\item \Cmd{\xpg@loaded}\ stores a comma-separated list of all loaded languages (polyglossia name)
\item \Cmd{\xpg@vloaded}\ stores a comma-separated list of all loaded variants
- \item \Cmd{\xpg@bloaded}\ stores a comma-separated list of \pkg{babel} names of all language variants
+ \item \Cmd{\xpg@bloaded}\ stores a comma-separated list of \pkg{babel} names of all language variants
+ \item \Cmd{\xpg@bcp@loaded}\new{1.47}\ stores a comma-separated list of the BCP-47 IDs of all language variants
\end{itemize}
-%
-Finally, you can test whether a language is loaded by
-\displaycmd{\iflanguageloaded\{⟨lang⟩\}\{⟨true⟩\}\{⟨false⟩\}}{\iflanguageloaded}
-where \texttt{⟨lang⟩} is a \pkg{polyglossia} language name, or
-\displaycmd{\ifbabellanguageloaded\{⟨lang⟩\}\{⟨true⟩\}\{⟨false⟩\}}{\ifbabellanguageloaded}
-where \texttt{⟨lang⟩} is a \pkg{babel} language name.
+\bigskip
+
+\noindent Whether a language is loaded can be tested by
+\displaycmd{\iflanguageloaded\marg{lang}\marg{true}\marg{false}}{\iflanguageloaded}
+where \texttt{\meta{lang}} is a \pkg{polyglossia} language name, by
+\displaycmd{\ifbabellanguageloaded\marg{lang}\marg{true}\marg{false}}{\ifbabellanguageloaded}
+where \texttt{\meta{lang}} is a \pkg{babel} language name (see table~\ref{tab:bbllang} on p.~\pageref{tab:bbllang}), or by
+\displaycmd{\iflanguageidloaded\marg{type}\marg{id}\marg{true}\marg{false}}{\iflanguageidloaded}\new{1.47}
+where \meta{type} is a supported language id type (such as ¦bcp-47¦) and \meta{id} is a language id
+(such as ¦en-US¦; see table~\ref{tab:BCP47-polyglossia} on p.~\pageref{tab:BCP47-polyglossia}).
+\bigskip
+
+\noindent Finally, if you want to know whether a specific language option has been set, you can use
+\displaycmd{\iflanguageoption\marg{lang}\marg{opt. key}\marg{opt. value}\marg{true}\marg{false}}{\iflanguageoption}\new{1.47}
\section{Acknowledgements (by François Charette)}
\pkg{Polyglossia} is notable for being a recycle box of previous contributions
@@ -1675,7 +2129,7 @@ individuals for their assistance in supporting specific languages: \TA{Yves Code
(Sanskrit), \TA{Zdenĕk Wagner} (Hindi), \TA{Mikhal Oren} (Hebrew), \TA{Sergey Astanin} (Russian),
\TA{Khaled Hosny} (Arabic), \TA{Sertaç Ö. Yıldız} (Turkish), \TA{Kamal Abdali} (Urdu),
and several other members of the \XeTeX\ user community, notably \TA{Enrico Gregorio}, who
-has sent me many useful suggestions and corrections and contributed the ¦\newXeTeXintercharclass¦
+has sent me many useful suggestions and corrections and contributed the \cmd\newXeTeXintercharclass\
mechanism in xelatex.ini which is now used by polyglossia.
More recently, \TA{Kevin Godby} of the \href{http://ubuntu-manual.org}{Ubuntu Manual} project has
contributed very useful feedback, bug hunting and, with the help of translators,
@@ -1692,9 +2146,9 @@ 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}.
+\TA{Ivan Kokan}, \TA{Caleb Maclennan}, \TA{José Mancera}, \TA{Yevgen Pogribnyi}, \TA{Will Robertson}, \TA{Maïeul Rouquette},
+\TA{Elie Roux}, \TA{Hugo Roy}, \TA{Guy Rutenberg}, \TA{Philipp Stephani}, \TA{Niranjan Tambe}, \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}.