aboutsummaryrefslogtreecommitdiff
path: root/ekdosis.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'ekdosis.dtx')
-rw-r--r--ekdosis.dtx132
1 files changed, 120 insertions, 12 deletions
diff --git a/ekdosis.dtx b/ekdosis.dtx
index 4e55f57..030fd8c 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -1123,7 +1123,7 @@ yesterday.
1123% quoted or cited in the text of the edition (\emph{apparatus 1123% quoted or cited in the text of the edition (\emph{apparatus
1124% fontium}), references to testimonia, or quotations of the edited 1124% fontium}), references to testimonia, or quotations of the edited
1125% text by other authors (\emph{apparatus testium}), explanatory notes, 1125% text by other authors (\emph{apparatus testium}), explanatory notes,
1126% and so forth.\footnote{See below, \vref{ref:type-app}.} Once 1126% and so forth.\footnote{See below, \vref{ref:type-note}.} Once
1127% additional layers have been defined and assigned to new 1127% additional layers have been defined and assigned to new
1128% \enquote*{types}, such as \enquote*{testium} and the like, these 1128% \enquote*{types}, such as \enquote*{testium} and the like, these
1129% types can be used as values appended to the |type| \enquote*{named 1129% types can be used as values appended to the |type| \enquote*{named
@@ -1228,7 +1228,7 @@ yesterday.
1228% \paragraph{Notes} 1228% \paragraph{Notes}
1229% \DescribeMacro{\note}\DescribeMacro{\note*} 1229% \DescribeMacro{\note}\DescribeMacro{\note*}
1230% \cs{note}\oarg{options}\marg{text} or 1230% \cs{note}\oarg{options}\marg{text} or
1231% \cs{note*}\oarg{options}\marg{text}\\ 1231% \cs{note*}\oarg{options}\marg{text}\label{ref:editorial-notes}\\
1232% It may happen that editorial notes be needed to record short 1232% It may happen that editorial notes be needed to record short
1233% comments of general nature \emph{between} lemmata and 1233% comments of general nature \emph{between} lemmata and
1234% readings. \cs{note} inserts inline comments while \cs{note*} places 1234% readings. \cs{note} inserts inline comments while \cs{note*} places
@@ -1245,12 +1245,16 @@ yesterday.
1245% \DescribeOption{post} |post|$=$\meta{words}\\ 1245% \DescribeOption{post} |post|$=$\meta{words}\\
1246% |post| inserts \meta{words} immediately after the note.\\ 1246% |post| inserts \meta{words} immediately after the note.\\
1247% 1247%
1248% \danger Under no circumstances is it permitted to insert the command 1248% \danger Under no circumstances is it permitted to insert this
1249% \cs{note} or \cs{note*} inside the argument of \cs{lem} or 1249% command \cs{note} or \cs{note*} inside the argument of \cs{lem} or
1250% \cs{rdg}. \cs{note}/\cs{note*} must go \emph{between} these 1250% \cs{rdg}. \cs{note}/\cs{note*} must go \emph{between} these
1251% commands. As a general rule, within \cs{app}|{}| elements, notes 1251% commands. As a general rule, within \cs{app}|{}| elements, notes are
1252% are inserted immediately \emph{after} the lemma or the variant 1252% inserted immediately \emph{after} the lemma or the variant reading
1253% reading they are related to. 1253% they are related to. However, as will be described below in
1254% \vref{ref:type-note}, the command \cs{note}\---with no star
1255% appended\---that is used to insert explanatory notes or references
1256% to sources or testimonia is permitted within the mandatory argument
1257% of \cs{lem}|{}|, although it is subject to a very strict syntax.
1254% 1258%
1255% \Vref{lst:pj2} provides an illustration of some of the possibilities 1259% \Vref{lst:pj2} provides an illustration of some of the possibilities
1256% afforded by the commands just described:--- 1260% afforded by the commands just described:---
@@ -1924,7 +1928,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
1924% internally. If any additional layer of notes be declared in the 1928% internally. If any additional layer of notes be declared in the
1925% preamble, this |default| layer must be included in the list of 1929% preamble, this |default| layer must be included in the list of
1926% declared layers.\\ 1930% declared layers.\\
1927% \DescribeMacro{\EkdosisDefaultApparatus} 1931% \DescribeMacro{\EkdosisDefaultApparatus}\label{ref:ekd-default-app}
1928% \cs{EkdosisDefaultApparatus}\marg{name} can be used at any point of 1932% \cs{EkdosisDefaultApparatus}\marg{name} can be used at any point of
1929% the document to change the default name that is used by 1933% the document to change the default name that is used by
1930% \pkg{ekdosis}. 1934% \pkg{ekdosis}.
@@ -1959,8 +1963,16 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
1959% |default|, \pkg{ekdosis} will print the testimonia at the top of the 1963% |default|, \pkg{ekdosis} will print the testimonia at the top of the
1960% apparatus block. 1964% apparatus block.
1961% 1965%
1962% \subsubsection{Laying Out Layers} 1966% \subsubsection{Laying Out Layers With The Optional Argument
1967% of \cs{DeclareApparatus}}
1963% \label{sec:layout-layers} 1968% \label{sec:layout-layers}
1969% \DescribeOption{direction}
1970% \DescribeOption{sep}
1971% \DescribeOption{delim}
1972% \DescribeOption{bhook}
1973% \DescribeOption{ehook}
1974% \DescribeOption{rule}
1975% \DescribeOption{norule}
1964% With regard to layout, any declared layer inherits the defaut values 1976% With regard to layout, any declared layer inherits the defaut values
1965% described above in \vref{sec:single-layer-app}. That said, as the 1977% described above in \vref{sec:single-layer-app}. That said, as the
1966% optional argument of \cs{DeclareApparatus} accepts the exact same 1978% optional argument of \cs{DeclareApparatus} accepts the exact same
@@ -2006,9 +2018,105 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
2006% inserted within the argument of \cs{app}|{}| as described 2018% inserted within the argument of \cs{app}|{}| as described
2007% \vpageref{ref:app-cmd} will go into that layer of the apparatus, 2019% \vpageref{ref:app-cmd} will go into that layer of the apparatus,
2008% unless \cs{EkdosisDefaultApparatus} has been used to set another 2020% unless \cs{EkdosisDefaultApparatus} has been used to set another
2009% name for the default layer. 2021% name for the default layer (see above
2022% \vpageref{ref:ekd-default-app}).
2010% 2023%
2024% \subsection{Variant Readings}
2025% \label{sec:variant-readings}
2026% In most cases, all variant readings go into the
2027% \textooquote|default|\textcoquote\ layer of the apparatus
2028% criticus. But in some other cases, for example when the manuscripts
2029% used refer to different recensions, it may happen that one wishes to
2030% record the related variants in separate layers. As already described
2031% \vpageref{ref:app-type}, the |type| optional argument of the
2032% \cs{app} command can be used to insert lemma texts and associated
2033% variants in any other \enquote*{declared} layer of the apparatus
2034% criticus.
2035%
2036% The following example assumes that some edition text is received in
2037% two different recensions and the variant readings that belong to the
2038% first recension are recorded in the default layer of notes while
2039% those of the second recension are to be printed in a second layer,
2040% below the default one. First, both layers must be declared in the
2041% preamble in sequence, like so:---
2042%
2043% \iffalse
2044%<*example>
2045% \fi
2046\begin{minted}[linenos=false]{latex}
2047\DeclareApparatus{default} % default layer
2048\DeclareApparatus{rec2} % additional layer below the default one
2049\end{minted}
2050% \iffalse
2051%</example>
2052% \fi
2053%
2054% If one wishes to refer to |rec1| as the default layer, then
2055% \cs{EkdosisDefaultApparatus} must be used, like so:---
2011% 2056%
2057% \iffalse
2058%<*example>
2059% \fi
2060\begin{minted}[linenos=false]{latex}
2061\EkdosisDefaultApparatus{rec1}
2062\DeclareApparatus{rec1} % new layer set as default
2063\DeclareApparatus{rec2} % additional layer below the default one
2064\end{minted}
2065% \iffalse
2066%</example>
2067% \fi
2068%
2069% Then, whatever option has been chosen, lemma texts and variants
2070% inserted with \cs{app}|{}| will go into the upper, default layer of
2071% notes, while those inserted with \cs{app}|[type=rec2]{}| will go
2072% into the lower one:---
2073%
2074% \iffalse
2075%<*example>
2076% \fi
2077\begin{minted}[linenos=false]{latex}
2078Some \app{
2079 \lem{word}
2080 \rdg{reading}
2081} to go into the default layer of notes.
2082
2083Some \app[type=rec2]{
2084 \lem{note}
2085 \rdg{comment}
2086} to be recorded as part of the second recension.
2087\end{minted}
2088% \iffalse
2089%</example>
2090% \fi
2091%
2092% At any rate, |type=default| or |type=rec1|, depending on what has
2093% been chosen, must be used if the editor wishes to retain that
2094% information in the \texttt{TEI xml} output file.
2095%
2096% \subsection{Other Notes, Comments, Sources, Testimonia}
2097% \label{ref:type-note}
2098% Additional layers of notes may be used to print short comments or to
2099% record references to texts quoted by the author of the edited text
2100% or references to the edited text by other authors or
2101% translators. The former is called an \emph{apparatus fontium} while
2102% the latter is called an \emph{apparatus testium}.
2103%
2104% \danger From a technical standpoint, these notes are very different
2105% from the short editorial notes inserted between lemma texts and
2106% variant readings that have been described above
2107% \vpageref{ref:editorial-notes}. However, for the sake of consistency
2108% with \texttt{TEI xml} encoding, \pkg{ekdosis} uses the same command
2109% \cs{note} to insert both kinds of notes.
2110%
2111% \danger One must also keep in mind that the notes that are described
2112% in this section refer either to a single word or to a span of
2113% text. By consequence, as boundaries must always be set outside spans
2114% of text, notes must be inserted immediately before the word or words
2115% they are related to. As a result of this rule, all spaces subsequent
2116% to \cs{note} are ignored.
2117%
2118% \DescribeMacro{\note} \cs{note}\oarg{options}\marg{text}\\
2119% As said above, \cs{note} when found outside \cs{app}|{}|,
2012% 2120%
2013% \section{To Be Continued...} 2121% \section{To Be Continued...}
2014% v1.0 of \pkg{ekdosis}, which should be available by the end of July 2122% v1.0 of \pkg{ekdosis}, which should be available by the end of July
@@ -2016,7 +2124,6 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
2016% author is working on this part of the package. 2124% author is working on this part of the package.
2017% 2125%
2018% 2126%
2019% \label{ref:type-app}
2020% \begin{comment} 2127% \begin{comment}
2021% \section{Correspondence and Alignment} 2128% \section{Correspondence and Alignment}
2022% \end{comment} 2129% \end{comment}
@@ -2642,7 +2749,8 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
2642\RequirePackage{lineno} 2749\RequirePackage{lineno}
2643\RequirePackage{keyfloat} 2750\RequirePackage{keyfloat}
2644\RequirePackage{refcount} 2751\RequirePackage{refcount}
2645\RequirePackage[user,abspage]{zref} 2752\RequirePackage{zref-user}
2753\RequirePackage{zref-abspage}
2646\RequirePackage{ltxcmds} 2754\RequirePackage{ltxcmds}
2647\RequirePackage{atbegshi} 2755\RequirePackage{atbegshi}
2648\if@pkg@parnotes 2756\if@pkg@parnotes