aboutsummaryrefslogtreecommitdiff
path: root/icite.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'icite.dtx')
-rw-r--r--icite.dtx153
1 files changed, 92 insertions, 61 deletions
diff --git a/icite.dtx b/icite.dtx
index 829a70d..d3dbd2f 100644
--- a/icite.dtx
+++ b/icite.dtx
@@ -188,7 +188,7 @@ Running "make install" installs the files in the local TeX tree.
188%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01] 188%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
189%<package>\ProvidesPackage{icite} 189%<package>\ProvidesPackage{icite}
190%<*package> 190%<*package>
191 [2019/02/22 v1.00 Make Indices locorum citatorum] 191 [2019/03/07 v1.00 Make Indices locorum citatorum]
192%</package> 192%</package>
193%<*driver> 193%<*driver>
194\documentclass{ltxdoc} 194\documentclass{ltxdoc}
@@ -241,7 +241,7 @@ Running "make install" installs the files in the local TeX tree.
241@MVBook{al-Nadim, 241@MVBook{al-Nadim,
242 author = {\prname{ibn al-nadIm}}, 242 author = {\prname{ibn al-nadIm}},
243 title = {\arb[trans]{\uc{f}ihrist}}, 243 title = {\arb[trans]{\uc{f}ihrist}},
244 sortname = {Nadim}, 244 sortname = {Ibn al-Nadim},
245 date = {1871/1872}, 245 date = {1871/1872},
246 shorthand = {\arb[trans]{\uc{f}ihrist}}, 246 shorthand = {\arb[trans]{\uc{f}ihrist}},
247 editor = {Flügel, Gustav}, 247 editor = {Flügel, Gustav},
@@ -251,7 +251,7 @@ Running "make install" installs the files in the local TeX tree.
251} 251}
252 252
253@Book{al-Qifti, 253@Book{al-Qifti,
254 sortname = {Qifti}, 254 sortname = {Ibn al-Qifti},
255 entrysubtype = {classical}, 255 entrysubtype = {classical},
256 shorthand = {\prname{al-qif.tiyy}, \arb[trans]{\uc{t}a'rI_h}}, 256 shorthand = {\prname{al-qif.tiyy}, \arb[trans]{\uc{t}a'rI_h}},
257 location = {Leipzig}, 257 location = {Leipzig},
@@ -318,8 +318,9 @@ Running "make install" installs the files in the local TeX tree.
318\usepackage{arabluatex} 318\usepackage{arabluatex}
319\SetTranslitConvention{loc} 319\SetTranslitConvention{loc}
320\usepackage{varioref} 320\usepackage{varioref}
321\usepackage{hyperxmp} 321\usepackage{xurl}
322\usepackage{uri} 322\usepackage{uri}
323\usepackage{hyperxmp}
323\usepackage[numbered]{hypdoc} 324\usepackage[numbered]{hypdoc}
324\hypersetup{unicode=true, colorlinks, allcolors=blue, 325\hypersetup{unicode=true, colorlinks, allcolors=blue,
325 linktocpage=true, pdfauthor={Robert Alessi}, pdftitle={The 326 linktocpage=true, pdfauthor={Robert Alessi}, pdftitle={The
@@ -344,9 +345,6 @@ Running "make install" installs the files in the local TeX tree.
344\makeindex 345\makeindex
345\makeindex[name=loccit, title=Index of Passages Cited (modern authors)] 346\makeindex[name=loccit, title=Index of Passages Cited (modern authors)]
346\makeindex[name=primary, title=\emph{Index locorum citatorum}] 347\makeindex[name=primary, title=\emph{Index locorum citatorum}]
347\usepackage{idxlayout}
348\idxlayout{hangindent=3.5cm, subindent=1em, font=footnotesize,
349 totoc=true}
350\usepackage{tabto} 348\usepackage{tabto}
351\usepackage{classics} 349\usepackage{classics}
352\newclassic{iau}{\classicsRoman{#1}|, #1|.#1} 350\newclassic{iau}{\classicsRoman{#1}|, #1|.#1}
@@ -374,10 +372,11 @@ Running "make install" installs the files in the local TeX tree.
374\newcommand{\package}[1]{\textsf{#1}\index{#1=#1 (package)}} 372\newcommand{\package}[1]{\textsf{#1}\index{#1=#1 (package)}}
375\usepackage{tikz} 373\usepackage{tikz}
376\usepackage[breakable, skins, xparse, minted]{tcolorbox} 374\usepackage[breakable, skins, xparse, minted]{tcolorbox}
377\tcbset{colback=white, boxrule=.15mm, colframe=red!50!white, left=6mm, 375\tcbset{colback=white, boxrule=.15mm, colframe=red!50!white,
378 breakable} 376 breakable}
379\newtcblisting{example}{minted options=linenos} 377\newtcblisting{example}{minted options={linenos, numbersep=0mm}}
380\newtcblisting{code}{minted options=linenos, listing only} 378\newtcblisting{code}{minted options={linenos, numbersep=0mm}, listing
379 only}
381\usepackage{etoc} 380\usepackage{etoc}
382\etocsettocdepth{paragraph} 381\etocsettocdepth{paragraph}
383\newcommand{\icitetableofcontents}{% 382\newcommand{\icitetableofcontents}{%
@@ -415,7 +414,7 @@ Running "make install" installs the files in the local TeX tree.
415%</driver> 414%</driver>
416% \fi 415% \fi
417% 416%
418% \CheckSum{0} 417% \CheckSum{269}
419% 418%
420% \CharacterTable 419% \CharacterTable
421% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z 420% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
@@ -470,12 +469,12 @@ Running "make install" installs the files in the local TeX tree.
470% \icitetableofcontents 469% \icitetableofcontents
471% \normalsize 470% \normalsize
472% 471%
473%\changes{v1.00}{2019/02/22}{First public release} 472%\changes{v1.00}{2019/03/07}{First public release}
474% 473%
475% \begin{abstract} 474% \begin{abstract}
476% \package{icite} is designed to produce from \hologo{BibTeX} or 475% \package{icite} is designed to produce from \hologo{BibTeX} or
477% Bib\LaTeX\ bibliographic databases the different indices of cited 476% Bib\LaTeX\ bibliographic databases the different indices of
478% authors and works which are called \emph{indices locorum 477% authors and works cited which are called \emph{indices locorum
479% citatorum}. It relies on a specific \cs{icite} command and can 478% citatorum}. It relies on a specific \cs{icite} command and can
480% operate with either \hologo{BibTeX} or Bib\LaTeX. 479% operate with either \hologo{BibTeX} or Bib\LaTeX.
481% \end{abstract} 480% \end{abstract}
@@ -517,6 +516,7 @@ Running "make install" installs the files in the local TeX tree.
517% source files: 516% source files:
518% \begin{itemize} 517% \begin{itemize}
519% \item |icite.dtx| 518% \item |icite.dtx|
519% \item |icite.ins|
520% \item |Makefile| 520% \item |Makefile|
521% \end{itemize} 521% \end{itemize}
522% 522%
@@ -573,7 +573,7 @@ Running "make install" installs the files in the local TeX tree.
573% \meta{key}$=$\meta{value}. The description of the optional arguments 573% \meta{key}$=$\meta{value}. The description of the optional arguments
574% follows:--- 574% follows:---
575% 575%
576% \DescribeOption{citecmd} 576% \DescribeOption{citecmd}\label{ref:citecmd}
577% |citecmd|$=$\meta{command}\hfill\tcboxverb{Default: cite}\\ 577% |citecmd|$=$\meta{command}\hfill\tcboxverb{Default: cite}\\
578% \meta{command} may be any citation command accepted by 578% \meta{command} may be any citation command accepted by
579% \hologo{BibTeX} or Bib\LaTeX. This option is used by the \cs{icite} 579% \hologo{BibTeX} or Bib\LaTeX. This option is used by the \cs{icite}
@@ -615,10 +615,10 @@ Running "make install" installs the files in the local TeX tree.
615% 615%
616% \paragraph{Styling the titles} 616% \paragraph{Styling the titles}
617% \DescribeMacro{\SetTitleStyle} By default, \package{icite} prints 617% \DescribeMacro{\SetTitleStyle} By default, \package{icite} prints
618% the titles of the works in 618% the titles of the works cited in italics.\\
619% italics. \cs{SetTitleStyle}\marg{for\-matting directives} can be used 619% \cs{SetTitleStyle}\marg{formatting directives} can be used in the
620% in the preamble only to customize the way titles are displayed in 620% preamble only to customize the way titles are displayed in the
621% the indices, like so:--- % 621% indices, like so:--- %
622% \iffalse 622% \iffalse
623%<*example> 623%<*example>
624% \fi 624% \fi
@@ -652,9 +652,11 @@ Running "make install" installs the files in the local TeX tree.
652% it may prove useful to define an additional |indexauthor| field to 652% it may prove useful to define an additional |indexauthor| field to
653% have printed in the index only the relevant part of the name, like 653% have printed in the index only the relevant part of the name, like
654% so: \\[1ex]% 654% so: \\[1ex]%
655% |indexauthor = {|\prname{.hunayn ibn 'is.hAq}|}|\\[1ex] 655% |indexauthor = {|\prname{.hunayn ibn 'is.hAq}|}| or
656% But in the end, the |sortname| field is also needed because the name 656% |indexauthor = {|\prname{.hunayn}|}|\\[1ex]
657% must be sorted without the diacritics:\\[1ex]% 657% But in the end, the |sortname| field is also needed because the
658% diacritics must be discarded so that the name be sorted
659% properly:\\[1ex]%
658% |sortname = {|Hunayn ibn Ishaq|}| 660% |sortname = {|Hunayn ibn Ishaq|}|
659% 661%
660% \subsection{Titles} 662% \subsection{Titles}
@@ -686,7 +688,7 @@ Running "make install" installs the files in the local TeX tree.
686%<*example> 688%<*example>
687% \fi 689% \fi
688\begin{code} 690\begin{code}
689 \icite[<pre>][<post>]{key}[command] 691 \icite[<pre>][<post>]{<key>}[<command>]
690\end{code} 692\end{code}
691% \iffalse 693% \iffalse
692%</example> 694%</example>
@@ -694,7 +696,8 @@ Running "make install" installs the files in the local TeX tree.
694% Where \oarg{command} can be used as a further optional argument to 696% Where \oarg{command} can be used as a further optional argument to
695% specify a standard citation command that \cs{icite} should emulate 697% specify a standard citation command that \cs{icite} should emulate
696% instead of the default \cs{cite} command or any other command set as 698% instead of the default \cs{cite} command or any other command set as
697% default in the preamble by means of the |citecmd| global option. 699% default in the preamble by means of the |citecmd| global
700% option.\footnote{See above, \vref{ref:citecmd}.}
698% 701%
699% \paragraph{Example} The following example illustrates how 702% \paragraph{Example} The following example illustrates how
700% \package{icite} can be used in combination with Bib\LaTeX\ and the 703% \package{icite} can be used in combination with Bib\LaTeX\ and the
@@ -718,7 +721,7 @@ Running "make install" installs the files in the local TeX tree.
718 721
719 % load imakeidx and use xindy to have the numbers sorted properly 722 % load imakeidx and use xindy to have the numbers sorted properly
720 \usepackage[xindy]{imakeidx} 723 \usepackage[xindy]{imakeidx}
721 \makeindex[name=loccit, title=Index of passages cited] 724 \makeindex[name=loccit, title=Index of Passages Cited (modern authors)]
722\end{code} 725\end{code}
723% \iffalse 726% \iffalse
724%</example> 727%</example>
@@ -728,7 +731,7 @@ Running "make install" installs the files in the local TeX tree.
728% \iffalse 731% \iffalse
729%<*example> 732%<*example>
730% \fi 733% \fi
731\begin{example} 734\begin{code}
732 \section*{\cs{icite} in action} 735 \section*{\cs{icite} in action}
733 Let us start with four citations of the same reference, to make sure 736 Let us start with four citations of the same reference, to make sure
734 that they are all indexed and sorted properly: 737 that they are all indexed and sorted properly:
@@ -742,16 +745,33 @@ Running "make install" installs the files in the local TeX tree.
742 Finally, let us have \cs{icite} use \cs{textcite} to cite 745 Finally, let us have \cs{icite} use \cs{textcite} to cite
743 \icite[123]{Endress1992}[textcite], and again, this time in a 746 \icite[123]{Endress1992}[textcite], and again, this time in a
744 footnote\icite[86]{Endress1992}. 747 footnote\icite[86]{Endress1992}.
745\end{example} 748\end{code}
746% \iffalse 749% \iffalse
747%</example> 750%</example>
748% \fi 751% \fi
752%
753% \begin{tcblisting}{text only}
754% \section*{\cs{icite} in action}
755% Let us start with four citations of the same reference, to make
756% sure that they are all indexed and sorted properly:
757% one\icite[123]{Ullmann1970}, two\icite[231]{Ullmann1970},
758% three\icite[81]{Ullmann1970} and four\icite[18]{Ullmann1970}.
759%
760% Let us continue with four other citations out of two other
761% references: one\icite[90]{Bürgel2016}, two\icite[370]{Dols1987},
762% three\icite[205]{Bürgel2016} and four\icite[380]{Dols1987}.
749% 763%
764% Finally, let us have \cs{icite} use \cs{textcite} to cite
765% \icite[123]{Endress1992}[textcite], and again, this time in a
766% footnote\icite[86]{Endress1992}.
767% \end{tcblisting}
768%
750% All indices and the contents of the \hologo{BibTeX} file that has 769% All indices and the contents of the \hologo{BibTeX} file that has
751% been used can be found below in the appendix (\vref{ref:indices} 770% been used can be found below in the appendix
752% and \vref{ref:icite-bib} respectively). As can be seen from the 771% (\vrefrange{ref:indices}{ref:icite-bib} respectively). As can be
753% bibliography generated in the footnotes, \package{icite} prints as 772% seen by comparing the bibliography generated in the footnotes with
754% expected the abbridged forms of the titles when they are 773% the text printed in the index, \package{icite} prints as expected
774% the abbridged forms of the titles when they are
755% available. Furthermore, as a default citation command set in the 775% available. Furthermore, as a default citation command set in the
756% preamble, the \enquote*{oxnotes} Bib\LaTeX\ option of 776% preamble, the \enquote*{oxnotes} Bib\LaTeX\ option of
757% \package{biblatex-oxref} style package makes \cs{autocite} behave 777% \package{biblatex-oxref} style package makes \cs{autocite} behave
@@ -770,7 +790,7 @@ Running "make install" installs the files in the local TeX tree.
770% differentiate between sources by drawing from the bibliographical 790% differentiate between sources by drawing from the bibliographical
771% database the exact string that may be found in the |entrysubtype| 791% database the exact string that may be found in the |entrysubtype|
772% entry field. To that end, the \cs{IndexSubtypeAs} command is 792% entry field. To that end, the \cs{IndexSubtypeAs} command is
773% provided. It takes to madatory arguments, like so:--- % 793% provided. It takes to mandatory arguments, like so:--- %
774% \iffalse 794% \iffalse
775%<*example> 795%<*example>
776% \fi 796% \fi
@@ -841,8 +861,7 @@ Running "make install" installs the files in the local TeX tree.
841 \addbibresource{bibliography.bib} 861 \addbibresource{bibliography.bib}
842 862
843 \usepackage[xindy]{imakeidx} 863 \usepackage[xindy]{imakeidx}
844 \makeindex[name=loccit, title=Index of passages cited (modern 864 \makeindex[name=loccit, title=Index of passages cited (modern authors)]
845 authors)]
846 \makeindex[name=primary, title=\emph{Index locorum citatorum}] 865 \makeindex[name=primary, title=\emph{Index locorum citatorum}]
847 866
848 \usepackage{classics} 867 \usepackage{classics}
@@ -861,7 +880,7 @@ Running "make install" installs the files in the local TeX tree.
861% \iffalse 880% \iffalse
862%<*example> 881%<*example>
863% \fi 882% \fi
864\begin{example} 883\begin{code}
865 \section*{\cs{icite} in action} 884 \section*{\cs{icite} in action}
866 Let us start with four citations of the same reference, to make sure 885 Let us start with four citations of the same reference, to make sure
867 that they are all indexed and sorted properly: 886 that they are all indexed and sorted properly:
@@ -884,41 +903,53 @@ Running "make install" installs the files in the local TeX tree.
884 Finally, let us have \cs{icite} use \cs{textcite} to cite 903 Finally, let us have \cs{icite} use \cs{textcite} to cite
885 \icite[123]{Endress1992}[textcite], and again, this time in a 904 \icite[123]{Endress1992}[textcite], and again, this time in a
886 footnote\icite[86]{Endress1992}. 905 footnote\icite[86]{Endress1992}.
887\end{example} 906\end{code}
888% \iffalse 907% \iffalse
889%</example> 908%</example>
890% \fi 909% \fi
891% 910%
911% \begin{tcblisting}{text only}
912% \section*{\cs{icite} in action}
913% Let us start with four citations of the same reference, to make
914% sure that they are all indexed and sorted properly:
915% one\icite[123]{Ullmann1970}, two\icite[231]{Ullmann1970},
916% three\icite[81]{Ullmann1970} and four\icite[18]{Ullmann1970}.
917%
918% Let us continue with four other citations out of two other
919% references: one\icite[90]{Bürgel2016}, two\icite[370]{Dols1987},
920% three\icite[205]{Bürgel2016} and four\icite[380]{Dols1987}.
921%
922% Before concluding, let us insert a few references to medieval
923% Arabic authors: one\icite[\iau{1}[81][32]]{IAUMuller},
924% two\icite[\razi{5}[7--10]]{RaziShukuk},
925% three\icite[133]{al-Qifti},
926% four\icite[\nadim{3}[7][286]]{al-Nadim},
927% five\icite[\iau{2}[214][20]]{IAUMuller},
928% six\icite[\razi{1}[6--20]]{RaziShukuk},
929% seven\icite[126.15--20]{al-Qifti} and
930% eight\icite[\nadim{3}[7][291]]{al-Nadim}.
931%
932% Finally, let us have \cs{icite} use \cs{textcite} to cite
933% \icite[123]{Endress1992}[textcite], and again, this time in a
934% footnote\icite[86]{Endress1992}.
935% \end{tcblisting}
936%
892% As already said above, all indices and the contents of the 937% As already said above, all indices and the contents of the
893% \hologo{BibTeX} file that has been used can be found below in the 938% \hologo{BibTeX} file that has been used can be found below in the
894% appendix (\vref{ref:indices} and \vref{ref:icite-bib} 939% appendix (\vrefrange{ref:indices}{ref:icite-bib} respectively). As
895% respectively). As one can see, \prname{ibn al-nadIm}, \prname{ibn 940% one can see, \prname{al-rAziyy} has been sorted under the letter R
896% al-qif.tiyy} and \prname{al-rAziyy} have been sorted under the 941% and references to classical works have been formatted properly.
897% letters N, Q and R respectively and references to classical works
898% have been formatted properly.
899% 942%
900% \section{Appendix} 943% \section{Appendix}
901% Designing the layout of indices is out of the scope of this 944% Designing the layout of indices is out of the scope of this
902% documentation. For information, the \package{idxlayout} and 945% documentation. For information, the \package{tabto} package has been
903% \package{tabto} packages have been used in the preamble like 946% used in the preamble in combination with the following |xindy| style
904% so:--- % 947% file:--- %
905% \iffalse
906%<*example>
907% \fi
908\begin{code}
909\usepackage{idxlayout}
910\idxlayout{hangindent=3.5cm, subindent=1em, font=footnotesize,
911 totoc=true}
912\usepackage{tabto}
913\end{code}
914% \iffalse
915%</example>
916% \fi
917% In combination with the following |xindy| style file:---
918% \iffalse 948% \iffalse
919%<*example> 949%<*example>
920% \fi 950% \fi
921\begin{tcblisting}{minted language=lisp, listing only, title=icite.xdy} 951\begin{tcblisting}{minted language=lisp, listing only,
952 title=icite.xdy}
922(markup-locclass-list :open "\tabto{3.5cm}" :sep ", ") 953(markup-locclass-list :open "\tabto{3.5cm}" :sep ", ")
923\end{tcblisting} 954\end{tcblisting}
924% \iffalse 955% \iffalse
@@ -933,8 +964,8 @@ Running "make install" installs the files in the local TeX tree.
933% \subsection{\texorpdfstring{\hologo{BibTeX} 964% \subsection{\texorpdfstring{\hologo{BibTeX}
934% file used in this document}{BibTeX file used in this document}} 965% file used in this document}{BibTeX file used in this document}}
935% \label{ref:icite-bib} 966% \label{ref:icite-bib}
936% \tcbinputlisting{minted options={linenos}, minted language=bibtex, 967% \tcbinputlisting{minted options={linenos, numbersep=1.5mm}, minted
937% listing file=icite.bib, listing only} 968% language=bibtex, listing file=icite.bib, listing only}
938% 969%
939%\StopEventually{} 970%\StopEventually{}
940% 971%