aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2019-03-11 21:47:11 +0100
committerRobert Alessi <alessi@robertalessi.net>2019-03-11 21:47:11 +0100
commit1c000b38db68ddd458d88923ad68e6624f622f48 (patch)
treec650c5b0216d06b460bf25e803b3cdafd6d1d95a
parentc10cc18e325fd90ef6e5881f7c8c168ed808a7a9 (diff)
downloadicite-1c000b38db68ddd458d88923ad68e6624f622f48.tar.gz
done documenting nobibengine global option
-rw-r--r--icite.dtx27
1 files 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.
453% 453%
454% \GetFileInfo{\jobname.dtx} 454% \GetFileInfo{\jobname.dtx}
455% \DoNotIndex{\newcommand,\newenvironment} 455% \DoNotIndex{\newcommand,\newenvironment}
456%
457% \newcommand*{\NEWfeature}[1]{%
458% \hskip 1sp \marginpar{\small\sffamily\raggedright
459% New feature\\#1}}
456% 460%
457% \title{\tcbox[colframe=black, enhanced, tikznode, drop lifted 461% \title{\tcbox[colframe=black, enhanced, tikznode, drop lifted
458% shadow, colback=white, boxrule=.25mm]{% 462% shadow, colback=white, boxrule=.25mm]{%
@@ -475,7 +479,7 @@ Running "make install" installs the files in the local TeX tree.
475% 479%
476% \begin{abstract} 480% \begin{abstract}
477% \package{icite} is designed to produce from \hologo{BibTeX} or 481% \package{icite} is designed to produce from \hologo{BibTeX} or
478% Bib\LaTeX\ bibliographic databases the different indices of 482% Bib\LaTeX\ bibliographical databases the different indices of
479% authors and works cited which are called \emph{indices locorum 483% authors and works cited which are called \emph{indices locorum
480% citatorum}. It relies on a specific \cs{icite} command and can 484% citatorum}. It relies on a specific \cs{icite} command and can
481% operate with either \hologo{BibTeX} or Bib\LaTeX. 485% operate with either \hologo{BibTeX} or Bib\LaTeX.
@@ -555,7 +559,7 @@ Running "make install" installs the files in the local TeX tree.
555% not require Bib\LaTeX. Instead, \hologo{BibTeX} can be used as 559% not require Bib\LaTeX. Instead, \hologo{BibTeX} can be used as
556% \package{icite} uses the \package{usebib} 560% \package{icite} uses the \package{usebib}
557% package\footnote{\cite{usebib}} to build the indices by drawing 561% package\footnote{\cite{usebib}} to build the indices by drawing
558% directly from the bibliographic database. 562% directly from the bibliographical database.
559% 563%
560% 564%
561% \section[The \package{icite} package]{The \textsf{icite} package} 565% \section[The \package{icite} package]{The \textsf{icite} package}
@@ -594,7 +598,23 @@ Running "make install" installs the files in the local TeX tree.
594% to |loccit| if it is used alone. This is an easy way to have all 598% to |loccit| if it is used alone. This is an easy way to have all
595% passages cited indexed in a separate index named |loccit|. 599% passages cited indexed in a separate index named |loccit|.
596% 600%
597% \paragraph{Bibliographic database} 601% \DescribeOption{nobibengine}\NEWfeature{v1.1}
602% |nobibengine|$=$|true|\verb+|+|false|\hfill%
603% \tcboxverb{Default: not set}\\
604% This named argument does not need a value as it defaults to |true|
605% if it is used. When this option is activated, \package{icite} does
606% not use \hologo{BibTeX} or Bib\LaTeX\ to insert the citations in the
607% body text---even if either is loaded in the preamble---and pulls the
608% necessary information directly from the bibliographical
609% database. For this reason, \cs{bibinput} described below is of
610% course still required. The citations inserted consist of the
611% elements described below \vref{sec:entry-fields}
612% \vpageref{sec:entry-fields}. However, it must be noted that if the
613% entry field |shorthand| of any author/work be set in the database,
614% it takes precedence over the fields used to define author names and
615% titles.
616%
617% \paragraph{Bibliographical database}
598% \DescribeMacro{\bibinput} Once \package{icite} is loaded, it must be 618% \DescribeMacro{\bibinput} Once \package{icite} is loaded, it must be
599% connected to at least one bibliographic |.bib| file. To that end, 619% connected to at least one bibliographic |.bib| file. To that end,
600% \package{icite} uses the same \cs{bibinput} command as 620% \package{icite} uses the same \cs{bibinput} command as
@@ -635,6 +655,7 @@ Running "make install" installs the files in the local TeX tree.
635% command. 655% command.
636% 656%
637% \subsection{Entry fields} 657% \subsection{Entry fields}
658% \label{sec:entry-fields}
638% \subsubsection{Author names} 659% \subsubsection{Author names}
639% To process author names, \package{icite} uses the following entry 660% To process author names, \package{icite} uses the following entry
640% fields: 661% fields: