From f11c5a44e78ad2706fe77886e19b1e55877d4ef6 Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Sun, 23 Aug 2020 10:27:02 +0200 Subject: a few corrections and additions in the documentation --- ekdosis.dtx | 61 ++++++++++++++++++++++++++++++++----------------------------- 1 file changed, 32 insertions(+), 29 deletions(-) diff --git a/ekdosis.dtx b/ekdosis.dtx index 13aa966..ac477be 100644 --- a/ekdosis.dtx +++ b/ekdosis.dtx @@ -1963,11 +1963,10 @@ yesterday. % \item[\dbend] The colon at the end of line~3 closes the whole % value of |text| and acts as a higher level separator. % \end{enumerate} -% \item Each name may be followed by a \enquote*{suboptional} argument -% between square brackets which will then be used to insert -% \texttt{TEI xml} attributes in the corresponding |
| -% element. For example, -% \iffalse +% \item \label{it:lang-subopt} Each name may be followed by a +% \enquote*{suboptional} argument between square brackets which will +% then be used to insert \texttt{TEI xml} attributes in the +% corresponding |
| element. For example, \iffalse %<*example> % \fi \begin{minted}[escapeinside=++]{latex} @@ -2303,9 +2302,10 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+ % only one word is suspect, only one crux is needed. % \end{description} % -% \DescribeMacro{\SetCritSymbols} \cs{SetCritSymbols}\marg{csv list of -% options} can be used to change the critical symbols described -% above. This command accepts the following list of |key-value| +% \DescribeMacro{\SetCritSymbols}\newfeature[v1.1] +% \cs{SetCritSymbols}\marg{csv list of options} can be used to change +% the critical symbols described above. This command accepts the +% following list of |key-value| % optional arguments:---\\ % \DescribeOption{suppbegin}|suppbegin|$=$\meta{symbol} % \hfill\tcboxverb{Default: <}\\ @@ -2357,30 +2357,31 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+ % used to perform the test. % % \paragraph{Editorial Addition} -% \DescribeMacro{\supplied} \cs{supplied}\marg{text} is used to mark -% \meta{text} that is by definition missing from the tradition as -% supplied by the editor or some other scholar. This command is -% normally expected in \cs{lem}|{}| or \cs{rdg}|{}|. +% \DescribeMacro{\supplied}\newfeature[v1.1]\cs{supplied}\marg{text} +% is used to mark \meta{text} that is by definition missing from the +% tradition as supplied by the editor or some other scholar. This +% command is normally expected in \cs{lem}|{}| or \cs{rdg}|{}|. % % \paragraph{Editorial Deletion} -% \DescribeMacro{\surplus} \cs{surplus}\marg{text} is used to mark -% \meta{text} that is deemed to be inauthentic, but nevertheless -% retained between braces in the edition text as it is transmitted by -% all witnesses. This command is normally expected in \cs{lem}|{}| or -% \cs{rdg}|{}|. +% \DescribeMacro{\surplus}\newfeature[v1.1] \cs{surplus}\marg{text} +% is used to mark \meta{text} that is deemed to be inauthentic, but +% nevertheless retained between braces in the edition text as it is +% transmitted by all witnesses. This command is normally expected in +% \cs{lem}|{}| or \cs{rdg}|{}|. % % \paragraph{Crux} -% \DescribeMacro{\sic} \cs{sic}\marg{text} takes as mandatory argument -% the text deemed by the editor to be readable but not -% understandable. \cs{sic} inserts \meta{text} between cruces while -% \cs{sic*} prints only one crux before \meta{text}. +% \DescribeMacro{\sic}\newfeature[v1.1] \cs{sic}\marg{text} takes as +% mandatory argument the text deemed by the editor to be readable but +% not understandable. \cs{sic} inserts \meta{text} between cruces +% while \cs{sic*} prints only one crux before \meta{text}. % % \paragraph{Lacuna} -% \DescribeMacro{\gap} \cs{gap}\marg{csv list of options} indicates -% that some amount of text has fallen away from the entire -% tradition. It takes as mandatory argument a comma-separated list of -% options that can be used to further specify the reason for omission, -% the unit of measurement, the quantity or the extent, as follows:---\\ +% \DescribeMacro{\gap}\newfeature[v1.1] \cs{gap}\marg{csv list of +% options} indicates that some amount of text has fallen away from the +% entire tradition. It takes as mandatory argument a comma-separated +% list of options that can be used to further specify the reason for +% omission, the unit of measurement, the quantity or the extent, as +% follows:---\\ % \DescribeOption{reason}|reason|$=$\meta{reason}\\ % |reason| gives the reason for omission.\\ % \DescribeOption{unit} |unit|$=$\meta{unit}\\ @@ -2390,8 +2391,8 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+ % |quantity| specifies the number of the given unit that comprise the % measurement.\\ % \DescribeOption{extent} |extent|$=$\meta{description}\\ -% |extent| describes the size, including quantity and units in a -% single string of words. +% |extent| describes the size, including quantity and unit in a single +% string of words. % % \paragraph{Conjectured Lacuna} % Assumably, the conjectured lacuna should be enclosed by @@ -3183,7 +3184,9 @@ argument of the % \pkg{polyglossia} can use the same language switching commands as % \pkg{babel},\footcite[See][3.2 \pno~14]{polyglossia} the general % advice given above in \vref{sec:alignment-hooks} applies in all -% cases. +% cases. As regards setting languages in the \texttt{TEI xml} output +% file, the reader is invited to refer to point \vref{it:lang-subopt} +% and \vref{sec:teixml-output}. % % \subsection{Languages Written From Right to Left} % \label{sec:rtl-languages} -- cgit v1.2.3