aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile4
-rw-r--r--ekdosis.dtx88
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
33 @ echo "Build the documentation of $(NAME)..." 33 @ echo "Build the documentation of $(NAME)..."
34 $(CMP) --shell-escape --recorder --interaction=batchmode $(NAME).dtx >/dev/null 34 $(CMP) --shell-escape --recorder --interaction=batchmode $(NAME).dtx >/dev/null
35 biber $(NAME) >/dev/null 35 biber $(NAME) >/dev/null
36 if [ -f $(NAME).glo ]; then makeindex -q -s gglo.ist -o $(NAME).gls $(NAME).glo; fi
37 if [ -f $(NAME).idx ]; then makeindex -q -s gind.ist -o $(NAME).ind $(NAME).idx; fi
38 $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null 36 $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
39 $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null 37 $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
40 $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null 38 $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
41 $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null 39 $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
40 if [ -f $(NAME).glo ]; then makeindex -q -s gglo.ist -o $(NAME).gls $(NAME).glo; fi
41 if [ -f $(NAME).idx ]; then makeindex -q -s gind.ist -o $(NAME).ind $(NAME).idx; fi
42 $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null 42 $(CMP) --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
43 43
44samples: clean sty 44samples: 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
851% or later hands, \emph{\&c.}) or abbreviated last names of scholars. 851% or later hands, \emph{\&c.}) or abbreviated last names of scholars.
852% To that effect, \pkg{ekdosis} provides the following preamble-only 852% To that effect, \pkg{ekdosis} provides the following preamble-only
853% commands:--- 853% commands:---
854% \begin{comment}
855% \begin{xltabular}[c]{0.4\linewidth}{lXr}
856% \caption*{\textbf{Conspectus Siglorum}}\\
857% \SigLine{M}\\
858% \end{xltabular}
859% \end{comment}
860% 854%
861% \paragraph{Witnesses} 855% \paragraph{Witnesses}
862% \DescribeMacro{\DeclareWitness} \cs{DeclareWitness}\marg{unique 856% \DescribeMacro{\DeclareWitness} \cs{DeclareWitness}\marg{unique
863% id}\marg{rendition}\marg{description}\oarg{options}\\ 857% id}\marg{rendition}\marg{description}\oarg{options}
858% \label{ref:declarewitness}\\
864% This command requires three mandatory arguments enclosed between 859% This command requires three mandatory arguments enclosed between
865% curly braces used to specify consecutively: 860% curly braces used to specify consecutively:
866% \begin{enumerate} 861% \begin{enumerate}
@@ -897,6 +892,7 @@ along with this program. If not, see
897% \DescribeOption{origDate} |origDate|$=$\meta{date}: Any form of date 892% \DescribeOption{origDate} |origDate|$=$\meta{date}: Any form of date
898% used to identify the date of origin for the witness. 893% used to identify the date of origin for the witness.
899% 894%
895% \label{ref:marcianus-b}
900% To take here one example, a witness such as the \emph{Marcianus 896% To take here one example, a witness such as the \emph{Marcianus
901% Graecus}~269, referred to as manuscript \enquote*{M} in the 897% Graecus}~269, referred to as manuscript \enquote*{M} in the
902% editions, which contains sixty treatises from Hippocrates, could be 898% editions, which contains sixty treatises from Hippocrates, could be
@@ -1001,6 +997,7 @@ along with this program. If not, see
1001% \iffalse 997% \iffalse
1002%</example> 998%</example>
1003% \fi 999% \fi
1000% \label{ref:marcianus-e}
1004% 1001%
1005% \paragraph{Shorthands} 1002% \paragraph{Shorthands}
1006% \DescribeMacro{\DeclareShorthand} \cs{DeclareShorthand}\marg{unique 1003% \DescribeMacro{\DeclareShorthand} \cs{DeclareShorthand}\marg{unique
@@ -1070,7 +1067,76 @@ along with this program. If not, see
1070%</example> 1067%</example>
1071% \fi 1068% \fi
1072% \label{sec:declarations-end} 1069% \label{sec:declarations-end}
1073% 1070%
1071% \subsubsection{Printing Formatted Witnesses
1072% --- Conspectus Siglorum}
1073% \label{sec:print-witnesses}
1074% Once witnesses, hands and scholars have been declared, \pkg{ekdosis}
1075% provides two commands to have them printed as declared from their
1076% indentifiers.
1077%
1078% \DescribeMacro{\getsiglum} \cs{getsiglum}\marg{csv list of witnesses
1079% or single witness} behaves exactly as the |wit| optional argument of
1080% \cs{lem} and \cs{rdg} described below on pages~\pageref{ref:lem-wit}
1081% and \pageref{ref:rdg-wit}. From a single identifier or from a
1082% comma-separated list of identifiers, it returns their formatted
1083% counterparts. To return to the example provided
1084% \vpagerefrange{ref:marcianus-b}{ref:marcianus-e}, |\getsiglum{M}|
1085% would return \getsiglum{M}, while |\getsiglum{M1}| would return
1086% \getsiglum{M1}.
1087%
1088% \DescribeMacro{\SigLine} \cs{SigLine}\marg{unique id} returns from
1089% \meta{unique id} used in the first argument of
1090% \cs{DeclareWitness}\footnote{See above
1091% \vpageref{ref:declarewitness}.} a line ready to be inserted in a
1092% table set to print a Conspectus Siglorum with the following items of
1093% information separated by the symbol |&|: the siglum referring to the
1094% witness, the contents of the |description| field and the contents of
1095% the |origDate| field. An example of how one could print the
1096% Conspectus Siglorum of the manuscripts of Caesar's \emph{Gallic War}
1097% from the list provided \vpageref{ref:caesar-bg-sigla} follows:---
1098%
1099% \captof{Conspectus Siglorum of Caesar's \emph{Gallic War}}
1100% \iffalse
1101%<*example>
1102% \fi
1103\begin{minted}[linenos=false]{latex}
1104\begin{xltabular}[c]{0.75\linewidth}{lXl}
1105 \caption*{\textbf{Conspectus siglorum}\label{tab:conspectus-siglorum}}\\
1106 \multicolumn{3}{c}{\emph{Familia} \getsiglum{a}}\\
1107 \SigLine{A}\\
1108 & \getsiglum{A1} \emph{Emendationes scribae ipsius} & \\
1109 \SigLine{M}\\
1110 [...]
1111 \SigLine{N}\\
1112 \multicolumn{3}{c}{\emph{Familia} \getsiglum{b}}\\
1113 \SigLine{T}\\
1114 [...]
1115 \SigLine{l}\\
1116\end{xltabular}
1117\end{minted}
1118% \iffalse
1119%</example>
1120% \fi
1121%
1122% \begin{xltabular}[c]{0.75\linewidth}{lXl}
1123% \caption*{\textbf{Conspectus siglorum}\label{tab:conspectus-siglorum}}\\
1124% \multicolumn{3}{c}{\emph{Familia} \getsiglum{ca}}\\
1125% \SigLine{cA}\\
1126% & \getsiglum{cA1} \emph{Emendationes scribae ipsius} & \\
1127% \SigLine{cM}\\
1128% \SigLine{cB}\\
1129% \SigLine{cR}\\
1130% \SigLine{cS}\\
1131% \SigLine{cL}\\
1132% \SigLine{cN}\\
1133% \multicolumn{3}{c}{\emph{Familia} \getsiglum{cb}}\\
1134% \SigLine{cT}\\
1135% \SigLine{cf}\\
1136% \SigLine{cU}\\
1137% \SigLine{cl}\\
1138% \end{xltabular}
1139%
1074% \subsection{Editing a Single Text With No Translation} 1140% \subsection{Editing a Single Text With No Translation}
1075% \label{sec:single-text-editing} 1141% \label{sec:single-text-editing}
1076% \DescribeEnv{ekdosis} 1142% \DescribeEnv{ekdosis}
@@ -1150,7 +1216,8 @@ yesterday.
1150% entry. \label{ref:lem-opts-b}The optional argument of \cs{lem} 1216% entry. \label{ref:lem-opts-b}The optional argument of \cs{lem}
1151% accepts the following 1217% accepts the following
1152% comma-separated list of \enquote{name$=$value} arguments:---\\ 1218% comma-separated list of \enquote{name$=$value} arguments:---\\
1153% \DescribeOption{wit} |wit|$=$\meta{csv list of witnesses}\\ 1219% \DescribeOption{wit} |wit|$=$\meta{csv list of
1220% witnesses}\label{ref:lem-wit}\\
1154% While a single witness may be recorded as in |wit=A|, 1221% While a single witness may be recorded as in |wit=A|,
1155% comma-separated lists of multiple witnesses must obviously be 1222% comma-separated lists of multiple witnesses must obviously be
1156% enclosed in curly braces, like so: 1223% enclosed in curly braces, like so:
@@ -1217,7 +1284,8 @@ yesterday.
1217% differences. The reader is invited to refer to the description 1284% differences. The reader is invited to refer to the description
1218% provided above \vpagerefrange{ref:lem-opts-b}{ref:lem-opts-e} for 1285% provided above \vpagerefrange{ref:lem-opts-b}{ref:lem-opts-e} for
1219% more detailed information:---\\ 1286% more detailed information:---\\
1220% \DescribeOption{wit} |wit|$=$\meta{csv list of witnesses}\\ 1287% \DescribeOption{wit} |wit|$=$\meta{csv list of
1288% witnesses}\label{ref:rdg-wit}\\
1221% \DescribeOption{alt} |alt|$=$\meta{alternate reading}\\ 1289% \DescribeOption{alt} |alt|$=$\meta{alternate reading}\\
1222% \DescribeOption{nordg} |nordg|$=$\verb+true|false+\\ 1290% \DescribeOption{nordg} |nordg|$=$\verb+true|false+\\
1223% This named argument does not need a value as it defaults to |true| 1291% This named argument does not need a value as it defaults to |true|