From 1c000b38db68ddd458d88923ad68e6624f622f48 Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Mon, 11 Mar 2019 21:47:11 +0100 Subject: done documenting nobibengine global option --- icite.dtx | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/icite.dtx b/icite.dtx index e3acb10..453da25 100644 --- a/icite.dtx +++ b/icite.dtx @@ -453,6 +453,10 @@ Running "make install" installs the files in the local TeX tree. % % \GetFileInfo{\jobname.dtx} % \DoNotIndex{\newcommand,\newenvironment} +% +% \newcommand*{\NEWfeature}[1]{% +% \hskip 1sp \marginpar{\small\sffamily\raggedright +% New feature\\#1}} % % \title{\tcbox[colframe=black, enhanced, tikznode, drop lifted % shadow, colback=white, boxrule=.25mm]{% @@ -475,7 +479,7 @@ Running "make install" installs the files in the local TeX tree. % % \begin{abstract} % \package{icite} is designed to produce from \hologo{BibTeX} or -% Bib\LaTeX\ bibliographic databases the different indices of +% Bib\LaTeX\ bibliographical databases the different indices of % authors and works cited which are called \emph{indices locorum % citatorum}. It relies on a specific \cs{icite} command and can % operate with either \hologo{BibTeX} or Bib\LaTeX. @@ -555,7 +559,7 @@ Running "make install" installs the files in the local TeX tree. % not require Bib\LaTeX. Instead, \hologo{BibTeX} can be used as % \package{icite} uses the \package{usebib} % package\footnote{\cite{usebib}} to build the indices by drawing -% directly from the bibliographic database. +% directly from the bibliographical database. % % % \section[The \package{icite} package]{The \textsf{icite} package} @@ -594,7 +598,23 @@ Running "make install" installs the files in the local TeX tree. % to |loccit| if it is used alone. This is an easy way to have all % passages cited indexed in a separate index named |loccit|. % -% \paragraph{Bibliographic database} +% \DescribeOption{nobibengine}\NEWfeature{v1.1} +% |nobibengine|$=$|true|\verb+|+|false|\hfill% +% \tcboxverb{Default: not set}\\ +% This named argument does not need a value as it defaults to |true| +% if it is used. When this option is activated, \package{icite} does +% not use \hologo{BibTeX} or Bib\LaTeX\ to insert the citations in the +% body text---even if either is loaded in the preamble---and pulls the +% necessary information directly from the bibliographical +% database. For this reason, \cs{bibinput} described below is of +% course still required. The citations inserted consist of the +% elements described below \vref{sec:entry-fields} +% \vpageref{sec:entry-fields}. However, it must be noted that if the +% entry field |shorthand| of any author/work be set in the database, +% it takes precedence over the fields used to define author names and +% titles. +% +% \paragraph{Bibliographical database} % \DescribeMacro{\bibinput} Once \package{icite} is loaded, it must be % connected to at least one bibliographic |.bib| file. To that end, % \package{icite} uses the same \cs{bibinput} command as @@ -635,6 +655,7 @@ Running "make install" installs the files in the local TeX tree. % command. % % \subsection{Entry fields} +% \label{sec:entry-fields} % \subsubsection{Author names} % To process author names, \package{icite} uses the following entry % fields: -- cgit v1.2.3