more detailed documentation about \setpairedpage

1 files changed, 23 insertions, 17 deletions

diff --git a/ekdosis.dtx b/ekdosis.dtx
index f9c3584..77bc273 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -61,7 +61,7 @@ along with this program.  If not, see
 %<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
 %<package>\ProvidesPackage{ekdosis}
 %<*package>
-    [2022/05/01 v1.5-dev Typesetting TEI xml-compliant critical editions]
+    [2022/05/04 v1.5-dev Typesetting TEI xml-compliant critical editions]
 %</package>
 %<*driver>
 \begin{filecontents}[noheader,overwrite]{bibdata.xml}
@@ -5983,21 +5983,23 @@ subtype="arabtex">'inna 'abI kAna mina
 % \DescribeMacro{\setpairedpage} \cs{setpairedpage} is provided to set
 % mirrored paired facing pages. This command takes no argument and is
 % meant to be issued in commands used to set headers and footers on
-% both sides, \emph{before} \cs{thepage} is called, like so:---
+% both sides, \emph{before any call} of the commands \cs{thepage} or
+% \cs{ekdmark}, like so:---
 %
 % \iffalse
 %<*example>
 % \fi
-\begin{minted}[linenos=false,highlightlines={4,9}]{latex}
+\begin{minted}[linenos,highlightlines={4,8-10}, escapeinside=++]{latex}
 % Preamble:
 \usepackage{titleps}
 \newpagestyle{edition}{
-  \sethead[\setpairedpage\ekdprintmark{HEL}{\thepage}]
+  \sethead[\setpairedpage\ekdprintmark{HEL}{\thepage}]+\label{ln:ekdpp:i}+
           [\ekdprintmark{HEC}{Hippocratis}]
           []
           {}
-          {\ekdprintmark{HOC}{Epidemiarum liber II, \ekdmark}}
-          {\setpairedpage\ekdprintmark{HOR}{\thepage}}
+          {\setpairedpage\ekdprintmark{HOC}{Epidemiarum liber II,\+\label{ln:ekdpp:ii}+
+              \ekdmark}}
+          {\ekdprintmark{HOR}{\thepage}}\+\label{ln:ekdpp:iii}+
 }
 % Apply the page style:
 \pagestyle{edition}
@@ -6007,10 +6009,14 @@ subtype="arabtex">'inna 'abI kAna mina
 % \fi
 %
 % \begin{remarks}
-% \item As can be seen, \cs{setpairedpage} must be issued
+% \item As can be seen from ll.~\lnref{ln:ekdpp:i} and
+%   \lnref{ln:ekdpp:ii}, \cs{setpairedpage} must be issued
 %   \emph{before} \cs{ekdprintmark} so that it can be processed on
 %   pages where headers and footers are removed by \cs{ekdnohfmarks}
 %   described below.
+% \item Additionally, ll.~\lnref{ln:ekdpp:ii}--\lnref{ln:ekdpp:iii}
+%   show that \cs{setpairedpage} precedes both \cs{ekdprintmark} and
+%   \cs{thepage}.
 % \item If there be no \cs{thepage} in headers or footers,
 %   \cs{setpairedpage} must still be issued once on each side.
 % \end{remarks}
@@ -8220,7 +8226,7 @@ Sample text with a \textcolor{red}{word} in red.
 %    \end{macrocode}
 % \paragraph{\textsf{ekdosis} Symbol}
 % \begin{macro}{\eKd}
