babel-estonian (21feb14)

git-svn-id: svn://tug.org/texlive/trunk@33023 c570f23f-e606-0410-a88d-b1316a301751

3 files changed, 154 insertions, 54 deletions

diff --git a/Master/texmf-dist/doc/generic/babel-estonian/estonian.pdf b/Master/texmf-dist/doc/generic/babel-estonian/estonian.pdf
index b2c9e27be5c..7167ef510c7 100644
--- a/Master/texmf-dist/doc/generic/babel-estonian/estonian.pdf
+++ b/Master/texmf-dist/doc/generic/babel-estonian/estonian.pdf
diff --git a/Master/texmf-dist/source/generic/babel-estonian/estonian.dtx b/Master/texmf-dist/source/generic/babel-estonian/estonian.dtx
index 48a39bfac0d..aa7cc664f95 100644
--- a/Master/texmf-dist/source/generic/babel-estonian/estonian.dtx
+++ b/Master/texmf-dist/source/generic/babel-estonian/estonian.dtx
@@ -16,7 +16,7 @@
 % 
 % This work has the LPPL maintenance status "maintained".
 % 
-% The Current Maintainer of this work is Johannes Braams.
+% The Current Maintainer of this work is Jaan Vajakas.
 % 
 % The list of all files belonging to the Babel system is
 % given in the file `manifest.bbl. See also `legal.bbl' for additional
@@ -26,7 +26,7 @@
 % and covered by LPPL is defined by the unpacking scripts (with
 % extension .ins) which are part of the distribution.
 % \fi
-% \CheckSum{327}
+% \CheckSum{325}
 % \iffalse
 %    Tell the \LaTeX\ system who we are and write an entry on the
 %    transcript.
@@ -36,7 +36,7 @@
 %<code>\ProvidesLanguage{estonian}
 %\fi
 %\ProvidesFile{estonian.dtx}
-        [2009/03/08 v1.0k Estonian support from the babel system]
+        [2014/02/20 v1.1 Estonian support from the babel system]
 %\iffalse
 %% File `estonian.dtx'
 %% Babel package for LaTeX version 2e
@@ -83,16 +83,20 @@
 %    with \LaTeX, moved the definition of \cs{atcatcode} right to the
 %    beginning.}
 % \changes{estonian-1.0k}{2009/03/07}{corrected documentation of the
-%    commands |"-| and |\-|}
+%    commands \texttt{"-} and \cs{-}}
+% \changes{estonian-1.1}{2014/02/20}{added usage guidelines to the
+%    documentation}
 %
 % \GetFileInfo{estonian.dtx}
 %
-% \section{The Estonian language}
+% \title{Estonian language support for \babel}
+% \author{Enn Saar\footnote{\texttt{saar@aai.ee}, original author (inactive)},
+% Jaan Vajakas\footnote{\texttt{jv@ut.ee}, maintainer since version 1.0k}}
+% \date{\filedate, \fileversion}
 %
-%    The file \file{\filename}\footnote{The file described in this
-%    section has version number \fileversion\ and was last revised on
-%    \filedate. The original author is Enn Saar,
-%    (\texttt{saar@aai.ee}).}  defines the language definition macro's
+% \maketitle
+%
+%    The file \file{\filename} defines the language definition macro's
 %    for the Estonian language.
 %
 %    This file was written as part of the TWGML project, and borrows
@@ -114,7 +118,7 @@
 %      |"u| & |\"u|, (and uppercase); \\
 %      |~s| & |\v s|, (and uppercase); \\
 %      |~z| & |\v z|, (and uppercase); \\
-%      \verb="|= & disable ligature at this position;\\
+%      \verb="|= & disable ligature at this position; \\
 %      |"-| & like |\-|, but allowing hyphenation
 %                  in the rest of the word;\\
 %      |"`| & for Estonian low left double quotes (same as German);\\
@@ -131,21 +135,115 @@
 %    that table; the original quote character can be typed using the
 %    macro |\dq|.
 %
