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.tex46
1 files changed, 43 insertions, 3 deletions
diff --git a/Master/texmf-dist/doc/latex/datatool/datatool-user.tex b/Master/texmf-dist/doc/latex/datatool/datatool-user.tex
index 25ab4e4d173..32208ad80e5 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.21}
+ \title{User Manual for datatool bundle version~2.22}
\author{Nicola L.C. Talbot\\
\url{http://www.dickimaw-books.com/}}
- \date{2014-03-08}
+ \date{2014-06-10}
\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.21}
+ read \qt{Documented Code for datatool v2.22}
\item[INSTALL] Installation instructions.
@@ -2290,6 +2290,15 @@ For example:
\DTLloaddb[noheader,keys={Temperature,Time,T2G}]{data}{data.csv}
\end{verbatim}
+\item[\csopt{DTLloaddb}{autokeys}] This is a boolean option that
+will automatically assign default keys (\cs{dtldefaultkey}\meta{n},
+as above) for all columns, regardless of whether the file has a
+header row. If true, this option overrides the
+\csopt{DTLloaddb}{keys} option. You may want to use this if you have
+a header row with many fields containing active characters but you
+only want to use commands like \cs{DTLdisplaydb}. (In which case,
+you may want to consider using \cs{DTLloadrawdb} to load the data.)
+
\item[\csopt{DTLloaddb}{headers}] This is a comma-separated list of
headers. If not supplied, the header will be the same as that given
in the header row, or the key if there is no header row. Note that
@@ -9644,6 +9653,16 @@ However, if there are only two author or editor names,
\DescribeMacro{\DTLtwoand}\cs{DTLtwoand}
is used instead of \cs{DTLandlast}.
+\DescribeMacro\DTLbibitem
+The command \cs{DTLbibitem} is used at the start of each
+bibliography item. It uses \cs{bibitem} to provide a marker,
+such as [1], and writes the citation information to the
+\texttt{.aux} file.
+
+\DescribeMacro\DTLmbibitem
+The command \cs{DTLmbibitem} is analogous to \cs{DTLbibitem} but is
+for use with \cs{DTLmbibliography}.
+
\DescribeMacro{\DTLendbibitem}
The command \cs{DTLendbibitem} is a hook provided to add
additional information at the end of each bibliography item.
@@ -9816,6 +9835,12 @@ where \meta{field label} may be one of: "Address", "Author",
"Title", "Type", "Volume", "Year", "ISBN", "DOI", "PubMed",
"Abstract" or "Url".
+Alternatively, you can assign the value of a field to a control
+sequence \meta{cs} using:
+\begin{definition}[\DescribeMacro\DTLbibfieldlet]
+\cs{DTLbibfieldlet}\marg{cs}\marg{field label}
+\end{definition}
+
You can determine if a field exists for a given entry using
\begin{definition}[\DescribeMacro{\DTLifbibfieldexists}]%
\cs{DTLifbibfieldexists}\marg{field label}\marg{true part}\marg{false
@@ -9847,6 +9872,21 @@ by the bibliography style. There is also a~version for use with
\begin{definition}[\DescribeMacro{\gDTLformatbibentry}]%
\cs{gDTLformatbibentry}
\end{definition}
+It's also possible to use \cs{DTLformatbibentry} for a specific key,
+rather than using it within \ics{DTLforeachbibentry} using:
+\begin{definition}
+\cs{DTLformatthisbibentry}\marg{db}\marg{cite key}
+\end{definition}
+where \meta{db} is the database name and \meta{cite key} is the
+citation label. Note that none of these three commands use
+\cs{bibitem}. You can manually insert \cs{bibitem}\marg{cite key}
+in front of the command, or you can use:
+\begin{definition}
+\cs{DTLcustombibitem}\marg{marker code}\marg{ref text}\marg{cite key}
+\end{definition}
+This is like \cs{bibitem}\oarg{text}\marg{cite key} except that it uses
+\meta{marker code} instead of \cs{item}\oarg{text} and it uses
+\meta{ref text} instead of \verb|\the\value{\@listctr}|.
\begin{definition}[\DescribeMacro{\DTLcomputewidestbibentry}]%
\cs{DTLcomputewidestbibentry}\marg{conditions}\marg{db