defer makeindex. documented \getsiglum and \SigLine

2 files changed, 80 insertions, 12 deletions

diff --git a/Makefile b/Makefile
index fc30a49..1026fae 100644
--- a/Makefile
+++ b/Makefile
@@ -33,12 +33,12 @@ $(NAME).pdf: $(NAME).dtx
         @ echo "Build the documentation of $(NAME)..."
         $(CMP) --shell-escape --recorder --interaction=batchmode $(NAME).dtx >/dev/null
         biber $(NAME) >/dev/null
-        if [ -f $(NAME).glo ]; then makeindex -q -s gglo.ist -o $(NAME).gls $(NAME).glo; fi
-        if [ -f $(NAME).idx ]; then makeindex -q -s gind.ist -o $(NAME).ind $(NAME).idx; fi
         $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
         $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
         $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
         $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
+        if [ -f $(NAME).glo ]; then makeindex -q -s gglo.ist -o $(NAME).gls $(NAME).glo; fi
+        if [ -f $(NAME).idx ]; then makeindex -q -s gind.ist -o $(NAME).ind $(NAME).idx; fi
         $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
 
 samples: clean sty
diff --git a/ekdosis.dtx b/ekdosis.dtx
index 8a84659..67e402c 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -851,16 +851,11 @@ along with this program.  If not, see
 % or later hands, \emph{\&c.}) or abbreviated last names of scholars.
 % To that effect, \pkg{ekdosis} provides the following preamble-only
 % commands:---
-% \begin{comment}
-%   \begin{xltabular}[c]{0.4\linewidth}{lXr}
-%     \caption*{\textbf{Conspectus Siglorum}}\\
-%     \SigLine{M}\\
-% \end{xltabular}
-% \end{comment}
 % 
 % \paragraph{Witnesses}
 % \DescribeMacro{\DeclareWitness} \cs{DeclareWitness}\marg{unique
-% id}\marg{rendition}\marg{description}\oarg{options}\\
+% id}\marg{rendition}\marg{description}\oarg{options}
+% \label{ref:declarewitness}\\
 % This command requires three mandatory arguments enclosed between
 % curly braces used to specify consecutively:
 % \begin{enumerate}
@@ -897,6 +892,7 @@ along with this program.  If not, see
 % \DescribeOption{origDate} |origDate|$=$\meta{date}: Any form of date
 % used to identify the date of origin for the witness.
 %
+% \label{ref:marcianus-b}
 % To take here one example, a witness such as the \emph{Marcianus
 % Graecus}~269, referred to as manuscript \enquote*{M} in the
 % editions, which contains sixty treatises from Hippocrates, could be
@@ -1001,6 +997,7 @@ along with this program.  If not, see
 % \iffalse
 %</example>
 % \fi
