summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/datatool/datatool-user.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/datatool/datatool-user.tex')
-rw-r--r--Master/texmf-dist/doc/latex/datatool/datatool-user.tex50
1 files changed, 39 insertions, 11 deletions
diff --git a/Master/texmf-dist/doc/latex/datatool/datatool-user.tex b/Master/texmf-dist/doc/latex/datatool/datatool-user.tex
index d641d8a5f3a..372ca7d0299 100644
--- a/Master/texmf-dist/doc/latex/datatool/datatool-user.tex
+++ b/Master/texmf-dist/doc/latex/datatool/datatool-user.tex
@@ -91,11 +91,11 @@
\MakeShortVerb{"}
\DeleteShortVerb{\|}
- \title{User Manual for datatool bundle version~2.18}
+ \title{User Manual for datatool bundle version~2.19}
\author{Nicola L.C. Talbot\\
\url{http://www.dickimaw-books.com/}}
- \date{2013-09-06}
+ \date{2014-01-17}
\maketitle
\pagenumbering{roman}
@@ -110,7 +110,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.18}
+ read \qt{Documented Code for datatool v2.19}
\item[INSTALL] Installation instructions.
@@ -2258,8 +2258,17 @@ before you use \cs{DTLloaddb}. You can reverse this using
\end{definition}
The file (\meta{filename}) may have a header row at the start of the file,
which provides the \meta{key} when creating a new database entry
-using \ics{DTLnewdbentry}. The optional argument \meta{options}
-is a key=value list of options. Available options are:
+using \ics{DTLnewdbentry}.
+The optional argument \meta{options}
+is a \meta{key}=\meta{value} list of options.
+\begin{important}
+Some of the keys may take a comma-separated list as a value.
+Note that spaces count in the default \TeX\ way within these lists.
+Remember that \TeX\ considers an end-of-line character as a space.
+If you have a long list, consider using the comment character (\%)
+to suppress unwanted space caused by line breaks in the code.
+\end{important}
+Available options are:
\begin{description}
\item[\csopt{DTLloaddb}{noheader}] This is a boolean value and
indicates if the file does not contain a header. If no value is
@@ -2275,7 +2284,8 @@ keys are supplied in \meta{options}, then the keys will be given by
\cs{dtldefaultkey}\meta{n}, where \meta{n} is the column number and
\DescribeMacro{\dtldefaultkey}\cs{dtldefaultkey} defaults to
``\dtldefaultkey''. Note that the list of keys must be delimited by
-braces since they contain commas. For example:
+braces since they contain commas.
+For example:
\begin{verbatim}
\DTLloaddb[noheader,keys={Temperature,Time,T2G}]{data}{data.csv}
\end{verbatim}
@@ -2312,6 +2322,10 @@ The delimiter can be changed using
\begin{definition}[\DescribeMacro{\DTLsetdelimiter}]%
\cs{DTLsetdelimiter}\marg{character}
\end{definition}
+\begin{important}
+Note that spaces count in the default \TeX\ manner (unless you
+specify a whitespace character as the delimiter).
+\end{important}
For example, suppose you have a file called \texttt{mydata.csv}
which contains the following:
@@ -2698,6 +2712,12 @@ Specifies the vertical alignment of the \env{tabular} environment
used by \cs{DTLdisplaydb}. Defaults to \texttt{c} (centred). May be redefined
to \texttt{t} (top) or \texttt{b} (bottom).
+\begin{definition}[\DescribeMacro{\dtldisplaycr}]
+\cs{dtldisplaycr}
+\end{definition}
+Specifies how to separate rows. Defaults to just
+\ics{tabularnewline}.
+
\begin{definition}[\DescribeMacro{\dtldisplaystarttab}]%
\cs{dtldisplaystarttab}
\end{definition}
@@ -6104,7 +6124,7 @@ adding to the definition of
\begin{definition}[\DescribeMacro\newtermlabelhook]
\cs{newtermlabelhook}
\end{definition}
-You can use \sty{etoolbox's} \ics{appto} command to append to this
+You can use \sty{etoolbox}'s \ics{appto} command to append to this
hook. For example, suppose you want to index the terms \verb|\TeX|,
\verb|e\TeX| and \verb|pdf\TeX|, but you want the terms to have the
label and sort fields to be just \verb|TeX|, \verb|eTeX| and
@@ -6247,6 +6267,11 @@ following analogous commands instead:
\cs{USEentrynl}\marg{label}\marg{field}
\end{definition}
+You can also specify your own custom text:
+\begin{definition}[\DescribeMacro\glslink]
+\cs{glslink}\marg{label}\marg{text}
+\end{definition}
+
In all the above commands, the \meta{label} argument may optionally
start with \oarg{format}, where format is the name of a control
name \emph{without} the preceding backslash. This command will be
@@ -6524,6 +6549,11 @@ Note that, unlike the \sty{glossaries} package, \cs{acr} isn't the
same as \cs{gls}. With \styfmt{datagidx}, \cs{gls} always references
the \csopt{newterm}{text} field. There is no ``first'' field.
+\begin{important}
+Take care when using acronyms with \cls{beamer}. Using overlays can
+cause problems with first use expansions.
+\end{important}
+
As a general rule, you're not supposed to capitalise the first
letter of an acronym (especially if it is displayed in small caps) but if you need to
you can use:
@@ -10426,13 +10456,11 @@ stores in \meta{cs} (which must be a command name).
\addcontentsline{toc}{chapter}{Acknowledgements}
\chapter*{Acknowledgements}
-Many thanks to Morten~H\o gholm for suggesting a much more
+Many thanks to Morten~H\o gholm for providing a much more
efficient way of storing the information in databases which
has significantly improved the time it takes to \LaTeX\ documents
containing large databases.
-\clearpage
-\phantomsection
-\addcontentsline{toc}{chapter}{Index}\PrintIndex
+\PrintIndex
\end{document}