\ekdmark needed more work for "paired" facing pages. new command \ekdEOprint

2 files changed, 129 insertions, 17 deletions

diff --git a/ekdosis.dtx b/ekdosis.dtx
index 91e2452..5faf7fa 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/01/17 v1.5-dev Typesetting TEI xml-compliant critical editions]
+    [2022/04/20 v1.5-dev Typesetting TEI xml-compliant critical editions]
 %</package>
 %<*driver>
 \begin{filecontents}[noheader,overwrite]{bibdata.xml}
@@ -3321,13 +3321,16 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
 % \underLine{semicolon}-separated list of previously defined
 % environments that shall receive at least one layer of apparatus
 % criticus.\\
-% \DescribeOption{paired} |paired|$=$\verb+true|false+%
+% \DescribeOption{paired} |paired|$=$\verb+true|false+%^^A
+% \phts\label{ref:paired-opt}%^^A
 % \hfill\tcboxverb{Default: true (initially not set)}\\
 % This named argument does not need a value as it defaults to |true|
 % if used. By default, \pkg{ekdosis} follows the \LaTeX{} page
 % numbering scheme when multiple texts are arranged on facing
 % pages. The |paired| option leaves every right-hand page number
-% unchanged, so that both facing pages hold the same page number.\\
+% unchanged, so that both facing pages hold the same page
+% number.\footnote{For setting headers and footers in this arrangement
+% of text, see \vpageref{sec:header-paired-pages}.}\\
 % \DescribeOption{lineation} |lineation|$=$\verb+page|document+
 % \hfill\tcboxverb{Default: document}\\
 % This option applies to edition texts initially set to receive an
@@ -5904,6 +5907,50 @@ subtype="arabtex">'inna 'abI kAna mina
 %</example>
 % \fi
 %
+% \paragraph{\enquote{Paired} facing pages}
+% \phts\label{sec:header-paired-pages}
+% As already described \vpageref{ref:paired-opt}\===the
+% \textooquote|paired|\textcoquote\ option\===\pkg{ekdosis} can
+% arrange texts on facing pages with every right-hand page number
+% unchanged, so that both facing pages hold the same number, as in the
+% \enquote{Budé} series. As a result of this layout, the distinction
+% between left- and right-hand pages does not apply and headers and
+% footers have to be set as if the whole edition text and the
+% translation were intended for single-sided printing. To return to
+% the example just given, the three optional arguments of \cs{sethead}
+% are inoperative, as are the symbolic letters |E| and |O| of
+% \cs{ekdprintmark}. Both letters must be omitted, which boils down to
+% using the following six selectors, instead of twelve: |HL|, |HC|,
+% |HR|, |FL|, |FC| and |FR|.
+%
+% \DescribeMacro{\ekdEOprint}\newfeature[v1.5] Finally, to make up for
+% commands and arguments designed to set headers and footers on
+% left-hand pages, \pkg{ekdosis} provides \cs{ekdEOprint}. This
+% command accepts two mandatory, self-evident arguments, like so:
+% \cs{ekdEOprint}\marg{left-hand mark}\marg{right-hand mark}.
+%
+% As an illustration, the example provided above would read as follows
+% for editions laid out on \enquote{paired} facing pages:---
+%
+% \iffalse
+%<*example>
+% \fi
+\begin{minted}[linenos=false]{latex}
+% Preamble:
+\usepackage{titleps}
+\newpagestyle{edition}{
+  \sethead{\ekdprintmark{HL}{\ekdEOprint{\thepage}{}}}
+          {\ekdprintmark{HC}{\ekdEOprint{Hippocratis}{%
+            Epidemiarum liber II, \ekdmark}}}
+          {\ekdprintmark{HR}{\ekdEOprint{}{\thepage}}}
+}
+% Apply the page style:
+\pagestyle{edition}
+\end{minted}
+% \iffalse
+%</example>
+% \fi
+%
 % \DescribeMacro{\ekdnohfmarks} Once all signposts are marked with
 % \cs{ekdprintmark}, \cs{ekdnohfmarks} can be used at any point of the
 % document with the same effect as the \LaTeX\ standard command
