aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2021-05-28 21:08:18 +0200
committerRobert Alessi <alessi@robertalessi.net>2021-05-28 21:08:18 +0200
commite24fd7fcf465ef7b3042f2c7c4abd9420d1c9d74 (patch)
tree33910c611a9704c03f47e58cb5b871aa4b954a10
parent3e60cf9bc593d7a92023ee687a73231c4fe6d2c5 (diff)
downloadekdosis-e24fd7fcf465ef7b3042f2c7c4abd9420d1c9d74.tar.gz
a point about what xml:ids must consist of
-rw-r--r--ekdosis.dtx32
1 files changed, 17 insertions, 15 deletions
diff --git a/ekdosis.dtx b/ekdosis.dtx
index c0ab205..85b7af7 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -1252,7 +1252,8 @@ along with this program. If not, see
1252% \begin{enumerate} 1252% \begin{enumerate}
1253% \item The unique identifier of the witness to be used both in the 1253% \item The unique identifier of the witness to be used both in the
1254% |.tex| source file and as an |xml:id| in the \texttt{TEI xml} 1254% |.tex| source file and as an |xml:id| in the \texttt{TEI xml}
1255% output if any. 1255% output if any.\footnote{See \vpageref{ref:xmlid} for more
1256% information.}
1256% \item The rendition to be used in the printed apparatus criticus, 1257% \item The rendition to be used in the printed apparatus criticus,
1257% which also will be found within the |<sourceDesc>| element of the 1258% which also will be found within the |<sourceDesc>| element of the
1258% \texttt{TEI} header where the description of the witness occurs, 1259% \texttt{TEI} header where the description of the witness occurs,
@@ -1318,7 +1319,7 @@ along with this program. If not, see
1318% \begin{enumerate} 1319% \begin{enumerate}
1319% \item The unique identifier of the hand to be used both in the 1320% \item The unique identifier of the hand to be used both in the
1320% |.tex| source file and as an |xml:id| in the \texttt{TEI xml} output 1321% |.tex| source file and as an |xml:id| in the \texttt{TEI xml} output
1321% if any. 1322% if any.\footnote{See \vpageref{ref:xmlid} for more information.}
1322% \item The unique identifier of the witness the hand is related 1323% \item The unique identifier of the witness the hand is related
1323% to. Of course, this witness must have been declared beforehand. 1324% to. Of course, this witness must have been declared beforehand.
1324% \item The rendition to be used in the printed apparatus criticus, 1325% \item The rendition to be used in the printed apparatus criticus,
@@ -1452,7 +1453,7 @@ along with this program. If not, see
1452% \begin{enumerate} 1453% \begin{enumerate}
1453% \item The unique identifier of the scholar to be used both in the 1454% \item The unique identifier of the scholar to be used both in the
1454% |.tex| source file and as an |xml:id| in the \texttt{TEI xml} output 1455% |.tex| source file and as an |xml:id| in the \texttt{TEI xml} output
1455% if any. 1456% if any.\footnote{See \vpageref{ref:xmlid} for more information.}
1456% \item The rendition to be used in the apparatus criticus in print, 1457% \item The rendition to be used in the apparatus criticus in print,
1457% which also will be found within the |<sourceDesc>| element of the 1458% which also will be found within the |<sourceDesc>| element of the
1458% \texttt{TEI} header where the description of the persons cited 1459% \texttt{TEI} header where the description of the persons cited
@@ -5606,18 +5607,19 @@ subtype="arabtex">'inna 'abI kAna mina
5606% |false| by means of \cs{SetTEIxmlExport} described above. 5607% |false| by means of \cs{SetTEIxmlExport} described above.
5607% 5608%
5608% \paragraph{The \texttt{xml:id} Attribute} 5609% \paragraph{The \texttt{xml:id} Attribute}
5609% As a general rule, the |xml:id| global attribute must be unique for 5610% \phts\label{ref:xmlid} As a general rule, the |xml:id| global
5610% the element that bears the attribute. Furthermore, it must begin 5611% attribute must be unique for the element that bears the
5611% with a letter or an underscore and contain no characters other that 5612% attribute. Furthermore, it must begin with a letter or an underscore
5612% letters, digits, hyphens, underscores and full stops. \pkg{ekdosis} 5613% and contain no characters other than letters of the Latin alphabet
5613% issues a warning when it finds that any \meta{unique id} of 5614% either upper or lower case from |a| to |z|, digits, hyphens,
5614% \meta{unique label} expected in the first argument of 5615% underscores and full stops. \pkg{ekdosis} issues a warning when it
5615% \cs{DeclareWitness}, \cs{DeclareHand}, \cs{DeclareSource} or 5616% finds that any \meta{unique id} of \meta{unique label} expected in
5616% \cs{DeclareScholar} is not unique or breaks the rules just 5617% the first argument of \cs{DeclareWitness}, \cs{DeclareHand},
5617% described, but does not prevent the |.tex| source file from 5618% \cs{DeclareSource} or \cs{DeclareScholar} is not unique or breaks
5618% compiling. Instead, it prints the string |<??>| in place of the 5619% the rules just described, but does not prevent the |.tex| source
5619% expected formatted siglum so that the error in the |.tex| source 5620% file from compiling. Instead, it prints the string |<??>| in place
5620% file can be easily spotted and corrected. 5621% of the expected formatted siglum so that the error in the |.tex|
5622% source file can be easily spotted and corrected.
5621% 5623%
5622% \danger As the \meta{unique id} declared with \cs{DeclareShorthand} 5624% \danger As the \meta{unique id} declared with \cs{DeclareShorthand}
5623% is not to be exported in the \texttt{TEI xml} output file, 5625% is not to be exported in the \texttt{TEI xml} output file,