diff options
author | Robert Alessi <alessi@robertalessi.net> | 2020-08-23 10:27:02 +0200 |
---|---|---|
committer | Robert Alessi <alessi@robertalessi.net> | 2020-08-23 10:27:02 +0200 |
commit | f11c5a44e78ad2706fe77886e19b1e55877d4ef6 (patch) | |
tree | 0cf1ecc81846394c0e29f3c2fffad2c6d9ae60f9 | |
parent | 1d9a30fcb6c09e12be510c344d5e3ff545363a7d (diff) | |
download | ekdosis-f11c5a44e78ad2706fe77886e19b1e55877d4ef6.tar.gz |
a few corrections and additions in the documentation
-rw-r--r-- | ekdosis.dtx | 61 |
1 files 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. | |||
1963 | % \item[\dbend] The colon at the end of line~3 closes the whole | 1963 | % \item[\dbend] The colon at the end of line~3 closes the whole |
1964 | % value of |text| and acts as a higher level separator. | 1964 | % value of |text| and acts as a higher level separator. |
1965 | % \end{enumerate} | 1965 | % \end{enumerate} |
1966 | % \item Each name may be followed by a \enquote*{suboptional} argument | 1966 | % \item \label{it:lang-subopt} Each name may be followed by a |
1967 | % between square brackets which will then be used to insert | 1967 | % \enquote*{suboptional} argument between square brackets which will |
1968 | % \texttt{TEI xml} attributes in the corresponding |<div>| | 1968 | % then be used to insert \texttt{TEI xml} attributes in the |
1969 | % element. For example, | 1969 | % corresponding |<div>| element. For example, \iffalse |
1970 | % \iffalse | ||
1971 | %<*example> | 1970 | %<*example> |
1972 | % \fi | 1971 | % \fi |
1973 | \begin{minted}[escapeinside=++]{latex} | 1972 | \begin{minted}[escapeinside=++]{latex} |
@@ -2303,9 +2302,10 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+ | |||
2303 | % only one word is suspect, only one crux is needed. | 2302 | % only one word is suspect, only one crux is needed. |
2304 | % \end{description} | 2303 | % \end{description} |
2305 | % | 2304 | % |
2306 | % \DescribeMacro{\SetCritSymbols} \cs{SetCritSymbols}\marg{csv list of | 2305 | % \DescribeMacro{\SetCritSymbols}\newfeature[v1.1] |
2307 | % options} can be used to change the critical symbols described | 2306 | % \cs{SetCritSymbols}\marg{csv list of options} can be used to change |
2308 | % above. This command accepts the following list of |key-value| | 2307 | % the critical symbols described above. This command accepts the |
2308 | % following list of |key-value| | ||
2309 | % optional arguments:---\\ | 2309 | % optional arguments:---\\ |
2310 | % \DescribeOption{suppbegin}|suppbegin|$=$\meta{symbol} | 2310 | % \DescribeOption{suppbegin}|suppbegin|$=$\meta{symbol} |
2311 | % \hfill\tcboxverb{Default: <}\\ | 2311 | % \hfill\tcboxverb{Default: <}\\ |
@@ -2357,30 +2357,31 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+ | |||
2357 | % used to perform the test. | 2357 | % used to perform the test. |
2358 | % | 2358 | % |
2359 | % \paragraph{Editorial Addition} | 2359 | % \paragraph{Editorial Addition} |
2360 | % \DescribeMacro{\supplied} \cs{supplied}\marg{text} is used to mark | 2360 | % \DescribeMacro{\supplied}\newfeature[v1.1]\cs{supplied}\marg{text} |
2361 | % \meta{text} that is by definition missing from the tradition as | 2361 | % is used to mark \meta{text} that is by definition missing from the |
2362 | % supplied by the editor or some other scholar. This command is | 2362 | % tradition as supplied by the editor or some other scholar. This |
2363 | % normally expected in \cs{lem}|{}| or \cs{rdg}|{}|. | 2363 | % command is normally expected in \cs{lem}|{}| or \cs{rdg}|{}|. |
2364 | % | 2364 | % |
2365 | % \paragraph{Editorial Deletion} | 2365 | % \paragraph{Editorial Deletion} |
2366 | % \DescribeMacro{\surplus} \cs{surplus}\marg{text} is used to mark | 2366 | % \DescribeMacro{\surplus}\newfeature[v1.1] \cs{surplus}\marg{text} |
2367 | % \meta{text} that is deemed to be inauthentic, but nevertheless | 2367 | % is used to mark \meta{text} that is deemed to be inauthentic, but |
2368 | % retained between braces in the edition text as it is transmitted by | 2368 | % nevertheless retained between braces in the edition text as it is |
2369 | % all witnesses. This command is normally expected in \cs{lem}|{}| or | 2369 | % transmitted by all witnesses. This command is normally expected in |
2370 | % \cs{rdg}|{}|. | 2370 | % \cs{lem}|{}| or \cs{rdg}|{}|. |
2371 | % | 2371 | % |
2372 | % \paragraph{Crux} | 2372 | % \paragraph{Crux} |
2373 | % \DescribeMacro{\sic} \cs{sic}\marg{text} takes as mandatory argument | 2373 | % \DescribeMacro{\sic}\newfeature[v1.1] \cs{sic}\marg{text} takes as |
2374 | % the text deemed by the editor to be readable but not | 2374 | % mandatory argument the text deemed by the editor to be readable but |
2375 | % understandable. \cs{sic} inserts \meta{text} between cruces while | 2375 | % not understandable. \cs{sic} inserts \meta{text} between cruces |
2376 | % \cs{sic*} prints only one crux before \meta{text}. | 2376 | % while \cs{sic*} prints only one crux before \meta{text}. |
2377 | % | 2377 | % |
2378 | % \paragraph{Lacuna} | 2378 | % \paragraph{Lacuna} |
2379 | % \DescribeMacro{\gap} \cs{gap}\marg{csv list of options} indicates | 2379 | % \DescribeMacro{\gap}\newfeature[v1.1] \cs{gap}\marg{csv list of |
2380 | % that some amount of text has fallen away from the entire | 2380 | % options} indicates that some amount of text has fallen away from the |
2381 | % tradition. It takes as mandatory argument a comma-separated list of | 2381 | % entire tradition. It takes as mandatory argument a comma-separated |
2382 | % options that can be used to further specify the reason for omission, | 2382 | % list of options that can be used to further specify the reason for |
2383 | % the unit of measurement, the quantity or the extent, as follows:---\\ | 2383 | % omission, the unit of measurement, the quantity or the extent, as |
2384 | % follows:---\\ | ||
2384 | % \DescribeOption{reason}|reason|$=$\meta{reason}\\ | 2385 | % \DescribeOption{reason}|reason|$=$\meta{reason}\\ |
2385 | % |reason| gives the reason for omission.\\ | 2386 | % |reason| gives the reason for omission.\\ |
2386 | % \DescribeOption{unit} |unit|$=$\meta{unit}\\ | 2387 | % \DescribeOption{unit} |unit|$=$\meta{unit}\\ |
@@ -2390,8 +2391,8 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+ | |||
2390 | % |quantity| specifies the number of the given unit that comprise the | 2391 | % |quantity| specifies the number of the given unit that comprise the |
2391 | % measurement.\\ | 2392 | % measurement.\\ |
2392 | % \DescribeOption{extent} |extent|$=$\meta{description}\\ | 2393 | % \DescribeOption{extent} |extent|$=$\meta{description}\\ |
2393 | % |extent| describes the size, including quantity and units in a | 2394 | % |extent| describes the size, including quantity and unit in a single |
2394 | % single string of words. | 2395 | % string of words. |
2395 | % | 2396 | % |
2396 | % \paragraph{Conjectured Lacuna} | 2397 | % \paragraph{Conjectured Lacuna} |
2397 | % Assumably, the conjectured lacuna should be enclosed by | 2398 | % Assumably, the conjectured lacuna should be enclosed by |
@@ -3183,7 +3184,9 @@ argument of the | |||
3183 | % \pkg{polyglossia} can use the same language switching commands as | 3184 | % \pkg{polyglossia} can use the same language switching commands as |
3184 | % \pkg{babel},\footcite[See][3.2 \pno~14]{polyglossia} the general | 3185 | % \pkg{babel},\footcite[See][3.2 \pno~14]{polyglossia} the general |
3185 | % advice given above in \vref{sec:alignment-hooks} applies in all | 3186 | % advice given above in \vref{sec:alignment-hooks} applies in all |
3186 | % cases. | 3187 | % cases. As regards setting languages in the \texttt{TEI xml} output |
3188 | % file, the reader is invited to refer to point \vref{it:lang-subopt} | ||
3189 | % and \vref{sec:teixml-output}. | ||
3187 | % | 3190 | % |
3188 | % \subsection{Languages Written From Right to Left} | 3191 | % \subsection{Languages Written From Right to Left} |
3189 | % \label{sec:rtl-languages} | 3192 | % \label{sec:rtl-languages} |