aboutsummaryrefslogtreecommitdiff
path: root/ekdosis.dtx
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2020-06-29 19:14:19 +0200
committerRobert Alessi <alessi@robertalessi.net>2020-06-29 19:14:19 +0200
commita77c57e7516c55d0f09581a39c85cef35bef6ee5 (patch)
treee20504c03b1975e481584682dda45cbbbed6fc89 /ekdosis.dtx
parentf33fc352fc0dd9fbc89b07d3ee297158f89957bf (diff)
downloadekdosis-a77c57e7516c55d0f09581a39c85cef35bef6ee5.tar.gz
still documenting (now on alignment)
Diffstat (limited to 'ekdosis.dtx')
-rw-r--r--ekdosis.dtx530
1 files changed, 491 insertions, 39 deletions
diff --git a/ekdosis.dtx b/ekdosis.dtx
index 3713787..c801a59 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -93,6 +93,30 @@ along with this program. If not, see
93 eprint = {hal-02779803} 93 eprint = {hal-02779803}
94} 94}
95 95
96@Book{Caesar-BG-v2,
97 author = {{Caesar}},
98 title = {Gallic War},
99 origtitle = {Guerre des Gaules},
100 date = 1987,
101 origdate = 1926,
102 editor = {Constans, L.-A.},
103 volume = 2,
104 pagination = {none},
105 series = {Collection des Universités de France},
106 publisher = {Les Belles Lettres},
107 location = {Paris}
108}
109
110@Book{CaesarTr,
111 author = {{Caesar}},
112 title = {Gallic War},
113 date = 1869,
114 editor = {McDevitte, W. A., and Bohn, W. S.},
115 edition = 1,
116 series = {Harper's New Classical Library},
117 publisher = {Harper \& Brothers},
118 location = {New York}}
119
96@Online{DLL-TC, 120@Online{DLL-TC,
97 author = {{Digital Latin Library}}, 121 author = {{Digital Latin Library}},
98 title = {Textual Criticism}, 122 title = {Textual Criticism},
@@ -125,8 +149,41 @@ along with this program. If not, see
125 origDate=s. X] 149 origDate=s. X]
126\DeclareHand{M1}{M}{M\textsuperscript{1}}[Emendatio scribae ipsius] 150\DeclareHand{M1}{M}{M\textsuperscript{1}}[Emendatio scribae ipsius]
127\DeclareHand{M2}{M}{M\textsuperscript{2}}[Manus posterior] 151\DeclareHand{M2}{M}{M\textsuperscript{2}}[Manus posterior]
152% Peter and John Story:
128\DeclareWitness{pjA}{A}{Manuscript A Call No 123} 153\DeclareWitness{pjA}{A}{Manuscript A Call No 123}
129\DeclareWitness{pjB}{B}{Manuscript B Call No 456} 154\DeclareWitness{pjB}{B}{Manuscript B Call No 456}
155% Caesar's Gallic War:
156\DeclareWitness{cA}{A}{\emph{Bongarsianus} 81}[
157 msName=\emph{Bongarsianus},
158 settlement=Amsterdam,
159 idno=81,
160 repository=University Library,
161 origDate=s. IX--X]
162\DeclareHand{cA1}{cA}{A\textsuperscript{1}}[\emph{Emendationes
163 scribae ipsius}]
164\DeclareWitness{cM}{M}{\emph{Parisinus Lat.} 5056}[
165 origDate={s. XII}]
166\DeclareWitness{cB}{B}{\emph{Parisinus Lat.} 5763}[
167 origDate={s. IX--X}]
168\DeclareWitness{cR}{R}{\emph{Vaticanus Lat.} 3864}[
169 origDate={s. X}]
170\DeclareWitness{cS}{S}{\emph{Laurentianus} R 33}[
171 origDate={s. X}]
172\DeclareWitness{cL}{L}{\emph{Londinensis} Br. Mus. 10084}[
173 origDate={s. XI}]
174\DeclareWitness{cN}{N}{\emph{Neapolitanus} IV, c. 11}[
175 origDate={s. XII}]
176\DeclareWitness{cT}{T}{\emph{Parisinus Lat.} 5764}[
177 origDate={s. XI}]
178\DeclareWitness{cf}{\emph{f}}{\emph{Vindobonensis} 95}[
179 origDate={s. XII}]
180\DeclareWitness{cU}{U}{\emph{Vaticanus Lat.} 3324}[
181 origDate={s. XI}]
182\DeclareWitness{cl}{\emph{l}}{\emph{Laurentianus} Riccard. 541}[
183 origDate={s. XI--XII}]
184
185\DeclareShorthand{ca}{α}{cA,cM,cB,cR,cS,cL,cN}
186\DeclareShorthand{cb}{β}{cT,cf,cU,cl}
130\end{filecontents} 187\end{filecontents}
131\documentclass{ltxdoc} 188\documentclass{ltxdoc}
132\usepackage[letterpaper,margin=25mm,left=50mm,nohead]{geometry} 189\usepackage[letterpaper,margin=25mm,left=50mm,nohead]{geometry}
@@ -134,7 +191,7 @@ along with this program. If not, see
134\doxitem{Option}{option}{options} 191\doxitem{Option}{option}{options}
135\usepackage{microtype} 192\usepackage{microtype}
136\usepackage[no-math]{fontspec} 193\usepackage[no-math]{fontspec}
137\usepackage[greek.ancient,american]{babel} 194\usepackage[latin.classic,greek.ancient,american]{babel}
138\babelfont{rm}[ 195\babelfont{rm}[
139 SlantedFont={Old Standard}, 196 SlantedFont={Old Standard},
140 SlantedFeatures={FakeSlant=0.25}, 197 SlantedFeatures={FakeSlant=0.25},
@@ -154,17 +211,25 @@ along with this program. If not, see
154\def\sg#1{\textancientgreek{#1}} 211\def\sg#1{\textancientgreek{#1}}
155\usepackage[Old Standard]{mathfont} 212\usepackage[Old Standard]{mathfont}
156\usepackage{arabluatex} 213\usepackage{arabluatex}
157\usepackage[teiexport=tidy]{ekdosis} 214\usepackage[parnotes=roman,teiexport=tidy]{ekdosis}
158\input{ekdosis-cfg} 215\input{ekdosis-cfg}
159\usepackage{xltabular} 216\usepackage{xltabular}
160\usepackage[prevent-all]{widows-and-orphans} 217\usepackage[prevent-all]{widows-and-orphans}
161\usepackage[shortcuts,nospacearound]{extdash} 218\usepackage[shortcuts,nospacearound]{extdash}
162\usepackage[american]{isodate} 219\usepackage[american]{isodate}
220\usepackage{nextpage}
221\usepackage{spacingtricks}
163\usepackage{csquotes} 222\usepackage{csquotes}
223\usepackage{relsize}
164\usepackage{enumitem} 224\usepackage{enumitem}
165\setlist{nosep} 225\setlist{nosep}
166\setlist[itemize]{label=\textendash} 226\setlist[itemize]{label=\textendash}
167\setlist[enumerate,1]{label=(\alph*)} 227\setlist[enumerate,1]{label=(\alph*)}
228\newlist{remarks}{enumerate}{10}
229\setlist[remarks]{
230 label*=\textsc{Rem.} \arabic*,
231 left=0.25in,
232 before=\smaller}
168\usepackage{manfnt} 233\usepackage{manfnt}
169\usepackage{lettrine} 234\usepackage{lettrine}
170\newcommand\danger{\lettrine[loversize=-.5]{\textdbend}{\hskip6pt}} 235\newcommand\danger{\lettrine[loversize=-.5]{\textdbend}{\hskip6pt}}
@@ -189,6 +254,8 @@ along with this program. If not, see
189\labelformat{subsection}{sect.~#1} 254\labelformat{subsection}{sect.~#1}
190\labelformat{subsubsection}{sect.~#1} 255\labelformat{subsubsection}{sect.~#1}
191\labelformat{figure}{fig.~#1} 256\labelformat{figure}{fig.~#1}
257\newcounter{dummy}
258\newcommand{\dummy}{\refstepcounter{dummy}}
192\usepackage[nospace,american]{varioref} 259\usepackage[nospace,american]{varioref}
193\usepackage[style=ext-verbose-inote]{biblatex} 260\usepackage[style=ext-verbose-inote]{biblatex}
194\usepackage[symbolpackage=tikz]{biblatex-ext-oa} 261\usepackage[symbolpackage=tikz]{biblatex-ext-oa}
@@ -263,28 +330,28 @@ along with this program. If not, see
263\renewcommand\cftlolprehook{\begin{multicols}{2}} 330\renewcommand\cftlolprehook{\begin{multicols}{2}}
264\renewcommand\cftlolposthook{\end{multicols}} 331\renewcommand\cftlolposthook{\end{multicols}}
265\renewcommand\cftloltitlefont{\Large\bfseries} 332\renewcommand\cftloltitlefont{\Large\bfseries}
266\usepackage{relsize}
267\usepackage{units} 333\usepackage{units}
334\newcommand*\tred[1]{\textcolor{red}{#1}}
268\usepackage{fbox} 335\usepackage{fbox}
269\usepackage{tikz} 336\usepackage{tikz}
270\usetikzlibrary{tikzmark} 337\usetikzlibrary{tikzmark}
271\NewDocumentCommand{\pointto}{m}{% 338\NewDocumentCommand{\pointto}{m}{%
272 \tikz[remember picture] \draw[>->,color=blue,overlay] (1em,0.5ex) to 339 \tikz[remember picture] \draw[>->,color=blue,overlay] (0em,0.5ex) to
273 ([shift={(0.5em,0pt)}]pic cs:#1);% 340 ([shift={(0.5em,0pt)}]pic cs:#1);%
274 \tikz[remember picture] \draw[color=gray, overlay] 341 \tikz[remember picture] \draw[color=gray, overlay]
275 ([shift={(0.5em,0.5ex)}]pic cs:#1) circle [radius=8pt];} 342 ([shift={(0.5em,0.5ex)}]pic cs:#1) circle [radius=8pt];}
276\NewDocumentCommand{\pointtor}{m}{% 343\NewDocumentCommand{\pointtol}{m}{%
277 \tikz[remember picture] \draw[>->,color=blue,overlay] (1em,0.5ex) to 344 \tikz[remember picture] \draw[>->,color=blue,overlay] (0em,0.5ex) to
278 [bend left] ([shift={(0.5em,0pt)}]pic cs:#1);% 345 [bend left] ([shift={(0.5em,0pt)}]pic cs:#1);%
279 \tikz[remember picture] \draw[color=gray, overlay] 346 \tikz[remember picture] \draw[color=gray, overlay]
280 ([shift={(0.5em,0.5ex)}]pic cs:#1) circle [radius=8pt];} 347 ([shift={(0.5em,0.5ex)}]pic cs:#1) circle [radius=8pt];}
281\NewDocumentCommand{\pointtol}{m}{% 348\NewDocumentCommand{\pointtor}{m}{%
282 \tikz[remember picture] \draw[>->,color=blue,overlay] (1em,0.5ex) to 349 \tikz[remember picture] \draw[>->,color=blue,overlay] (0em,0.5ex) to
283 [bend right] ([shift={(0.5em,0pt)}]pic cs:#1);% 350 [bend right] ([shift={(0.5em,0pt)}]pic cs:#1);%
284 \tikz[remember picture] \draw[color=gray, overlay] 351 \tikz[remember picture] \draw[color=gray, overlay]
285 ([shift={(0.5em,0.5ex)}]pic cs:#1) circle [radius=8pt];} 352 ([shift={(0.5em,0.5ex)}]pic cs:#1) circle [radius=8pt];}
286\NewDocumentCommand{\pointtoel}{m}{% 353\NewDocumentCommand{\pointtoer}{m}{%
287 \tikz[remember picture] \draw[>->,color=blue,overlay] (1em,0.5ex) to 354 \tikz[remember picture] \draw[>->,color=blue,overlay] (0em,0.5ex) to
288 [bend right] ([shift={(0em,0pt)}]pic cs:#1);% 355 [bend right] ([shift={(0em,0pt)}]pic cs:#1);%
289 \tikz[remember picture] \draw[color=gray, overlay] 356 \tikz[remember picture] \draw[color=gray, overlay]
290 ([shift={(-0.5em,0.5ex)}]pic cs:#1) ellipse [x radius=45pt, y 357 ([shift={(-0.5em,0.5ex)}]pic cs:#1) ellipse [x radius=45pt, y
@@ -547,14 +614,14 @@ along with this program. If not, see
547% \label{sec:features} 614% \label{sec:features}
548% A list of the main features of \pkg{ekdosis} follows:--- 615% A list of the main features of \pkg{ekdosis} follows:---
549% \begin{enumerate} 616% \begin{enumerate}
550% \item \emph{Multilingual critical editions\/}: \pkg{ekdosis} can 617% \item \label{it:multicol-feature}\emph{Multilingual critical
551% be used to typeset any number of texts in any direction accepted 618% editions\/}: \pkg{ekdosis} can be used to typeset any number of
552% by \hologo{LuaTeX}. Running paragraphs of text can be arranged in 619% texts in any direction accepted by \hologo{LuaTeX}. Running
553% any number of columns, either on single or facing pages, which in 620% paragraphs of text can be arranged in any number of columns,
554% turn can be synchronized or not. \pkg{ekdosis} is also 621% either on single or facing pages, which in turn can be
555% suitable for complex layouts as in the case of Arabic poetry or 622% synchronized or not. \pkg{ekdosis} is also suitable for complex
556% images where three-way alignment is required, or diagrams, 623% layouts as in the case of Arabic poetry or images where three-way
557% \emph{\&c}. 624% alignment is required, or diagrams, \emph{\&c}.
558% \item \emph{Apparatus criticus\/}: Edited texts can receive multiple 625% \item \emph{Apparatus criticus\/}: Edited texts can receive multiple
559% layers of apparatus, e.g.\ apparatus criticus (to record variant 626% layers of apparatus, e.g.\ apparatus criticus (to record variant
560% readings), apparatus fontium (to collect references to texts quoted 627% readings), apparatus fontium (to collect references to texts quoted
@@ -642,11 +709,11 @@ along with this program. If not, see
642% the page, above the line, and naturally shows the accepted 709% the page, above the line, and naturally shows the accepted
643% readings. The margins are used for numeration. In the apparatus 710% readings. The margins are used for numeration. In the apparatus
644% criticus, below the line, reference to the text is made by 711% criticus, below the line, reference to the text is made by
645% specifying the number of the line and if several items refer to the 712% specifying the number of the line and if several entries refer to
646% same line, numbers are not repeated. Instead, items are separated 713% the same line, numbers are not repeated. Instead, entries are
647% from one another by a broad horizontal space. Finally, a square 714% separated from one another by a broad horizontal space. Finally, a
648% bracket is used inside items to distinguish the lemma from the 715% square bracket is used inside entries to distinguish the lemma from
649% variant readings. 716% the variant readings.
650% 717%
651% Furthermore, as said above, if a \texttt{TEI xml} output is 718% Furthermore, as said above, if a \texttt{TEI xml} output is
652% required, \pkg{ekdosis} compiles an additional |.xml| file an 719% required, \pkg{ekdosis} compiles an additional |.xml| file an
@@ -702,7 +769,7 @@ along with this program. If not, see
702% \danger It must be noted that the two styles are mutually exclusive. 769% \danger It must be noted that the two styles are mutually exclusive.
703% \vskip\baselineskip 770% \vskip\baselineskip
704% 771%
705% \DescribeOption{parnotes}\label{ref:parnotes-opt} 772% \DescribeOption{parnotes}\dummy\label{ref:parnotes-opt}
706% |parnotes|$=$\verb+true|false|roman+% 773% |parnotes|$=$\verb+true|false|roman+%
707% \hfill\tcboxverb{Default: not set}\\ 774% \hfill\tcboxverb{Default: not set}\\
708% This named argument does not need a value as it defaults to |true| 775% This named argument does not need a value as it defaults to |true|
@@ -919,7 +986,10 @@ along with this program. If not, see
919% divided into two families: α, which includes mss.\ A, M, B, R, S, L 986% divided into two families: α, which includes mss.\ A, M, B, R, S, L
920% and N, and β, which includes mss.\ T, f, U and l. Therefore, 987% and N, and β, which includes mss.\ T, f, U and l. Therefore,
921% provided that all theses witnesses have been already declared, here 988% provided that all theses witnesses have been already declared, here
922% is how the two families α and β could be declared:--- 989% is how the two families α and β could be
990% declared:---\footnote{These witnesses are used in the example
991% provided below in \vref{lst:caesar-bg}.}
992% \dummy\label{ref:caesar-bg-sigla}
923% \iffalse 993% \iffalse
924%<*example> 994%<*example>
925% \fi 995% \fi
@@ -995,7 +1065,7 @@ along with this program. If not, see
995% \ref{sec:declarations} 1065% \ref{sec:declarations}
996% \vpagerefrange{sec:declarations}{sec:declarations-end}, the \cs{app} 1066% \vpagerefrange{sec:declarations}{sec:declarations-end}, the \cs{app}
997% command is used for inserting entries in the apparatus criticus, 1067% command is used for inserting entries in the apparatus criticus,
998% either, lemmas, readings or notes, like so:--- 1068% either lemmata, readings or notes, like so:---
999% \iffalse 1069% \iffalse
1000%<*example> 1070%<*example>
1001% \fi 1071% \fi
@@ -1023,22 +1093,138 @@ yesterday.
1023% quoted or cited in the text of the edition (\emph{apparatus 1093% quoted or cited in the text of the edition (\emph{apparatus
1024% fontium}), references to testimonia, or quotations of the edited 1094% fontium}), references to testimonia, or quotations of the edited
1025% text by other authors (\emph{apparatus testium}), explanatory notes, 1095% text by other authors (\emph{apparatus testium}), explanatory notes,
1026% and so forth.\footnote{See below, \vpageref{ref:type-app}.} Once 1096% and so forth.\footnote{See below, \vref{ref:type-app}.} Once
1027% additional layers have been defined and assigned to new 1097% additional layers have been defined and assigned to new
1028% \enquote*{types}, such as \enquote*{testium} and the like, these 1098% \enquote*{types}, such as \enquote*{testium} and the like, these
1029% types can be used as values appended to the |type| \enquote*{named 1099% types can be used as values appended to the |type| \enquote*{named
1030% option}. 1100% option}.
1031% 1101%
1032% \paragraph{Readings} As can be seen in the example above, there are 1102% \paragraph{Base text and variants} As can be seen in the example
1033% two kinds of individual readings: the \emph{lemma}, which contains 1103% above, there are two kinds of individual readings: the \emph{lemma},
1034% the base text accepted by the editor, and the \emph{reading}, which 1104% which contains the base text accepted by the editor, and the
1035% contains deviant readings rejected by the editor. 1105% \emph{reading}, which contains deviant readings rejected by the
1106% editor.
1036% 1107%
1037% \paragraph{Lemmas} \DescribeMacro{\lem} 1108% \paragraph{Lemmata} \DescribeMacro{\lem}
1038% \cs{lem}\oarg{options}\marg{lemma text} 1109% \cs{lem}\oarg{options}\marg{lemma text}\\
1110% As \meta{lemma text} is a word or a phrase judged by the editor to
1111% be authentic or authoritative, \cs{lem} prints it by default both in
1112% the edition text and as the first part of a new entry in the
1113% apparatus criticus, preceded by the line number where it occurs or a
1114% broad space if the entry refers to the same line as the preceding
1115% entry. The optional argument of \cs{lem} accepts the following
1116% comma-separated list of \enquote{name$=$value} arguments:---\\
1117% \DescribeOption{wit} |wit|$=$\meta{csv list of witnesses}\\
1118% While a single witness may be recorded as in |wit=A|,
1119% comma-separated lists of multiple witnesses must obviously be
1120% enclosed in curly braces, like so:
1121% |wit={A,B,C}|. \dummy\label{ref:mss-sep-families}It must be noted
1122% that witnesses can be grouped by using spaces as separators, like
1123% so: \verb*|wit={A,B,C, D,E,F}|.\\
1124% \label{ref:lem-opts-b}
1125% \DescribeOption{alt} |alt|$=$\meta{alternate lemma}\\
1126% While the mandatory argument of \cs{lem}, \meta{lemma text}, is
1127% always used to print the edition text in the upper part of the page,
1128% \meta{alternate lemma}, if specified, supersedes what is printed in
1129% the related unit of the apparatus criticus. This mechanism is useful
1130% in more than one respect. For instance, it can be used to insert
1131% abbreviated lemmata in the apparatus criticus, or to introduce an
1132% alternate way of writing entries with Latin technical terms in the
1133% apparatus criticus as will be demonstrated below in the example
1134% provided by \vref{lst:pj2}.\\
1135% \DescribeOption{sep} |sep|$=$\meta{separator}\\
1136% |sep| allows to change the symbol used to separate the lemma text
1137% from deviant readings, which is by default the closing square
1138% bracket (|]|)\\
1139% \DescribeOption{nosep} |nosep|$=$\verb+true|false+\\
1140% This named argument does not need a value as it defaults to |true|
1141% if it is used. Obviously, |nosep| removes the separator mentioned
1142% above.\\
1143% \DescribeOption{nolem} |nolem|$=$\verb+true|false+\\
1144% This named argument does not need a value as it defaults to |true|
1145% if it is used. |nolem| completely removes the lemma text from the
1146% related
1147% entry in the apparatus criticus.\\
1148% \DescribeOption{type} |type|$=$\meta{value}\\
1149% This named argument has no effect on the apparatus criticus of the
1150% edition in print, but it is used in the \texttt{TEI xml} ouput to
1151% classify the variation recorded in the entry according to some
1152% convenient typology. Categories such as lexical, morphological,
1153% orthographical and the like may apply.
1039% 1154%
1040% \begin{comment} 1155% Finally, four named arguments can be used to insert words at the
1041% \captof{The \enquote{Peter/John} full example} 1156% following specific places in the lemma text:\\
1157% \noindent
1158% \fparbox*{\centered{\textbf{1} \tikzmark{pre}\tred{pre} Peter
1159% \tikzmark{post}\tred{post} \tikzmark{prewit}\tred{prewit}
1160% \getsiglum{pjA}
1161% \tikzmark{postwit}\tred{postwit}] John \getsiglum{pjB}}}\\
1162% \DescribeOption{pre} |pre|$=$\meta{words}\pointtol{pre}\\
1163% |pre| inserts \meta{words} \emph{before} the lemma text.\\
1164% \DescribeOption{post} |post|$=$\meta{words}\pointto{post}\\
1165% |post| inserts \meta{words} \emph{after} the lemma text.\\
1166% \DescribeOption{prewit} |prewit|$=$\meta{words}\pointto{prewit}\\
1167% |prewit| inserts \meta{words} \emph{before} the list of witnesses.\\
1168% \DescribeOption{postwit} |postwit|$=$\meta{words}\pointtor{postwit}\\
1169% |postwit| inserts \meta{words} \emph{after} the list of witnesses.
1170% \label{ref:lem-opts-e}
1171%
1172% \paragraph{Readings} \DescribeMacro{\rdg}
1173% \cs{rdg}\oarg{options}\marg{variant reading}\\
1174% As \meta{reading} is a word or a phrase judged by the editor to be
1175% unsatisfactory or corrupted, \cs{rdg} prints it by default in the
1176% last part of the corresponding entry in the apparatus criticus,
1177% after the symbol that is used to separate words of the base text
1178% (the lemma text) from words rejected by the editor. The optional
1179% argument of \cs{rdg} accepts a comma-separated list of
1180% \enquote{name$=$value} arguments that is almost identical to
1181% \cs{app}. Therefore, emphasis will be placed here only on the
1182% differences. The reader is invited to refer to the description
1183% provided above \vpagerefrange{ref:lem-opts-b}{ref:lem-opts-e} for
1184% more detailed information:---\\
1185% \DescribeOption{wit} |wit|$=$\meta{csv list of witnesses}\\
1186% \DescribeOption{alt} |alt|$=$\meta{alternate reading}\\
1187% \DescribeOption{nordg} |nordg|$=$\verb+true|false+\\
1188% This named argument does not need a value as it defaults to |true|
1189% if it is used. |nordg| completely removes the variant reading from
1190% the related entry in the apparatus criticus.\\
1191% \DescribeOption{type} |type|$=$\meta{value}\\
1192% \DescribeOption{pre} |pre|$=$\meta{words}\\
1193% \DescribeOption{post} |post|$=$\meta{words}\\
1194% \DescribeOption{prewit} |prewit|$=$\meta{words}\\
1195% \DescribeOption{postwit} |postwit|$=$\meta{words}\\
1196%
1197% \paragraph{Notes}
1198% \DescribeMacro{\note}\DescribeMacro{\note*}
1199% \cs{note}\oarg{options}\marg{text} or
1200% \cs{note*}\oarg{options}\marg{text}\\
1201% It may happen that editorial notes be needed to record short
1202% comments of general nature \emph{between} lemmata and
1203% readings. \cs{note} inserts inline comments while \cs{note*} places
1204% comments below the entire apparatus block. Furthermore, if
1205% \pkg{ekdosis} has been loaded with the |parnotes| option as
1206% described above \vpageref{ref:parnotes-opt}, \cs{note*} will use the
1207% \pkg{parnotes} package to lay out the notes as an additional
1208% paragraph below the apparatus criticus. The optional argument of
1209% \cs{note}/\cs{note*} accepts the following comma-separated list of
1210% \enquote{name$=$value}
1211% arguments:---\\
1212% \DescribeOption{pre} |pre|$=$\meta{words}\\
1213% |pre| inserts \meta{words} immediately before the note.\\
1214% \DescribeOption{post} |post|$=$\meta{words}\\
1215% |post| inserts \meta{words} immediately after the note.\\
1216%
1217% \danger Under no circumstances is it permitted to insert the command
1218% \cs{note} or \cs{note*} inside the argument of \cs{lem} or
1219% \cs{rdg}. \cs{note}/\cs{note*} must go \emph{between} these
1220% commands. As a general rule, within \cs{app}|{}| elements, notes
1221% are inserted immediately \emph{after} the lemma or the variant
1222% reading they are related to.
1223%
1224% \Vref{lst:pj2} provides an illustration of some of the possibilities
1225% afforded by the commands just described:---
1226%
1227% \captof{The \enquote{Peter/John} full example}[\label{lst:pj2}]
1042% \iffalse 1228% \iffalse
1043%<*example> 1229%<*example>
1044% \fi 1230% \fi
@@ -1061,18 +1247,20 @@ yesterday.
1061 \app{ 1247 \app{
1062 \lem[wit=A, alt={How nice... said}]{\enquote{How nice to find 1248 \lem[wit=A, alt={How nice... said}]{\enquote{How nice to find
1063 you here!} he said.} 1249 you here!} he said.}
1250 \note*{There are no quotation marks in the mss.}
1064 \rdg[wit=B, alt=\emph{om.}]{}} 1251 \rdg[wit=B, alt=\emph{om.}]{}}
1065 I chuckled to myself, recalling the last time we 1252 I chuckled to myself, recalling the last time we
1066 \app{ 1253 \app{
1067 \lem[wit=A,nolem]{met} 1254 \lem[wit=A,nolem]{met}
1068 \rdg[wit=B, alt={\emph{post} met \emph{add.} there}]{met 1255 \rdg[wit=B, alt={\emph{post} met \emph{add.} there}]{met
1069 there}}. 1256 there}
1257 \note*{Ms. B provides other additions of this kind.}}.
1070\end{ekdosis} 1258\end{ekdosis}
1071\end{minted} 1259\end{minted}
1072% \iffalse 1260% \iffalse
1073%</example> 1261%</example>
1074% \fi 1262% \fi
1075% 1263% \resetlinenumber
1076% \begin{alignment}[tcols=1,texts=specimen,apparatus=specimen] 1264% \begin{alignment}[tcols=1,texts=specimen,apparatus=specimen]
1077% \begin{specimen} 1265% \begin{specimen}
1078% I \app{\lem[wit=pjA]{saw}\rdg[wit=pjB]{met}} my friend 1266% I \app{\lem[wit=pjA]{saw}\rdg[wit=pjB]{met}} my friend
@@ -1088,18 +1276,282 @@ yesterday.
1088% \app{ 1276% \app{
1089% \lem[wit=pjA, alt={\textooquote How nice... said}]{\enquote{How 1277% \lem[wit=pjA, alt={\textooquote How nice... said}]{\enquote{How
1090% nice to find you here!} he said.} 1278% nice to find you here!} he said.}
1279% \note*{There are no quotation marks in the mss.}
1091% \rdg[wit=pjB, alt=\emph{om.}]{}} 1280% \rdg[wit=pjB, alt=\emph{om.}]{}}
1092% I chuckled to myself, recalling the last time we 1281% I chuckled to myself, recalling the last time we
1093% \app{ 1282% \app{
1094% \lem[wit=pjA,nolem]{met} 1283% \lem[wit=pjA,nolem]{met}
1095% \rdg[wit=pjB, alt={\emph{post} met \emph{add.} there}]{met 1284% \rdg[wit=pjB, alt={\emph{post} met \emph{add.} there}]{met
1096% there}}. 1285% there}
1286% \note*{Ms. B provides other additions of this kind.}}.
1097% \end{specimen} 1287% \end{specimen}
1098% \end{alignment} 1288% \end{alignment}
1099% \end{comment} 1289%
1290% \begin{remarks}
1291% \item Close examination of lines~17--8 from \vref{lst:pj2} shows how
1292% |alt| has been used to insert an abbridged lemma text in the
1293% apparatus criticus in print while keeping safe what is to be found
1294% in the \texttt{TEI xml} output.
1295% \item The same technique has been used at line~24 to insert
1296% alternate words, including Latin technical terms, in place of the
1297% variant reading. Hence the use of |nolem| at line~23 to remove the
1298% lemma text from the apparatus criticus in print.
1299% \item \cs{note*} has been used to insert short annotations in two
1300% places (ll.~19 and 26).
1301% \item For an example of the use of |nordg|, see below
1302% \vref{lst:caesar-bg}, l.~11.
1303% \end{remarks}
1304%
1305% The corresponding \texttt{TEI xml} output produced by \pkg{ekdosis}
1306% from the \LaTeX{} source file follows:---
1100% 1307%
1308% \captof{The \enquote{Peter/John} full example: \texttt{TEI xml}
1309% output}[\label{lst:pj2-tei}]
1310% \iffalse
1311%<*example>
1312% \fi
1313\begin{minted}[linenos=false]{xml}
1314<p>I
1315<app>
1316 <lem wit="#A">saw</lem>
1317 <rdg wit="#B">met</rdg>
1318</app>my friend
1319<app>
1320 <lem>Peter</lem>
1321 <rdg>John</rdg>
1322</app>at the station yesterday. We were both in a
1323<app>
1324 <lem wit="#A">great</lem>
1325 <rdg wit="#B">good</rdg>
1326</app>mood.
1327<app>
1328 <lem wit="#A">
1329 <quote>How nice to find you here!</quote> he said.</lem>
1330 <note>There are no quotation marks in the mss.</note>
1331 <rdg wit="#B" />
1332</app>I chuckled to myself, recalling the last time we
1333<app>
1334 <lem wit="#A">met</lem>
1335 <rdg wit="#B">met there</rdg>
1336 <note>Ms. B provides some further additions of this
1337 kind.</note>
1338</app>.</p>
1339\end{minted}
1340% \iffalse
1341%</example>
1342% \fi
1343%
1344% \section{Alignment of Parallel Texts}
1345% \label{sec:alignment-basic}
1346% As already said above,\footnote{See point
1347% \vref{it:multicol-feature}.} \pkg{ekdosis} can arrange sundry texts
1348% in parallel columns\---synchronized or not\---either on the same
1349% page or on facing pages. Depending on what is needed, any text can
1350% be equipped with an apparatus criticus. The most common example is
1351% that of an edition of a classical text with an apparatus criticus
1352% accompanied by a translation into a modern language on the facing
1353% page. One can also imagine an edition of two classical texts or two
1354% different recensions of the same text, each of which provides
1355% variants recorded in separate apparatus crititus, laid out on the
1356% left-hand pages, with one or more translations on the corresponding
1357% right-hand pages, and so forth.
1358%
1359% \paragraph{The \env{alignment} Environment}
1360% \DescribeEnv{alignment} \cs{begin}|{alignment}|\oarg{options}\dots
1361% \cs{end}|{alignment}|\\
1362% This environment can be used as it is provided to typeset a standard
1363% critical edition, namely an edition text, equipped with an apparatus
1364% criticus and laid out on the left-hand pages, accompanied by a
1365% translation into a modern language on the facing pages.
1366%
1367% \DescribeEnv{edition}\DescribeEnv{translation} Within
1368% \env{alignment}, two environments are available by default:
1369% \cs{begin}|{edition}|\dots \cs{end}|{ed|\allowbreak|ition}| and
1370% \cs{begin}|{translation}|\dots \cs{end}|{translation}|. Obviously,
1371% the former is used to typeset the edition text with an apparatus
1372% criticus on the left, while the latter is used to typeset the
1373% translation on the right, like so:---
1374% \iffalse
1375%<*example>
1376% \fi
1377\begin{minted}[linenos=false]{latex}
1378\begin{alignment}
1379 \begin{edition}
1380 First § of the edition text.
1381 \end{edition}
1382 \begin{translation}
1383 First § of the translation.
1384 \end{translation}
1385 \begin{edition}
1386 Second § of the edition text.
1387 \end{edition}
1388 \begin{translation}
1389 Second § of the translation.
1390 \end{translation}
1391\end{alignment}
1392\end{minted}
1393% \iffalse
1394%</example>
1395% \fi
1396%
1397% \DescribeEnv{edition*}\DescribeEnv{translation*} Furthermore,
1398% so-called \enquote{starred} versions of these environments can be
1399% used at any point to synchronize texts, that is to print them in
1400% such a way that the tops of all paragraphs are vertically
1401% aligned. To that effect, it must be noted that merely applying this
1402% command on a single environment\---for instance the leftmost
1403% one\---will have all other associated paragraphs printed aligned.
1404%
1405% \danger While the whole edition text and the whole translation can
1406% be inserted in a single \env{edition}/\env{translation} environment
1407% respectively, it is recommended to enter both texts paragraph by
1408% paragraph as shown in the example above. Not only this method of
1409% encoding allows not to lose sight of paragraphs that are meant to be
1410% read together, but it is also the only way to align paragraphs in
1411% print, and it is much more suitable to mark up correspondence
1412% between spans of texts as will be demonstrated below in
1413% \vref{ref:segmentation}.
1414%
1415% As an illustration, a short extract of Caesar's \emph{Gallic War},
1416% VI, XIII.1 follows.\footnote{Latin text: \cite{Caesar-BG-v2};
1417% English translation: \cite{CaesarTr}.} See the list of sigla for
1418% manuscripts and manuscript families above
1419% \vpageref{ref:caesar-bg-sigla}. As this document is not set for
1420% duplex printing, both texts have been put together on the same
1421% page:---
1422%
1423% \captof{Caesar's \emph{Gallic War}, VI, 13.1}[\label{lst:caesar-bg}]
1424% \iffalse
1425%<*example>
1426% \fi
1427\begin{minted}{latex}
1428\begin{alignment}
1429 \begin{edition}
1430 \ekddiv{head=XIII, depth=2, n=6.13, type=section}
1431 In omni Gallia eorum hominum qui \app{
1432 \lem[wit=a]{aliquo}
1433 \rdg[wit=b, alt=in al-]{in aliquo}}
1434 sunt numero atque honore genera sunt duo. Nam plebes paene
1435 seruorum habetur loco, quae \app{
1436 \lem[wit={A,M}, alt={nihil audet (aut et \getsiglum{A1})
1437 per se}]{nihil audet per se}
1438 \rdg[wit=A1,nordg]{nihil aut et per se}
1439 \rdg[wit={R,S,L,N}]{nihil habet per se}
1440 \rdg[wit=b]{per se nihil audet}}, \app{
1441 \lem[wit=a]{nullo}
1442 \rdg[wit=b]{nulli}} adhibetur \app{
1443 \lem{consilio}
1444 \rdg[wit={T, U}, alt=conc-]{concilio}}.
1445 \end{edition}
1446 \begin{translation}
1447 \ekddiv{head=XIII, depth=2, n=6.13, type=section}
1448 Throughout all Gaul there are two orders of those men who are of
1449 any rank and dignity: for the commonality is held almost in the
1450 condition of slaves, and dares to undertake nothing of itself,
1451 and is admitted to no deliberation.
1452 \end{translation}
1453\end{alignment}
1454\end{minted}
1455% \iffalse
1456%</example>
1457% \fi
1458%
1459% \resetlinenumber
1460% \ekdfmtdiv{2}{}{.}
1461% \begin{alignment}[lcols=2,
1462% texts=edition[xml:lang="la"];
1463% translation[xml:lang="en"]]
1464% \AtBeginEnvironment{edition}{\selectlanguage{latin}}
1465% \AtBeginEnvironment{translation}{\selectlanguage{american}}
1466% \begin{edition}
1467% \ekddiv{head=XIII, depth=2, n=6.13, type=section}
1468% In omni Gallia eorum hominum qui \app{
1469% \lem[wit=ca]{aliquo}
1470% \rdg[wit=cb, alt=in al-]{in aliquo}}
1471% sunt numero atque honore genera sunt duo. Nam plebes paene
1472% seruorum habetur loco, quae \app{
1473% \lem[wit={cA,cM}, alt={nihil audet (aut et \getsiglum{cA1})
1474% per se}]{nihil audet per se}
1475% \rdg[wit=cA1,nordg]{nihil aut et per se}
1476% \rdg[wit={cR,cS,cL,cN}]{nihil habet per se}
1477% \rdg[wit=cb]{per se nihil audet}}, \app{
1478% \lem[wit=ca]{nullo}
1479% \rdg[wit=cb]{nulli}} adhibetur \app{
1480% \lem{consilio}
1481% \rdg[wit={cT, cU}, alt=conc-]{concilio}}.
1482% \end{edition}
1483% \begin{translation}
1484% \ekddiv{head=XIII, depth=2, n=6.13, type=section}
1485% Throughout all Gaul there are two orders of those men who are of
1486% any rank and dignity: for the commonality is held almost in the
1487% condition of slaves, and dares to undertake nothing of itself,
1488% and is admitted to no deliberation.
1489% \end{translation}
1490% \end{alignment}
1491%
1492% \begin{remarks}
1493% \item As can be seen from the apparatus entry related to l.~4 above,
1494% a subvariant has been inserted in the lemma part: \enquote{(aut et
1495% \getsiglum{cA1})}. This was done by using |alt| in
1496% \vref{lst:caesar-bg}, l.~9. But as this variant is already
1497% recorded\---and printed\---in the lemma part, it was necessary to
1498% remove the entire otherwise redundant variant from the apparatus
1499% criticus in print. Hence the use of |nordg| at l.~11.
1500% \item For examples of abbreviations, see ll.~6 and 17.
1501% \item Line~17 shows how mss.\ T and U (which belong to two distinct
1502% subfamilies) have been separated from one another: %
1503% \verb*+wit={T, U}+. See above \vpageref{ref:mss-sep-families} for
1504% more information on this technique.
1505% \end{remarks}
1506%
1507% Finally, the corresponding \texttt{TEI xml} output follows:---
1508% \iffalse
1509%<*example>
1510% \fi
1511\begin{minted}[linenos=false]{xml}
1512<div xml:id="div-edition_1" xml:lang="la">
1513 <div type="section" n="6.13">
1514 <head>XIII</head>
1515 <p>In omni Gallia eorum hominum qui
1516 <app>
1517 <lem wit="#A #M #B #R #S #L #N">aliquo</lem>
1518 <rdg wit="#T #f #U #l">in aliquo</rdg>
1519 </app>sunt numero atque honore genera sunt duo. Nam
1520 plebes paene seruorum habetur loco, quae
1521 <app>
1522 <lem wit="#A #M">nihil audet per se</lem>
1523 <rdg wit="#A1">nihil aut et per se</rdg>
1524 <rdg wit="#R #S #L #N">nihil habet per se</rdg>
1525 <rdg wit="#T #f #U #l">per se nihil audet</rdg>
1526 </app>,
1527 <app>
1528 <lem wit="#A #M #B #R #S #L #N">nullo</lem>
1529 <rdg wit="#T #f #U #l">nulli</rdg>
1530 </app>adhibetur
1531 <app>
1532 <lem>consilio</lem>
1533 <rdg wit="#T #U">concilio</rdg>
1534 </app>.</p>
1535 </div>
1536</div>
1537<div xml:id="div-translation_1" xml:lang="en">
1538 <div type="section" n="6.13">
1539 <head>XIII</head>
1540 <p>Throughout all Gaul there are two orders of those men
1541 who are of any rank and dignity: for the commonality is
1542 held almost in the condition of slaves, and dares to
1543 undertake nothing of itself, and is admitted to no
1544 deliberation.</p>
1545 </div>
1546</div>
1547\end{minted}
1548% \iffalse
1549%</example>
1550% \fi
1551%
1101% \section{To be continued...} 1552% \section{To be continued...}
1102% \label{ref:type-app} 1553% \label{ref:type-app}
1554% \label{ref:segmentation}
1103% 1555%
1104% \section{GNU Free Documentation License} 1556% \section{GNU Free Documentation License}
1105% \label{sec:fdl} 1557% \label{sec:fdl}