+% \label{ref:marcianus-e}
 %
 % \paragraph{Shorthands}
 % \DescribeMacro{\DeclareShorthand} \cs{DeclareShorthand}\marg{unique
@@ -1070,7 +1067,76 @@ along with this program.  If not, see
 %</example>
 % \fi
 % \label{sec:declarations-end}
-% 
+%
+% \subsubsection{Printing Formatted Witnesses
+% --- Conspectus Siglorum}
+% \label{sec:print-witnesses}
+% Once witnesses, hands and scholars have been declared, \pkg{ekdosis}
+% provides two commands to have them printed as declared from their
+% indentifiers.
+%
+% \DescribeMacro{\getsiglum} \cs{getsiglum}\marg{csv list of witnesses
+% or single witness} behaves exactly as the |wit| optional argument of
+% \cs{lem} and \cs{rdg} described below on pages~\pageref{ref:lem-wit}
+% and \pageref{ref:rdg-wit}. From a single identifier or from a
+% comma-separated list of identifiers, it returns their formatted
+% counterparts. To return to the example provided
+% \vpagerefrange{ref:marcianus-b}{ref:marcianus-e}, |\getsiglum{M}|
+% would return \getsiglum{M}, while |\getsiglum{M1}| would return
+% \getsiglum{M1}.
+%
+% \DescribeMacro{\SigLine} \cs{SigLine}\marg{unique id} returns from
+% \meta{unique id} used in the first argument of
+% \cs{DeclareWitness}\footnote{See above
+% \vpageref{ref:declarewitness}.} a line ready to be inserted in a
+% table set to print a Conspectus Siglorum with the following items of
+% information separated by the symbol |&|: the siglum referring to the
+% witness, the contents of the |description| field and the contents of
+% the |origDate| field. An example of how one could print the
+% Conspectus Siglorum of the manuscripts of Caesar's \emph{Gallic War}
+% from the list provided \vpageref{ref:caesar-bg-sigla} follows:---
+%
+% \captof{Conspectus Siglorum of Caesar's \emph{Gallic War}}
+% \iffalse
+%<*example>
+% \fi
+\begin{minted}[linenos=false]{latex}
+\begin{xltabular}[c]{0.75\linewidth}{lXl}
+  \caption*{\textbf{Conspectus siglorum}\label{tab:conspectus-siglorum}}\\
+  \multicolumn{3}{c}{\emph{Familia} \getsiglum{a}}\\
+  \SigLine{A}\\
+  & \getsiglum{A1} \emph{Emendationes scribae ipsius} & \\
+  \SigLine{M}\\
+  [...]
+  \SigLine{N}\\
+  \multicolumn{3}{c}{\emph{Familia} \getsiglum{b}}\\
+  \SigLine{T}\\
+  [...]
+  \SigLine{l}\\
+\end{xltabular}
+\end{minted}
+% \iffalse
+%</example>
+% \fi
+%
+% \begin{xltabular}[c]{0.75\linewidth}{lXl}
+%   \caption*{\textbf{Conspectus siglorum}\label{tab:conspectus-siglorum}}\\
+%   \multicolumn{3}{c}{\emph{Familia} \getsiglum{ca}}\\
+%   \SigLine{cA}\\
+%   & \getsiglum{cA1} \emph{Emendationes scribae ipsius} & \\
+%   \SigLine{cM}\\
+%   \SigLine{cB}\\
+%   \SigLine{cR}\\
+%   \SigLine{cS}\\
+%   \SigLine{cL}\\
+%   \SigLine{cN}\\
+%   \multicolumn{3}{c}{\emph{Familia} \getsiglum{cb}}\\
+%   \SigLine{cT}\\
+%   \SigLine{cf}\\
+%   \SigLine{cU}\\
+%   \SigLine{cl}\\
+% \end{xltabular}
+%
 % \subsection{Editing a Single Text With No Translation}
 % \label{sec:single-text-editing}
 % \DescribeEnv{ekdosis}
@@ -1150,7 +1216,8 @@ yesterday.
 % entry. \label{ref:lem-opts-b}The optional argument of \cs{lem}
 % accepts the following
 % comma-separated list of \enquote{name$=$value} arguments:---\\
-% \DescribeOption{wit} |wit|$=$\meta{csv list of witnesses}\\
+% \DescribeOption{wit} |wit|$=$\meta{csv list of
+% witnesses}\label{ref:lem-wit}\\
 % While a single witness may be recorded as in |wit=A|,
 % comma-separated lists of multiple witnesses must obviously be
 % enclosed in curly braces, like so:
@@ -1217,7 +1284,8 @@ yesterday.
 % differences. The reader is invited to refer to the description
 % provided above \vpagerefrange{ref:lem-opts-b}{ref:lem-opts-e} for
 % more detailed information:---\\
-% \DescribeOption{wit} |wit|$=$\meta{csv list of witnesses}\\
+% \DescribeOption{wit} |wit|$=$\meta{csv list of
+% witnesses}\label{ref:rdg-wit}\\
 % \DescribeOption{alt} |alt|$=$\meta{alternate reading}\\
 % \DescribeOption{nordg} |nordg|$=$\verb+true|false+\\
 % This named argument does not need a value as it defaults to |true|