@@ -8063,7 +8110,7 @@ Sample text with a \textcolor{red}{word} in red.
 %    \end{macrocode}
 % \paragraph{\textsf{ekdosis} Symbol}
 % \begin{macro}{\eKd}
-% \changes{v1.5}{2022/01/17}{Prints \textsf{ekdosis} indentifying
+% \changes{v1.5}{2022/04/20}{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.
@@ -8324,7 +8371,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/01/17}{direct insertion of empty elements in the
+% \changes{v1.5}{2022/04/20}{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
@@ -8339,7 +8386,7 @@ Sample text with a \textcolor{red}{word} in red.
 % \end{macro}
 % \end{macro}
 % \begin{macro}{\getTEIxmlid}
-% \changes{v1.5}{2022/01/17}{returns \texttt{TEI xml:ids} from a
+% \changes{v1.5}{2022/04/20}{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
@@ -9915,7 +9962,7 @@ Sample text with a \textcolor{red}{word} in red.
 % \end{macro}
 % \paragraph{Lacunae}
 % \begin{macro}{\ilabel}
-% \changes{v1.5}{2022/01/17}{recalls and sets the ending label of
+% \changes{v1.5}{2022/04/20}{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
@@ -10159,14 +10206,18 @@ Sample text with a \textcolor{red}{word} in red.
 % \begin{macro}{\ekdprintmark}
 % \changes{v1.3}{2021/08/18}{prints or removes the marks in headers
 % and footers} \cs{ekdprintmark}\marg{selector}\marg{signpost} The
-% signposts printed in headers and footers must be 
-% passed as second argument of \cs{ekdprintmark} so that \pkg{ekdosis}
-% can remove them on pages where printing them is not
-% desirable. \meta{selector} refers to three symbolic letters where
-% the first can be either |H| or |F|\===for \underLine{h}eader or
+% signposts printed in headers and footers must be passed as second
+% argument of \cs{ekdprintmark} so that \pkg{ekdosis} can remove
+% them on pages where printing them is not desirable. \meta{selector}
+% refers to three possible symbolic letters where the first can be
+% either |H| or |F|\===for \underLine{h}eader or
 % \underLine{f}ooter\===, the second |E| or |O|\===for \underLine{o}dd
 % or \underLine{e}ven\===and the third |L|, |C| or |R|\===for
-% \underLine{l}eft, \underLine{c}enter or \underLine{r}ight:---
+% \underLine{l}eft, \underLine{c}enter or \underLine{r}ight. When
+% critical editions are layed out on \enquote{paired} facing pages as
+% described above \vpageref{ref:paired-opt}, the second letter, |E| or
+% |O|, must obviously be omitted for headers and footers are the same
+% on every facing page:---
 %    \begin{macrocode}
 \ekvdefinekeys{ekd@marks}{
   choice mark = {HEL = \def\ekd@mk{HEL},
@@ -10185,13 +10236,59 @@ Sample text with a \textcolor{red}{word} in red.
     must be either `HEL', `HEC', `HER', `HOL', `HOC', `HOR', `FEL', 
     \MessageBreak `FEC', `FER', `FOL', `FOC' or `FOR'.}
 }
-\NewDocumentCommand{\ekdprintmark}{m m}{%
+\NewDocumentCommand{\ekd@printmark}{m m}{%
   \bgroup
   \ekvset{ekd@marks}{mark = #1}%
   \luadirect{tex.sprint(ekdosis.printmark(\luastringN{#2},
     \luastringO{\ekd@mk}))}%
   \egroup
 }
+\NewDocumentCommand{\ekdprintmark}{m m}{%
+  \def\@tempa{#1}%
+  \def\mk@HL{HL}\def\mk@HC{HC}\def\mk@HR{HR}%
+  \def\mk@FL{FL}\def\mk@FC{FC}\def\mk@FR{FR}%
+  \ifx\@tempa\mk@HL
+    \csname ekd@printmark\endcsname{HEL}{\csname
+      ekd@printmark\endcsname{HOL}{#2}}%
+  \else
+  \ifx\@tempa\mk@HC
+    \csname ekd@printmark\endcsname{HEC}{\csname
+      ekd@printmark\endcsname{HOC}{#2}}%
+  \else
+  \ifx\@tempa\mk@HR
+    \csname ekd@printmark\endcsname{HER}{\csname
+      ekd@printmark\endcsname{HOR}{#2}}%
+  \else
+  \ifx\@tempa\mk@FL
+    \csname ekd@printmark\endcsname{FEL}{\csname
+      ekd@printmark\endcsname{FOL}{#2}}%
+  \else
+  \ifx\@tempa\mk@FC
+    \csname ekd@printmark\endcsname{FEC}{\csname
+      ekd@printmark\endcsname{FOC}{#2}}%
+  \else
+  \ifx\@tempa\mk@FR
+    \csname ekd@printmark\endcsname{FER}{\csname
+      ekd@printmark\endcsname{FOR}{#2}}%
+  \else
+    \csname ekd@printmark\endcsname{#1}{#2}%
+  \fi\fi\fi\fi\fi\fi
+}
+%    \end{macrocode}
+% \end{macro}
+% \begin{macro}{\ekdEOprint}
+% \changes{v1.5}{2022/04/20}{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
+% so: \cs{ekdEOprint}\marg{left-hand mark}\marg{right-hand mark}. This
+% command uses the zero-based |abspage| counter provided by
+% \pkg{zref-abspage}. So if the number returned by this counter is
+% odd, it falls on a left-hand page:---
+%    \begin{macrocode}
+\NewDocumentCommand{\ekdEOprint}{m m}{%
+  \ifnumodd{\theabspage}{#1}{#2}%
+}
 %    \end{macrocode}
 % \end{macro}
 % \begin{macro}{\ekdnofhmarks}
@@ -10200,7 +10297,7 @@ Sample text with a \textcolor{red}{word} in red.
 % \cs{ekdnohfmarks} has the same effect as the \LaTeX\ standard
 % command \cs{thispagestyle}|{empty}|.
 %    \begin{macrocode}
-\NewDocumentCommand{\ekdnohfmark}{}{%
+\NewDocumentCommand{\ekdnohfmarks}{}{%
   \luadirect{ekdosis.nohfmark()}%
 }
 %    \end{macrocode}
@@ -11670,7 +11767,20 @@ function ekdosis.gethfmark(page)
    then
       return hfmarks[indexpage].mark
    else
-      return hfmarks[#hfmarks-1].mark or ""
+      if page > hfmarks[#hfmarks].a
+      then
+         return hfmarks[#hfmarks].mark
+      else
+         for i=1,#hfmarks
+         do
+            if hfmarks[i].a > page
+            then
+               idfound = i
+               break
+            end
+         end
+         return hfmarks[idfound-1].mark or ""
+      end
    end
 end
 
diff --git a/ekdosis.el b/ekdosis.el
index e9fb8a7..f2fa1e7 100644
--- a/ekdosis.el
+++ b/ekdosis.el
@@ -386,8 +386,10 @@
       (TeX-arg-eval completing-read
                     (TeX-argument-prompt nil nil "selector")
                     '("HEL" "HEC" "HER" "HOL" "HOC" "HOR"
-                      "FEL" "FEC" "FER" "FOL" "FOC" "FOR"))
+                      "FEL" "FEC" "FER" "FOL" "FOC" "FOR"
+                      "HL" "HC" "HR" "FL" "FC" "FR"))
       "signpost" 0 )
+    '("ekdEOprint" "even page" "odd page" 0)
     '("ekdnohfmark" 0)
     '("ekdresethfmarks" 0)
     '("ekdpb" [ "page number" ] "line number" 0)