aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2020-08-21 08:33:46 +0200
committerRobert Alessi <alessi@robertalessi.net>2020-08-21 08:33:46 +0200
commitf1aa91c51e256760de1a882d8c78f9d8bc0225ff (patch)
treed492902b8fdeda652dd3711605d4b253293b521a
parent2324c3128137ff37e5c387e5d5e1dc225b03fe7e (diff)
downloadekdosis-f1aa91c51e256760de1a882d8c78f9d8bc0225ff.tar.gz
a few corrections in the documentation
-rw-r--r--ekdosis.dtx32
1 files changed, 17 insertions, 15 deletions
diff --git a/ekdosis.dtx b/ekdosis.dtx
index 736b7b9..0433df9 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -1100,7 +1100,7 @@ along with this program. If not, see
1100 <institution>Marciana Library</institution> 1100 <institution>Marciana Library</institution>
1101 <idno>269</idno> 1101 <idno>269</idno>
1102 <msName> 1102 <msName>
1103 <emph>Marcianus Gr.</emph> 1103 Marcianus Gr.
1104 </msName> 1104 </msName>
1105 </msIdentifier> 1105 </msIdentifier>
1106 <physDesc> 1106 <physDesc>
@@ -3560,15 +3560,15 @@ subtype="arabtex">'inna 'abI kAna mina
3560% As a general rule, the |xml:id| global attribute must be unique for 3560% As a general rule, the |xml:id| global attribute must be unique for
3561% the element that bears the attribute. Furthermore, it must begin 3561% the element that bears the attribute. Furthermore, it must begin
3562% with a letter or an underscore and contain no characters other that 3562% with a letter or an underscore and contain no characters other that
3563% letters, digits, hyphens underscores and full stops. \pkg{ekdosis} 3563% letters, digits, hyphens, underscores and full stops. \pkg{ekdosis}
3564% issues a warning when it finds that any \meta{unique id} of 3564% issues a warning when it finds that any \meta{unique id} of
3565% \meta{unique label} expected in the first argument of 3565% \meta{unique label} expected in the first argument of
3566% \cs{DeclareWitness}, \cs{DeclareHand}, \cs{DeclareScholar} or 3566% \cs{DeclareWitness}, \cs{DeclareHand}, \cs{DeclareSource} or
3567% \cs{DeclareSource} is not unique or breaks the rules just described, 3567% \cs{DeclareScholar} is not unique or breaks the rules just
3568% but does not prevent the |.tex| source file from compiling. Instead, 3568% described, but does not prevent the |.tex| source file from
3569% it prints the string |<??>| in place of the expected formatted 3569% compiling. Instead, it prints the string |<??>| in place of the
3570% siglum so that the error in the |.tex| source file can be easily 3570% expected formatted siglum so that the error in the |.tex| source
3571% spotted and corrected. 3571% file can be easily spotted and corrected.
3572% 3572%
3573% \danger As the \meta{unique id} declared with \cs{DeclareShorthand} 3573% \danger As the \meta{unique id} declared with \cs{DeclareShorthand}
3574% is not to be exported in the \texttt{TEI xml} outputfile, 3574% is not to be exported in the \texttt{TEI xml} outputfile,
@@ -3733,7 +3733,7 @@ many mathematical writings and to the sense of
3733% \texttt{TEI} element it is to be converted into and any additional 3733% \texttt{TEI} element it is to be converted into and any additional
3734% \texttt{xml} attributes to be appended to the opening \texttt{TEI} 3734% \texttt{xml} attributes to be appended to the opening \texttt{TEI}
3735% element. For example, the \cs{sidenote} command that is provided by 3735% element. For example, the \cs{sidenote} command that is provided by
3736% the \cs{sidenotes} package can be processed like so:--- 3736% the \pkg{sidenotes} package can be processed like so:---
3737% 3737%
3738% \iffalse 3738% \iffalse
3739%<*example> 3739%<*example>
@@ -3780,7 +3780,9 @@ many mathematical writings and to the sense of
3780% references inserted by \pkg{ekdosis} in the back matter section of 3780% references inserted by \pkg{ekdosis} in the back matter section of
3781% the \texttt{TEI} ouput file. See below 3781% the \texttt{TEI} ouput file. See below
3782% \vref{sec:references-cited-works} for more information on how to do 3782% \vref{sec:references-cited-works} for more information on how to do
3783% this.}--- 3783% this. Scholars can also be referred to as individuals by means of
3784% the \cs{DeclareScholar} command. See above
3785% \vpageref{ref:declare-source}.}---
3784% 3786%
3785% \iffalse 3787% \iffalse
3786%<*example> 3788%<*example>
@@ -3970,7 +3972,7 @@ Sample text with a \textcolor{red}{word} in red.
3970% paragraph in the PDF output. 3972% paragraph in the PDF output.
3971% \item Line~4 instructs \pkg{ekdosis} to convert \env{speech} \LaTeX\ 3973% \item Line~4 instructs \pkg{ekdosis} to convert \env{speech} \LaTeX\
3972% environments into |<sp>| \texttt{TEI xml} elements. 3974% environments into |<sp>| \texttt{TEI xml} elements.
3973% \item Line~6 disables the |autopar| algorithm that \cs{ekdosis} 3975% \item Line~6 disables the |autopar| algorithm that \pkg{ekdosis}
3974% provides by default for running paragraphs of text. As a 3976% provides by default for running paragraphs of text. As a
3975% consequence, \env{ekdpar} is used to mark the paragraphs. 3977% consequence, \env{ekdpar} is used to mark the paragraphs.
3976% \end{remarks} 3978% \end{remarks}
@@ -4043,10 +4045,10 @@ Sample text with a \textcolor{red}{word} in red.
4043% file, as |<biblStruct>| elements within a |listBibl| section. 4045% file, as |<biblStruct>| elements within a |listBibl| section.
4044% 4046%
4045% As an example, the following Bib\hologo{(La)TeX} entry and its 4047% As an example, the following Bib\hologo{(La)TeX} entry and its
4046% \texttt{TEI} equivalent follow:\footnote{\label{fn:zotero}To the 4048% \texttt{TEI} equivalent are provided:\footnote{\label{fn:zotero}To
4047% author's knowledge, \textsf{Zotero} (\url{https://www.zotero.org}) 4049% the author's knowledge, \textsf{Zotero}
4048% provides excellent \texttt{TEI xml} output from Bib\hologo{(La)TeX} 4050% (\url{https://www.zotero.org}) provides excellent \texttt{TEI xml}
4049% input files.}--- 4051% output from Bib\hologo{(La)TeX} input files.}---
4050% 4052%
4051% \iffalse 4053% \iffalse
4052%<*example> 4054%<*example>