aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ekdosis.dtx170
1 files changed, 85 insertions, 85 deletions
diff --git a/ekdosis.dtx b/ekdosis.dtx
index 64b2cff..33a537d 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -394,7 +394,7 @@ along with this program. If not, see
394 394
395@Software{icite, 395@Software{icite,
396 title = {The Icite package}, 396 title = {The Icite package},
397 subtitle = {Indices locorum citatorum}, 397 titleaddon = {Indices locorum citatorum},
398 author = {Alessi, Robert}, 398 author = {Alessi, Robert},
399 url = {http://ctan.org/pkg/icite}, 399 url = {http://ctan.org/pkg/icite},
400 date = {2020-03-05}, 400 date = {2020-03-05},
@@ -512,7 +512,7 @@ along with this program. If not, see
512\DeclareSource{shWalsh1908}{Wa} 512\DeclareSource{shWalsh1908}{Wa}
513\DeclareSource{shButler1899}{But} 513\DeclareSource{shButler1899}{But}
514\DeclareScholar{shGod}{Godwin}[rawname=Godwin] 514\DeclareScholar{shGod}{Godwin}[rawname=Godwin]
515\DeclareScholar{shStee}{Stee}[rawname=Godwin, note=Notes in Malone] 515\DeclareScholar{shStee}{Stee}[rawname=Steevens, note=Notes in Malone]
516\end{filecontents} 516\end{filecontents}
517\documentclass{ltxdoc} 517\documentclass{ltxdoc}
518 %\usepackage[letterpaper,margin=25mm,left=50mm,nohead]{geometry} 518 %\usepackage[letterpaper,margin=25mm,left=50mm,nohead]{geometry}
@@ -1156,7 +1156,7 @@ along with this program. If not, see
1156% |poetry=verse| instructs \pkg{ekdosis} to load and use the facilites 1156% |poetry=verse| instructs \pkg{ekdosis} to load and use the facilites
1157% supplied by the \pkg{verse} package for the typesetting of lines of 1157% supplied by the \pkg{verse} package for the typesetting of lines of
1158% poetry.\footnote{\texttt{verse} does not need to be set if the 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 1159% \cls{memoir} class be used. See \vref{sec:verse-package} for more
1160% detail.} The \env{ekdverse} environment must then be used instead of 1160% detail.} The \env{ekdverse} environment must then be used instead of
1161% the \env{verse} environment that is provided by the \pkg{verse} 1161% the \env{verse} environment that is provided by the \pkg{verse}
1162% package as described below in \vref{sec:verse-package}. 1162% package as described below in \vref{sec:verse-package}.
@@ -1165,17 +1165,17 @@ along with this program. If not, see
1165% |parnotes|$=$\verb+true|false|roman+% 1165% |parnotes|$=$\verb+true|false|roman+%
1166% \hfill\tcboxverb{Default: not set}\\ 1166% \hfill\tcboxverb{Default: not set}\\
1167% 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|
1168% if it is used. Apparatus criticus typeset by \pkg{ekdosis} may 1168% if used. Apparatus criticus typeset by \pkg{ekdosis} may contain
1169% contain notes and footnotes. The latter can be laid out as 1169% notes and footnotes. The latter can be laid out as paragraphed notes
1170% paragraphed notes below the block of critical notes by means of the 1170% below the block of critical notes by means of the \pkg{parnotes}
1171% \pkg{parnotes} package. Additionally, |parnotes=roman| prints these 1171% package. Additionally, |parnotes=roman| prints these footnotes
1172% footnotes numbered with Roman numerals. 1172% numbered with Roman numerals.
1173% 1173%
1174% \DescribeOption{teiexport}\phts\label{ref:teiexport-option} 1174% \DescribeOption{teiexport}\phts\label{ref:teiexport-option}
1175% |teiexport|$=$\verb+true|false|tidy+% 1175% |teiexport|$=$\verb+true|false|tidy+%
1176% \hfill\tcboxverb{Default: not set}\\ 1176% \hfill\tcboxverb{Default: not set}\\
1177% 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|
1178% if it is used. If |teiexport| be set to |true|, \pkg{ekdosis} is 1178% if used. If |teiexport| be set to |true|, \pkg{ekdosis} is
1179% instructed to output both PDF and \texttt{TEI xml} files at the same 1179% instructed to output both PDF and \texttt{TEI xml} files at the same
1180% time. By default, the \texttt{TEI} file will receive the same 1180% time. By default, the \texttt{TEI} file will receive the same
1181% basename as the |.tex| source file, suffixed with |-tei.xml|. The 1181% basename as the |.tex| source file, suffixed with |-tei.xml|. The
@@ -1666,7 +1666,7 @@ yesterday.
1666% 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
1667% 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
1668% 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
1669% broad space if the entry refers to the same line as the preceding 1669% broad space when the entry refers to the same line as the preceding
1670% entry. \phts\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}
1671% accepts the following 1671% accepts the following
1672% comma-separated list of \enquote{name$=$value} arguments:---\\ 1672% comma-separated list of \enquote{name$=$value} arguments:---\\
@@ -1675,9 +1675,9 @@ yesterday.
1675% While a single witness may be recorded as in |wit=A|, 1675% While a single witness may be recorded as in |wit=A|,
1676% comma-separated lists of multiple witnesses must obviously be 1676% comma-separated lists of multiple witnesses must obviously be
1677% enclosed in curly braces, like so: 1677% enclosed in curly braces, like so:
1678% |wit={A,B,C}|. \phts\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
1679% witnesses can be grouped by using spaces as separators, like so: 1679% that witnesses can be grouped by using spaces as separators, like
1680% \verb*|wit={A,B,C, D,E,F}|. Although any unique identifiers or 1680% so: \verb*|wit={A,B,C, D,E,F}|. Although any unique identifiers or
1681% labels used to \enquote{declare} sources and scholars as described 1681% labels used to \enquote{declare} sources and scholars as described
1682% above \vpagerefrange{ref:declare-source}{ref:declare-scholar} can 1682% above \vpagerefrange{ref:declare-source}{ref:declare-scholar} can
1683% also be used as values of the |wit| optional argument, it is 1683% also be used as values of the |wit| optional argument, it is
@@ -1714,21 +1714,19 @@ yesterday.
1714% bracket (|]|)\\ 1714% bracket (|]|)\\
1715% \DescribeOption{nosep} |nosep|$=$\verb+true|false+\\ 1715% \DescribeOption{nosep} |nosep|$=$\verb+true|false+\\
1716% This named argument does not need a value as it defaults to |true| 1716% This named argument does not need a value as it defaults to |true|
1717% if it is used. |nosep| removes the separator mentioned 1717% if used. |nosep| removes the separator mentioned above. Obviously,
1718% above. Obviously, |nosep| must be used when for some reason no 1718% |nosep| must be used when for some reason no \cs{rdg} command
1719% \cs{rdg} command follows a \cs{lem} command that has just been 1719% follows a \cs{lem} command that has just been used, as shown below
1720% used, as shown below in \vref{lst:emend-coni-corr}, l.~7. 1720% in \vref{lst:emend-coni-corr}, l.~7.
1721% \danger \DescribeMacro{\ekdsep} If |nosep| has been used so as to 1721% \danger \DescribeMacro{\ekdsep} If |nosep| be used so as to insert
1722% insert an explanatory note after the lemma text with the \cs{note} 1722% an explanatory note after the lemma text with the \cs{note} command
1723% command described below \vpageref{ref:editorial-notes}, then 1723% described below \vpageref{ref:editorial-notes}, then \cs{ekdsep} can
1724% \cs{ekdsep} can be used\---for instance as value of the |post| 1724% be used\---for instance as value of the |post| optional argument of
1725% optional argument of the note\---to put back in the separator. This 1725% the note\---to put back in the separator. This technique is
1726% technique is demonstrated below in 1726% demonstrated below in \vref{lst:emend-coni-corr}, ll.~23--5.\\
1727% \vref{lst:emend-coni-corr}, ll.~23--5.\\
1728% \DescribeOption{nolem} |nolem|$=$\verb+true|false+\\ 1727% \DescribeOption{nolem} |nolem|$=$\verb+true|false+\\
1729% This named argument does not need a value as it defaults to |true| 1728% This named argument does not need a value as it defaults to |true|
1730% if it is used. |nolem| completely removes the lemma text from the 1729% if used. |nolem| completely removes the lemma text from the related
1731% related
1732% entry in the apparatus criticus.\\ 1730% entry in the apparatus criticus.\\
1733% \DescribeOption{type} |type|$=$\meta{value}\\ 1731% \DescribeOption{type} |type|$=$\meta{value}\\
1734% This named argument has no effect on the apparatus criticus of the 1732% This named argument has no effect on the apparatus criticus of the
@@ -1777,7 +1775,7 @@ yesterday.
1777% \DescribeOption{alt} |alt|$=$\meta{alternate reading}\\ 1775% \DescribeOption{alt} |alt|$=$\meta{alternate reading}\\
1778% \DescribeOption{nordg} |nordg|$=$\verb+true|false+\\ 1776% \DescribeOption{nordg} |nordg|$=$\verb+true|false+\\
1779% This named argument does not need a value as it defaults to |true| 1777% This named argument does not need a value as it defaults to |true|
1780% if it is used. |nordg| completely removes the variant reading from 1778% if used. |nordg| completely removes the variant reading from
1781% the related entry in the apparatus criticus.\\ 1779% the related entry in the apparatus criticus.\\
1782% \DescribeOption{type} |type|$=$\meta{value}\\ 1780% \DescribeOption{type} |type|$=$\meta{value}\\
1783% Obviously, |type=conjecture| should be restricted to variant 1781% Obviously, |type=conjecture| should be restricted to variant
@@ -1792,12 +1790,12 @@ yesterday.
1792% \DescribeMacro{\note}\phts\label{ref:notes-b}\DescribeMacro{\note*} 1790% \DescribeMacro{\note}\phts\label{ref:notes-b}\DescribeMacro{\note*}
1793% \cs{note}\oarg{options}\marg{text} or 1791% \cs{note}\oarg{options}\marg{text} or
1794% \cs{note*}\oarg{options}\marg{text}\phts\label{ref:editorial-notes}\\ 1792% \cs{note*}\oarg{options}\marg{text}\phts\label{ref:editorial-notes}\\
1795% It may happen that editorial notes be needed to record short 1793% It may happen that editorial notes are needed to record short
1796% comments of general nature \emph{between} lemmata and 1794% comments of general nature \emph{between} lemmata and
1797% readings. \cs{note} inserts inline comments while \cs{note*} places 1795% readings. \cs{note} inserts inline comments while \cs{note*} places
1798% comments below the entire apparatus block. Furthermore, if 1796% comments below the entire apparatus block. Furthermore, if
1799% \pkg{ekdosis} has been loaded with the |parnotes| option as 1797% \pkg{ekdosis} be loaded with the |parnotes| option as described
1800% described above \vpageref{ref:parnotes-opt}, \cs{note*} will use the 1798% above \vpageref{ref:parnotes-opt}, \cs{note*} will use the
1801% \pkg{parnotes} package to lay out the notes as an additional 1799% \pkg{parnotes} package to lay out the notes as an additional
1802% paragraph below the apparatus criticus. The optional argument of 1800% paragraph below the apparatus criticus. The optional argument of
1803% \cs{note}/\cs{note*} accepts the following comma-separated list of 1801% \cs{note}/\cs{note*} accepts the following comma-separated list of
@@ -2119,7 +2117,7 @@ friend
2119% From a technical standpoint, \enquote{conjectures} are readings that 2117% From a technical standpoint, \enquote{conjectures} are readings that
2120% are not supported by manuscript evidence, but are instead proposed 2118% are not supported by manuscript evidence, but are instead proposed
2121% by scholars to be taken into consideration for establishing the 2119% by scholars to be taken into consideration for establishing the
2122% edition text. A conjecture is called an \enquote{emendation} if it 2120% edition text. A conjecture is called an \enquote{emendation} when it
2123% is adopted in place of what is provided by or missing from the text 2121% is adopted in place of what is provided by or missing from the text
2124% provided by the manuscripts. Emendations and conjectures are 2122% provided by the manuscripts. Emendations and conjectures are
2125% therefore readings and as such expected to be found within |<lem>| 2123% therefore readings and as such expected to be found within |<lem>|
@@ -2257,7 +2255,7 @@ friend
2257% \end{alignment} 2255% \end{alignment}
2258% 2256%
2259% \texttt{TEI xml} output:--- 2257% \texttt{TEI xml} output:---
2260% 2258% \enlargethispage{\baselineskip}
2261% \iffalse 2259% \iffalse
2262%<*example> 2260%<*example>
2263% \fi 2261% \fi
@@ -2293,7 +2291,7 @@ friend
2293% \item[<***>] conjectured lacuna. 2291% \item[<***>] conjectured lacuna.
2294% \item[\{\}] editorial deletion. 2292% \item[\{\}] editorial deletion.
2295% \item[\dag\dag] text judged by the editor to be corrupt. Note that if 2293% \item[\dag\dag] text judged by the editor to be corrupt. Note that if
2296% only one word is suspect, only one crux is needed. 2294% only one word be suspect, only one crux is needed.
2297% \end{description} 2295% \end{description}
2298% 2296%
2299% \DescribeMacro{\SetCritSymbols}\newfeature[v1.1] 2297% \DescribeMacro{\SetCritSymbols}\newfeature[v1.1]
@@ -2345,7 +2343,7 @@ friend
2345% \danger If modified, brackets can be adapted to languages that are 2343% \danger If modified, brackets can be adapted to languages that are
2346% written from right to left. To that effect, \pkg{ekdosis} provides a 2344% written from right to left. To that effect, \pkg{ekdosis} provides a
2347% boolean expression |al@rlmode| which is evaluated as |true| if the 2345% boolean expression |al@rlmode| which is evaluated as |true| if the
2348% writing direction is set from right to left and as |false| 2346% writing direction be set from right to left and as |false|
2349% otherwise. As the \pkg{etoolbox} package is loaded by \pkg{ekdosis}, 2347% otherwise. As the \pkg{etoolbox} package is loaded by \pkg{ekdosis},
2350% \cs{ifboolean}|{al@rlmode}|\marg{rtl symbol}\marg{ltr symbol} can be 2348% \cs{ifboolean}|{al@rlmode}|\marg{rtl symbol}\marg{ltr symbol} can be
2351% used to perform the test. 2349% used to perform the test.
@@ -2828,7 +2826,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
2828% \DescribeOption{paired} |paired|$=$\verb+true|false+% 2826% \DescribeOption{paired} |paired|$=$\verb+true|false+%
2829% \hfill\tcboxverb{Default: true (initially not set)}\\ 2827% \hfill\tcboxverb{Default: true (initially not set)}\\
2830% This named argument does not need a value as it defaults to |true| 2828% This named argument does not need a value as it defaults to |true|
2831% if it is used. By default, \pkg{ekdosis} follows the \LaTeX{} page 2829% if used. By default, \pkg{ekdosis} follows the \LaTeX{} page
2832% numbering scheme when multiple texts are arranged on facing 2830% numbering scheme when multiple texts are arranged on facing
2833% pages. The |paired| option leaves every right-hand page number 2831% pages. The |paired| option leaves every right-hand page number
2834% unchanged, so that both facing pages hold the same page number.\\ 2832% unchanged, so that both facing pages hold the same page number.\\
@@ -2841,7 +2839,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
2841% \DescribeOption{flush} |flush|$=$\verb+true|false+ 2839% \DescribeOption{flush} |flush|$=$\verb+true|false+
2842% \hfill\tcboxverb{Default: false}\\ 2840% \hfill\tcboxverb{Default: false}\\
2843% This named argument does not need a value as it defaults to |true| 2841% This named argument does not need a value as it defaults to |true|
2844% if it is used. This option applies when two or more distinct 2842% if used. This option applies when two or more distinct
2845% \env{alignment} environments are started on the same page. Should 2843% \env{alignment} environments are started on the same page. Should
2846% this happen, any subsequent \env{alignment} environment must be set 2844% this happen, any subsequent \env{alignment} environment must be set
2847% with the |flush| option so that every one of them carry its own 2845% with the |flush| option so that every one of them carry its own
@@ -2882,9 +2880,9 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
2882% 2880%
2883% \DescribeMacro{\SetAlignment} 2881% \DescribeMacro{\SetAlignment}
2884% \cs{SetAlignment}\marg{alignment settings}\\ 2882% \cs{SetAlignment}\marg{alignment settings}\\
2885% If the same alignment settings are to be shared by several 2883% If the same alignment settings be shared by several \env{alignment}
2886% \env{alignment} environments, common settings can be collected in 2884% environments, common settings can be collected in the argument of
2887% the argument of \cs{SetAlignment}, like 2885% \cs{SetAlignment}, like
2888% so:---\\ 2886% so:---\\
2889% \iffalse 2887% \iffalse
2890%<*example> 2888%<*example>
@@ -3422,7 +3420,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
3422%</example> 3420%</example>
3423% \fi 3421% \fi
3424% 3422%
3425% If one wishes to refer to |rec1| as the default layer, then 3423% Should one wish to refer to |rec1| as the default layer, then
3426% \cs{SetDefaultApparatus} must be used, like so:--- 3424% \cs{SetDefaultApparatus} must be used, like so:---
3427% 3425%
3428% \iffalse 3426% \iffalse
@@ -3461,7 +3459,7 @@ Some \app[type=rec2]{
3461% \fi 3459% \fi
3462% 3460%
3463% \danger At any rate, |type=default| or |type=rec1|, depending on 3461% \danger At any rate, |type=default| or |type=rec1|, depending on
3464% what has been chosen, must be used if the editor wishes to retain 3462% what has been chosen, must be used should the editor wish to retain
3465% that information in the \texttt{TEI xml} output file. 3463% that information in the \texttt{TEI xml} output file.
3466% 3464%
3467% \subsection{Other Notes for Comments, Sources or Testimonia} 3465% \subsection{Other Notes for Comments, Sources or Testimonia}
@@ -3500,7 +3498,7 @@ Some \app[type=rec2]{
3500% The separator between the lemma text and the contents of the note.\\ 3498% The separator between the lemma text and the contents of the note.\\
3501% \DescribeOption{nosep} |nosep|$=$\verb+true|false+\\ 3499% \DescribeOption{nosep} |nosep|$=$\verb+true|false+\\
3502% This named argument does not need a value as it defaults to |true| 3500% This named argument does not need a value as it defaults to |true|
3503% if it is used. Obviously, |nosep| removes the separator mentioned 3501% if used. Obviously, |nosep| removes the separator mentioned
3504% above.\\ 3502% above.\\
3505% \DescribeOption{lem} |lem|$=$\meta{lemma text}\\ 3503% \DescribeOption{lem} |lem|$=$\meta{lemma text}\\
3506% |lem| is the span of text the note is about. It may consist of one 3504% |lem| is the span of text the note is about. It may consist of one
@@ -3516,8 +3514,8 @@ Some \app[type=rec2]{
3516% \DescribeOption{labele} |labele|$=$\meta{label}\\ 3514% \DescribeOption{labele} |labele|$=$\meta{label}\\
3517% |labele| is the unique label to serve as a reference for the point 3515% |labele| is the unique label to serve as a reference for the point
3518% immediately following the lemma text. Contrary to |labelb|, |labele| 3516% immediately following the lemma text. Contrary to |labelb|, |labele|
3519% may be left unspecified if the note is only about one word. If it is 3517% may be left unspecified if the note be only about one word. If the
3520% about a span, then |labele| ought to be specified.\\ 3518% note be about a span, then |labele| must be specified.\\
3521% \DescribeMacro{\linelabel} \cs{linelabel}\marg{label}\\ 3519% \DescribeMacro{\linelabel} \cs{linelabel}\marg{label}\\
3522% If |labele|$=$\meta{some\_label} be specified in the optional 3520% If |labele|$=$\meta{some\_label} be specified in the optional
3523% argument of \cs{note}, \cs{linelabel}\marg{some\allowbreak\_label} 3521% argument of \cs{note}, \cs{linelabel}\marg{some\allowbreak\_label}
@@ -3604,12 +3602,12 @@ the American Continent</emph>, II.61--2.</note></p>
3604% \fi 3602% \fi
3605% 3603%
3606% \paragraph{\cs{note} or \cs{linelabel} inside \cs{lem}} 3604% \paragraph{\cs{note} or \cs{linelabel} inside \cs{lem}}
3607% It may happen that \cs{note} or \cs{linelabel} commands be found 3605% It may happen that the \cs{note} or \cs{linelabel} command is found
3608% inside the argument of \cs{lem}. Obviously, inserting such commands 3606% inside the argument of \cs{lem}. Obviously, inserting such a command
3609% in the apparatus criticus in print makes no sense and will lead to 3607% in the apparatus criticus in print makes no sense and will lead to
3610% an error. The solution is to insert in the value of the |alt| 3608% an error. The solution is to insert in the value of the |alt|
3611% optional argument of \cs{lem} a duplicate of the lemma text devoid 3609% optional argument of \cs{lem} a duplicate of the lemma text devoid
3612% of those commands, like so:--- 3610% of that command, like so:---
3613% 3611%
3614% \iffalse 3612% \iffalse
3615%<*example> 3613%<*example>
@@ -3785,7 +3783,7 @@ argument of the
3785% as explained above \vpageref{ref:poetry-opt}. Simply loading the 3783% as explained above \vpageref{ref:poetry-opt}. Simply loading the
3786% \pkg{verse} package by means of \cs{usepackage} will have no effect. 3784% \pkg{verse} package by means of \cs{usepackage} will have no effect.
3787% 3785%
3788% \danger The foregoing does not apply if the \cls{memoir} class is 3786% \danger The foregoing does not apply if the \cls{memoir} class be
3789% used.\footcite{memoir} In this case, \pkg{ekdosis} automatically 3787% used.\footcite{memoir} In this case, \pkg{ekdosis} automatically
3790% uses the code provided by this class without the need to set 3788% uses the code provided by this class without the need to set
3791% the global option |poetry=verse|. 3789% the global option |poetry=verse|.
@@ -4406,7 +4404,7 @@ substantiall fewell,}
4406% equivalent to |vmodulo=5|. |vmodulo=0| prevents the 4404% equivalent to |vmodulo=5|. |vmodulo=0| prevents the
4407% numbers from being printed.\\ 4405% numbers from being printed.\\
4408% \DescribeOption{vmargin} |vmargin|$=$\verb+right|left+ 4406% \DescribeOption{vmargin} |vmargin|$=$\verb+right|left+
4409% \hfill\tcboxverb{Initially: right}\\ 4407% \hfill\tcboxverb{Default: right}\\
4410% |vmargin| sets the margin in which the verse line numbers are to be 4408% |vmargin| sets the margin in which the verse line numbers are to be
4411% printed.\\ 4409% printed.\\
4412% \DescribeOption{continuousvnum}\hfill\tcboxverb{Default: not set}\\ 4410% \DescribeOption{continuousvnum}\hfill\tcboxverb{Default: not set}\\
@@ -4588,7 +4586,7 @@ substantiall fewell,}
4588% \cs{setLR} are two argument-less commands provided by \pkg{ekdosis} 4586% \cs{setLR} are two argument-less commands provided by \pkg{ekdosis}
4589% that can be used to change the writing direction of running 4587% that can be used to change the writing direction of running
4590% paragraphs. The former sets the direction from right to left and the 4588% paragraphs. The former sets the direction from right to left and the
4591% latter form left to right. If \pkg{babel} has been set as above, 4589% latter form left to right. If \pkg{babel} be set as above,
4592% \cs{setRL} \dots\ \cs{setLR} can be used in place of 4590% \cs{setRL} \dots\ \cs{setLR} can be used in place of
4593% \cs{begin}|{Arabic}| \dots\ \cs{end}|{Arabic}|. 4591% \cs{begin}|{Arabic}| \dots\ \cs{end}|{Arabic}|.
4594% 4592%
@@ -5149,7 +5147,7 @@ subtype="arabtex">'inna 'abI kAna mina
5149% able to settle down. The condition may be typically illustrated as 5147% able to settle down. The condition may be typically illustrated as
5150% follows: after Lua\LaTeX\ has been run, an entry is attached to the 5148% follows: after Lua\LaTeX\ has been run, an entry is attached to the
5151% last line of the page. As said above, this entry does not show 5149% last line of the page. As said above, this entry does not show
5152% yet. But when it does, if it results in an additional line being 5150% yet. But when it does, should it result in an additional line being
5153% printed in the apparatus criticus, the last line of the edition 5151% printed in the apparatus criticus, the last line of the edition
5154% text\---the one the entry was previously attached to\---goes to the 5152% text\---the one the entry was previously attached to\---goes to the
5155% next page. As a result, this entry also moves to the next page with 5153% next page. As a result, this entry also moves to the next page with
@@ -5162,7 +5160,7 @@ subtype="arabtex">'inna 'abI kAna mina
5162% 5160%
5163% An alert reader may have guessed that inserting a \cs{pagebreak} is 5161% An alert reader may have guessed that inserting a \cs{pagebreak} is
5164% a good way to get out of the vicious circle. And surely, if only a 5162% a good way to get out of the vicious circle. And surely, if only a
5165% few pages are at stake, this is the way to go. However, 5163% few pages be at stake, this is the way to go. However,
5166% \cs{pagebreak} commands should only be inserted when the whole 5164% \cs{pagebreak} commands should only be inserted when the whole
5167% edition text is ready for any substantial change in the preceding 5165% edition text is ready for any substantial change in the preceding
5168% pages may result in pages that break just after they begin. 5166% pages may result in pages that break just after they begin.
@@ -5177,7 +5175,7 @@ subtype="arabtex">'inna 'abI kAna mina
5177% should take place. An optional argument allows to further specify 5175% should take place. An optional argument allows to further specify
5178% the page number where the page break should occur. The value that is 5176% the page number where the page break should occur. The value that is
5179% expected is the page number as it is printed\===e.g.\ an Arabic, 5177% expected is the page number as it is printed\===e.g.\ an Arabic,
5180% Roman or alphanumeric number. If the specified conditions are not 5178% Roman or alphanumeric number. If the specified conditions be not
5181% met, then the page break is not triggered. 5179% met, then the page break is not triggered.
5182% 5180%
5183% \paragraph{Using \texttt{maxentries}} 5181% \paragraph{Using \texttt{maxentries}}
@@ -5194,7 +5192,7 @@ subtype="arabtex">'inna 'abI kAna mina
5194% should entries overflow on a given page, the edition text and the 5192% should entries overflow on a given page, the edition text and the
5195% apparatus criticus may clash again. As said above, a couple of 5193% apparatus criticus may clash again. As said above, a couple of
5196% clashes can be managed with a couple of manually inserted page 5194% clashes can be managed with a couple of manually inserted page
5197% breaks. But if there are too many of them, it is a good indication 5195% breaks. But if there be too many of them, it is a good indication
5198% that the selected value of |maxentries| is too to high. 5196% that the selected value of |maxentries| is too to high.
5199% 5197%
5200% Complex edition texts do have a magic number. An advisable way to 5198% Complex edition texts do have a magic number. An advisable way to
@@ -5233,9 +5231,9 @@ subtype="arabtex">'inna 'abI kAna mina
5233% circumstantially arise. 5231% circumstantially arise.
5234% 5232%
5235% \paragraph{Superfluous Dots} 5233% \paragraph{Superfluous Dots}
5236% \phts\label{sec:superfluous-dots} 5234% \phts\label{sec:superfluous-dots} As said above
5237% As said above \vpageref{ref:ending-dot}, it is customary in some 5235% \vpageref{ref:ending-dot}, it is customary in some editions to have
5238% editions to have a full stop printed at the end of the apparatus 5236% a full stop printed at the end of the apparatus
5239% criticus. \pkg{ekdosis} provides specific commands to achieve this 5237% criticus. \pkg{ekdosis} provides specific commands to achieve this
5240% in a straightforward way, such as \cs{SetEndApparatus} and the 5238% in a straightforward way, such as \cs{SetEndApparatus} and the
5241% |ehook| optional argument of \cs{SetApparatus} and 5239% |ehook| optional argument of \cs{SetApparatus} and
@@ -5244,9 +5242,9 @@ subtype="arabtex">'inna 'abI kAna mina
5244% if the last word of the apparatus criticus on a given page be an 5242% if the last word of the apparatus criticus on a given page be an
5245% abbreviation followed by a dot, such a setting will have two dots 5243% abbreviation followed by a dot, such a setting will have two dots
5246% printed at the end of the apparatus instead of one. The solution is 5244% printed at the end of the apparatus instead of one. The solution is
5247% to define a command to have a dot printed only if it is not followed 5245% to define a command to have a dot printed only if not followed by a
5248% by a dot, and append this command to the abbreviated form of the 5246% dot, and append this command to the abbreviated form of the word,
5249% word, like so:--- 5247% like so:---
5250% 5248%
5251% \iffalse 5249% \iffalse
5252%<*example> 5250%<*example>
@@ -5277,7 +5275,7 @@ subtype="arabtex">'inna 'abI kAna mina
5277% \cs{makeatletter} \dots\ \cs{makeatother}. 5275% \cs{makeatletter} \dots\ \cs{makeatother}.
5278% \item Line~10: \cs{ekddot} will only work with multiple-layer 5276% \item Line~10: \cs{ekddot} will only work with multiple-layer
5279% apparatus criticus. Therefore, \cs{DeclareAppa{\allowbreak}ratus} 5277% apparatus criticus. Therefore, \cs{DeclareAppa{\allowbreak}ratus}
5280% must be used even if only one layer of critical notes is needed. 5278% must be used even if only one layer of critical notes be needed.
5281% \end{remarks} 5279% \end{remarks}
5282% 5280%
5283% \paragraph{Backup of Essential Files} 5281% \paragraph{Backup of Essential Files}
@@ -5285,8 +5283,8 @@ subtype="arabtex">'inna 'abI kAna mina
5285% the |.aux| corresponding \LaTeX\ auxiliary file and its own |.ekd| 5283% the |.aux| corresponding \LaTeX\ auxiliary file and its own |.ekd|
5286% auxiliary file so as to process labels and collect entries of the 5284% auxiliary file so as to process labels and collect entries of the
5287% apparatus criticus. If for whatever reason\---e.g.\ some unknown 5285% apparatus criticus. If for whatever reason\---e.g.\ some unknown
5288% command has been inserted\---the compilation freezes and so must be 5286% command has been inserted\---the compilation be frozen and so must
5289% aborted, it may happen that most of the edition text has to be 5287% be aborted, it may happen that most of the edition text has to be
5290% reconstructed page after page. For large and complex editions, this 5288% reconstructed page after page. For large and complex editions, this
5291% makes advisable to have current versions of those files backed up 5289% makes advisable to have current versions of those files backed up
5292% each time a new compilation begins, which can be achieved by 5290% each time a new compilation begins, which can be achieved by
@@ -5513,8 +5511,8 @@ subtype="arabtex">'inna 'abI kAna mina
5513% 5511%
5514% \danger It must be noted that \LaTeX\ labels that are provided in 5512% \danger It must be noted that \LaTeX\ labels that are provided in
5515% commands such as \cs{label}, \cs{cite} and the like must also be 5513% commands such as \cs{label}, \cs{cite} and the like must also be
5516% unique in the document. As \LaTeX\ will issue warnings if it finds 5514% unique in the document. As \LaTeX\ will issue warnings if duplicates
5517% duplicates, \cs{ekdosis} does not check their uniqueness but will 5515% be found, \cs{ekdosis} does not check their uniqueness but will
5518% issue warnings if such labels contain invalid strings. 5516% issue warnings if such labels contain invalid strings.
5519% 5517%
5520% \subsection{Routine \LaTeX\ Commands and Environments} 5518% \subsection{Routine \LaTeX\ Commands and Environments}
@@ -5549,7 +5547,7 @@ subtype="arabtex">'inna 'abI kAna mina
5549% \cs{pagebreak}\meta{\oarg{1-4}} & no output \\ 5547% \cs{pagebreak}\meta{\oarg{1-4}} & no output \\
5550% \cs{mbox}\marg{text} & \meta{text} \\ 5548% \cs{mbox}\marg{text} & \meta{text} \\
5551% \midrule 5549% \midrule
5552% \multicolumn{2}{c}{From the \pkg{exdash}\footcite{extdash} 5550% \multicolumn{2}{c}{From the \pkg{extdash}\footcite{extdash}
5553% package:}\\ 5551% package:}\\
5554% \cs{---} or \cs{===} & --- \\ 5552% \cs{---} or \cs{===} & --- \\
5555% \cs{--} or \cs{==} & -- \\ 5553% \cs{--} or \cs{==} & -- \\
@@ -5568,8 +5566,6 @@ subtype="arabtex">'inna 'abI kAna mina
5568% |center| & |<p rend="align(center)"></p>| \\ 5566% |center| & |<p rend="align(center)"></p>| \\
5569% |quotation| & |<quote></quote>| \\ 5567% |quotation| & |<quote></quote>| \\
5570% |quoting| & |<quote></quote>| \\ 5568% |quoting| & |<quote></quote>| \\
5571% |ekdpar| & |<p></p>| \\
5572% |ekdverse| & |<lg></lg>| \\
5573% |verse| & |<lg></lg>| \\ 5569% |verse| & |<lg></lg>| \\
5574% \bottomrule 5570% \bottomrule
5575% \end{xltabular} 5571% \end{xltabular}
@@ -5581,7 +5577,7 @@ subtype="arabtex">'inna 'abI kAna mina
5581% \cs{begin}|{quote}| \dots\ \cs{end}|{quote}| will result in 5577% \cs{begin}|{quote}| \dots\ \cs{end}|{quote}| will result in
5582% |<emph></emph>| and |<quote></quote>| respectively. 5578% |<emph></emph>| and |<quote></quote>| respectively.
5583% 5579%
5584% For the same simple reason, if one wishes to have words within a 5580% For the same simple reason, should one wish to have words within a
5585% \texttt{TEI xml} element that does not have any \LaTeX\ equivalent, 5581% \texttt{TEI xml} element that does not have any \LaTeX\ equivalent,
5586% all is needed is to define an inoperative \LaTeX\ command named 5582% all is needed is to define an inoperative \LaTeX\ command named
5587% after the \texttt{TEI} element, like so:--- 5583% after the \texttt{TEI} element, like so:---
@@ -6339,23 +6335,24 @@ Sample text with a \textcolor{red}{word} in red.
6339% \item Text structure: milestone elements. 6335% \item Text structure: milestone elements.
6340% \item Marginal edition texts: It may happen that the marginalia of 6336% \item Marginal edition texts: It may happen that the marginalia of
6341% manuscripts contain texts worth editing in addition to and along 6337% manuscripts contain texts worth editing in addition to and along
6342% the main text to which they are linked by reference 6338% the main text to which they are linked by reference signs.
6343% signs.
6344% \item Headers and footers: \cs{ekddiv} will provide top and bottom 6339% \item Headers and footers: \cs{ekddiv} will provide top and bottom
6345% marks to be used in headers and footers. 6340% marks to be used in headers and footers.
6346% \end{enumerate} 6341% \end{enumerate}
6347% \item Short-term (months):--- 6342% \item Short-term (months):---
6348% \begin{enumerate} 6343% \begin{enumerate}
6349% \item Poetry: The standard \env{verse} environment is supported by 6344% \item Poetry: \pkg{ekdosis} is now able to load and use the
6350% the current version of \pkg{ekdosis}, in addition to 6345% facilities provided by the \pkg{verse} package. Refined options
6351% \env{ekdverse} an example of which has been provided above 6346% will be added, such as metrical analysis. Arabic poetry through
6352% \vpageref{ref:ekdverse-ex}. \env{ekdverse} will provide refined 6347% the environments and commands provided by the \pkg{arabluatex}
6353% options, such as metrical analysis, stanzaic forms, \emph{\&c.} 6348% package will also be supported. Other packages will also be
6354% Arabic poetry through the environments and commands provided by 6349% considered for inclusion, such as \pkg{poetry} or
6355% the \pkg{arabluatex} package will also be supported. 6350% \pkg{teubner}. In the end, \pkg{ekdosis} will provide a way for
6351% typesetting poetry which will allow for more flexibility and
6352% compatibility with \texttt{TEI xml}.
6356% \item Correspondence and alignment, segmentation: The functions 6353% \item Correspondence and alignment, segmentation: The functions
6357% are being tested at the time of writing and will be included 6354% are being tested at the time of writing and will be included in
6358% shortly in \pkg{ekdosis}. 6355% \pkg{ekdosis}.
6359% \end{enumerate} 6356% \end{enumerate}
6360% \item Medium-term: Indexing, commands and environments for specific 6357% \item Medium-term: Indexing, commands and environments for specific
6361% modules of the \texttt{TEI}. 6358% modules of the \texttt{TEI}.
@@ -7079,7 +7076,10 @@ Sample text with a \textcolor{red}{word} in red.
7079% hooks meant to be shared by all declared apparatuses, such as the 7076% hooks meant to be shared by all declared apparatuses, such as the
7080% font size, the format of numerals, \emph{\&c.} This command can be 7077% font size, the format of numerals, \emph{\&c.} This command can be
7081% used in the preamble or at any point of the document. 7078% used in the preamble or at any point of the document.
7082% \changes{v1.2}{2021/03/03}{new option \texttt{lemmastyle}} 7079% \changes{v1.2}{2021/03/30}{general hooks: new option
7080% \texttt{lemmastyle}}
7081% \changes{v1.2}{2021/03/30}{general hooks: new option
7082% \texttt{readingstyle}}
7083% \begin{macrocode} 7083% \begin{macrocode}
7084\ekvdefinekeys{ekd@hooks}{ 7084\ekvdefinekeys{ekd@hooks}{
7085 store appfontsize = \ekd@appfontsize, 7085 store appfontsize = \ekd@appfontsize,
@@ -7429,7 +7429,7 @@ Sample text with a \textcolor{red}{word} in red.
7429% \end{macrocode} 7429% \end{macrocode}
7430% \end{macro} 7430% \end{macro}
7431% \begin{macro}{\ekdpb} 7431% \begin{macro}{\ekdpb}
7432% \changes{v1.2}{2021/02/21}{insert conditional page breaks} 7432% \changes{v1.2}{2021/03/30}{conditional page breaks}
7433% \cs{ekdpk}\oarg{page no}\marg{line no} is used to insert conditional 7433% \cs{ekdpk}\oarg{page no}\marg{line no} is used to insert conditional
7434% page breaks by specifying that the page break should occur only on a 7434% page breaks by specifying that the page break should occur only on a
7435% given line and optionally a given page. If the specified conditions 7435% given line and optionally a given page. If the specified conditions
@@ -7600,7 +7600,7 @@ Sample text with a \textcolor{red}{word} in red.
7600% \end{macrocode} 7600% \end{macrocode}
7601% \end{macro} 7601% \end{macro}
7602% \begin{macro}{\SetApparatusLanguage} 7602% \begin{macro}{\SetApparatusLanguage}
7603% \changes{v1.2}{2021/03/05}{defines an alternate language to be 7603% \changes{v1.2}{2021/03/30}{defines an alternate language to be
7604% applied in apparatus entries} 7604% applied in apparatus entries}
7605% \cs{SetApparatusLang}\marg{languagename} can be used when 7605% \cs{SetApparatusLang}\marg{languagename} can be used when
7606% it is needed to apply in the apparatus criticus a language 7606% it is needed to apply in the apparatus criticus a language
@@ -8947,7 +8947,7 @@ Sample text with a \textcolor{red}{word} in red.
8947% \end{macrocode} 8947% \end{macrocode}
8948% \end{environment} 8948% \end{environment}
8949% \begin{macro}{\resetvlinenumber} 8949% \begin{macro}{\resetvlinenumber}
8950% \changes{v1.2}{2021/03/06}{resets line numbers in poetry environments} 8950% \changes{v1.2}{2021/03/30}{resets line numbers in poetry environments}
8951% This command is the equivalent of \cs{resetlinenumber} for lines of 8951% This command is the equivalent of \cs{resetlinenumber} for lines of
8952% poetry. It takes an integer as optional argument, which is |1| by 8952% poetry. It takes an integer as optional argument, which is |1| by
8953% default. 8953% default.
@@ -8960,7 +8960,7 @@ Sample text with a \textcolor{red}{word} in red.
8960% \end{macrocode} 8960% \end{macrocode}
8961% \end{macro} 8961% \end{macro}
8962% \begin{environment}{ekdstanza} 8962% \begin{environment}{ekdstanza}
8963% \changes{v1.2}{2021/03/08}{new environment for stanzas} 8963% \changes{v1.2}{2021/03/30}{new environment for stanzas}
8964% \env{ekdstanza} is needed when lines are grouped into stanzas, 8964% \env{ekdstanza} is needed when lines are grouped into stanzas,
8965% which can be further named by means of the |type| optional 8965% which can be further named by means of the |type| optional
8966% argument:--- 8966% argument:---