diff options
-rw-r--r-- | Makefile | 2 | ||||
-rw-r--r-- | ekdosis.dtx | 79 |
2 files changed, 63 insertions, 18 deletions
@@ -39,7 +39,7 @@ $(NAME).pdf: testsamples $(NAME).dtx | |||
39 | @ if [ -f $(NAME).glo ]; then makeindex -q -s gglo.ist -o $(NAME).gls $(NAME).glo; fi | 39 | @ if [ -f $(NAME).glo ]; then makeindex -q -s gglo.ist -o $(NAME).gls $(NAME).glo; fi |
40 | @ if [ -f $(NAME).idx ]; then makeindex -q -s gind.ist -o $(NAME).ind $(NAME).idx; fi | 40 | @ if [ -f $(NAME).idx ]; then makeindex -q -s gind.ist -o $(NAME).ind $(NAME).idx; fi |
41 | @ echo "Final runs of $(CMP)..." | 41 | @ echo "Final runs of $(CMP)..." |
42 | @ for run in {1..3}; do $(call do_documentation); done | 42 | @ for run in {1..7}; do $(do_documentation); done |
43 | @ echo "Done" | 43 | @ echo "Done" |
44 | 44 | ||
45 | samples: clean sty | 45 | samples: clean sty |
diff --git a/ekdosis.dtx b/ekdosis.dtx index 6ece3c8..229d7c1 100644 --- a/ekdosis.dtx +++ b/ekdosis.dtx | |||
@@ -411,7 +411,7 @@ along with this program. If not, see | |||
411 | version = {4.00} | 411 | version = {4.00} |
412 | } | 412 | } |
413 | \end{filecontents} | 413 | \end{filecontents} |
414 | \begin{filecontents}[overwrite]{\jobname-cfg.tex} | 414 | \begin{filecontents}[overwrite]{\jobname-ekd.cfg} |
415 | \footnotelayout{m} | 415 | \footnotelayout{m} |
416 | \EnvtoTEI{ancientgreek}{p}[xml:lang="grc"] | 416 | \EnvtoTEI{ancientgreek}{p}[xml:lang="grc"] |
417 | \DeclareApparatus{fontium}[ | 417 | \DeclareApparatus{fontium}[ |
@@ -509,8 +509,8 @@ along with this program. If not, see | |||
509 | \DeclareSource{shSewell1725}{S} | 509 | \DeclareSource{shSewell1725}{S} |
510 | \DeclareSource{shEwing1771}{E} | 510 | \DeclareSource{shEwing1771}{E} |
511 | \DeclareSource{shHudson1856}{Hu\textsuperscript{2}} | 511 | \DeclareSource{shHudson1856}{Hu\textsuperscript{2}} |
512 | \DeclareSource{shWalsh1908}{Wa} | ||
513 | \DeclareSource{shButler1899}{But} | 512 | \DeclareSource{shButler1899}{But} |
513 | \DeclareSource{shWalsh1908}{Wa} | ||
514 | \DeclareScholar{shGod}{Godwin}[rawname=Godwin] | 514 | \DeclareScholar{shGod}{Godwin}[rawname=Godwin] |
515 | \DeclareScholar{shStee}{Stee}[rawname=Steevens, note=Notes in Malone] | 515 | \DeclareScholar{shStee}{Stee}[rawname=Steevens, note=Notes in Malone] |
516 | \end{filecontents} | 516 | \end{filecontents} |
@@ -542,7 +542,6 @@ along with this program. If not, see | |||
542 | \usepackage{chifoot} | 542 | \usepackage{chifoot} |
543 | \usepackage{arabluatex} | 543 | \usepackage{arabluatex} |
544 | \usepackage[parnotes=roman, teiexport=tidy, poetry=verse]{ekdosis} | 544 | \usepackage[parnotes=roman, teiexport=tidy, poetry=verse]{ekdosis} |
545 | \input{ekdosis-cfg} | ||
546 | \AddxmlBibResource{bibdata.xml} | 545 | \AddxmlBibResource{bibdata.xml} |
547 | \usepackage{booktabs} | 546 | \usepackage{booktabs} |
548 | \usepackage{xltabular} | 547 | \usepackage{xltabular} |
@@ -781,7 +780,7 @@ along with this program. If not, see | |||
781 | %</driver> | 780 | %</driver> |
782 | % \fi | 781 | % \fi |
783 | % | 782 | % |
784 | % \CheckSum{2184} | 783 | % \CheckSum{2188} |
785 | % | 784 | % |
786 | % \CharacterTable | 785 | % \CharacterTable |
787 | % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z | 786 | % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z |
@@ -1118,7 +1117,7 @@ along with this program. If not, see | |||
1118 | %</example> | 1117 | %</example> |
1119 | % \fi | 1118 | % \fi |
1120 | % | 1119 | % |
1121 | % \pkg{ekdosis} may be loaded with four optional \enquote*{named | 1120 | % \pkg{ekdosis} may be loaded with five optional \enquote*{named |
1122 | % arguments} either of which is set using the syntax | 1121 | % arguments} either of which is set using the syntax |
1123 | % \meta{key}$=$\meta{value}. The description of the optional arguments | 1122 | % \meta{key}$=$\meta{value}. The description of the optional arguments |
1124 | % follows. | 1123 | % follows. |
@@ -1204,6 +1203,18 @@ along with this program. If not, see | |||
1204 | %</example> | 1203 | %</example> |
1205 | % \fi | 1204 | % \fi |
1206 | % | 1205 | % |
1206 | % \subsection{Using a Configuration File} | ||
1207 | % \label{sec:using-conf-file} | ||
1208 | % Complex editions may use a large number of witnesses, sources and | ||
1209 | % scholars. It may also be required to define a multiple-layer | ||
1210 | % apparatus criticus, several text environments to be aligned and | ||
1211 | % quite a number of new commands. \pkg{ekdosis} provides a convenient | ||
1212 | % way to avoid overloading the document preamble: all the settings | ||
1213 | % related to the critical edition can be gathered in a separate | ||
1214 | % configuration file named |\jobname-ekd.cfg|. If such a file can be | ||
1215 | % found, its contents is automatically read and used by | ||
1216 | % \pkg{ekdosis}. | ||
1217 | % | ||
1207 | % \subsection{Witnesses, Hands, Sources, Scholars \& Shorthands} | 1218 | % \subsection{Witnesses, Hands, Sources, Scholars \& Shorthands} |
1208 | % \label{sec:declarations} | 1219 | % \label{sec:declarations} |
1209 | % \paragraph{Terminology} | 1220 | % \paragraph{Terminology} |
@@ -2586,8 +2597,7 @@ friend | |||
2586 | % encoding allows not to lose sight of paragraphs that are meant to be | 2597 | % encoding allows not to lose sight of paragraphs that are meant to be |
2587 | % read together, but it is also the only way to align paragraphs in | 2598 | % read together, but it is also the only way to align paragraphs in |
2588 | % print, and it is much more suitable to mark up correspondence | 2599 | % print, and it is much more suitable to mark up correspondence |
2589 | % between spans of texts as will be demonstrated below in | 2600 | % between spans of texts. |
2590 | % \vref{ref:segmentation}. | ||
2591 | % | 2601 | % |
2592 | % As an illustration, a short extract of Caesar's \emph{Gallic War}, | 2602 | % As an illustration, a short extract of Caesar's \emph{Gallic War}, |
2593 | % VI, XIII.1 follows.\footnote{Latin text: \cite{Caesar-BG-v2}; | 2603 | % VI, XIII.1 follows.\footnote{Latin text: \cite{Caesar-BG-v2}; |
@@ -3057,8 +3067,9 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+ | |||
3057 | % at the bottom of the page. | 3067 | % at the bottom of the page. |
3058 | % | 3068 | % |
3059 | % \danger Regular footnotes are printed above the block of critical | 3069 | % \danger Regular footnotes are printed above the block of critical |
3060 | % notes. Places can be interchanged by just loading the \pkg{fnpos} | 3070 | % notes. The respective places of these blocks can be interchanged by |
3061 | % package in the preamble.\footcite{fnpos} | 3071 | % just loading the \pkg{fnpos} package in the |
3072 | % preamble.\footcite{fnpos} | ||
3062 | % | 3073 | % |
3063 | % \section{Laying Out the Apparatus Criticus} | 3074 | % \section{Laying Out the Apparatus Criticus} |
3064 | % \label{sec:apparatus-layout} | 3075 | % \label{sec:apparatus-layout} |
@@ -3215,6 +3226,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+ | |||
3215 | % \DescribeOption{lang} |lang|$=$\meta{languagename} | 3226 | % \DescribeOption{lang} |lang|$=$\meta{languagename} |
3216 | % \newfeature[v1.2]\phts\label{ref:app-lang-opt} | 3227 | % \newfeature[v1.2]\phts\label{ref:app-lang-opt} |
3217 | % \hfill\tcboxverb{Default: not set}\\ | 3228 | % \hfill\tcboxverb{Default: not set}\\ |
3229 | % \needspace{3\baselineskip}\noindent | ||
3218 | % |lang=<languagename>| is used as described | 3230 | % |lang=<languagename>| is used as described |
3219 | % \vpageref[above]{ref:app-lang} when it is needed to apply in the | 3231 | % \vpageref[above]{ref:app-lang} when it is needed to apply in the |
3220 | % apparatus criticus a language different from the one that is | 3232 | % apparatus criticus a language different from the one that is |
@@ -3379,7 +3391,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+ | |||
3379 | % the apparatus criticus this option is related to. As a result, the | 3391 | % the apparatus criticus this option is related to. As a result, the |
3380 | % page will actually break at the end of the current line. The | 3392 | % page will actually break at the end of the current line. The |
3381 | % particulars of this technique will be discussed below in | 3393 | % particulars of this technique will be discussed below in |
3382 | % \vref{sec:tricks-of-trade}. | 3394 | % \vref{sec:oscillating-problem}. |
3383 | % | 3395 | % |
3384 | % \section{Inserting Notes in Multiple-Layer Apparatus} | 3396 | % \section{Inserting Notes in Multiple-Layer Apparatus} |
3385 | % \label{sec:notes-in-multilayer-app} | 3397 | % \label{sec:notes-in-multilayer-app} |
@@ -4155,11 +4167,35 @@ substantiall fewell,} | |||
4155 | % \fi | 4167 | % \fi |
4156 | % | 4168 | % |
4157 | % \begin{remarks} | 4169 | % \begin{remarks} |
4158 | % \item[\textsc{Rem.}] \cs{ekdlettrine} (l.~23) is a specific command | 4170 | % \item |Gildon1710|, |Gildon1714|, |Sewell1725|, |Ewing1771|, |
4159 | % for the \pkg{lettrine} package does not work in list | 4171 | % |Hudson1856|, |Butler1899| and |Walsh1908| have been declared as |
4160 | % environments. \cs{TeXtoTEIPat} has been used as described below | 4172 | % sources.\footnote{See above \vpageref{ref:declare-source} and |
4161 | % \vpageref{ref:textoteipat} to instruct \pkg{ekdosis} to convert this | 4173 | % below \vref{sec:references-cited-works}.} |God| and |Stee|, |
4162 | % command into an acceptable \texttt{TEI} equivalent. | 4174 | % resp.\ Godwin and Steevens, have been decalred as |
4175 | % scholars.\footnote{See above \vpageref{ref:declare-scholar}.} | ||
4176 | % \item \cs{ekdlettrine} (l.~23) is a specific command for the | ||
4177 | % \pkg{lettrine} package does not work in list | ||
4178 | % environments. \cs{TeXtoTEIPat} has been used as described below | ||
4179 | % \vpageref{ref:textoteipat} to instruct \pkg{ekdosis} to convert | ||
4180 | % this command into an acceptable \texttt{TEI} equivalent. The | ||
4181 | % definition of \cs{ekdlettrine} follows:--- | ||
4182 | % \iffalse | ||
4183 | %<*example> | ||
4184 | % \fi | ||
4185 | \begin{minted}[linenos=false]{latex} | ||
4186 | % Preamble: | ||
4187 | \usepackage{adjustbox} | ||
4188 | % This basic command actually requires an adjustment of the vertical | ||
4189 | % space at the end of the current line (eg. \\[-1.875ex]) and \vin at | ||
4190 | % the beginning of the next line:--- | ||
4191 | \NewDocumentCommand{\ekdlettrine}{mm}{% | ||
4192 | \adjustbox{valign=t,raise=-0.75ex}{\Huge #1}\textsc{#2}% | ||
4193 | } | ||
4194 | \TeXtoTEIPat{\ekdlettrine {#1}{#2}}{<hi rend="smallcaps">#1#2</hi>} | ||
4195 | \end{minted} | ||
4196 | % \iffalse | ||
4197 | %</example> | ||
4198 | % \fi | ||
4163 | % \end{remarks} | 4199 | % \end{remarks} |
4164 | % | 4200 | % |
4165 | % PDF output:--- | 4201 | % PDF output:--- |
@@ -5142,6 +5178,8 @@ subtype="arabtex">'inna 'abI kAna mina | |||
5142 | % \hologo{LuaLaTeX} to be run three more times to get everything to | 5178 | % \hologo{LuaLaTeX} to be run three more times to get everything to |
5143 | % the right place with the right numbers. | 5179 | % the right place with the right numbers. |
5144 | % | 5180 | % |
5181 | % \subsection{The Oscillating Problem} | ||
5182 | % \label{sec:oscillating-problem} | ||
5145 | % In some instances, notably when on a given page entries are very | 5183 | % In some instances, notably when on a given page entries are very |
5146 | % abundant in number, specifically when the edition text is getting | 5184 | % abundant in number, specifically when the edition text is getting |
5147 | % close to the bottom of the page, \pkg{ekdosis} may oscillate | 5185 | % close to the bottom of the page, \pkg{ekdosis} may oscillate |
@@ -5195,7 +5233,7 @@ subtype="arabtex">'inna 'abI kAna mina | |||
5195 | % apparatus criticus may clash again. As said above, a couple of | 5233 | % apparatus criticus may clash again. As said above, a couple of |
5196 | % clashes can be managed with a couple of manually inserted page | 5234 | % clashes can be managed with a couple of manually inserted page |
5197 | % breaks. But if there be too many of them, it is a good indication | 5235 | % 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. | 5236 | % that the selected value of |maxentries| is too high. |
5199 | % | 5237 | % |
5200 | % Complex edition texts do have a magic number. An advisable way to | 5238 | % Complex edition texts do have a magic number. An advisable way to |
5201 | % figure it out would be to start from a sample of only a few pages, | 5239 | % figure it out would be to start from a sample of only a few pages, |
@@ -8986,7 +9024,14 @@ Sample text with a \textcolor{red}{word} in red. | |||
8986 | \NewDocumentEnvironment{ekdpar}{}{\par}{\par} | 9024 | \NewDocumentEnvironment{ekdpar}{}{\par}{\par} |
8987 | % \end{macrocode} | 9025 | % \end{macrocode} |
8988 | % \end{environment} | 9026 | % \end{environment} |
8989 | % | 9027 | % \paragraph{Configuration File} Finally, if a configuration file |
9028 | % named |\jobname-ekd.cfg| can be found, this file is read and its | ||
9029 | % contents loaded into the document preamble. This provides a | ||
9030 | % convenient way to gather all the settings related to the critical | ||
9031 | % edition in a separate file. | ||
9032 | % \begin{macrocode} | ||
9033 | \IfFileExists{\jobname-ekd.cfg}{\input{\jobname-ekd.cfg}}{} | ||
9034 | % \end{macrocode} | ||
8990 | % \iffalse | 9035 | % \iffalse |
8991 | %</package> | 9036 | %</package> |
8992 | % \fi | 9037 | % \fi |