-% \changes{v1.5}{2022/05/01}{Prints \textsf{ekdosis} indentifying
+% \changes{v1.5}{2022/05/04}{Prints \textsf{ekdosis} indentifying
 % symbol} As of v1.5, \pkg{ekdosis} has its own identifying
 % symbol. It is produced by \cs{eKd} and best printed with the Old
 % Standard Greek font.
@@ -8481,7 +8487,7 @@ Sample text with a \textcolor{red}{word} in red.
 % \begin{macro}{\teidirectE}
 % \changes{v1.3}{2021/08/18}{direct insertion of elements in the
 % \texttt{TEI xml} file}
-% \changes{v1.5}{2022/05/01}{direct insertion of empty elements in the
+% \changes{v1.5}{2022/05/04}{direct insertion of empty elements in the
 % \texttt{TEI xml} file}
 % \cs{teidirect}\oarg{xml attributes}\marg{xml element}\marg{code}
 % does nothing in \LaTeX. It is only used to insert elements in the
@@ -8496,7 +8502,7 @@ Sample text with a \textcolor{red}{word} in red.
 % \end{macro}
 % \end{macro}
 % \begin{macro}{\getTEIxmlid}
-% \changes{v1.5}{2022/05/01}{returns \texttt{TEI xml:ids} from a
+% \changes{v1.5}{2022/05/04}{returns \texttt{TEI xml:ids} from a
 % csv-list of ids} This command returns from a csv-list of unique
 % identifiers declared in commands such as \cs{DeclareWitness} and the
 % like a space-separated list of their corresponding |xml:id|s, each
@@ -10072,7 +10078,7 @@ Sample text with a \textcolor{red}{word} in red.
 % \end{macro}
 % \paragraph{Lacunae}
 % \begin{macro}{\ilabel}
-% \changes{v1.5}{2022/05/01}{recalls and sets the ending label of
+% \changes{v1.5}{2022/05/04}{recalls and sets the ending label of
 % lemmas used to mark lacunae in witnesses} When \cs{lem} has been
 % used with the optional argument |ilabel=<label>|,
 % \cs{ilabel}\marg{label} must be used to mark the point where the
@@ -10387,7 +10393,7 @@ Sample text with a \textcolor{red}{word} in red.
 %    \end{macrocode}
 % \end{macro}
 % \begin{macro}{\ekdEOprint}
-% \changes{v1.5}{2022/05/01}{Sets headers and footers on
+% \changes{v1.5}{2022/05/04}{Sets headers and footers on
 % \enquote{paired} facing pages}
 % To set headers and footers on \enquote{paired} facing pages,
 % \cs{ekdEOprint} accepts two mandatory, self-evident arguments, like
@@ -10427,7 +10433,7 @@ Sample text with a \textcolor{red}{word} in red.
 % counter to set the value of the page numbers. This counter should be
 % incremented every two pages.
 % \begin{counter}{pairedpage}
-% \changes{v1.5}{2022/05/01}{A counter incremented every two pages}
+% \changes{v1.5}{2022/05/04}{A counter incremented every two pages}
 % |pairedpage| is first set as a global counter:---
 %    \begin{macrocode}
 \newcounter{pairedpage}
@@ -10435,19 +10441,19 @@ Sample text with a \textcolor{red}{word} in red.
 %    \end{macrocode}
 % \end{counter}
 % \begin{macro}{\setpairedpagenum}
-%   \changes{v1.5}{2022/05/01}{sets the same page number on paired
+%   \changes{v1.5}{2022/05/04}{sets the same page number on paired
 %   pages} \cs{setpairedpagenum}\marg{number} is used just ahead of
 %   the alignment environment to set the number of the first left-hand
 %   paired page.
 % \begin{macro}{\setpairedpage}
-%   \changes{v1.5}{2022/05/01}{sets the page number of the first paired
+%   \changes{v1.5}{2022/05/04}{sets the page number of the first paired
 %   page} \cs{setpairedpage} is an argument-less command meant to be
 %   issued in commands used to set headers or footers before
 %   \cs{thepage}. This command has the counter |pairedpage|
 %   incremented on right-hand pages only, and sets |page| $\leftarrow$
 %   |pairedpage| on every page.
 % \begin{macro}{\resetpagenumber}
-%   \changes{v1.5}{2022/05/01}{resets normal running page numbers}
+%   \changes{v1.5}{2022/05/04}{resets normal running page numbers}
 %   \cs{resetpagenumber} must be used right out of \enquote{mirrored}
 %   paired pages alignment environments. This argument-less command
 %   corrects any numbering error on the page following the edition
@@ -10458,7 +10464,7 @@ Sample text with a \textcolor{red}{word} in red.
 }
 \NewDocumentCommand{\setpairedpage}{}{%
   \ifnumodd{\thepage}{\setcounter{page}{\thepairedpage}}
-  {\refstepcounter{pairedpage}\setcounter{page}{\thepairedpage}}%
+  {\stepcounter{pairedpage}\setcounter{page}{\thepairedpage}}%
 }
 \def\resetpagenumber{%
   \ifnumodd{\thepairedpage}{}{\addtocounter{page}{-1}}