summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/caption/bicaption.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/caption/bicaption.dtx')
-rw-r--r--Master/texmf-dist/source/latex/caption/bicaption.dtx140
1 files changed, 103 insertions, 37 deletions
diff --git a/Master/texmf-dist/source/latex/caption/bicaption.dtx b/Master/texmf-dist/source/latex/caption/bicaption.dtx
index 665bf5d6567..49c9d1f5089 100644
--- a/Master/texmf-dist/source/latex/caption/bicaption.dtx
+++ b/Master/texmf-dist/source/latex/caption/bicaption.dtx
@@ -2,7 +2,7 @@
%
% This is file `bicaption.dtx'.
%
-% Copyright (C) 2010-2016 Axel Sommerfeldt (axel.sommerfeldt@f-m.fm)
+% Copyright (C) 2010-2018 Axel Sommerfeldt (axel.sommerfeldt@f-m.fm)
%
% --------------------------------------------------------------------------
%
@@ -25,12 +25,12 @@
% and the user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex.
%
% \fi
-% \CheckSum{402}
+% \CheckSum{427}
%
% \iffalse
%<*driver>
\NeedsTeXFormat{LaTeX2e}[1994/12/01]
-\ProvidesFile{bicaption.drv}[2012/04/10 v1.1 Adds a bilingual caption feature to the caption package]
+\ProvidesFile{bicaption.drv}[2016/03/27 v1.2 Adds a bilingual caption feature to the caption package]
\hbadness=9999 \newcount\hbadness \hfuzz=74pt % Make TeX shut up.
%\errorcontextlines=3
%
@@ -61,8 +61,8 @@
\ifpdf\usepackage{hypdestopt}\fi
\hypersetup{pdfkeywords={LaTeX, package, bicaption},pdfstartpage={},pdfstartview={}}
%
-\usepackage{bicaption}[2012/12/26]
-\usepackage{subcaption}[2012/04/09]
+\usepackage{bicaption}[2016/03/27]
+\usepackage{subcaption}[2016/02/21]
%
\newcommand*\purerm[1]{{\upshape\mdseries\rmfamily #1}}
\newcommand*\puresf[1]{{\upshape\mdseries\sffamily #1}}
@@ -85,7 +85,7 @@
\newenvironment{background*}{\small\MARGINSYM{\Mountain}\ignorespaces}{\par}
%
\newcommand*\MARGINSYM[1]{\hskip 1sp \marginpar{\raggedleft\textcolor{blue}{{#1}}}}
-%\newcommand*\NEW[2]{}%\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}}
+\newcommand*\NEW[2]{\MARGINSYM{\vskip2pt\footnotesize#1\\#2}}
%
\newenvironment{Options}[1]%
{\list{}{\renewcommand\makelabel[1]{\texttt{##1}\hfil}%
@@ -118,10 +118,11 @@
%
% \GetFileInfo{bicaption.drv}
% \let\docdate\filedate
+% \let\docversion\fileversion
% \GetFileInfo{bicaption.sty}
%
% \title{\texorpdfstring{\Thispackage\thanks{%^^A
-% This package has version number \fileversion, last revised \filedate.}}%^^A
+% This package has version number \docversion.}}%^^A
% {The bicaption package}}
% \author{Axel Sommerfeldt\\
% \url{https://gitlab.com/axelsommerfeldt/caption}}
@@ -228,8 +229,9 @@
% |\captionsetup[figure][bi-first]|\oarg{options}
% \end{quote}
% will limit the settings to the first heading of |figure| environments only.
-% Please note that the environment name has to be specified as first optional argument
-% while the bilingual selection as second one.
+% Please note that the environment name (|figure|, |table|, \ldots) has to be specified
+% as first optional argument while the bilingual selection (|bi|, |bi-first|, or |bi-second|)
+% as second one.
%
% \section{Additional options}
% \label{sec:additional-options}
@@ -685,6 +687,7 @@
% \medskip
%
% \DescribeMacro\selectcaptionlanguage
+% \NEWfeature{v1.1}
% |\select|\-|caption|\-|lan|\-|guage| will be used internally to select the language:
% \begin{quote}
% |\selectcaptionlanguage|\marg{font-or-list-entry}\marg{language}
@@ -704,8 +707,43 @@
%
% \medskip
%
-% Please note that all of this will only be relevant if the |lang=| option will be used.
-% Otherwise |\select|\-|caption|\-|lan|\-|guage| won't be used by \thispackage\ at all.
+% \DescribeMacro\DeclareCaptionLangOption
+% \NEWfeature{v1.2}
+% For internal implementation reasons the selection of language will be done delayed,
+% i.e.~not done immediately at |lang=|\meta{language}. So if you do
+% \begin{quote}
+% |\captionsetup[bi-second]{lang=ngerman,labelsep=quad}|
+% \end{quote}
+% the language |ngerman| will only be stored internally, and the label separator will
+% be set to |quad| afterwards. Some time later, right before the caption is actually
+% typeset, the language will be set to |ngerman|.
+%
+% Usually this is no problem, but think of options which will be overwritten by the
+% language selection, or options which act on the language currently set, for example
+% \begin{quote}
+% |\captionsetup[bi-second]{lang=ngerman,name=Bild}|\quad.
+% \end{quote}
+% |lang=ngerman| changes the environment name to ``Abbildung'', and |name=Bild|
+% changes the environment name to ``Bild''. One would expect that the name is
+% finally ``Bild'', but because of the delayed nature of |lang=ngerman| it will
+% be ``Abbildung'' instead, at least if we don't take action about this.
+%
+% For that reason the command
+% \begin{quote}
+% |\DeclareCaptionLangOption|\marg{caption option name}
+% \end{quote}
+% is offered. Options handled this way will be applied twice if used after the |lang=|
+% option, when the option is actually used, and right after the language is selected.
+%
+% \begin{quote}
+% |\DeclareCaptionLangOption{name}|
+% \end{quote}
+% will be done by \thispackage\ automatically, since the environment name will usually
+% be overwritten by a language selection. So actually
+% \begin{quote}
+% |\captionsetup[bi-second]{lang=ngerman,name=Bild}|
+% \end{quote}
+% will give the expected result, i.e. the environment name is typeset as ``Bild''.
%
% \iffalse
% --------------------------------------------------------------------------- %
@@ -792,10 +830,10 @@
%
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}[1994/12/01]
-\ProvidesPackage{bicaption}[2018/08/26 v1.1-159 Bilingual Captions (AR)]
+\ProvidesPackage{bicaption}[2016/03/27 v1.2 Bilingual Captions (AR)]
% \end{macrocode}
% \begin{macrocode}
-\RequirePackage{caption}[2016/02/01] % needs v3.3-134 or newer
+\RequirePackage{caption}[2018/05/11] % needs v3.4 or newer
% \end{macrocode}
% \changes{v1.0}{2011/09/01}{Compatibility error added}
% \begin{macrocode}
@@ -902,35 +940,52 @@
% using the \package{microtype} package via |\usepackage[babel]{microtype}|.
% So we store the selected language to |\bicaption@language| instead and will set it later on.
% But this has a drawback, option settings which will be overwritten by the selection of
-% the language do not work correctly anymore.
-% The only option affected I'm aware off is the |name=| option, so this will be saved
-% and set later on, too.
-% (Since the user can declare own options it would be nice to have a new command for handling
-% delayed option settings because of the language selection,
-% e.g. |\DeclareCaptionLangOption|\marg{option key}.
-% This will be offered by a future version of \thispackage.)
+% the language do not work correctly anymore. Therefore we will save specific options
+% and set them (again) after setting the language.
% \begin{macrocode}
\DeclareCaptionOption{lang}{%
\caption@ifundefined\bicaption@language
- {\let\KV@bicaption@name\KV@caption@name
- \def\KV@caption@name{\bicaption@KV{name}}}%
- {}%
+ \bicaption@language@setupkeys
+ \relax
\def\bicaption@language{#1}%
- \let\bicaption@language@options\@empty}
+ \let\bicaption@language@setoptions\@empty}
% \end{macrocode}
+% Map |language=| to |lang=|.
% \begin{macrocode}
\let\KV@caption@language\KV@caption@lang
% \end{macrocode}
%
-% \begin{macro}{\bicaption@KV}
-% \changes{v1.1}{2016/03/27}{This macro added}
-% |\bicaption@KV|\marg{option key}\marg{option value}\par
-% This macro do execute the given caption package option, and store it additionally for
-% delayed execution after setting the language.
+% \begin{macro}{\DeclareCaptionLangOption}
+% \changes{v1.2}{2016/03/27}{This macro added}
+% |\DeclareCaptionLangOption|\marg{option key}\par
+% Saves the gives \meta{option key} to the list |\bicaption@language@keylist|.
+% These options will be stored and set (again) after setting the language.
+% \begin{macrocode}
+\newcommand*\bicaption@language@keylist{}
+% \end{macrocode}
+% \begin{macrocode}
+\newcommand*\DeclareCaptionLangOption[1]{%
+ \@ifundefined{KV@caption@#1}%
+ {\bicaption@Error{Undefined caption option `#1'}}%
+ {\@cons\bicaption@language@keylist{{#1}}}}
+% \end{macrocode}
+% \begin{macrocode}
+\let\DeclareCaptionLanguageOption\DeclareCaptionLangOption
+% \end{macrocode}
+% \begin{macrocode}
+\newcommand*\bicaption@language@setupkeys{%
+ \def\@elt##1{%
+ \expandafter\let\csname KV@bicaption@##1\expandafter\endcsname
+ \csname KV@caption@##1\endcsname
+ \@namedef{KV@caption@##1}{\bicaption@KV{##1}}}%
+ \bicaption@language@keylist
+ \let\@elt\relax}
+% \end{macrocode}
% \begin{macrocode}
\newcommand\bicaption@KV[2]{%
\@bicaption@KV{#1}{#2}%
- \l@addto@macro\bicaption@language@options{\@bicaption@KV{#1}{#2}}}
+ \l@addto@macro\bicaption@language@setoptions{%
+ \@bicaption@KV{#1}{#2}}}
% \end{macrocode}
% \begin{macrocode}
\newcommand\@bicaption@KV[1]{%
@@ -938,19 +993,26 @@
% \end{macrocode}
% \end{macro}
%
+% The only option affected I'm aware off is the |name=| option, so this will be saved
+% and set later on.
+% \begin{macrocode}
+\DeclareCaptionLangOption{name}
+% \end{macrocode}
+%
% \begin{macro}{\bicaption@selectlanguage}
% \changes{v1.0}{2011/08/31}{Starred variant added}
% \changes{v1.1}{2012/04/09}{Support of \cs{selectcaptionlanguage} added}
% \changes{v1.1}{2016/03/25}{Patching of \cs{caption@applyfont} replaced by \cs{caption@beginhook}}
-% \changes{v1.1}{2016/03/27}{Usage of \cs{bicaption@language@options} added}
+% \changes{v1.1}{2016/03/27}{Usage of \cs{bicaption@language@setoptions} added}
% |\bicaption@selectlanguage|\marg{font-or-list-entry}\par
% Set the language (stored in |\bi|\-|caption@lan|\-|guage|)
% via |\select|\-|bi|\-|caption|\-|lan|\-|guage|.
% \begin{macrocode}
\newcommand*\bicaption@selectlanguage[1]{%
\caption@ifundefined\bicaption@language{}{%
- \expandafter\selectcaptionlanguage\expandafter#1\expandafter{\bicaption@language}%
- \bicaption@language@options}}
+ \expandafter\selectcaptionlanguage\expandafter#1\expandafter
+ {\bicaption@language}%
+ \bicaption@language@setoptions}}
% \end{macrocode}
% |\caption@beginhook| (of the \package{caption} package kernel) will be extended here
% so the language setting will actually take effect.
@@ -980,12 +1042,15 @@
% Set the language for the first caption.
% \begin{macrocode}
\ifcsname captionmainlanguage\endcsname
- \bicaption@InfoNoLine{main language is set to \captionmainlanguage}
+ \bicaption@InfoNoLine{%
+ main language is set to \captionmainlanguage}
\else\ifcsname bbl@main@language\endcsname
- \bicaption@InfoNoLine{babel found, main language is \bbl@main@language}
+ \bicaption@InfoNoLine{%
+ babel found, main language is \bbl@main@language}
\let\captionmainlanguage\bbl@main@language
\else\ifcsname xpg@main@language\endcsname
- \bicaption@InfoNoLine{polyglossia found, main language is \xpg@main@language}
+ \bicaption@InfoNoLine{%
+ polyglossia found, main language is \xpg@main@language}
\let\captionmainlanguage\xpg@main@language
\else
\bicaption@InfoNoLine{main language is not set}
@@ -993,7 +1058,8 @@
% \end{macrocode}
% \begin{macrocode}
\ifcsname captionmainlanguage\endcsname
- \edef\@tempa{\noexpand\captionsetup[bi-first]{lang=\captionmainlanguage}}
+ \edef\@tempa{%
+ \noexpand\captionsetup[bi-first]{lang=\captionmainlanguage}}
\@tempa
\fi
% \end{macrocode}
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-12 13:26:08 +0000