-%    We support also the T1 output encoding (and Cork-encoded text
-%    input).  You can choose the T1 encoding by the command
-%    |\usepackage[T1]{fontenc}|.  This package must be loaded before
-%    \babel. As the standard Estonian hyphenation file
-%    \file{eehyph.tex} is in the Cork encoding, choosing this encoding
-%    will give you better hyphenation.
-%
-%    As mentioned in the Spanish style file, it may happen that some
-%    packages fail (usually in a \cs{message}). In this case you
-%    should change the order of the \cs{usepackage} declarations
-%    or the order of the style options in \cs{documentclass}.
+% \section{Usage guidelines}
+% 
+% \subsection{Overview and usage example}
+%
+% In short, it is recommended to include lines like the following in the preamble:
+% \begin{itemize}
+% \item in \LaTeX{}:
+%\begin{verbatim}
+%\usepackage[utf8]{inputenc}
+%\usepackage[T1]{fontenc}
+%\usepackage{mathptmx}  % or \usepackage{lmodern} or something else
+%\usepackage[estonian .notilde]{babel}
+%\end{verbatim}
+% \item in XeLaTeX or LuaLaTeX:\footnote{In XeLaTeX and LuaLaTeX, you may want
+% to use the more modern \textsf{polyglossia} package instead of \babel{},
+% although the latter also works.}
+%\begin{verbatim}
+%\usepackage[estonian .notilde]{babel}
+%\usepackage{fontspec}
+%\end{verbatim}
+% \end{itemize}
+% When saving your file with your text editor, make sure it is saved in the UTF-8 encoding.
+%
+% In the following subsections, the rationale of these options is explained.
+% Some authors have also advised not to use ligatures in Estonian;
+% the last subsection discusses that matter.
+%
+% \subsection{Use the T1 font encoding and avoid CM}
+% If using the Estonian package in \LaTeX, it is recommended to choose
+% the T1 output encoding (also known as Cork encoding). It will give you better hyphenation,
+% as the standard Estonian hyphenation file \file{eehyph.tex} is in the Cork encoding.
+% You can choose the T1 output encoding (also known as Cork encoding) by the command
+% |\usepackage[T1]{fontenc}|.
+%
+% If you like Computer Modern (CM), the default font, then we recommend using
+% its successor Latin Modern (|\usepackage{lmodern}|) instead --- it is almost identical but
+% has the tilde in the letter ``\~o'' slightly lower, looking more natural.
+% (In the OT1 encoding, the Estonian package takes special care to lower the tilde,
+% but that feature is not supported for the T1 output encoding since
+% version 1.0k, as it created many issues of its own.)
+%
+% In XeLaTeX and LuaLaTeX, the default font (CM) does not support accented letters
+% and therefore the \textsf{fontspec} package (or \textsf{xltxtra}) has to be used.
+%
+% \subsection{Use UTF-8 and disable tilde shorthands}
+%
+% In the early 1990s, handling accented letters was a problem
+% for many programs. So shorthands for accented letters in Estonian (|~o|, |"a| etc.) were created.
+% Nowadays the UTF-8 standard is widespread, allowing to represent
+% letters from almost all the world's languages in a single text file.
+% Therefore it is recommended to use UTF-8 as input encoding and type Estonian accented
+% characters directly, instead of using the shorthands. We also recommend UTF-8 over
+% cp1257, the default encoding for Estonian on Windows, since it contains more
+% characters and is more likely understood
+% by the text editors of your foreign partners.
+%
+% In addition, a problem is caused by the shorthands starting with tilde.
+% Namely, in \TeX, the |~| command originally means non-breaking space:
+% if \babel{} is not used then e.~g. |U.~S.| is rendered as ``U.~S.''.
+% However, with |\usepackage[estonian]{babel}| in preamble,
+% |U.~S.| is rendered as ``U.\v S.'' by default.
+% If you don't need the shorthands starting with tilde,
+% you can restore the original behavior of |~| by using the option
+% |notilde|, like this:
+%\begin{verbatim}\usepackage[estonian .notilde]{babel}\end{verbatim}
+% The option |notilde| was introduced in version 1.1 of the Estonian package.
+% If you need compatibility with older versions, write instead
+%\begin{verbatim}
+%\usepackage[estonian]{babel}
+%\makeatletter\addto\extrasestonian{\bbl@deactivate{~}}\makeatother
+%\addto\captionsestonian{% Redefine captions containing ~o
+%  \def\abstractname{Kokkuv\~ote}%
+%  \def\proofname{T\~oestus}%
+%  \def\glossaryname{S\~onastik}%
+%}
+%\end{verbatim}
+% If you don't disable the tilde shorthands, you must write |U.\nobreak{} S.|
+%
+% \subsection{Ligatures}
+% Ligatures have been considered unsuitable for Estonian by some authors.\footnote{
+% In their ``L\"uhike \LaTeX i\~opetus'', Henn Saar and Hans Ibrus recommend against
+% using ligatures in Estonian, giving the word ``fiiber'' as a bad example.
+% Indeed, ``ii'' denotes a single long vowel in Estonian, but the ligature seems to suggest
+% that instead the first two letters ``f'' and ``i'' are grouped together.
+% Ligatures are practically absent from Estonian books published during the Soviet
+% period (e. g. mathematical books have no ligature in ``def\/initsioon'').
+% However, during Estonia's first independence period, ligatures, while not ubiquitous,
+% did appear in some books: e.~g. Borkvell's ``Tasapinnalise ja ruumilise anal\"u\"utilise geomeetria p\~ohijooni'' from 1937
+% (``Determinandi definitsioon'' with fi ligature) or ``Eesti Ents\"uklopeedia'' from 1932--1937
+% (having even ``Af\/fiinsus'' with ligature fi --- in this case probably for the convenience of the typesetter rather than the reader).}
+% By default, \TeX{} creates ligatures fi, ff, fl, ffi and ffl in the CM fonts (other fonts may have other
+% ligatures). This package offers the command \verb="|= for disabling ligatures one-by-one,
+% but if you want to get rid of all ligatures in \LaTeX, include the following lines in your preamble:\footnote{
+% Note that the above only disables ligatures starting with f.
+% You would not want to apply {\tt DisableLigatures} to all letter combinations,
+% since it also disables kerning (and letter combinations like
+% ``VA'' and ``Ve'' look much nicer with kerning).}
+%\begin{verbatim}
+%\usepackage{microtype}
+%\DisableLigatures[f]{encoding = *, family = * }
+%\end{verbatim}
+% In XeLaTeX and LuaLaTeX, use the following line instead (replace the font name):
+%\begin{verbatim}
+%\setmainfont[Ligatures={NoRequired,NoCommon,NoContextual}]{Font Name}
+%\end{verbatim}
 %
 % \StopEventually{}
 %
-% \subsection{Implementation}
+% \section{Implementation}
 %
 %    The macro |\LdfInit| takes care of preventing that this file is
 %    loaded more than once, checking the category code of the
@@ -181,6 +279,9 @@
 %    `Proof'}
 % \changes{estonian-1.0k}{2009/02/03}{Added translation of
 %    `Glossary'}
+% \changes{estonian-1.1}{2014/02/20}{Replaced \texttt{\textasciitilde o} with \cs{\textasciitilde o}
+%    for compatibility with the \texttt{notilde} option, and to have the same style,
+%    also replaced \texttt{"u} with \cs{"u} in ``Peat\"ukk''.}
 %    \begin{macrocode}
 \addto\captionsestonian{%
   \def\prefacename{Sissejuhatus}%
@@ -200,20 +301,11 @@
   \def\pagename{Lk.}%
   \def\seename{vt.}%
   \def\alsoname{vt. ka}%
-  }
-%    \end{macrocode}
-%
-%    These captions contain accented characters.
-%
-%    \begin{macrocode}
-\begingroup \catcode`\"\active
-\def\x{\endgroup
-\addto\captionsestonian{%
-  \def\abstractname{Kokkuv~ote}%
-  \def\chaptername{Peat"ukk}%
-  \def\proofname{T~oestus}%
-  \def\glossaryname{S~onastik}%
-}}\x
+  \def\abstractname{Kokkuv\~ote}%
+  \def\chaptername{Peat\"ukk}%
+  \def\proofname{T\~oestus}%
+  \def\glossaryname{S\~onastik}%
+}
 %    \end{macrocode}
 %  \end{macro}
 %
@@ -265,6 +357,15 @@
 % \changes{estonian-1.0d}{1995/07/27}{Removed the code that changes
 %    category, lower case, uper case and space factor codes }
 %
+% \changes{estonian-1.1}{2014/02/20}{introduced the \texttt{notilde} option} 
+%  \begin{macro}{notilde}
+%   The option |notilde| disables the shorthands starting with |~|,
+%   restoring the original function of |~| as non-breaking space.
+%    \begin{macrocode}
+\bbl@declare@ttribute{estonian}{notilde}{\addto\extrasestonian{\bbl@deactivate{~}}}
+%    \end{macrocode}
+%  \end{macro}
+%
 %    Estonian does not use extra spaces after sentences.
 %
 %    \begin{macrocode}
@@ -288,7 +389,7 @@
 %  we have to lower them (following the \babel\ German style).
 %  For umlauts, we can use |\umlautlow| in \file{babel.ldf}.
 % \changes{estonian-1.0k}{2009/02/03}{use \cs{umlauthigh} to restore
-%    umlauts (before, |\babel@save\"| was used but that did not work)}
+%    umlauts (before, \cs{babel@save}\cs{"} was used but that did not work)}
 %    \begin{macrocode}
 \addto\extrasestonian{\umlautlow}
 \addto\noextrasestonian{\umlauthigh}
@@ -304,10 +405,10 @@
 %  encoding, |\et@gentilde| places the tilde through the letter o).
 %  In plain \TeX\ there is no encoding infrastructure, so we just
 %  redefine |\~|.
-% \changes{estonian-1.0k}{2009/02/03}{redefine
-%    |\csname OT1\string\~\endcsname| instead of |\~| (before,
-%    redefining |\~| resulted in no hyphenation of words containing
-%    |\~o| in T1 and incorrect display of |\~o| with the times package)}
+% \changes{estonian-1.0k}{2009/02/03}{redefine \cs{\textasciitilde} only for OT1 (before,
+%    redefining \cs{\textasciitilde} resulted in no hyphenation of words containing
+%    \cs{\textasciitilde}\texttt{o} in T1 and incorrect display of
+%    \cs{\textasciitilde}\texttt{o} with the \textsf{times} package)}
 %    \begin{macrocode}
 \ifet@latex
   \addto\extrasestonian{%
@@ -354,7 +455,7 @@
 %    We save the double quote character in |\dq|, and  tilde in |\til|.
 % \changes{estonian-1.0k}{2009/02/03}{removed macros \cs{dieresis} and
 %    \cs{texttilde} that were used to store the original definitions of
-%    |\"| and |\~|, as they would have no purpose now}
+%    \cs{"} and \cs{\textasciitilde}, as they would have no purpose now}
 %
 %    \begin{macrocode}
 \begingroup \catcode`\"12
@@ -385,7 +486,7 @@
 %    hyphenation beyond the accent. In this case \TeX\ will not find
 %    all possible breaks, and we have to warn people.
 % \changes{estonian-1.0k}{2009/02/03}{removed definitions of macros
-%    |\@umlaut| and |\@tilde| as they seemed to have no purpose}
+%    \cs{@umlaut} and \cs{@tilde} as they seemed to have no purpose}
 %    \begin{macrocode}
 \else
   \wlog{Warning: Hyphenation would work better for the T1 encoding.}
@@ -395,7 +496,9 @@
 %    Now we define the shorthands: umlauts,
 % \changes{estonian-1.0d}{1995/07/27}{The second argument was missing
 %    in the definition of some of the double-quote shorthands}
-% \changes{estonian-1.0k}{2009/02/08}{use \cs{allowhyphens} to allow hyphenation in words containing |"a|, |"A|, |"o|, |"O|, |"u| or |"U|}
+% \changes{estonian-1.0k}{2009/02/08}{use \cs{allowhyphens} to allow
+%    hyphenation in words containing \texttt{"a}, \texttt{"A},
+%    \texttt{"o}, \texttt{"O}, \texttt{"u} or \texttt{"U}}
 %    \begin{macrocode}
 \declare@shorthand{estonian}{"a}{\textormath{\"{a}\allowhyphens}{\ddot a}}
 \declare@shorthand{estonian}{"A}{\textormath{\"{A}\allowhyphens}{\ddot A}}
diff --git a/Master/texmf-dist/tex/generic/babel-estonian/estonian.ldf b/Master/texmf-dist/tex/generic/babel-estonian/estonian.ldf
index e6d95b898ba..eb4383ee510 100644
--- a/Master/texmf-dist/tex/generic/babel-estonian/estonian.ldf
+++ b/Master/texmf-dist/tex/generic/babel-estonian/estonian.ldf
@@ -37,7 +37,7 @@
 %% and covered by LPPL is defined by the unpacking scripts (with
 %% extension .ins) which are part of the distribution.
 \ProvidesLanguage{estonian}
-        [2009/03/08 v1.0k Estonian support from the babel system]
+        [2014/02/20 v1.1 Estonian support from the babel system]
 %% File `estonian.dtx'
 %% Babel package for LaTeX version 2e
 %% Copyright (C) 1989 - 2009
@@ -71,15 +71,11 @@
   \def\pagename{Lk.}%
   \def\seename{vt.}%
   \def\alsoname{vt. ka}%
-  }
-\begingroup \catcode`\"\active
-\def\x{\endgroup
-\addto\captionsestonian{%
-  \def\abstractname{Kokkuv~ote}%
-  \def\chaptername{Peat"ukk}%
-  \def\proofname{T~oestus}%
-  \def\glossaryname{S~onastik}%
-}}\x
+  \def\abstractname{Kokkuv\~ote}%
+  \def\chaptername{Peat\"ukk}%
+  \def\proofname{T\~oestus}%
+  \def\glossaryname{S\~onastik}%
+}
 \begingroup \catcode`\"\active
 \def\x{\endgroup
   \def\month@estonian{\ifcase\month\or
@@ -99,6 +95,7 @@
 \initiate@active@char{~}
 \addto\extrasestonian{\languageshorthands{estonian}}
 \addto\extrasestonian{\bbl@activate{"}\bbl@activate{~}}
+\bbl@declare@ttribute{estonian}{notilde}{\addto\extrasestonian{\bbl@deactivate{~}}}
 \addto\extrasestonian{\bbl@frenchspacing}
 \addto\noextrasestonian{\bbl@nonfrenchspacing}
 \providehyphenmins{\CurrentOption}{\tw@\tw@}