aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2021-03-29 08:25:38 +0200
committerRobert Alessi <alessi@robertalessi.net>2021-03-29 08:25:38 +0200
commit06f82a8158874e49c5ff6c0045e3fdf1250a287a (patch)
tree4552a3e7a8622a1ac4907e155e7583b96f208792
parent3296aeaae9cb2b4dce92b573ee2745aa03a3c3a3 (diff)
downloadekdosis-06f82a8158874e49c5ff6c0045e3fdf1250a287a.tar.gz
done documenting the new features. getting close to v1.2
-rw-r--r--ekdosis.dtx545
1 files changed, 454 insertions, 91 deletions
diff --git a/ekdosis.dtx b/ekdosis.dtx
index c7f6592..64b2cff 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -254,13 +254,15 @@ along with this program. If not, see
254 254
255@Book{McDonald1916, 255@Book{McDonald1916,
256 editor = {MacDonald Alden, Raymond}, 256 editor = {MacDonald Alden, Raymond},
257 shorteditor = {MacDonald},
257 title = {The Sonnets of Shakespeare}, 258 title = {The Sonnets of Shakespeare},
258 date = 1916, 259 date = 1916,
259 titleaddon = {From the Quarto of 1609 with Variorum Readings and 260 titleaddon = {From the Quarto of 1609 with Variorum Readings and
260 Commentary}, 261 Commentary},
261 publisher = {Houghton Mifflin Co.}, 262 organization = {Houghton Mifflin Co.},
262 options = {useauthor=false, useeditor=true}, 263 publisher = {The Riverside Press Cambridge},
263 location = {Boston} 264 options = {useauthor=false, useeditor=true},
265 location = {Boston \& New York}
264} 266}
265 267
266@Book{ReynoldsWilson1991, 268@Book{ReynoldsWilson1991,
@@ -336,6 +338,15 @@ along with this program. If not, see
336 version = {4.41} 338 version = {4.41}
337} 339}
338 340
341@Software{memoir,
342 title = {The Memoir package},
343 titleaddon = {Typeset fiction, non-fiction and mathematical books},
344 author = {Madsen, Lars and Wilson, Peter R.},
345 url = {http://www.ctan.org/pkg/memoir},
346 date = {2021-03-23},
347 version = {3.7o}
348}
349
339@Software{paracol, 350@Software{paracol,
340 title = {The Paracol package}, 351 title = {The Paracol package},
341 titleaddon = {Multiple columns with texts “in parallel”}, 352 titleaddon = {Multiple columns with texts “in parallel”},
@@ -580,6 +591,7 @@ along with this program. If not, see
580\usepackage[defaultindex=none,citecmd=autocite]{icite} 591\usepackage[defaultindex=none,citecmd=autocite]{icite}
581\bibinput{ekdosis} 592\bibinput{ekdosis}
582\usepackage[nospace,american]{varioref} 593\usepackage[nospace,american]{varioref}
594\newcommand\phts{\phantomsection}
583\usepackage[style=oxnotes-inote,dashed]{biblatex} 595\usepackage[style=oxnotes-inote,dashed]{biblatex}
584\DeclareSourcemap{ 596\DeclareSourcemap{
585 \maps[datatype=bibtex]{ 597 \maps[datatype=bibtex]{
@@ -714,6 +726,7 @@ along with this program. If not, see
714 xleftmargin=12pt, breaklines, numberblanklines=false, numbersep=3pt} 726 xleftmargin=12pt, breaklines, numberblanklines=false, numbersep=3pt}
715\renewcommand{\theFancyVerbLine}{\normalfont\smaller\arabic{FancyVerbLine}} 727\renewcommand{\theFancyVerbLine}{\normalfont\smaller\arabic{FancyVerbLine}}
716\usepackage[contents]{colordoc} 728\usepackage[contents]{colordoc}
729\newcommand{\cls}[1]{\textsf{#1}\index{#1=#1 (class)}}
717\newcommand{\pkg}[1]{\textsf{#1}\index{#1=#1 (package)}} 730\newcommand{\pkg}[1]{\textsf{#1}\index{#1=#1 (package)}}
718\newcommand{\env}[1]{\texttt{#1}\index{#1=#1 (environment)}} 731\newcommand{\env}[1]{\texttt{#1}\index{#1=#1 (environment)}}
719\backgroundcolor{c}{ekdcolor} 732\backgroundcolor{c}{ekdcolor}
@@ -978,7 +991,7 @@ along with this program. If not, see
978% \label{sec:features} 991% \label{sec:features}
979% A list of the main features of \pkg{ekdosis} follows:--- 992% A list of the main features of \pkg{ekdosis} follows:---
980% \begin{enumerate} 993% \begin{enumerate}
981% \item \label{it:multicol-feature}\emph{Multilingual critical 994% \item \phts\label{it:multicol-feature}\emph{Multilingual critical
982% editions\/}: \pkg{ekdosis} can be used to typeset any number of 995% editions\/}: \pkg{ekdosis} can be used to typeset any number of
983% texts in any direction accepted by \hologo{LuaTeX}. Running 996% texts in any direction accepted by \hologo{LuaTeX}. Running
984% paragraphs of text can be arranged in any number of columns, 997% paragraphs of text can be arranged in any number of columns,
@@ -986,7 +999,7 @@ along with this program. If not, see
986% synchronized or not. \pkg{ekdosis} is also suitable for complex 999% synchronized or not. \pkg{ekdosis} is also suitable for complex
987% layouts as in the case of Arabic poetry or images where three-way 1000% layouts as in the case of Arabic poetry or images where three-way
988% alignment is required, or diagrams, \emph{\&c}. 1001% alignment is required, or diagrams, \emph{\&c}.
989% \item \label{it:multilayer-feature}\emph{Apparatus criticus\/}: 1002% \item \phts\label{it:multilayer-feature}\emph{Apparatus criticus\/}:
990% Edited texts can receive multiple layers of apparatus, e.g.\ 1003% Edited texts can receive multiple layers of apparatus, e.g.\
991% apparatus criticus (to record variant readings), apparatus fontium 1004% apparatus criticus (to record variant readings), apparatus fontium
992% (to collect references to texts quoted or cited in the edited 1005% (to collect references to texts quoted or cited in the edited
@@ -1111,7 +1124,7 @@ along with this program. If not, see
1111% \danger The reader is invited to refer to the relevant sections of 1124% \danger The reader is invited to refer to the relevant sections of
1112% this documentation for more information on how to use them. 1125% this documentation for more information on how to use them.
1113% 1126%
1114% \DescribeOption{layout}\label{ref:layout-opt} 1127% \DescribeOption{layout}\phts\label{ref:layout-opt}
1115% |layout|$=$\verb+float|footins+\hfill\tcboxverb{Default: float}\\ 1128% |layout|$=$\verb+float|footins+\hfill\tcboxverb{Default: float}\\
1116% By default, layers of critical notes are inserted as a floating 1129% By default, layers of critical notes are inserted as a floating
1117% environment to be printed at the bottom of pages. |layout=footins| 1130% environment to be printed at the bottom of pages. |layout=footins|
@@ -1121,7 +1134,7 @@ along with this program. If not, see
1121% will be inserted between regular numbered footnotes, but will carry 1134% will be inserted between regular numbered footnotes, but will carry
1122% no footnote mark of its own. 1135% no footnote mark of its own.
1123% 1136%
1124% \DescribeOption{divs}\label{ref:divs-opt} 1137% \DescribeOption{divs}\phts\label{ref:divs-opt}
1125% |divs|$=$\verb+ekdosis|latex+\hfill\tcboxverb{Default: ekdosis}\\ 1138% |divs|$=$\verb+ekdosis|latex+\hfill\tcboxverb{Default: ekdosis}\\
1126% In many occasions, \LaTeX{} standard textual divisions do not meet 1139% In many occasions, \LaTeX{} standard textual divisions do not meet
1127% the specific requirements of classical and literary texts, the 1140% the specific requirements of classical and literary texts, the
@@ -1137,17 +1150,18 @@ along with this program. If not, see
1137% \danger It must be noted that the two styles are mutually exclusive. 1150% \danger It must be noted that the two styles are mutually exclusive.
1138% \vskip\baselineskip 1151% \vskip\baselineskip
1139% 1152%
1140% \DescribeOption{poetry}\label{ref:poetry-opt} 1153% \DescribeOption{poetry}\phts\label{ref:poetry-opt}
1141% \newfeature[v1.2] 1154% \newfeature[v1.2] |poetry|$=$\verb+verse+
1142% |poetry|$=$\verb+verse+
1143% \hfill\tcboxverb{Default: not set}\\ 1155% \hfill\tcboxverb{Default: not set}\\
1144% |poetry=verse| instructs \pkg{ekdosis} to load and use the facilites 1156% |poetry=verse| instructs \pkg{ekdosis} to load and use the facilites
1145% supplied by the \pkg{verse} package for typesetting lines of 1157% supplied by the \pkg{verse} package for the typesetting of lines of
1146% poetry. The \env{ekdverse} environment must then be used instead of 1158% poetry.\footnote{\texttt{verse} does not need to be set if the
1159% \cls{memoir} class is used. See \vref{sec:verse-package} for more
1160% detail.} The \env{ekdverse} environment must then be used instead of
1147% the \env{verse} environment that is provided by the \pkg{verse} 1161% the \env{verse} environment that is provided by the \pkg{verse}
1148% package as described below in \vref{sec:verse-package}. 1162% package as described below in \vref{sec:verse-package}.
1149% 1163%
1150% \DescribeOption{parnotes}\label{ref:parnotes-opt} 1164% \DescribeOption{parnotes}\phts\label{ref:parnotes-opt}
1151% |parnotes|$=$\verb+true|false|roman+% 1165% |parnotes|$=$\verb+true|false|roman+%
1152% \hfill\tcboxverb{Default: not set}\\ 1166% \hfill\tcboxverb{Default: not set}\\
1153% This named argument does not need a value as it defaults to |true| 1167% This named argument does not need a value as it defaults to |true|
@@ -1157,7 +1171,7 @@ along with this program. If not, see
1157% \pkg{parnotes} package. Additionally, |parnotes=roman| prints these 1171% \pkg{parnotes} package. Additionally, |parnotes=roman| prints these
1158% footnotes numbered with Roman numerals. 1172% footnotes numbered with Roman numerals.
1159% 1173%
1160% \DescribeOption{teiexport}\label{ref:teiexport-option} 1174% \DescribeOption{teiexport}\phts\label{ref:teiexport-option}
1161% |teiexport|$=$\verb+true|false|tidy+% 1175% |teiexport|$=$\verb+true|false|tidy+%
1162% \hfill\tcboxverb{Default: not set}\\ 1176% \hfill\tcboxverb{Default: not set}\\
1163% This named argument does not need a value as it defaults to |true| 1177% This named argument does not need a value as it defaults to |true|
@@ -1214,7 +1228,7 @@ along with this program. If not, see
1214% \paragraph{Witnesses} 1228% \paragraph{Witnesses}
1215% \DescribeMacro{\DeclareWitness} \cs{DeclareWitness}\marg{unique 1229% \DescribeMacro{\DeclareWitness} \cs{DeclareWitness}\marg{unique
1216% id}\marg{rendition}\marg{description}\oarg{options} 1230% id}\marg{rendition}\marg{description}\oarg{options}
1217% \label{ref:declarewitness}\\ 1231% \phts\label{ref:declarewitness}\\
1218% This command requires three mandatory arguments enclosed between 1232% This command requires three mandatory arguments enclosed between
1219% curly braces used to specify consecutively: 1233% curly braces used to specify consecutively:
1220% \begin{enumerate} 1234% \begin{enumerate}
@@ -1251,7 +1265,7 @@ along with this program. If not, see
1251% \DescribeOption{origDate} |origDate|$=$\meta{date}: Any form of date 1265% \DescribeOption{origDate} |origDate|$=$\meta{date}: Any form of date
1252% used to identify the date of origin for the witness. 1266% used to identify the date of origin for the witness.
1253% 1267%
1254% \label{ref:marcianus-b} 1268% \phts\label{ref:marcianus-b}
1255% To take here one example, a witness such as the \emph{Marcianus 1269% To take here one example, a witness such as the \emph{Marcianus
1256% Graecus}~269, referred to as manuscript \enquote*{M} in the 1270% Graecus}~269, referred to as manuscript \enquote*{M} in the
1257% editions, which contains sixty treatises transmitted under the name 1271% editions, which contains sixty treatises transmitted under the name
@@ -1358,10 +1372,10 @@ along with this program. If not, see
1358% \iffalse 1372% \iffalse
1359%</example> 1373%</example>
1360% \fi 1374% \fi
1361% \label{ref:marcianus-e} 1375% \phts\label{ref:marcianus-e}
1362% 1376%
1363% \paragraph{Sources} 1377% \paragraph{Sources}
1364% \label{ref:declare-source} 1378% \phts\label{ref:declare-source}
1365% \DescribeMacro{\DeclareSource} \cs{DeclareSource}\marg{unique 1379% \DescribeMacro{\DeclareSource} \cs{DeclareSource}\marg{unique
1366% label}\marg{rendition}\newfeature[v1.1]\\ 1380% label}\marg{rendition}\newfeature[v1.1]\\
1367% The \emph{Conspectus Siglorum} that is placed ahead of the edition 1381% The \emph{Conspectus Siglorum} that is placed ahead of the edition
@@ -1398,10 +1412,10 @@ along with this program. If not, see
1398% \iffalse 1412% \iffalse
1399%</example> 1413%</example>
1400% \fi 1414% \fi
1401% \label{sec:declarations-end} 1415% \phts\label{sec:declarations-end}
1402% 1416%
1403% \paragraph{Scholars} 1417% \paragraph{Scholars}
1404% \label{ref:declare-scholar} 1418% \phts\label{ref:declare-scholar}
1405% \DescribeMacro{\DeclareScholar}\cs{DeclareScholar}\marg{unique 1419% \DescribeMacro{\DeclareScholar}\cs{DeclareScholar}\marg{unique
1406% id}\marg{rendition}\oarg{options}\newfeature[v1.1]\\ 1420% id}\marg{rendition}\oarg{options}\newfeature[v1.1]\\
1407% Occasionally, it is necessary to refer to a scholar as a person. For 1421% Occasionally, it is necessary to refer to a scholar as a person. For
@@ -1462,7 +1476,7 @@ along with this program. If not, see
1462% is how the two families α and β could be 1476% is how the two families α and β could be
1463% declared:\footnote{These witnesses are used in the example 1477% declared:\footnote{These witnesses are used in the example
1464% provided below in \vref{lst:caesar-bg}.}--- 1478% provided below in \vref{lst:caesar-bg}.}---
1465% \label{ref:caesar-bg-sigla} 1479% \phts\label{ref:caesar-bg-sigla}
1466% \iffalse 1480% \iffalse
1467%<*example> 1481%<*example>
1468% \fi 1482% \fi
@@ -1593,7 +1607,7 @@ along with this program. If not, see
1593% 1607%
1594% \paragraph{Apparatus Entries} 1608% \paragraph{Apparatus Entries}
1595% \DescribeMacro{\app} \cs{app}|[type=|\meta{type}|]|\marg{apparatus 1609% \DescribeMacro{\app} \cs{app}|[type=|\meta{type}|]|\marg{apparatus
1596% entries}\label{ref:app-cmd}\\ 1610% entries}\phts\label{ref:app-cmd}\\
1597% This command takes one mandatory argument and accepts one optional 1611% This command takes one mandatory argument and accepts one optional
1598% argument. Once references to be used as witnesses in the apparatus 1612% argument. Once references to be used as witnesses in the apparatus
1599% criticus have been declared in the preamble as described in 1613% criticus have been declared in the preamble as described in
@@ -1618,7 +1632,7 @@ yesterday.
1618%</example> 1632%</example>
1619% \fi 1633% \fi
1620% \cs{app} accepts one further optional argument:---\\ 1634% \cs{app} accepts one further optional argument:---\\
1621% \DescribeOption{type} |type|$=$\meta{type}\label{ref:app-type} 1635% \DescribeOption{type} |type|$=$\meta{type}\phts\label{ref:app-type}
1622% \hfill\tcboxverb{Default: default}\\ 1636% \hfill\tcboxverb{Default: default}\\
1623% As will be described below in \vref{sec:multilayer-apparatus}, 1637% As will be described below in \vref{sec:multilayer-apparatus},
1624% \pkg{ekdosis} initially sets one layer of notes\--- the |default| 1638% \pkg{ekdosis} initially sets one layer of notes\--- the |default|
@@ -1646,22 +1660,22 @@ yesterday.
1646% \enquote{source} and \enquote{scholar} as defined above 1660% \enquote{source} and \enquote{scholar} as defined above
1647% \vpageref{sec:terminology}. 1661% \vpageref{sec:terminology}.
1648% 1662%
1649% \paragraph{Lemmata} \label{ref:lemmata}\DescribeMacro{\lem} 1663% \paragraph{Lemmata} \phts\label{ref:lemmata}\DescribeMacro{\lem}
1650% \cs{lem}\oarg{options}\marg{lemma text}\\ 1664% \cs{lem}\oarg{options}\marg{lemma text}\\
1651% As \meta{lemma text} is a word or a phrase judged by the editor to 1665% As \meta{lemma text} is a word or a phrase judged by the editor to
1652% be authentic or authoritative, \cs{lem} prints it by default both in 1666% be authentic or authoritative, \cs{lem} prints it by default both in
1653% the edition text and as the first part of a new entry in the 1667% the edition text and as the first part of a new entry in the
1654% apparatus criticus, preceded by the line number where it occurs or a 1668% apparatus criticus, preceded by the line number where it occurs or a
1655% broad space if the entry refers to the same line as the preceding 1669% broad space if the entry refers to the same line as the preceding
1656% entry. \label{ref:lem-opts-b}The optional argument of \cs{lem} 1670% entry. \phts\label{ref:lem-opts-b}The optional argument of \cs{lem}
1657% accepts the following 1671% accepts the following
1658% comma-separated list of \enquote{name$=$value} arguments:---\\ 1672% comma-separated list of \enquote{name$=$value} arguments:---\\
1659% \DescribeOption{wit} |wit|$=$\meta{csv list of 1673% \DescribeOption{wit} |wit|$=$\meta{csv list of
1660% witnesses}\label{ref:lem-wit}\\ 1674% witnesses}\phts\label{ref:lem-wit}\\
1661% While a single witness may be recorded as in |wit=A|, 1675% While a single witness may be recorded as in |wit=A|,
1662% comma-separated lists of multiple witnesses must obviously be 1676% comma-separated lists of multiple witnesses must obviously be
1663% enclosed in curly braces, like so: 1677% enclosed in curly braces, like so:
1664% |wit={A,B,C}|. \label{ref:mss-sep-families}It must be noted that 1678% |wit={A,B,C}|. \phts\label{ref:mss-sep-families}It must be noted that
1665% witnesses can be grouped by using spaces as separators, like so: 1679% witnesses can be grouped by using spaces as separators, like so:
1666% \verb*|wit={A,B,C, D,E,F}|. Although any unique identifiers or 1680% \verb*|wit={A,B,C, D,E,F}|. Although any unique identifiers or
1667% labels used to \enquote{declare} sources and scholars as described 1681% labels used to \enquote{declare} sources and scholars as described
@@ -1670,7 +1684,7 @@ yesterday.
1670% recommended to use |sources| and |resp| to refer to either category 1684% recommended to use |sources| and |resp| to refer to either category
1671% respectively as described below.\\ 1685% respectively as described below.\\
1672% \DescribeOption{source} |source|$=$\meta{csv list of 1686% \DescribeOption{source} |source|$=$\meta{csv list of
1673% sources}\label{ref:lem-source}\newfeature[v1.1]\\ 1687% sources}\phts\label{ref:lem-source}\newfeature[v1.1]\\
1674% A \enquote{source} refers to any type of document consulted by the 1688% A \enquote{source} refers to any type of document consulted by the
1675% editor to establish the edition text. Most commonly, corrections and 1689% editor to establish the edition text. Most commonly, corrections and
1676% emendations from previous editions are cited in the apparatus 1690% emendations from previous editions are cited in the apparatus
@@ -1678,7 +1692,7 @@ yesterday.
1678% below in \vref{sec:emendations-conjectures} and 1692% below in \vref{sec:emendations-conjectures} and
1679% \vref{sec:references-cited-works}.}\\ 1693% \vref{sec:references-cited-works}.}\\
1680% \DescribeOption{resp} |resp|$=$\meta{csv list of 1694% \DescribeOption{resp} |resp|$=$\meta{csv list of
1681% scholars}\label{ref:lem-resp}\newfeature[v1.1]\\ 1695% scholars}\phts\label{ref:lem-resp}\newfeature[v1.1]\\
1682% |resp| refers to scholars responsible for the emendations, 1696% |resp| refers to scholars responsible for the emendations,
1683% conjectures and corrections that are cited in the apparatus 1697% conjectures and corrections that are cited in the apparatus
1684% criticus.\footnote{See detailed examples in 1698% criticus.\footnote{See detailed examples in
@@ -1741,7 +1755,7 @@ yesterday.
1741% |prewit| inserts \meta{words} \emph{before} the list of witnesses.\\ 1755% |prewit| inserts \meta{words} \emph{before} the list of witnesses.\\
1742% \DescribeOption{postwit} |postwit|$=$\meta{words}\pointtor{postwit}\\ 1756% \DescribeOption{postwit} |postwit|$=$\meta{words}\pointtor{postwit}\\
1743% |postwit| inserts \meta{words} \emph{after} the list of witnesses. 1757% |postwit| inserts \meta{words} \emph{after} the list of witnesses.
1744% \label{ref:lem-opts-e} 1758% \phts\label{ref:lem-opts-e}
1745% 1759%
1746% \paragraph{Readings} \DescribeMacro{\rdg} 1760% \paragraph{Readings} \DescribeMacro{\rdg}
1747% \cs{rdg}\oarg{options}\marg{variant reading}\\ 1761% \cs{rdg}\oarg{options}\marg{variant reading}\\
@@ -1757,7 +1771,7 @@ yesterday.
1757% provided above \vpagerefrange{ref:lem-opts-b}{ref:lem-opts-e} for 1771% provided above \vpagerefrange{ref:lem-opts-b}{ref:lem-opts-e} for
1758% more detailed information:---\\ 1772% more detailed information:---\\
1759% \DescribeOption{wit} |wit|$=$\meta{csv list of 1773% \DescribeOption{wit} |wit|$=$\meta{csv list of
1760% witnesses}\label{ref:rdg-wit}\\ 1774% witnesses}\phts\label{ref:rdg-wit}\\
1761% \DescribeOption{source} |source|$=$\meta{csv list of sources}\\ 1775% \DescribeOption{source} |source|$=$\meta{csv list of sources}\\
1762% \DescribeOption{resp} |resp|$=$\meta{csv list of scholars}\\ 1776% \DescribeOption{resp} |resp|$=$\meta{csv list of scholars}\\
1763% \DescribeOption{alt} |alt|$=$\meta{alternate reading}\\ 1777% \DescribeOption{alt} |alt|$=$\meta{alternate reading}\\
@@ -1775,9 +1789,9 @@ yesterday.
1775% \DescribeOption{postwit} |postwit|$=$\meta{words}\\ 1789% \DescribeOption{postwit} |postwit|$=$\meta{words}\\
1776% 1790%
1777% \paragraph{Notes} 1791% \paragraph{Notes}
1778% \DescribeMacro{\note}\label{ref:notes-b}\DescribeMacro{\note*} 1792% \DescribeMacro{\note}\phts\label{ref:notes-b}\DescribeMacro{\note*}
1779% \cs{note}\oarg{options}\marg{text} or 1793% \cs{note}\oarg{options}\marg{text} or
1780% \cs{note*}\oarg{options}\marg{text}\label{ref:editorial-notes}\\ 1794% \cs{note*}\oarg{options}\marg{text}\phts\label{ref:editorial-notes}\\
1781% It may happen that editorial notes be needed to record short 1795% It may happen that editorial notes be needed to record short
1782% comments of general nature \emph{between} lemmata and 1796% comments of general nature \emph{between} lemmata and
1783% readings. \cs{note} inserts inline comments while \cs{note*} places 1797% readings. \cs{note} inserts inline comments while \cs{note*} places
@@ -1927,7 +1941,7 @@ yesterday.
1927% \iffalse 1941% \iffalse
1928%</example> 1942%</example>
1929% \fi 1943% \fi
1930% \label{ref:notes-e} 1944% \phts\label{ref:notes-e}
1931% 1945%
1932% \subsection{Indicating Subvariation in Apparatus Entries} 1946% \subsection{Indicating Subvariation in Apparatus Entries}
1933% \label{sec:indic-subv-appar} 1947% \label{sec:indic-subv-appar}
@@ -2193,7 +2207,7 @@ friend
2193% |prewit=|\texttt{coni.} or |prewit=|\texttt{falso coni.}, to print 2207% |prewit=|\texttt{coni.} or |prewit=|\texttt{falso coni.}, to print
2194% explanatory words in the apparatus criticus before the abridged 2208% explanatory words in the apparatus criticus before the abridged
2195% name of the scholar. 2209% name of the scholar.
2196% \item \label{it:egomute}Conversely, line~9 introduces an 2210% \item \phts\label{it:egomute}Conversely, line~9 introduces an
2197% \emph{emendation} for which the shorthand |egoscr| has been used 2211% \emph{emendation} for which the shorthand |egoscr| has been used
2198% to print the exact term \emph{scripsi} in the apparatus criticus 2212% to print the exact term \emph{scripsi} in the apparatus criticus
2199% while keeping |ego| as an |xml:id| for the \texttt{TEI xml} output 2213% while keeping |ego| as an |xml:id| for the \texttt{TEI xml} output
@@ -2519,7 +2533,7 @@ friend
2519% 2533%
2520% \paragraph{The \env{alignment} Environment} 2534% \paragraph{The \env{alignment} Environment}
2521% \DescribeEnv{alignment} \cs{begin}|{alignment}|\oarg{options}\dots 2535% \DescribeEnv{alignment} \cs{begin}|{alignment}|\oarg{options}\dots
2522% \cs{end}|{alignment}|\label{ref:alignment-syntax}\\ 2536% \cs{end}|{alignment}|\phts\label{ref:alignment-syntax}\\
2523% This environment can be used as it is provided to typeset a standard 2537% This environment can be used as it is provided to typeset a standard
2524% critical edition, namely an edition text, equipped with an apparatus 2538% critical edition, namely an edition text, equipped with an apparatus
2525% criticus and laid out on the left-hand pages, accompanied by a 2539% criticus and laid out on the left-hand pages, accompanied by a
@@ -2555,12 +2569,13 @@ friend
2555%</example> 2569%</example>
2556% \fi 2570% \fi
2557% 2571%
2558% \DescribeEnv{edition*}\DescribeEnv{translation*} 2572% \DescribeEnv{edition*}
2559% \label{ref:starred-envs} Furthermore, so-called \enquote{starred} 2573% \DescribeEnv{translation*}
2560% versions of these environments can be used at any point to 2574% \phts\label{ref:starred-envs} Furthermore, so-called
2561% synchronize texts, that is to print them in such a way that the tops 2575% \enquote{starred} versions of these environments can be used at any
2562% of all paragraphs are vertically aligned. To that effect, it must be 2576% point to synchronize texts, that is to print them in such a way that
2563% noted that merely applying this command on a single 2577% the tops of all paragraphs are vertically aligned. To that effect,
2578% it must be noted that merely applying this command on a single
2564% environment\---for instance the leftmost one\---will have all other 2579% environment\---for instance the leftmost one\---will have all other
2565% associated paragraphs printed aligned. 2580% associated paragraphs printed aligned.
2566% 2581%
@@ -2761,7 +2776,7 @@ friend
2761% \item[\dbend] The colon at the end of line~3 closes the whole 2776% \item[\dbend] The colon at the end of line~3 closes the whole
2762% value of |text| and acts as a higher level separator. 2777% value of |text| and acts as a higher level separator.
2763% \end{enumerate} 2778% \end{enumerate}
2764% \item \label{it:lang-subopt} Each name may be followed by a 2779% \item \phts\label{it:lang-subopt} Each name may be followed by a
2765% \enquote*{suboptional} argument between square brackets which will 2780% \enquote*{suboptional} argument between square brackets which will
2766% then be used to insert \texttt{TEI xml} attributes in the 2781% then be used to insert \texttt{TEI xml} attributes in the
2767% corresponding |<div>| element. For example, \iffalse 2782% corresponding |<div>| element. For example, \iffalse
@@ -3054,9 +3069,9 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3054% the apparatus criticus (e.g. sources, testimonia, variant readings 3069% the apparatus criticus (e.g. sources, testimonia, variant readings
3055% \emph{\&c.}) 3070% \emph{\&c.})
3056% 3071%
3057% \DescribeMacro{\SetHooks} 3072% \DescribeMacro{\SetHooks} \cs{SetHooks}\marg{csv list of hooks} can
3058% \cs{SetHooks}\marg{csv list of hooks} can be used either in 3073% be used either in the preamble or at any point of the document. The
3059% the preamble or at any point of the document. The list of accepted 3074% list of accepted
3060% hooks at the time of writing follows:---\\ 3075% hooks at the time of writing follows:---\\
3061% \DescribeOption{appfontsize} |appfontsize|$=$\meta{command} 3076% \DescribeOption{appfontsize} |appfontsize|$=$\meta{command}
3062% \hfill\tcboxverb{Default: \footnotesize}\\ 3077% \hfill\tcboxverb{Default: \footnotesize}\\
@@ -3069,8 +3084,8 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3069% font used to print references to line numbers in the apparatus 3084% font used to print references to line numbers in the apparatus
3070% criticus. By default, numbers are printed in bold face. As an 3085% criticus. By default, numbers are printed in bold face. As an
3071% example, |refnumstyle=\normalfont| will have them printed in the 3086% example, |refnumstyle=\normalfont| will have them printed in the
3072% font and shape selected by default for the 3087% font and shape selected by default for the document, while
3073% document, while |refnumstyle=\bfseries\itshape| will have them 3088% |refnumstyle=\bfseries\itshape| will have them
3074% printed in bold and italic.\\ 3089% printed in bold and italic.\\
3075% \DescribeOption{postrefnum} |postrefnum|$=$\meta{command \textbar\ 3090% \DescribeOption{postrefnum} |postrefnum|$=$\meta{command \textbar\
3076% chars}\hfill\tcboxverb{Default: ~}\\ 3091% chars}\hfill\tcboxverb{Default: ~}\\
@@ -3091,7 +3106,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3091% \newfeature[v1.2] |readingstyle| operates in the same way as 3106% \newfeature[v1.2] |readingstyle| operates in the same way as
3092% |lemmastyle| but applies to variant readings.\\ 3107% |lemmastyle| but applies to variant readings.\\
3093% \DescribeOption{initialrule} |initialrule|$=$\meta{command} 3108% \DescribeOption{initialrule} |initialrule|$=$\meta{command}
3094% \label{ref:initialrule}\hfill\bgroup\footnotesize 3109% \phts\label{ref:initialrule}\hfill\bgroup\footnotesize
3095% \tcboxverb{Default: \rule{0.4\columnwidth}{0.4pt} (initially not set)}% 3110% \tcboxverb{Default: \rule{0.4\columnwidth}{0.4pt} (initially not set)}%
3096% \egroup 3111% \egroup
3097% \newfeature[v1.2] |initialrule| draws a separating rule between the 3112% \newfeature[v1.2] |initialrule| draws a separating rule between the
@@ -3102,7 +3117,10 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3102% \DescribeOption{noinitialrule}\hfill\tcboxverb{Default: not set}\\ 3117% \DescribeOption{noinitialrule}\hfill\tcboxverb{Default: not set}\\
3103% This is a no-value option. It removes any previously set 3118% This is a no-value option. It removes any previously set
3104% |initialrule|. 3119% |initialrule|.
3105% 3120%
3121% An example of the way these hooks may be used is provided below in
3122% \vref{lst:shak-sonnet1}.
3123%
3106% \subsection{Single-Layer Apparatus Criticus} 3124% \subsection{Single-Layer Apparatus Criticus}
3107% \label{sec:single-layer-app} 3125% \label{sec:single-layer-app}
3108% \paragraph{Specific Commands} 3126% \paragraph{Specific Commands}
@@ -3130,13 +3148,12 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3130% block, while |\SetBeginApparatus{\hskip 1em}| will set an 3148% block, while |\SetBeginApparatus{\hskip 1em}| will set an
3131% indentation of one em. 3149% indentation of one em.
3132% 3150%
3133% \DescribeMacro{\SetEndApparatus} 3151% \DescribeMacro{\SetEndApparatus}\phts\label{ref:setendapparatus}
3134% \label{ref:setendapparatus}
3135% \cs{SetEndApparatus}\marg{characters} can be used to append 3152% \cs{SetEndApparatus}\marg{characters} can be used to append
3136% \meta{characters} at the end of the apparatus block. By default, 3153% \meta{characters} at the end of the apparatus block. By default,
3137% nothing is appended. \label{ref:ending-dot}As an example of use, 3154% nothing is appended. \phts\label{ref:ending-dot}As an example of
3138% |\SetEndApparatus{.}| will have a period printed at the end of the 3155% use, |\SetEndApparatus{.}| will have a period printed at the end of
3139% apparatus as it is customary in some 3156% the apparatus as it is customary in some
3140% editions.\footnote{\label{fn:rm-dots}See also below 3157% editions.\footnote{\label{fn:rm-dots}See also below
3141% \vpageref{sec:superfluous-dots} on how to remove superfluous dots.} 3158% \vpageref{sec:superfluous-dots} on how to remove superfluous dots.}
3142% 3159%
@@ -3157,14 +3174,14 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3157% as in \cs{SetDefaultRule}|{}| removes the line. 3174% as in \cs{SetDefaultRule}|{}| removes the line.
3158% 3175%
3159% \DescribeMacro{\SetApparatusLanguage} 3176% \DescribeMacro{\SetApparatusLanguage}
3160% \label{ref:app-lang}\newfeature[v1.2] 3177% \phts\label{ref:app-lang}\newfeature[v1.2]
3161% \cs{SetApparatusLanguage}\marg{languagename} can be used when it is 3178% \cs{SetApparatusLanguage}\marg{languagename} can be used when it is
3162% needed to apply in the apparatus criticus a language different from 3179% needed to apply in the apparatus criticus a language different from
3163% the one that is selected in the edition text. 3180% the one that is selected in the edition text.
3164% 3181%
3165% \paragraph{General Command} 3182% \paragraph{General Command}
3166% \DescribeMacro{\SetApparatus} \cs{SetApparatus}\marg{csv list of 3183% \DescribeMacro{\SetApparatus} \cs{SetApparatus}\marg{csv list of
3167% apparatus settings}\label{ref:apparatus-settings-b}\\ 3184% apparatus settings}\phts\label{ref:apparatus-settings-b}\\
3168% Finally, all the settings described above can also be collected in 3185% Finally, all the settings described above can also be collected in
3169% the argument of \cs{SetApparatus}. \cs{SetApparatus} accepts the 3186% the argument of \cs{SetApparatus}. \cs{SetApparatus} accepts the
3170% following list of comma-separated |key=value| options:---\\ 3187% following list of comma-separated |key=value| options:---\\
@@ -3194,9 +3211,9 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3194% also be used to remove the line.\\ 3211% also be used to remove the line.\\
3195% \DescribeOption{norule}\hfill\tcboxverb{Default: not set}\\ 3212% \DescribeOption{norule}\hfill\tcboxverb{Default: not set}\\
3196% |norule| does not accept any value and has the same effect as 3213% |norule| does not accept any value and has the same effect as
3197% |rule=none|.\label{ref:apparatus-settings-e}\\ 3214% |rule=none|.\phts\label{ref:apparatus-settings-e}\\
3198% \DescribeOption{lang} |lang|$=$\meta{languagename} 3215% \DescribeOption{lang} |lang|$=$\meta{languagename}
3199% \newfeature[v1.2]\label{ref:app-lang-opt} 3216% \newfeature[v1.2]\phts\label{ref:app-lang-opt}
3200% \hfill\tcboxverb{Default: not set}\\ 3217% \hfill\tcboxverb{Default: not set}\\
3201% |lang=<languagename>| is used as described 3218% |lang=<languagename>| is used as described
3202% \vpageref[above]{ref:app-lang} when it is needed to apply in the 3219% \vpageref[above]{ref:app-lang} when it is needed to apply in the
@@ -3209,7 +3226,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3209% and variant readings, a broad space as a delimiter between entries 3226% and variant readings, a broad space as a delimiter between entries
3210% and a \unit[0.7]{in} line above could be laid out as follows:--- 3227% and a \unit[0.7]{in} line above could be laid out as follows:---
3211% 3228%
3212% \label{ex:single-layer-app-layout} 3229% \phts\label{ex:single-layer-app-layout}
3213% \iffalse 3230% \iffalse
3214%<*example> 3231%<*example>
3215% \fi 3232% \fi
@@ -3252,7 +3269,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3252% internally. If any additional layer of notes be declared in the 3269% internally. If any additional layer of notes be declared in the
3253% preamble, this |default| layer must be included in the list of 3270% preamble, this |default| layer must be included in the list of
3254% declared layers.\\ 3271% declared layers.\\
3255% \DescribeMacro{\SetDefaultApparatus}\label{ref:ekd-default-app} 3272% \DescribeMacro{\SetDefaultApparatus}\phts\label{ref:ekd-default-app}
3256% \cs{SetDefaultApparatus}\marg{name} can be used at any point of the 3273% \cs{SetDefaultApparatus}\marg{name} can be used at any point of the
3257% document to change the name to be used as the default one by 3274% document to change the name to be used as the default one by
3258% \pkg{ekdosis}. 3275% \pkg{ekdosis}.
@@ -3297,7 +3314,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3297% \DescribeOption{ehook} 3314% \DescribeOption{ehook}
3298% \DescribeOption{rule} 3315% \DescribeOption{rule}
3299% \DescribeOption{norule} 3316% \DescribeOption{norule}
3300% \DescribeOption{lang}\label{ref:apps-lang-opt} 3317% \DescribeOption{lang}\phts\label{ref:apps-lang-opt}
3301% With regard to layout, any declared layer inherits the default values 3318% With regard to layout, any declared layer inherits the default values
3302% described above in \vref{sec:single-layer-app}. That said, as the 3319% described above in \vref{sec:single-layer-app}. That said, as the
3303% optional argument of \cs{DeclareApparatus} accepts the exact same 3320% optional argument of \cs{DeclareApparatus} accepts the exact same
@@ -3348,7 +3365,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3348% \end{remarks} 3365% \end{remarks}
3349% 3366%
3350% \paragraph{Limiting the Number of Entries per Page} 3367% \paragraph{Limiting the Number of Entries per Page}
3351% \label{ref:maxentries} 3368% \phts\label{ref:maxentries}
3352% In some instances, it can be useful to set a limit to the number of 3369% In some instances, it can be useful to set a limit to the number of
3353% entries per page that a given layer of critical notes may accept, 3370% entries per page that a given layer of critical notes may accept,
3354% notably when entries are so abundant in number that \pkg{ekdosis} 3371% notably when entries are so abundant in number that \pkg{ekdosis}
@@ -3754,18 +3771,25 @@ argument of the
3754% 3771%
3755% \subsection[The \textsf{verse} Package]{The \pkg{verse} Package} 3772% \subsection[The \textsf{verse} Package]{The \pkg{verse} Package}
3756% \label{sec:verse-package} 3773% \label{sec:verse-package}
3774% \newfeature[v1.2]
3757% \pkg{ekdosis} can use the facilities offered by the excellent 3775% \pkg{ekdosis} can use the facilities offered by the excellent
3758% \pkg{verse} package\footcite{verse} to which it adds a specific 3776% \pkg{verse} package\footcite{verse} to which it adds a specific
3759% environment for the encoding of line groups such as 3777% environment for the encoding of line groups such as
3760% stanzas. Furthermore, as the \pkg{verse} package provides its own 3778% stanzas. Furthermore, as the \pkg{verse} package provides its own
3761% numbering mechanism, the lines can be numbered independently of 3779% numbering mechanism, the lines can be numbered independently of
3762% prose text. 3780% prose text.\footnote{See \vpageref{ref:verse-lineation} for
3781% details.}
3763% 3782%
3764% \danger For what is described in this section to operate, 3783% \danger For what is described in this section to operate,
3765% \pkg{ekdosis} must be loaded with the global option |poetry=verse| 3784% \pkg{ekdosis} must be loaded with the global option |poetry=verse|
3766% as explained above \vpageref{ref:poetry-opt}. Simply loading the 3785% as explained above \vpageref{ref:poetry-opt}. Simply loading the
3767% \pkg{verse} package by means of \cs{usepackage} will have no effect. 3786% \pkg{verse} package by means of \cs{usepackage} will have no effect.
3768% 3787%
3788% \danger The foregoing does not apply if the \cls{memoir} class is
3789% used.\footcite{memoir} In this case, \pkg{ekdosis} automatically
3790% uses the code provided by this class without the need to set
3791% the global option |poetry=verse|.
3792%
3769% \paragraph{Compatible Verse Commands} 3793% \paragraph{Compatible Verse Commands}
3770% The reader is invited to refer to the documentation of the 3794% The reader is invited to refer to the documentation of the
3771% \env{verse} package for detailed information. Within the 3795% \env{verse} package for detailed information. Within the
@@ -3787,13 +3811,14 @@ argument of the
3787% specified is added between lines, whereas |\\>[...]| adds an 3811% specified is added between lines, whereas |\\>[...]| adds an
3788% horizontal space after the line break. 3812% horizontal space after the line break.
3789% 3813%
3790% \DescribeMacro{\vin} \cs{vin} indents a verse line by a length which 3814% \DescribeMacro{\vin} \phts\label{ref:verse-vin}\cs{vin} indents a
3791% is by default \unit[1.5]{em}. This length is stored as \cs{vgap} and 3815% verse line by a length which is by default \unit[1.5]{em}. This
3792% can be changed by \cs{setlength} or \cs{addtolength}. 3816% length is stored as \cs{vgap} and can be changed by \cs{setlength}
3817% or \cs{addtolength}.
3793% 3818%
3794% \paragraph{The \env{ekdverse} Environment} 3819% \paragraph{The \env{ekdverse} Environment}
3795% \DescribeEnv{ekdverse} \cs{begin}|{ekdverse}|\oarg{options} \dots\ 3820% \DescribeEnv{ekdverse} \cs{begin}|{ekdverse}|\oarg{options} \dots\
3796% \cs{end}|{ekdverse}|\label{ref:ekdverse-syntax}\newfeature[v1.2]\\ 3821% \cs{end}|{ekdverse}|\phts\label{ref:ekdverse-syntax}\\
3797% This environment is used to hold verse lines as described above and 3822% This environment is used to hold verse lines as described above and
3798% may receive an optional argument in which the following 3823% may receive an optional argument in which the following
3799% \enquote{name$=$value} arguments are accepted:---\\ 3824% \enquote{name$=$value} arguments are accepted:---\\
@@ -3818,15 +3843,20 @@ argument of the
3818% \fi % 3843% \fi %
3819% \begin{remarks} 3844% \begin{remarks}
3820% \item[\textsc{Rem.}] \cs{versewidth} is provided by the \env{verse} 3845% \item[\textsc{Rem.}] \cs{versewidth} is provided by the \env{verse}
3821% package as a convenience and can be used by \env{ekdosis}. 3846% package as a convenience and can be used by \env{ekdosis}.
3822% \end{remarks} 3847% \end{remarks}
3823% \DescribeOption{type} |width|$=$\meta{type} 3848% \DescribeOption{type} |type|$=$\meta{type}
3824% \hfill\tcboxverb{Default: not set}\\ 3849% \hfill\tcboxverb{Default: not set}\\
3825% This named argument is used in the \texttt{TEI xml} output to 3850% This named argument is used in the \texttt{TEI xml} output to
3826% name the type of unit encoded within the |<lg>| element, viz.\ 3851% name the type of unit encoded within the |<lg>| element, viz.\
3827% \enquote{sonnet}, \enquote{quatrain}, \enquote{couplet} and the 3852% \enquote{sonnet}, \enquote{quatrain}, \enquote{couplet} and the
3828% like. 3853% like.
3829% 3854%
3855% \danger Unlike the \texttt{TEI xml} element |<lg>|, \env{ekdverse}
3856% may not nest hiearchichally. Within this environment,
3857% \env{ekdstanza} must be used instead to encode stanzas as described
3858% \vpageref[below][below]{ref:ekdstanza}.
3859%
3830% As an example, the first five lines of Homer's \emph{Odyssey} could 3860% As an example, the first five lines of Homer's \emph{Odyssey} could
3831% be encoded like so:\footcite{HomerMurray}--- 3861% be encoded like so:\footcite{HomerMurray}---
3832% 3862%
@@ -3933,6 +3963,208 @@ argument of the
3933%</example> 3963%</example>
3934% \fi 3964% \fi
3935% 3965%
3966% \paragraph{Stanzas}
3967% As can be seen above, the \LaTeX\ \env{ekdverse} environment is
3968% translated into the \texttt{TEI xml} |<lg>| element. The |type|
3969% attribute may then be used to name the type of unit encoded by this
3970% element.
3971%
3972% \DescribeEnv{ekdstanza} \cs{begin}|{ekdstanza}|\oarg{options} \dots\
3973% \cs{end}|{ekdstanza}| \phts\label{ref:ekdstanza}\\
3974% This environment is used within \env{ekdverse} to encode succeeding
3975% stanzaic forms. Within \env{ekdstanza}, the last line is ended by
3976% |\\!| or |\\| depending on whether an additional vertical space is
3977% required between stanzas. This environment may receive an optional
3978% argument in which the following \enquote{name$=$value} argument is
3979% accepted:---\\
3980% \DescribeOption{type} |type|$=$\meta{type}
3981% \hfill\tcboxverb{Default: not set}\\
3982% As in the case of \env{ekdverse}, this named argument is used in the
3983% \texttt{TEI xml} output to name the type of unit encoded within the
3984% |<lg>| element, viz.\ \enquote{quatrain}, \enquote{couplet} and the
3985% like.
3986%
3987% \paragraph{Indentation Patterns}
3988% \pkg{ekdosis} can use the \env{patverse} environment and its
3989% associated command \cs{indentpattern} that are provided by the
3990% \pkg{verse} package. As described in the documentation of this
3991% package,\footcite[6]{verse} the indentation pattern consists of an
3992% array of digits, \emph{d\textsubscript{1}} to
3993% \emph{d\textsubscript{n}}, where the \emph{n\textsuperscript{th}}
3994% line is indented by \emph{d\textsubscript{n}} times the amount of
3995% \cs{vgap} described above \vpageref{ref:verse-vin}.
3996%
3997% The overall structure of lines grouped into stanzas may look as
3998% follows:---
3999%
4000% \iffalse
4001%<*example>
4002% \fi
4003\begin{minted}[escapeinside=++]{latex}
4004\begin{ekdverse}[type={+\emph{overall type}+}]
4005 \identpattern{+\emph{digits}+}
4006 \begin{patverse}
4007 \begin{ekdstanza}[type={+\emph{stanza 1 type}+}]
4008 line 1 \\
4009 line 2 \\
4010 [...]
4011 final line \\!
4012 \end{ekdstanza}
4013 \end{patverse}
4014\end{ekdverse}
4015\end{minted}
4016% \iffalse
4017%</example>
4018% \fi
4019%
4020% Of course, if no indentation pattern be required or be only required
4021% occasionally, \env{patverse} (ll.~3 and 10) and \cs{indentpattern}
4022% (l.~2) are of no use:---
4023%
4024% \iffalse
4025%<*example>
4026% \fi
4027\begin{minted}[escapeinside=++]{latex}
4028\begin{ekdverse}[type={+\emph{overall type}+}]
4029 \begin{ekdstanza}[type={+\emph{stanza 1 type}+}]
4030 line 1 \\
4031 line 2 \\
4032 \vin indented line 3 \\
4033 [...]
4034 final line \\!
4035 \end{ekdstanza}
4036\end{ekdverse}
4037\end{minted}
4038% \iffalse
4039%</example>
4040% \fi
4041%
4042% A detailed example follows. It is taken from
4043% \citename{McDonald1916}{editor}'s edition of Shakespeare's
4044% \emph{Sonnets} from the Quarto of 1609 with variorum
4045% readings.\footcite[Sonnet~1, \pno~15]{McDonald1916} Compared to
4046% \citename{McDonald1916}{shorteditor}'s edition, an effort has been
4047% made to use the typography and punctuation of the original edition
4048% which can be consulted online at the British Library's
4049% website.\footnote{Shake-speares \emph{Sonnets}. Neuer before
4050% Imprinted. (A Louers Complaint. By William
4051% Shake-speare.). \url{https://www.bl.uk/collection-items/first-edition-of-shakespeares-sonnets-1609}.
4052% Call number \texttt{C.21.c.44}, fol.~B.} However, this typographical
4053% refinement has been retained for the sonnet only. For the sake of
4054% clarity, the line numbers and the apparatus criticus use modern
4055% typography. The references to line numbers in the apparatus criticus
4056% have been made consistent with
4057% \citename{McDonald1916}{shorteditor}'s edition, as have the entries
4058% in the apparatus criticus, namely the bare line number followed by a
4059% dot, then the lemma text in bold face, then the variant in italic
4060% shape:---
4061%
4062% \captof{Poetry: Shakespeare's Sonnet~1}[\label{lst:shak-sonnet1}]
4063% \iffalse
4064%<*example>
4065% \fi
4066\begin{minted}{latex}
4067\junicode % Use the Junicode font with 'hist' feature enabled for
4068 % long-s
4069% MacDonald's style for numbers and entries in the apparatus
4070% criticus:
4071\SetHooks{
4072 refnumstyle=\normalfont,
4073 postrefnum=.~,
4074 lemmastyle=\bfseries,
4075 readingstyle=\itshape
4076}
4077% The lines are to be centered horizontally:
4078\settowidth{\versewidth}{Feed'st thy lights flame with selfe
4079substantiall fewell,}
4080% Format of the outermost <div> element:
4081\NewDocumentEnvironment{ekdcenter}{}{\par\centering}{\nobreak\par}
4082\FormatDiv{1}{\begin{ekdcenter}}{\end{ekdcenter}}
4083\begin{ekdosis}
4084 \ekddiv{type=sonnets, n=1, head=1}
4085 \begin{ekdverse}[type=sonnet, width=\versewidth]
4086 \indentpattern{00000000000011}
4087 \begin{patverse}
4088 \begin{ekdstanza}[type=quatrain]
4089 \ekdlettrine{F}{r}om fairest creatures we desire
4090 increase,\\
4091 That thereby beauties \emph{Rose}
4092 \app{
4093 \lem{might}
4094 \rdg[source={Gildon1710, Sewell1725, Ewing1771}]{may}
4095 } neuer die,\\
4096 But as the riper should by time
4097 \app{
4098 \lem{decease}
4099 \rdg[source=Hudson1856]{decrease}
4100 },\\
4101 His tender heire might beare his memory:\\
4102 \end{ekdstanza}
4103 \begin{ekdstanza}[type=quatrain]
4104 But thou contracted to thine owne bright eyes,\\
4105 Feed'st thy
4106 \app{
4107 \lem{lights}
4108 \rdg[source={Butler1899, Walsh1908}]{life's}
4109 } flame with
4110 \app{
4111 \lem{selfe substantiall}
4112 \rdg[source=Gildon1714,
4113 alt={\textnormal{Hyphened by}}]{selfe-substantiall}
4114 \note{etc.}} fewell,\\
4115 Making a famine where aboundance lies,\\
4116 Thy selfe thy foe,to thy sweet selfe too cruell:\\
4117 \end{ekdstanza}
4118 \begin{ekdstanza}[type=quatrain]
4119 Thou that art now the worlds fresh ornament,\\
4120 And
4121 \app{
4122 \lem{only}
4123 \rdg[resp=God, type=conjecture]{early}
4124 \note{conj.}
4125 } herauld to the gaudy spring,\\
4126 Within thine owne bud buriest thy content,\\
4127 And tender
4128 \app{
4129 \lem{chorle}
4130 \rdg[source=Gildon1710]{churl}
4131 \note{etc.}
4132 } makst wast in niggarding:\\
4133 \end{ekdstanza}
4134 \begin{ekdstanza}[type=couplet]
4135 Pitty the world,or else this glutton be,\\
4136 To eate the worlds due,\app{
4137 \lem{by the}
4138 \rdg[resp=Stee, type=conjecture]{be thy}
4139 \note{conj.}
4140 \rdg[resp=God, type=conjecture]{by thy}
4141 \note{conj.}
4142 } graue
4143 \app{
4144 \lem{and}
4145 \rdg[resp=God, type=conjecture]{as}
4146 \note{conj.}
4147 } thee.\\!
4148 \end{ekdstanza}
4149 \end{patverse}
4150 \end{ekdverse}
4151\end{ekdosis}
4152\end{minted}
4153% \iffalse
4154%</example>
4155% \fi
4156%
4157% \begin{remarks}
4158% \item[\textsc{Rem.}] \cs{ekdlettrine} (l.~23) is a specific command
4159% for the \pkg{lettrine} package does not work in list
4160% environments. \cs{TeXtoTEIPat} has been used as described below
4161% \vpageref{ref:textoteipat} to instruct \pkg{ekdosis} to convert this
4162% command into an acceptable \texttt{TEI} equivalent.
4163% \end{remarks}
4164%
4165% PDF output:---
4166% \medskip
4167%
3936% \begingroup 4168% \begingroup
3937% \junicode 4169% \junicode
3938% \SetHooks{ 4170% \SetHooks{
@@ -4024,7 +4256,90 @@ argument of the
4024% \end{alignment} 4256% \end{alignment}
4025% \endgroup 4257% \endgroup
4026% 4258%
4027% \url{https://www.bl.uk/collection-items/first-edition-of-shakespeares-sonnets-1609} 4259% \texttt{TEI xml} output:---
4260% \medskip
4261%
4262% \iffalse
4263%<*example>
4264% \fi
4265\begin{minted}[linenos=false]{xml}
4266<div type="sonnets" n="1">
4267 <head>1</head>
4268 <lg type="sonnet">
4269 <lg type="quatrain">
4270 <l>
4271 <hi rend="smallcaps">Fr</hi>om fairest creatures we
4272 desire increase,</l>
4273 <l>That thereby beauties
4274 <emph>Rose</emph>
4275 <app>
4276 <lem>might</lem>
4277 <rdg source="#Gildon1710 #Sewell1725 #Ewing1771">
4278 may</rdg>
4279 </app>neuer die,</l>
4280 <l>But as the riper should by time
4281 <app>
4282 <lem>decease</lem>
4283 <rdg source="#Hudson1856">decrease</rdg>
4284 </app>,</l>
4285 <l>His tender heire might beare his memory:</l>
4286 </lg>
4287 <lg type="quatrain">
4288 <l>But thou contracted to thine owne bright eyes,</l>
4289 <l>Feed'st thy
4290 <app>
4291 <lem>lights</lem>
4292 <rdg source="#Butler1899 #Walsh1908">
4293 life's</rdg>
4294 </app>flame with
4295 <app>
4296 <lem>selfe substantiall</lem>
4297 <rdg source="#Gildon1714">
4298 selfe-substantiall</rdg>
4299 <note>etc.</note>
4300 </app>fewell,</l>
4301 <l>Making a famine where aboundance lies,</l>
4302 <l>Thy selfe thy foe,to thy sweet selfe too
4303 cruell:</l>
4304 </lg>
4305 <lg type="quatrain">
4306 <l>Thou that art now the worlds fresh ornament,</l>
4307 <l>And
4308 <app>
4309 <lem>only</lem>
4310 <rdg resp="#God" type="conjecture">early</rdg>
4311 <note>conj.</note>
4312 </app>herauld to the gaudy spring,</l>
4313 <l>Within thine owne bud buriest thy content,</l>
4314 <l>And tender
4315 <app>
4316 <lem>chorle</lem>
4317 <rdg source="#Gildon1710">churl</rdg>
4318 <note>etc.</note>
4319 </app>makst wast in niggarding:</l>
4320 </lg>
4321 <lg type="couplet">
4322 <l>Pitty the world,or else this glutton be,</l>
4323 <l>To eate the worlds due,
4324 <app>
4325 <lem>by the</lem>
4326 <rdg resp="#Stee" type="conjecture">be thy</rdg>
4327 <note>conj.</note>
4328 <rdg resp="#God" type="conjecture">by thy</rdg>
4329 <note>conj.</note>
4330 </app>graue
4331 <app>
4332 <lem>and</lem>
4333 <rdg resp="#God" type="conjecture">as</rdg>
4334 <note>conj.</note>
4335 </app>thee.</l>
4336 </lg>
4337 </lg>
4338</div>
4339\end{minted}
4340% \iffalse
4341%</example>
4342% \fi
4028% 4343%
4029% \section{Lineation Settings} 4344% \section{Lineation Settings}
4030% \label{sec:lineation} 4345% \label{sec:lineation}
@@ -4044,6 +4359,7 @@ argument of the
4044% options} may be used in the preamble or at any point of the document 4359% options} may be used in the preamble or at any point of the document
4045% to set lineation preferences. Its argument processes the |key=value| 4360% to set lineation preferences. Its argument processes the |key=value|
4046% options that follow:---\\ 4361% options that follow:---\\
4362% \textbf{General Options}\\
4047% \DescribeOption{lineation} |lineation|$=$\verb+page|document+ 4363% \DescribeOption{lineation} |lineation|$=$\verb+page|document+
4048% \hfill\tcboxverb{Default: document}\\ 4364% \hfill\tcboxverb{Default: document}\\
4049% |lineation=document| has the lines numbered continuously throughout 4365% |lineation=document| has the lines numbered continuously throughout
@@ -4069,14 +4385,36 @@ argument of the
4069% elides the last number of a range to the fewest number of figures 4385% elides the last number of a range to the fewest number of figures
4070% possible\---viz. 35--7, 129--31 \emph{\&c.}\---without eliding 4386% possible\---viz. 35--7, 129--31 \emph{\&c.}\---without eliding
4071% digits in the group 10 to 19 in each hundred\---viz. 17--19, 115--18 4387% digits in the group 10 to 19 in each hundred\---viz. 17--19, 115--18
4072% \emph{\&c.} |numbers=full| leaves the numbers untouched. 4388% \emph{\&c.} |numbers=full| leaves the numbers untouched.\\
4073%
4074% \DescribeMacro{\innerlinenumbers} \DescribeMacro{\outerlinenumbers} 4389% \DescribeMacro{\innerlinenumbers} \DescribeMacro{\outerlinenumbers}
4075% \cs{innerlinenumbers} and \cs{outerlinenumbers} are equivalent to 4390% \cs{innerlinenumbers} and \cs{outerlinenumbers} are equivalent to
4076% \cs{SetLineation}|{numb|\allowbreak|ers=outer}| and 4391% \cs{SetLineation}|{numb|\allowbreak|ers=outer}| and
4077% \cs{SetLineation}|{numbers=inner}| respectively. Both commands are 4392% \cs{SetLineation}|{numbers=inner}| respectively. Both commands are
4078% complementary to \cs{rightlinenumbers} and \cs{leftlinenumbers} 4393% complementary to \cs{rightlinenumbers} and \cs{leftlinenumbers}
4079% already provided by the \pkg{lineno} package. 4394% already provided by the \pkg{lineno} package.\\
4395% \textbf{Options Specific to the |poetry=verse| Global
4396% Setting}\footnote{See above
4397% \vref{sec:verse-package}.}\phts\label{ref:verse-lineation}\\
4398% \DescribeOption{vlineation} |vlineation|$=$\verb+page|document+
4399% \hfill\tcboxverb{Default: document}\\
4400% |vlineation| operates on verse texts in the same way as |lineation|
4401% on prose texts.\\
4402% \DescribeOption{vmodulo} |vmodulo|$=$\emph{n} (where \emph{n} is
4403% an integer)\hfill\tcboxverb{Initially: 1, Default: 5}\\
4404% |vmodulo|$=$\emph{n} has every \emph{n\textsuperscript{th}} lines of
4405% verse printed in the margin. If used without value, this option is
4406% equivalent to |vmodulo=5|. |vmodulo=0| prevents the
4407% numbers from being printed.\\
4408% \DescribeOption{vmargin} |vmargin|$=$\verb+right|left+
4409% \hfill\tcboxverb{Initially: right}\\
4410% |vmargin| sets the margin in which the verse line numbers are to be
4411% printed.\\
4412% \DescribeOption{continuousvnum}\hfill\tcboxverb{Default: not set}\\
4413% The |poetry=verse| global option has the succeeding lines of verse
4414% numbered independently of prose text. |continuousvnum| has all lines
4415% numbered continuously, irrespective of whether they are lines of
4416% prose or poetry text.
4417%
4080% 4418%
4081% \paragraph{Useful Lineation Commands} 4419% \paragraph{Useful Lineation Commands}
4082% As implied above, pretty much all commands that are provided by the 4420% As implied above, pretty much all commands that are provided by the
@@ -4094,13 +4432,32 @@ argument of the
4094% \DescribeMacro{\linenumbersep} \cs{linenumbersep} is the distance 4432% \DescribeMacro{\linenumbersep} \cs{linenumbersep} is the distance
4095% between the numbers and the margin. By default, this distance is set 4433% between the numbers and the margin. By default, this distance is set
4096% to \unit[10]{pt}. It can be redefined like so: 4434% to \unit[10]{pt}. It can be redefined like so:
4097% \cs{setlength}\cs{linenumbersep}\marg{length}.\\ 4435% \cs{setlength}\cs{linenumbersep}\marg{length}.
4098% \DescribeMacro{\linelabel} \DescribeMacro{\lineref} 4436%
4099% \cs{linelabel}\marg{label} sets a line label that can be referred to 4437% \paragraph{Poetry Lineation Commands}
4100% with \cs{lineref}\marg{label}. 4438% In addition to these commands, if \pkg{ekdosis} be loaded with the
4439% global option |poetry=verse| as described above in
4440% \vref{sec:verse-package}, the commands dedicated to line numbering
4441% that are provided by the \pkg{verse} package can be used.\\
4442% \DescribeMacro{\resetvlinenumber} \cs{resetvlinenumber}\oarg{n} has
4443% for lines of verse the same effect as \cs{resetlinenumber} for
4444% lines of prose text.\\
4445% \DescribeMacro{\verselinenumfont}
4446% \cs{verselinenumfont}\marg{commands} can be used to set the font
4447% used for lines of verse. By default, the definition is
4448% |\normalfont\footnotesize|. \danger If the \cls{memoir} class be
4449% loaded, this command is replaced with \cs{linenumberfont} described
4450% above.\\
4451% \DescribeMacro{\vrightskip} The \pkg{verse} package prints the
4452% numbers at the distance \cs{vrightskip} into the right margin. This
4453% distance can be redefined by means of \cs{setlength} like so:
4454% \cs{setlength}\cs{vrightskip}\allowbreak\marg{length}.
4101% 4455%
4102% The reader is invited to refer to the documentation of the 4456%
4103% \pkg{lineno} package for more information. 4457% \paragraph{Labels}
4458% \DescribeMacro{\linelabel} \DescribeMacro{\ref} In prose as well
4459% as in poetry texts, \cs{linelabel}\marg{label} sets a line label
4460% that can be referred to with \cs{ref}\marg{label}.
4104% 4461%
4105% As an example, what follows has every fifth line number printed in 4462% As an example, what follows has every fifth line number printed in
4106% the inner margins. Additionally, the numbering shall start afresh at 4463% the inner margins. Additionally, the numbering shall start afresh at
@@ -4876,7 +5233,7 @@ subtype="arabtex">'inna 'abI kAna mina
4876% circumstantially arise. 5233% circumstantially arise.
4877% 5234%
4878% \paragraph{Superfluous Dots} 5235% \paragraph{Superfluous Dots}
4879% \label{sec:superfluous-dots} 5236% \phts\label{sec:superfluous-dots}
4880% As said above \vpageref{ref:ending-dot}, it is customary in some 5237% As said above \vpageref{ref:ending-dot}, it is customary in some
4881% editions to have a full stop printed at the end of the apparatus 5238% editions to have a full stop printed at the end of the apparatus
4882% criticus. \pkg{ekdosis} provides specific commands to achieve this 5239% criticus. \pkg{ekdosis} provides specific commands to achieve this
@@ -5437,6 +5794,7 @@ many mathematical writings and to the sense of
5437% \fi 5794% \fi
5438% 5795%
5439% \DescribeMacro{\TeXtoTEIPat} 5796% \DescribeMacro{\TeXtoTEIPat}
5797% \phts\label{ref:textoteipat}
5440% \cs{TeXtoTEIPat}\marg{\TeX\ pattern}\marg{TEI pattern}\\ 5798% \cs{TeXtoTEIPat}\marg{\TeX\ pattern}\marg{TEI pattern}\\
5441% Finally, this more flexible\---and more delicate to 5799% Finally, this more flexible\---and more delicate to
5442% handle\---command uses pattern matching to instruct \pkg{ekdosis} 5800% handle\---command uses pattern matching to instruct \pkg{ekdosis}
@@ -5676,7 +6034,7 @@ Sample text with a \textcolor{red}{word} in red.
5676%</example> 6034%</example>
5677% \fi 6035% \fi
5678% 6036%
5679% \label{ref:ekdverse-ex} 6037% \phts\label{ref:ekdverse-ex}
5680% Finally, an extract of Silius Italicus' \emph{Punica}, Book~9, 6038% Finally, an extract of Silius Italicus' \emph{Punica}, Book~9,
5681% ll.~30-2 follows (|.tex| source file, PDF output and \texttt{TEI} 6039% ll.~30-2 follows (|.tex| source file, PDF output and \texttt{TEI}
5682% output files):--- 6040% output files):---
@@ -7413,8 +7771,8 @@ Sample text with a \textcolor{red}{word} in red.
7413% addition to \cs{rightlinenum{\allowbreak}bers} and 7771% addition to \cs{rightlinenum{\allowbreak}bers} and
7414% \cs{leftlinenumbers}. 7772% \cs{leftlinenumbers}.
7415% \begin{macrocode} 7773% \begin{macrocode}
7416\def\outerlinenumbers{ 7774\def\outerlinenumbers{%
7417 \def\makeLineNumberRunning{ 7775 \def\makeLineNumberRunning{%
7418 \checkoddpage 7776 \checkoddpage
7419 \ifoddpage 7777 \ifoddpage
7420 \linenumberfont\hskip\linenumbersep\hskip\textwidth 7778 \linenumberfont\hskip\linenumbersep\hskip\textwidth
@@ -7422,10 +7780,10 @@ Sample text with a \textcolor{red}{word} in red.
7422 \else 7780 \else
7423 \hss\linenumberfont\LineNumber\hskip\linenumbersep 7781 \hss\linenumberfont\LineNumber\hskip\linenumbersep
7424 \fi 7782 \fi
7425 } 7783 }%
7426} 7784}
7427\def\innerlinenumbers{ 7785\def\innerlinenumbers{%
7428 \def\makeLineNumberRunning{ 7786 \def\makeLineNumberRunning{%
7429 \checkoddpage 7787 \checkoddpage
7430 \ifoddpage 7788 \ifoddpage
7431 \hss\linenumberfont\LineNumber\hskip\linenumbersep 7789 \hss\linenumberfont\LineNumber\hskip\linenumbersep
@@ -7433,7 +7791,7 @@ Sample text with a \textcolor{red}{word} in red.
7433 \linenumberfont\hskip\linenumbersep\hskip\textwidth 7791 \linenumberfont\hskip\linenumbersep\hskip\textwidth
7434 \hbox to\linenumberwidth{\hss\LineNumber}\hss 7792 \hbox to\linenumberwidth{\hss\LineNumber}\hss
7435 \fi 7793 \fi
7436 } 7794 }%
7437} 7795}
7438% \end{macrocode} 7796% \end{macrocode}
7439% \end{macro} 7797% \end{macro}
@@ -7476,7 +7834,12 @@ Sample text with a \textcolor{red}{word} in red.
7476 outer = \outerlinenumbers}, 7834 outer = \outerlinenumbers},
7477 unknown-choice margin = \PackageError{ekdosis}{unknown 7835 unknown-choice margin = \PackageError{ekdosis}{unknown
7478 margin=#1}{`margin' must be either `left', `right', \MessageBreak 7836 margin=#1}{`margin' must be either `left', `right', \MessageBreak
7479 `inner' or `outer'} 7837 `inner' or `outer'},
7838 choice vmargin = {
7839 right = \if@pkg@poetry@verse\verselinenumbersright\fi,
7840 left = \if@pkg@poetry@verse\verselinenumbersleft\fi},
7841 unknown-choice vmargin = \PackageError{ekdosis}{unknown
7842 vmargin=#1}{`margin' must be either `left' ot `right'}
7480} 7843}
7481% \end{macrocode} 7844% \end{macrocode}
7482% \begin{macro}{\SetLineation} 7845% \begin{macro}{\SetLineation}
@@ -9301,8 +9664,8 @@ end
9301local function versetotei(str) 9664local function versetotei(str)
9302 str = string.gsub(str, "\\begin%s?%{ekdverse%}(%b[])(.-)\\end%s?%{ekdverse%}", function(opt, arg) 9665 str = string.gsub(str, "\\begin%s?%{ekdverse%}(%b[])(.-)\\end%s?%{ekdverse%}", function(opt, arg)
9303 arg = string.gsub(arg, "\\par%s?", "") 9666 arg = string.gsub(arg, "\\par%s?", "")
9304 arg = string.gsub(arg, "\\begin%s?%{patverse%}", "") 9667 arg = string.gsub(arg, "\\begin%s?%{patverse%*?%}", "")
9305 arg = string.gsub(arg, "\\end%s?%{patverse%}", "") 9668 arg = string.gsub(arg, "\\end%s?%{patverse%*?%}", "")
9306 arg = string.gsub(arg, "\\indentpattern%s?%b{}", "") 9669 arg = string.gsub(arg, "\\indentpattern%s?%b{}", "")
9307 opt = string.sub(opt, 2, -2) 9670 opt = string.sub(opt, 2, -2)
9308 teitype = get_attr_value(opt, "type") 9671 teitype = get_attr_value(opt, "type")