diff options
author | Karl Berry <karl@freefriends.org> | 2019-09-28 21:32:49 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2019-09-28 21:32:49 +0000 |
commit | ccc34419a1783744295ce86fffaf9138b91d72f7 (patch) | |
tree | 59be2264d2a34af9404a0fadb20e2b7dc6071d05 /Master/texmf-dist/doc/latex/datatool/datatool-user.tex | |
parent | cc09915f2283c012a12045169ce8e1caa621dbe3 (diff) |
datatool (28sep19)
git-svn-id: svn://tug.org/texlive/trunk@52198 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/datatool/datatool-user.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/datatool/datatool-user.tex | 66 |
1 files changed, 47 insertions, 19 deletions
diff --git a/Master/texmf-dist/doc/latex/datatool/datatool-user.tex b/Master/texmf-dist/doc/latex/datatool/datatool-user.tex index 08f01e258ff..f60a4f34485 100644 --- a/Master/texmf-dist/doc/latex/datatool/datatool-user.tex +++ b/Master/texmf-dist/doc/latex/datatool/datatool-user.tex @@ -103,11 +103,11 @@ \MakeShortVerb{"} - \title{User Manual for datatool bundle version~2.31} + \title{User Manual for datatool bundle version~2.32} \author{Nicola L.C. Talbot\\ \url{http://www.dickimaw-books.com/}} - \date{2018-12-07} + \date{2019-09-27} \maketitle \pagenumbering{roman} @@ -122,7 +122,7 @@ The \styfmt{datatool} bundle comes with the following documentation: \item[\url{datatool-code.pdf}] Advanced users wishing to know more about the inner workings of all the packages provided in the \styfmt{datatool} bundle should - read \qt{Documented Code for datatool v2.31} + read \qt{Documented Code for datatool v2.32} \item[INSTALL] Installation instructions. @@ -130,6 +130,13 @@ The \styfmt{datatool} bundle comes with the following documentation: \item[README] Package summary. \end{description} +Additional online resources: +\begin{itemize} +\item \styfmt{datatool} FAQ: +\href{https://www.dickimaw-books.com/faqs/datatoolfaq.html}{dickimaw-books.com/faqs/datatoolfaq.html} +\item Bug tracker: \href{https://www.dickimaw-books.com/bugtracker.php}{dickimaw-books.com/bugtracker.php} +\item \styfmt{datatool} performance: \href{https://www.dickimaw-books.com/gallery/datatool-performance.shtml}{dickimaw-books.com/gallery/datatool-performance.shtml} +\end{itemize} \begin{important} There's an old adage, ``use the right tool for the right job.'' @@ -2266,7 +2273,26 @@ A case-sensitive comparison. \begin{definition}[\DescribeMacro\dtlicompare] \cs{dtlicompare}\marg{register}\marg{A}\marg{B} \end{definition} -A case-insensitive comparison. +A case-insensitive comparison. The two above commands work in much +the same way except that the first compares character codes and the +second compares the lowercase character codes. If control sequences +are found then the comparison is determined by the conditional: +\begin{definition}[\DescribeMacro\ifdtlcompareskipcs] +\cs{ifdtlcompareskipcs} +\end{definition} +This is switched on with: +\begin{definition}[\DescribeMacro\dtlcompareskipcstrue] +\cs{dtlcompareskipcstrue} +\end{definition} +and switched off with: +\begin{definition}[\DescribeMacro\dtlcompareskipcsfalse] +\cs{dtlcompareskipcsfalse} +\end{definition} +The default setting is false (off). If true control sequences will +be skipped. If false control sequences will considered as having the +code 0. + +There are also two comparison commands designed for indexes: \begin{definition}[\DescribeMacro\dtlwordindexcompare] \cs{dtlwordindexcompare}\marg{register}\marg{A}\marg{B} \end{definition} @@ -2276,7 +2302,7 @@ the Oxford Style Manual. \cs{dtlletterindexcompare}\marg{register}\marg{A}\marg{B} \end{definition} English letter-ordering comparison for indexes. -Those last two commands are described in more detail in +These last two commands are described in more detail in \sectionref{sec:sort}. For example: @@ -6782,9 +6808,8 @@ sets both the label and sort fields to \texttt{macedoine} but the name and text fields are set to \verb|mac\'edoine|. \begin{important} -The first letter must be grouped if it's an accent or ligature or a -character outside the range \texttt{a}\ldots\texttt{z} or -\texttt{A}\ldots\texttt{Z}. +The first letter must be grouped if it's an accent or ligature +command. \end{important} \item This example must have the sort and label fields set manually @@ -6793,29 +6818,32 @@ because the first letter has an accent: \newterm[label=elite,sort=elite]{{\'e}lite} \end{verbatim} -\item The same applies if you are using the \sty{inputenc} package: +\item This used to also apply when using the \sty{inputenc} package +with older versions of \styfmt{datatool-base} and \styfmt{mfirstuc}. +However now it's no longer necessary for accents: +\begin{verbatim} +\newterm{élite} +\end{verbatim} + +\item Commands such as \ics{oe} aren't dealt with, so you must +manually set the label and sort key: \begin{verbatim} -\newterm[label=elite,sort=elite]{{é}lite} +\newterm[label=manoeuvre,sort=manoeuvre]{man\oe uvre} \end{verbatim} \item The same applies to plural terms set explicitly: \begin{verbatim} \newterm [% - plural={{œ}sophagi},% + plural={{\oe}sophagi},% label={oesophagus},% sort={oesophagus}% ] - {{œ}sophagus} -\end{verbatim} - -\item Commands such as \ics{oe} aren't dealt with, so you must -manually set the label and sort key: -\begin{verbatim} -\newterm[label=manoeuvre,sort=manoeuvre]{man\oe uvre} + {{\oe}sophagus} \end{verbatim} -\item The same applies if you are using the \sty{inputenc} package: +\item The same applies if you are using the \sty{inputenc} package +to enter ligatures: \begin{verbatim} \newterm[label=manoeuvre,sort=manoeuvre]{manœuvre} \end{verbatim} |