diff options
-rw-r--r-- | ekdosis.dtx | 63 |
1 files changed, 40 insertions, 23 deletions
diff --git a/ekdosis.dtx b/ekdosis.dtx index db99e5c..fa5f338 100644 --- a/ekdosis.dtx +++ b/ekdosis.dtx | |||
@@ -61,7 +61,7 @@ along with this program. If not, see | |||
61 | %<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01] | 61 | %<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01] |
62 | %<package>\ProvidesPackage{ekdosis} | 62 | %<package>\ProvidesPackage{ekdosis} |
63 | %<*package> | 63 | %<*package> |
64 | [2022/08/26 v1.5-dev Typesetting TEI xml-compliant critical editions] | 64 | [2022/08/27 v1.5-dev Typesetting TEI xml-compliant critical editions] |
65 | %</package> | 65 | %</package> |
66 | %<*driver> | 66 | %<*driver> |
67 | \begin{filecontents}[noheader,overwrite]{bibdata.xml} | 67 | \begin{filecontents}[noheader,overwrite]{bibdata.xml} |
@@ -1929,10 +1929,20 @@ yesterday. | |||
1929 | % option}. For more information about inserting notes in | 1929 | % option}. For more information about inserting notes in |
1930 | % multiple-layer apparatus, see \vref{sec:notes-in-multilayer-app}. | 1930 | % multiple-layer apparatus, see \vref{sec:notes-in-multilayer-app}. |
1931 | % | 1931 | % |
1932 | % \paragraph{Alternate Command} | 1932 | % \paragraph{Code Folding} |
1933 | % The variant readings and the critical notes can grow in number to a | ||
1934 | % point where they may clutter the source text. As a result, the | ||
1935 | % edition text can become illegible. One way around this difficulty is | ||
1936 | % to use the \textsf{emacs} editor with |ekdosis.el|, the AUC\TeX\ | ||
1937 | % style file that is provided with \pkg{ekdosis}, to fold the code so | ||
1938 | % that only the edition text, exclusive of variants and notes, is | ||
1939 | % displayed on the screen. | ||
1940 | % | ||
1933 | % \DescribeMacro{\App} | 1941 | % \DescribeMacro{\App} |
1934 | % \newfeature[v1.5]\cs{App}|[type=|\meta{type}|]|\marg{lemma | 1942 | % \newfeature[v1.5]\cs{App}|[type=|\meta{type}|]|\marg{lemma |
1935 | % text}\marg{readings and notes}\phts\label{ref:App-cmd}\\ | 1943 | % text}\marg{readings and notes}\phts\label{ref:App-cmd}\\ |
1944 | % \cs{App} allows for much more flexible code folding where notes and | ||
1945 | % variants are hidden to let only the base text appear on the screen. | ||
1936 | % \cs{App} is strictly equivalent to \cs{app}, except that the | 1946 | % \cs{App} is strictly equivalent to \cs{app}, except that the |
1937 | % apparatus entries are meant to be distributed in two different | 1947 | % apparatus entries are meant to be distributed in two different |
1938 | % arguments, like so:--- | 1948 | % arguments, like so:--- |
@@ -1940,23 +1950,29 @@ yesterday. | |||
1940 | % \iffalse | 1950 | % \iffalse |
1941 | %<*example> | 1951 | %<*example> |
1942 | % \fi | 1952 | % \fi |
1943 | \begin{minted}[linenos=false]{latex} | 1953 | \begin{minted}[escapeinside=++]{latex} |
1944 | I saw my friend \App{\lem{Peter}}{\rdg{John}} yesterday. | 1954 | I saw my friend \App{\lem{Peter}}{\rdg{John}} yesterday. |
1945 | or: | 1955 | or: |
1946 | I saw my friend \App{\lem{Peter}}{ | 1956 | I saw my friend \App{\lem{Peter}}{+\label{ln:App:1}+ |
1947 | \rdg{John} | 1957 | \rdg{John} |
1948 | } yesterday. | 1958 | } yesterday.+\label{ln:App:2}+ |
1949 | \end{minted} | 1959 | \end{minted} |
1950 | % \iffalse | 1960 | % \iffalse |
1951 | %</example> | 1961 | %</example> |
1952 | % \fi | 1962 | % \fi |
1953 | % | 1963 | % |
1954 | % Used in the \textsf{emacs} editor conjointly with the AUC\TeX\ style | 1964 | % \begin{remarks} |
1955 | % file that is provided by \pkg{ekdosis}, this command allows for much | 1965 | % \item As can be seen, the first argument of \cs{App} is meant to |
1956 | % more flexible code folding where notes and variants are hidden to | 1966 | % receive the lemma text while \cs{rdg}, \cs{note} and the like are |
1957 | % let only the base text appear on the screen. Code folding, once | 1967 | % inserted in the second one. |
1958 | % applied, results in a clean source text with no clutter as | 1968 | % \item As the second argument of \cs{App} is the foldable item, a |
1959 | % follows:--- | 1969 | % good practice is to keep the lemma text on the same line as the |
1970 | % opening brace (l.~\lnref{ln:App:1}) and to write the continuation | ||
1971 | % of the text just after the closing brace (l.~\lnref{ln:App:2}). | ||
1972 | % \end{remarks} | ||
1973 | % | ||
1974 | % Code folding, once applied, results in a clean source text with no | ||
1975 | % clutter as follows:--- | ||
1960 | % | 1976 | % |
1961 | % \iffalse | 1977 | % \iffalse |
1962 | %<*example> | 1978 | %<*example> |
@@ -1968,8 +1984,9 @@ I saw my friend +\textcolor{lavender}{Peter}+ yesterday. | |||
1968 | %</example> | 1984 | %</example> |
1969 | % \fi | 1985 | % \fi |
1970 | % | 1986 | % |
1971 | % \danger There is no point in using this command for anything other | 1987 | % \danger As there is no point in using this command for anything |
1972 | % than this specific purpose. | 1988 | % other than this specific purpose, \cs{app} is used in the examples |
1989 | % throughout this document. | ||
1973 | % | 1990 | % |
1974 | % \paragraph{Base text and variants} As can be seen in \vref{lst:pj1} | 1991 | % \paragraph{Base text and variants} As can be seen in \vref{lst:pj1} |
1975 | % and the examples provided above, there are two kinds of individual | 1992 | % and the examples provided above, there are two kinds of individual |
@@ -8314,7 +8331,7 @@ Sample text with a \textcolor{red}{word} in red. | |||
8314 | % \end{macrocode} | 8331 | % \end{macrocode} |
8315 | % \paragraph{\textsf{ekdosis} Symbol} | 8332 | % \paragraph{\textsf{ekdosis} Symbol} |
8316 | % \begin{macro}{\eKd} | 8333 | % \begin{macro}{\eKd} |
8317 | % \changes{v1.5}{2022/08/26}{Prints \textsf{ekdosis} indentifying | 8334 | % \changes{v1.5}{2022/08/27}{Prints \textsf{ekdosis} indentifying |
8318 | % symbol} As of v1.5, \pkg{ekdosis} has its own identifying | 8335 | % symbol} As of v1.5, \pkg{ekdosis} has its own identifying |
8319 | % symbol. It is produced by \cs{eKd} and best printed with the Old | 8336 | % symbol. It is produced by \cs{eKd} and best printed with the Old |
8320 | % Standard Greek font. | 8337 | % Standard Greek font. |
@@ -8577,7 +8594,7 @@ Sample text with a \textcolor{red}{word} in red. | |||
8577 | % \begin{macro}{\teidirectE} | 8594 | % \begin{macro}{\teidirectE} |
8578 | % \changes{v1.3}{2021/08/18}{direct insertion of elements in the | 8595 | % \changes{v1.3}{2021/08/18}{direct insertion of elements in the |
8579 | % \texttt{TEI xml} file} | 8596 | % \texttt{TEI xml} file} |
8580 | % \changes{v1.5}{2022/08/26}{direct insertion of empty elements in the | 8597 | % \changes{v1.5}{2022/08/27}{direct insertion of empty elements in the |
8581 | % \texttt{TEI xml} file} | 8598 | % \texttt{TEI xml} file} |
8582 | % \cs{teidirect}\oarg{xml attributes}\marg{xml element}\marg{code} | 8599 | % \cs{teidirect}\oarg{xml attributes}\marg{xml element}\marg{code} |
8583 | % does nothing in \LaTeX. It is only used to insert elements in the | 8600 | % does nothing in \LaTeX. It is only used to insert elements in the |
@@ -8592,7 +8609,7 @@ Sample text with a \textcolor{red}{word} in red. | |||
8592 | % \end{macro} | 8609 | % \end{macro} |
8593 | % \end{macro} | 8610 | % \end{macro} |
8594 | % \begin{macro}{\getTEIxmlid} | 8611 | % \begin{macro}{\getTEIxmlid} |
8595 | % \changes{v1.5}{2022/08/26}{returns \texttt{TEI xml:ids} from a | 8612 | % \changes{v1.5}{2022/08/27}{returns \texttt{TEI xml:ids} from a |
8596 | % csv-list of ids} This command returns from a csv-list of unique | 8613 | % csv-list of ids} This command returns from a csv-list of unique |
8597 | % identifiers declared in commands such as \cs{DeclareWitness} and the | 8614 | % identifiers declared in commands such as \cs{DeclareWitness} and the |
8598 | % like a space-separated list of their corresponding |xml:id|s, each | 8615 | % like a space-separated list of their corresponding |xml:id|s, each |
@@ -9340,7 +9357,7 @@ Sample text with a \textcolor{red}{word} in red. | |||
9340 | % \end{macrocode} | 9357 | % \end{macrocode} |
9341 | % \end{macro} | 9358 | % \end{macro} |
9342 | % \begin{macro}{\App} | 9359 | % \begin{macro}{\App} |
9343 | % \changes{v1.5}{2022/08/26}{To be used conjointly with | 9360 | % \changes{v1.5}{2022/08/27}{To be used conjointly with |
9344 | % \texttt{ekdosis.el}} | 9361 | % \texttt{ekdosis.el}} |
9345 | % In contrast to \cs{app}, \cs{App} takes two mandatory arguments and | 9362 | % In contrast to \cs{app}, \cs{App} takes two mandatory arguments and |
9346 | % accepts one optional argument like so: | 9363 | % accepts one optional argument like so: |
@@ -10213,7 +10230,7 @@ Sample text with a \textcolor{red}{word} in red. | |||
10213 | % \end{macro} | 10230 | % \end{macro} |
10214 | % \paragraph{Lacunae} | 10231 | % \paragraph{Lacunae} |
10215 | % \begin{macro}{\ilabel} | 10232 | % \begin{macro}{\ilabel} |
10216 | % \changes{v1.5}{2022/08/26}{recalls and sets the ending label of | 10233 | % \changes{v1.5}{2022/08/27}{recalls and sets the ending label of |
10217 | % lemmas used to mark lacunae in witnesses} When \cs{lem} has been | 10234 | % lemmas used to mark lacunae in witnesses} When \cs{lem} has been |
10218 | % used with the optional argument |ilabel=<label>|, | 10235 | % used with the optional argument |ilabel=<label>|, |
10219 | % \cs{ilabel}\marg{label} must be used to mark the point where the | 10236 | % \cs{ilabel}\marg{label} must be used to mark the point where the |
@@ -10529,7 +10546,7 @@ Sample text with a \textcolor{red}{word} in red. | |||
10529 | % \end{macrocode} | 10546 | % \end{macrocode} |
10530 | % \end{macro} | 10547 | % \end{macro} |
10531 | % \begin{macro}{\ekdEOprint} | 10548 | % \begin{macro}{\ekdEOprint} |
10532 | % \changes{v1.5}{2022/08/26}{Sets headers and footers on | 10549 | % \changes{v1.5}{2022/08/27}{Sets headers and footers on |
10533 | % \enquote{paired} facing pages} | 10550 | % \enquote{paired} facing pages} |
10534 | % To set headers and footers on \enquote{paired} facing pages, | 10551 | % To set headers and footers on \enquote{paired} facing pages, |
10535 | % \cs{ekdEOprint} accepts two mandatory, self-evident arguments, like | 10552 | % \cs{ekdEOprint} accepts two mandatory, self-evident arguments, like |
@@ -10569,7 +10586,7 @@ Sample text with a \textcolor{red}{word} in red. | |||
10569 | % counter to set the value of the page numbers. This counter should be | 10586 | % counter to set the value of the page numbers. This counter should be |
10570 | % incremented every two pages. | 10587 | % incremented every two pages. |
10571 | % \begin{counter}{pairedpage} | 10588 | % \begin{counter}{pairedpage} |
10572 | % \changes{v1.5}{2022/08/26}{A counter incremented every two pages} | 10589 | % \changes{v1.5}{2022/08/27}{A counter incremented every two pages} |
10573 | % |pairedpage| is first set as a global counter:--- | 10590 | % |pairedpage| is first set as a global counter:--- |
10574 | % \begin{macrocode} | 10591 | % \begin{macrocode} |
10575 | \newcounter{pairedpage} | 10592 | \newcounter{pairedpage} |
@@ -10577,19 +10594,19 @@ Sample text with a \textcolor{red}{word} in red. | |||
10577 | % \end{macrocode} | 10594 | % \end{macrocode} |
10578 | % \end{counter} | 10595 | % \end{counter} |
10579 | % \begin{macro}{\setpairedpagenum} | 10596 | % \begin{macro}{\setpairedpagenum} |
10580 | % \changes{v1.5}{2022/08/26}{sets the same page number on paired | 10597 | % \changes{v1.5}{2022/08/27}{sets the same page number on paired |
10581 | % pages} \cs{setpairedpagenum}\marg{number} is used just ahead of | 10598 | % pages} \cs{setpairedpagenum}\marg{number} is used just ahead of |
10582 | % the alignment environment to set the number of the first left-hand | 10599 | % the alignment environment to set the number of the first left-hand |
10583 | % paired page. | 10600 | % paired page. |
10584 | % \begin{macro}{\setpairedpage} | 10601 | % \begin{macro}{\setpairedpage} |
10585 | % \changes{v1.5}{2022/08/26}{sets the page number of the first paired | 10602 | % \changes{v1.5}{2022/08/27}{sets the page number of the first paired |
10586 | % page} \cs{setpairedpage} is an argument-less command meant to be | 10603 | % page} \cs{setpairedpage} is an argument-less command meant to be |
10587 | % issued in commands used to set headers or footers before | 10604 | % issued in commands used to set headers or footers before |
10588 | % \cs{thepage}. This command has the counter |pairedpage| | 10605 | % \cs{thepage}. This command has the counter |pairedpage| |
10589 | % incremented on right-hand pages only, and sets |page| $\leftarrow$ | 10606 | % incremented on right-hand pages only, and sets |page| $\leftarrow$ |
10590 | % |pairedpage| on every page. | 10607 | % |pairedpage| on every page. |
10591 | % \begin{macro}{\resetpagenumber} | 10608 | % \begin{macro}{\resetpagenumber} |
10592 | % \changes{v1.5}{2022/08/26}{resets normal running page numbers} | 10609 | % \changes{v1.5}{2022/08/27}{resets normal running page numbers} |
10593 | % \cs{resetpagenumber} must be used right out of \enquote{mirrored} | 10610 | % \cs{resetpagenumber} must be used right out of \enquote{mirrored} |
10594 | % paired pages alignment environments. This argument-less command | 10611 | % paired pages alignment environments. This argument-less command |
10595 | % corrects any numbering error on the page following the edition | 10612 | % corrects any numbering error on the page following the edition |