summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex')
-rw-r--r--Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex134
1 files changed, 116 insertions, 18 deletions
diff --git a/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex b/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
index d8cc59d6593..5f0c1c0d1bf 100644
--- a/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
+++ b/Master/texmf-dist/doc/latex/polyglossia/polyglossia.tex
@@ -570,11 +570,8 @@ Table~\ref{tab:BCP47-polyglossia} lists the currently supported tags.
\begin{itemize}
\item \xpgboolkeyfalse[1.1.1]{babelshorthands}
- Globally activates \pkg{babel} shorthands whenever available. Such shorthands are
- implemented currently 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.
+ Globally activates \pkg{babel} shorthands whenever available.
+ Please refer to sec.~\ref{shorthands} for details.
\item \xpgboolkeyfalse{localmarks} redefines the internal \LaTeX\ macros \cmd\markboth\ and
\cmd\markright\ to the effect that the header text is explicitly set in the currently
@@ -600,6 +597,43 @@ Table~\ref{tab:BCP47-polyglossia} lists the currently supported tags.
by \LaTeX, \pkg{fontspec} and \pkg{polyglossia} are output.
\end{itemize}
+\subsection{Shorthands}\label{shorthands}
+
+\pkg{Babel} has introduced the nifty feature of \enquote{shorthands} for some of the languages
+it supports.
+Shorthands make use of active characters to provide quick access to glyphs and formatting
+peculiarities that are common in a respective language (\eg ¦"a¦ for German umlaut ⟨ä⟩ in case
+this is not available on your keyboard).
+\pkg{Polyglossia} has adopted this feature, we call it \emph{babelshorthands}.
+
+Shorthands need to be activated for the respective language, or can be activated globally, via
+the boolean option \xpgoption{babelshorthands} (either passed globally when loading \pkg{polyglossia}
+or to a specific language when loading it).
+
+Shorthands are implemented currently for Afrikaans, Belarusian, Catalan, Croatian,
+Czech, Dutch, Finnish, Georgian, German, Italian, Latin, Mongolian, Occitan,
+Piedmontese, Polish, Portuguese, Russian, Slovak, and Ukrainian, and their number and function
+differs between these languages. Please refer to the respective language descriptions (sec.~\ref{specific})
+for detailed elaborations.
+
+If you want to re-use the shorthands defined for a specific language in a different language,
+you can do so by using in preamble:\new{2.0}
+\displaycmd{\inheritbabelshorthands\marg{source language}\marg{target language}}{\inheritbabelshorthands}
+in order to input and activate the shorthands defined for the \meta{source language} in
+the \meta{target language}. Both languages will be loaded as \enquote{other} languages if they have not
+been loaded yet. If one of the languages does not exist, or if the \meta{source language} does not provide any
+shorthands, you will get an error message.
+
+Note, also, that you can only use \cmd{\inheritbabelshorthands} once per language. Subsequent
+calls will overwrite previous ones (and also the shorthand that might be defined for a
+\meta{target language} in the first place).
+
+If you want to enable the shorthands of a specific language inline, also when the language itself
+is not active (but loaded in the preamble), you can do so by means of\new{2.0}
+\displaycmd{\usebabelshorthands\marg{language}}{\usebabelshorthands}
+The effect of this is local to groups. If you want to disable any active shorthands, you can use
+¦\usebabelshorthands{none}¦.
+
\section{Language-switching commands}\label{languageswitching}
\subsection{Recommended commands}\label{sec:langcmds}
@@ -697,9 +731,11 @@ ought to be mentioned here.
In a similar vein, it is possible to use \Cmd\rmfamilylatin, \Cmd\sffamilylatin,
and \Cmd\ttfamilylatin.
-\item \Cmd\latinalph: Representation of counter as a lower-case letter: 1 = a, 2 = b, etc.
+\item \DescribeMacro{\latinalph}\cmd{\latinalph\marg{counter}}: Representation of counter as a lower-case letter:
+ 1 = a, 2 = b, etc.
-\item \Cmd\latinAlph: Representation of counter as a upper-case letter: 1 = A, 2 = B, etc.
+\item \DescribeMacro{\latinAlph}\cmd{\latinAlph\marg{counter}}: Representation of counter as a upper-case letter:
+ 1 = A, 2 = B, etc.
\end{itemize}
@@ -1139,23 +1175,37 @@ and that passing \xpgvalue{babelshorthands} (without value) is equivalent to pas
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 \cmd\-).
- \item[\texttt{"\textasciitilde}] for a hyphen sign without a breakpoint. Useful for
- cases where the hyphen should stick at the following syllable.
+ \item[¦"-¦] adds an explicit hyphen without a breakpoint, allowing for hyphenation at the
+ other points preset in the hyphenation patterns. Useful for
+ cases where the hyphen should stick at the following syllable
+ (\eg ¦pakastekaapit ja "-arkut¦).
+ \item[\texttt{"=}] for a hyphen sign without a breakpoint that does also remove all other
+ breakpoints in the word (as opposed to ¦"-¦).
+ \item[\texttt{"\textasciitilde}] functionally equivalent to ¦"-¦ (provided for backwards
+ compatibility reasons).
\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 \cmd\slash,
hyphenation at the breakpoints preset in the hyphenation patterns is still allowed.
\end{shorthands}
- \item \xpgboolkeyfalse[1.54]{schoolhyphens}
- If this is set to true, alternative (experimental) hyphenation patterns are used rather than the
- default Finnish patterns. These (so-called `School') patterns allow hyphenation at
+ \item \xpgchoicekey[2.0]{hyphens}{\xpgpresetvalue{default}, \xpgvalue{babel}, \xpgvalue{school}}
+ Hyphenation in Finnish is peculiar since there are many rather long words. In order to select a suitable
+ hyphenation pattern, three different options are provided:
+ \begin{itemize}
+ \item The \xpgvalue{default} patterns as used by \LaTeX\ are rather strict and try to prevent hyphenation
+ at points which are valid but considered sub-optimal from an ortho-typographic point of view
+ (\eg hyphenation between two vowels), with the drawback that simple words are sometimes not being
+ hyphenated at points where this would be valid, and lines might become unevenly spaced.
+ \item The \pkg{babel} support for Finnish by default tweaks some hyphenation-related values
+ (such as \cmd\hyphenpenalty) for Finnish. If you want to replicate this with \pkg{polyglossia},
+ select \xpgvalue{babel} (this still uses the default patterns).
+ \item The \xpgvalue{school} setting, finally, employs alternative (experimental) hyphenation patterns
+ rather than the default Finnish patterns. These (so-called `School') patterns allow hyphenation at
all valid points, including hyphenation points that are considered sub-optimal from an
- ortho-typographic point of view (e.\,g., hyphenation between two vowels).
- The default patterns try to prevent such hyphenation, with the drawback that simple words
- are sometimes not being hyphenated at points where this would be valid.
+ ortho-typographic point of view.\footnote{This equals the previous boolean option \xpgoption{schoolhyphens},
+ which is still supported for backwards compatibility.}
See \url{https://github.com/hyphenation/basic-finnish} for details.
+ \end{itemize}
\end{itemize}
\subsection{french}\label{french}
@@ -1313,6 +1363,11 @@ and that passing \xpgvalue{babelshorthands} (without value) is equivalent to pas
\eg ¦(pseudo"~)""wissenschaftlich¦.
\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[¦"*¦]\new{2.0} An asterisk which assures the word can still be hyphenated at its defined breakpoints.
+ Useful if you want to employ gender-sensitive writing (,gender star`).
+ Similar shorthands are available for the alternative gender-sensitive spellings, ¦":¦ and ¦"_¦.
+ \item[¦"x¦]\new{2.0} Inserts a gender mark which assures the word can still be hyphenated at its defined breakpoints.
+ This is predefined to ¦*¦ but can be globally redefined by redefining the macro \cmd\mkgender\ (see below).
\end{shorthands}
There are also four shorthands for quotation signs:
@@ -1323,6 +1378,11 @@ and that passing \xpgvalue{babelshorthands} (without value) is equivalent to pas
\item[¦">¦] for French-style right double quotes (»).
\end{shorthands}
\end{itemize}
+ \paragraph*{Commands:}
+ \begin{itemize}
+ \item \Cmd\mkgender\new{2.0} Defines which gender mark is output by the babelshorthand ¦"x¦.
+ Predefined to ¦\def\mkgender{*}¦.
+ \end{itemize}
\subsection{greek}\label{greek}
\paragraph*{Options:}
@@ -2637,7 +2697,45 @@ where \meta{type} is a supported language id type (such as ¦bcp-47¦) and \meta
\section{Revision history}
\bgroup\footnotesize
-\subsection*{1.66 (2023/12/02)}
+
+\subsection*{2.0 (2024/02/17)}
+
+\subsubsection*{Bug fixes}
+\begin{itemize}
+ \item Fix error with undefined property list that unhides with
+ \pkg{l3kernel} version 2024-02-13 (\TXI{626}).
+ \item Fix \xpgoption{frenchfootnote} option (\TXI{620}).
+ \item The error message on improper font setting is now
+ correct if the main script is non-Latin, for
+ non-Roman fonts (\TXI{571}), and specifically for
+ the CJK case (\TXI{621}).
+ \item Fix expansion of localnumeral (\TXI{622}).
+\end{itemize}
+
+\subsubsection*{New Features}
+\begin{itemize}
+ \item Add \cmd{\inheritbabelshorthands} (\TXI{604}).
+ \item Add \cmd{\usebabelshorthands}.
+ \item Add shorthands for German gender-sensitive writing.
+ \item Implement \pkg{babel}-style hyphenation for Finnish.
+\end{itemize}
+
+\subsubsection*{Documentation improvements}
+\begin{itemize}
+ \item Fix documentation of Finnish shorthands (\TXI{623}).
+\end{itemize}
+
+\subsubsection*{Internal work}
+\begin{itemize}
+ \item The package code has been subjected to a major rewrite.
+ Code has been cleaned up, and in general, \pkg{polyglossia}
+ more consistently employs \pkg{latex3} now. Note that this is
+ an ongoing and yet unfinished project that will continue over
+ the next releases.
+\end{itemize}
+
+
+\subsection*{1.66 (2023/12/11)}
\subsubsection*{Bug fixes}
\begin{itemize}