aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ekdosis.dtx79
1 files changed, 69 insertions, 10 deletions
diff --git a/ekdosis.dtx b/ekdosis.dtx
index 0fc51ae..620fc2b 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -2599,11 +2599,14 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
2599% indentation of one em. 2599% indentation of one em.
2600% 2600%
2601% \DescribeMacro{\SetEndApparatus} 2601% \DescribeMacro{\SetEndApparatus}
2602% \label{ref:setendapparatus}
2602% \cs{SetEndApparatus}\marg{characters} can be used to append 2603% \cs{SetEndApparatus}\marg{characters} can be used to append
2603% \meta{characters} at the end of the apparatus block. By default, 2604% \meta{characters} at the end of the apparatus block. By default,
2604% nothing is appended. As an example of use, |\SetEndApparatus{.}| 2605% nothing is appended. \label{ref:ending-dot}As an example of use,
2605% will have a period printed at the end of the apparatus as it is 2606% |\SetEndApparatus{.}| will have a period printed at the end of the
2606% customary in some editions. 2607% apparatus as it is customary in some
2608% editions.\footnote{\label{fn:rm-dots}See also below
2609% \vpageref{sec:superfluous-dots} on how to remove superfluous dots.}
2607% 2610%
2608% \DescribeMacro{\SetUnitDelimiter} 2611% \DescribeMacro{\SetUnitDelimiter}
2609% \cs{SetUnitDelimiter}\marg{delimiter} can be used to set the 2612% \cs{SetUnitDelimiter}\marg{delimiter} can be used to set the
@@ -2644,7 +2647,8 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
2644% apparatus block.\\ 2647% apparatus block.\\
2645% \DescribeOption{ehook} |ehook|$=$\meta{characters} 2648% \DescribeOption{ehook} |ehook|$=$\meta{characters}
2646% \hfill\tcboxverb{Default: empty}\\ 2649% \hfill\tcboxverb{Default: empty}\\
2647% The characters to be appended at the end of the apparatus block.\\ 2650% The characters to be appended at the end of the apparatus
2651% block.\footnote{See also n.~\vref{fn:rm-dots}.}\\
2648% \DescribeOption{rule} |rule|$=$\meta{command}\verb+|+|none| 2652% \DescribeOption{rule} |rule|$=$\meta{command}\verb+|+|none|
2649% \hfill\tcboxverb{Default: \rule{0.4\columnwidth}{0.4pt}}\\ 2653% \hfill\tcboxverb{Default: \rule{0.4\columnwidth}{0.4pt}}\\
2650% As described above, |rule| is used to draw the separating line 2654% As described above, |rule| is used to draw the separating line
@@ -3836,8 +3840,8 @@ subtype="arabtex">'inna 'abI kAna mina
3836% run a test is performed on this auxliary file to determine whether 3840% run a test is performed on this auxliary file to determine whether
3837% there are entries\---and if so, which ones\---to be printed on the 3841% there are entries\---and if so, which ones\---to be printed on the
3838% current page. At the same time, references to the line numbers are 3842% current page. At the same time, references to the line numbers are
3839% updated if necessary. Then, on the third run, the apparatus criticus 3843% updated if necessary. Finally, on the third run, the apparatus
3840% is printed. 3844% criticus is printed.
3841% 3845%
3842% Of course, every change made to the input may similarly require 3846% Of course, every change made to the input may similarly require
3843% \hologo{LuaLaTeX} to be run three more times to get everything to 3847% \hologo{LuaLaTeX} to be run three more times to get everything to
@@ -3879,10 +3883,10 @@ subtype="arabtex">'inna 'abI kAna mina
3879% vertical spaces may come between the edition text and the apparatus 3883% vertical spaces may come between the edition text and the apparatus
3880% criticus. Conversely, |maxentries| must not be too big: otherwise, 3884% criticus. Conversely, |maxentries| must not be too big: otherwise,
3881% should entries overflow on a given page, the edition text and the 3885% should entries overflow on a given page, the edition text and the
3882% apparatus criticus may clash. As said above, a couple of clashes can 3886% apparatus criticus may clash again. As said above, a couple of
3883% be managed with a couple of manually inserted page breaks. But if 3887% clashes can be managed with a couple of manually inserted page
3884% there are too many ot them, it is a good indication that the 3888% breaks. But if there are too many ot them, it is a good indication
3885% selected value of |maxentries| is too to high. 3889% that the selected value of |maxentries| is too to high.
3886% 3890%
3887% Complex edition texts do have a magic number. An advisable way to 3891% Complex edition texts do have a magic number. An advisable way to
3888% figure it out would be to start from a sample of only a few pages, 3892% figure it out would be to start from a sample of only a few pages,
@@ -3913,6 +3917,61 @@ subtype="arabtex">'inna 'abI kAna mina
3913% many of them and \pkg{ekdosis} still oscillates between different 3917% many of them and \pkg{ekdosis} still oscillates between different
3914% sets of page decisions. 3918% sets of page decisions.
3915% 3919%
3920% \subsection{Variae Quaestiones}
3921% \label{sec:variae-quaestiones}
3922% This section is about issues that are not strictly speaking part of
3923% the documentation of \pkg{ekdosis} but may nevertheless
3924% circumstancially arise.
3925%
3926% \paragraph{Superfluous Dots}
3927% \label{sec:superfluous-dots}
3928% As said above \vpageref{ref:ending-dot}, it is customary in some
3929% editions to have a full stop printed at the end of the apparatus
3930% criticus. \pkg{ekdosis} provides specific commands to achieve this
3931% in a straightforward way, such as \cs{SetEndApparatus} and the
3932% |ehook| optional argument of \cs{SetApparatus} and
3933% \cs{DeclareApparatus}.\footnote{See above on pages
3934% \pageref{ref:setendapparatus}, \pageref{ref:apparatus-settings-b}
3935% and \pageref{sec:declaring-layers} respectively.} However, if the
3936% last word of the apparatus criticus on a given page be an
3937% abbreviation followed by a dot, such a setting will have two dots
3938% printed at the end of the apparatus instead of one. The solution is
3939% to define a command to have a dot printed only if it is not followed
3940% by a dot, and append this command to the abbreviated form of the
3941% word, like so:---
3942%
3943% \iffalse
3944%<*example>
3945% \fi
3946\begin{minted}{latex}
3947% Preamble:
3948\usepackage{xspace}
3949\usepackage{ekdosis}
3950
3951\makeatletter
3952\newcommand{\ekddot}{%
3953 \ltx@ifnextchar{.}{\xspace}{.\xspace}}
3954\makeatother
3955
3956\DeclareApparatus{default}[ehook=.]
3957\DeclareScholar{Erm}{Erm\ekddot}
3958\end{minted}
3959% \iffalse
3960%</example>
3961% \fi
3962%
3963% \begin{remarks}
3964% \item Line~2: The \pkg{xspace} package is needed for \cs{xspace} is
3965% used by the \cs{ekddot} command that is defined at l.~6.
3966% \item Line~7: \cs{ltx@ifnextchar} is part of the \pkg{ltxcmds}
3967% package which is loaded by \pkg{ekdosis}. As this command uses a
3968% private control sequence, it must be found within
3969% \cs{makeatletter} \dots\ \cs{makeatother}.
3970% \item Line~10: \cs{ekddot} will only work with multiple-layer
3971% apparatus criticus. Therefore, \cs{DeclareAppa{\allowbreak}ratus}
3972% must be used even if only one layer of critical notes is needed.
3973% \end{remarks}
3974%
3916% \section{\texttt{TEI xml} Output} 3975% \section{\texttt{TEI xml} Output}
3917% \label{sec:teixml-output} 3976% \label{sec:teixml-output}
3918% Several examples of \texttt{TEI xml} output have been provided 3977% Several examples of \texttt{TEI xml} output have been provided