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.tex47
1 files changed, 36 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 db2f306c297..25ab4e4d173 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.20}
+ \title{User Manual for datatool bundle version~2.21}
\author{Nicola L.C. Talbot\\
\url{http://www.dickimaw-books.com/}}
- \date{2014-02-03}
+ \date{2014-03-08}
\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.20}
+ read \qt{Documented Code for datatool v2.21}
\item[INSTALL] Installation instructions.
@@ -2723,18 +2723,25 @@ Specifies how to separate rows. Defaults to just
\end{definition}
This is a hook to add something at the beginning of the
\env{tabular} environment. This defaults to nothing.
+In the case of \cs{DTLdisplaylongdb}, this hook is done before the
+header row on each page of the \env{longtable}.
\begin{definition}[\DescribeMacro{\dtldisplayendtab}]%
\cs{dtldisplayendtab}
\end{definition}
This is a hook to add something at the end of the
\env{tabular} environment. This defaults to nothing.
+In the case of \cs{DTLdisplaylongdb}, this hook is only done on the
+\emph{last} page of the \env{longtable}. You have to use the
+\texttt{foot} option to specify some code to do at the end of each page.
\begin{definition}[\DescribeMacro{\dtldisplayafterhead}]%
\cs{dtldisplayafterhead}
\end{definition}
This is a hook to add something after the header row, before
the first row of data. This defaults to nothing.
+In the case of \cs{DTLdisplaylongdb}, this hook is done after the
+header row on each page of the \env{longtable}.
\begin{definition}[\DescribeMacro{\dtldisplaystartrow}]%
\cs{dtldisplaystartrow}
@@ -5596,7 +5603,9 @@ The \sty{datagidx} package is provided as an alternative to the
indexing application, such as \app{xindy} or
\app{makeindex}, it uses the database mechanism of the
\sty{datatool} package. \emph{\sty{datagidx} and \sty{glossaries}
-are not compatible.}
+are not compatible.} (Note: \sty{glossaries} version 4.04 now has an
+option that uses \TeX\ to sort the glossaries instead of using
+\app{makeindex} or \app{xindy}.)
First a repeat of the caveat at the start of this manual:
\begin{important}
@@ -9019,7 +9028,7 @@ For example, you may want to sort the bibliography in
reverse chronological order. Once you have sorted the bibliography,
you can display it using \cs{DTLbibliography}, described in
\autoref{sec:thebib}, or you can iterate through the database
-using \cs{DTLforeachbib}, described in \autoref{sec:foreachbib}.
+using \cs{DTLforeachbibentry}, described in \autoref{sec:foreachbib}.
Note that the \sty{databib}
package is not automatically loaded by \sty{datatool}, so if
@@ -9759,16 +9768,28 @@ not meet your needs. For example, you may be required
to list journal papers and conference proceedings in separate
sections. In which case, you may find it easier to iterate through
the bibliography using:
-\begin{definition}[\DescribeMacro{\DTLforeachbib}]%
-\cs{DTLforeachbib}\oarg{condition}\marg{db name}\marg{text}
+\begin{definition}[\DescribeMacro{\DTLforeachbibentry}]%
+\cs{DTLforeachbibentry}\oarg{condition}\marg{db name}\marg{text}
\end{definition}
-\begin{definition}[\DescribeMacro{\DTLforeachbib*}]%
-\cs{DTLforeachbib*}\oarg{condition}\marg{db name}\marg{text}
+\begin{definition}[\DescribeMacro{\DTLforeachbibentry*}]%
+\cs{DTLforeachbibentry*}\oarg{condition}\marg{db name}\marg{text}
\end{definition}
This iterates through the \sty{databib} database called
\meta{db name} and does \meta{text} if \meta{condition} is met.
As with \cs{DTLforeach}, the starred version is read-only.
+\cs{DTLforeachbibentry} only makes local assignments, which means that it's unsuitable to display the references
+in a~\env{tabular}-like environment (for example, the
+\env{europecv} environment provided by the \cls{europecv} class). It's also a~short command, so
+\meta{text} can't contain any paragraph breaks. Instead you can use
+the analogous commands:
+\begin{definition}[\DescribeMacro{\gDTLforeachbibentry}]%
+\cs{gDTLforeachbibentry}\oarg{condition}\marg{db name}\marg{text}
+\end{definition}
+\begin{definition}[\DescribeMacro{\gDTLforeachbibentry*}]%
+\cs{gDTLforeachbibentry*}\oarg{condition}\marg{db name}\marg{text}
+\end{definition}
+
For each row of the database, the following commands are set:
\begin{itemize}
\item \cs{DBIBcitekey} \DescribeMacro{\DBIBcitekey}This is the
@@ -9821,7 +9842,11 @@ This formats the bibliography entry for the current row. It
checks for the existence of the command
\cs{DTLformat}\meta{entry type}, where \meta{entry type}
is given by \cs{DBIBentrytype}. These commands are defined
-by the bibliography style.
+by the bibliography style. There is also a~version for use with
+\cs{gDTLforeachbibentry}:
+\begin{definition}[\DescribeMacro{\gDTLformatbibentry}]%
+\cs{gDTLformatbibentry}
+\end{definition}
\begin{definition}[\DescribeMacro{\DTLcomputewidestbibentry}]%
\cs{DTLcomputewidestbibentry}\marg{conditions}\marg{db
@@ -9835,7 +9860,7 @@ argument of the \env{thebibliography} environment.
The counter \desctr{DTLbibrow} keeps track of the current
bibliography entry. This is reset at the start of each
-\cs{DTLforeachbib} and is incremented if \meta{conditions}
+\cs{DTLforeachbibentry} and is incremented if \meta{conditions}
is met.
Within the optional argument \meta{condition}, you may use any of the