summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/icite
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-03-17 21:38:40 +0000
committerKarl Berry <karl@freefriends.org>2019-03-17 21:38:40 +0000
commit92df70634c796daf81679360e2cc092d28cb6edc (patch)
treea3403716b50edd585d1ec3d100964b8e5030abeb /Master/texmf-dist/doc/latex/icite
parent39948ee1306a518baab7bd81a847e11249643885 (diff)
icite (17mar19)
git-svn-id: svn://tug.org/texlive/trunk@50429 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/icite')
-rw-r--r--Master/texmf-dist/doc/latex/icite/README.md112
-rw-r--r--Master/texmf-dist/doc/latex/icite/icite.pdfbin213292 -> 237025 bytes
-rw-r--r--Master/texmf-dist/doc/latex/icite/samples/icite-biblatex.pdfbin59993 -> 60828 bytes
-rw-r--r--Master/texmf-dist/doc/latex/icite/samples/icite-biblatex.tex56
-rw-r--r--Master/texmf-dist/doc/latex/icite/samples/icite-minimal.pdfbin0 -> 42307 bytes
-rw-r--r--Master/texmf-dist/doc/latex/icite/samples/icite-minimal.tex72
-rw-r--r--Master/texmf-dist/doc/latex/icite/samples/icite-nobiblatex.pdfbin56710 -> 57312 bytes
-rw-r--r--Master/texmf-dist/doc/latex/icite/samples/icite-nobiblatex.tex57
8 files changed, 255 insertions, 42 deletions
diff --git a/Master/texmf-dist/doc/latex/icite/README.md b/Master/texmf-dist/doc/latex/icite/README.md
new file mode 100644
index 00000000000..05846e536a7
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/icite/README.md
@@ -0,0 +1,112 @@
+---
+author:
+- Robert Alessi
+title: 'The icite package – README file'
+---
+
+Overview
+========
+
+`icite` is designed to produce from BibTeX or BibLaTeX bibliographical
+databases the different indices of authors and works cited which are
+called _indices locorum citatorum_. It relies on a specific
+`\icite` command and can operate with either BibTeX or BibLaTeX.
+
+License and disclamer
+=====================
+
+icite – Indices locorum citatorum
+
+Copyright ⓒ 2019 Robert Alessi
+
+Please send error reports and suggestions for improvements to Robert
+Alessi:
+
+- email: <alessi@robertalessi.net>
+
+- website: <http://www.robertalessi.net/icite>
+
+- comments, feature requests, bug reports:
+ <https://gitlab.com/ralessi/icite/issues>
+
+This program is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
+Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <http://www.gnu.org/licenses/>.
+
+This release of icite consists of the following source files:
+
+- `icite.dtx`
+
+- `icite.ins`
+
+- `Makefile`
+
+License applicable to the documentation
+---------------------------------------
+
+Copyright ⓒ 2019 Robert Alessi
+
+The documentation file `icite.pdf` that is generated from the
+`icite.dtx` source file is licensed under the Creative Commons
+Attribution-ShareAlike 4.0 International License. To view a copy of this
+license, visit <http://creativecommons.org/licenses/by-sa/4.0/> or send
+a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+
+Installation
+============
+
+1. Run `'latex icite.ins'` to produce the `icite.sty`
+ file;
+
+2. To finish the installation you have to move the `icite.sty` file into
+ a directory where LaTeX can find them. See the FAQ on `texfaq.org`
+ at <https://texfaq.org/FAQ-inst-wlcf> for more on this.
+
+Development, Git Repository
+===========================
+
+Browse the code
+---------------
+
+You can browse icite repository on the web:
+<http://git.robertalessi.net/icite>
+
+From this page, you can download all the releases of `icite`. For
+instructions on how to install `icite`, please see above.
+
+Comments, Feature requests, Bug Reports
+---------------------------------------
+
+<https://gitlab.com/ralessi/icite/issues>
+
+Download the repository
+-----------------------
+
+`icite` development is facilitated by git, a distributed version
+control system. You will need to install git (most GNU/Linux
+distributions package it in their repositories).
+
+Use this command to download the repository
+
+ git clone http://git.robertalessi.net/icite
+
+A new directory named icite will have been created, containing
+`icite`.
+
+Git hosting
+-----------
+
+Make an account on <https://gitlab.com> and navigate (while logged in)
+to <https://gitlab.com/ralessi/icite>. Click *Fork* and you will
+have in your account your own repository of `icite` where you will
+be able to make whatever changes you like to.
+
diff --git a/Master/texmf-dist/doc/latex/icite/icite.pdf b/Master/texmf-dist/doc/latex/icite/icite.pdf
index 02d254f85fb..c492cb5e314 100644
--- a/Master/texmf-dist/doc/latex/icite/icite.pdf
+++ b/Master/texmf-dist/doc/latex/icite/icite.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/icite/samples/icite-biblatex.pdf b/Master/texmf-dist/doc/latex/icite/samples/icite-biblatex.pdf
index 3e6300f2959..f19d15473cf 100644
--- a/Master/texmf-dist/doc/latex/icite/samples/icite-biblatex.pdf
+++ b/Master/texmf-dist/doc/latex/icite/samples/icite-biblatex.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/icite/samples/icite-biblatex.tex b/Master/texmf-dist/doc/latex/icite/samples/icite-biblatex.tex
index e52cb8b9d6a..b49bc3491cb 100644
--- a/Master/texmf-dist/doc/latex/icite/samples/icite-biblatex.tex
+++ b/Master/texmf-dist/doc/latex/icite/samples/icite-biblatex.tex
@@ -1,3 +1,8 @@
+\RequirePackage{filecontents}
+\begin{filecontents*}{\jobname.xdy}
+(merge-rule "\*" "" :eregexp)
+(markup-locclass-list :open ": " :sep ", ")
+\end{filecontents*}
% Compile with --shell-escape
\documentclass{article}
\usepackage[english]{babel}
@@ -17,11 +22,15 @@
\setlist[enumerate,2]{label=\roman*.}
\usepackage[citecmd=autocite, defaultindex=none]{icite}
-\IndexSubtypeAs{ancient}{pr-sources}
+\IndexSubtypeAs{ancient}{\jobname-primary}
\bibinput{bibsample}
-\usepackage[xindy]{imakeidx}
-\makeindex[name=pr-sources, title={Index locorum citatorum}]
+\usepackage{classics}
+\newclassic{plat}{#1|#1|#1}
+\newclassic{arist}{#1|\textit{#1}|#1}
+
+\usepackage[xindy,nonewpage]{imakeidx}
+\makeindex[name=\jobname-primary, title={Index locorum citatorum}]
\usepackage[style=oxnotes]{biblatex}
\addbibresource{bibsample.bib}
@@ -40,11 +49,15 @@ index of passages cited in combination with Bib\LaTeX.
The relevant part of the preamble which is used here follows:
\begin{Verbatim}
\usepackage[citecmd=autocite, defaultindex=none]{icite}
-\IndexSubtypeAs{ancient}{pr-sources}
+\IndexSubtypeAs{ancient}{icite-biblatex-primary}
\bibinput{bibsample}
+\usepackage{classics}
+\newclassic{plat}{#1|#1|#1}
+\newclassic{arist}{#1|\textit{#1}|#1}
+
\usepackage[xindy]{imakeidx}
-\makeindex[name=pr-sources, title={Index locorum citatorum}]
+\makeindex[name=icite-biblatex-primary, title={Index locorum citatorum}]
\usepackage[style=oxnotes]{biblatex}
\addbibresource{bibsample.bib}
@@ -55,33 +68,34 @@ The relevant part of the preamble which is used here follows:
\item |citecmd=autocite| instructs \textsf{icite} to use the
|\autocite| command to insert the citations in the body text.
\item |defaultindex=none| disables indexing by default.
-\item |\IndexSubtypeAs{ancient}{pr-sources}| makes an exception for
- authors whose |entrysubtype| field matches the string |ancient| and
- instructs \textsf{icite} to have them indexed in an index named
- |pr-sources|.
-\item To actually produce the index, |\printindex[pr-sources]| is needed
- at the end of the document.
+\item |\IndexSubtypeAs{ancient}{icite-biblatex-primary}| makes an
+ exception for authors whose |entrysubtype| field matches the string
+ |ancient| and instructs \textsf{icite} to have them indexed in an
+ index named\\ |icite-biblatex-primary|.
+\item To actually produce the index,
+ |\printindex[icite-biblatex-primary]| is needed at the end of the
+ document.
\end{enumerate}
\section*{Body text}
Plato, \emph{Laches}: first
-citation\icite[179a1--4]{Plato:Laches}. And
-another\icite[179c5--180a1]{Plato:Laches}, and
-another\icite[181b5--181c3]{Plato:Laches}.
+citation\icite[\plat{179}[a][1--4]]{Plato:Laches}. And
+another\icite[\plat*{179}[c][5]{180}[a][1]]{Plato:Laches}, and
+another\icite[\plat*{181}[b][5]{181}[c][3]]{Plato:Laches}.
Plato, \emph{Theaetetus}: first
-citation\icite[142c2--142d3]{Plato:Theaetetus}. And
-another\icite[142d4--5]{Plato:Theaetetus}, and
-another\icite[143b5]{Plato:Theaetetus}.
+citation\icite[\plat*{142}[c][2]{142}[d][3]]{Plato:Theaetetus}. And
+another\icite[\plat{142}[d][4--5]]{Plato:Theaetetus}, and
+another\icite[\plat{143}[b][5]]{Plato:Theaetetus}.
Aristotle, \emph{Politica}: first
-citation\icite[1252a25--1252.b27]{Aristotle:Politica}. And
-another\icite[1253a5]{Aristotle:Politica}, and
-another\icite[1253a30--39]{Aristotle:Politica}.
+citation\icite[\arist*{1252}[a][25]{1252}[b][27]]{Aristotle:Politica}. And
+another\icite[\arist{1253}[a][5]]{Aristotle:Politica}, and
+another\icite[\arist{1253}[a][30--39]]{Aristotle:Politica}.
This passage should not be indexed\icite[44--78]{Reynolds.Wilson1994}.
-\printindex[pr-sources]
+\printindex[\jobname-primary]
\section*{Bibliographical database}
\VerbatimInput{bibsample.bib}
diff --git a/Master/texmf-dist/doc/latex/icite/samples/icite-minimal.pdf b/Master/texmf-dist/doc/latex/icite/samples/icite-minimal.pdf
new file mode 100644
index 00000000000..e010128479b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/icite/samples/icite-minimal.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/icite/samples/icite-minimal.tex b/Master/texmf-dist/doc/latex/icite/samples/icite-minimal.tex
new file mode 100644
index 00000000000..32bb4a29b97
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/icite/samples/icite-minimal.tex
@@ -0,0 +1,72 @@
+\documentclass{article}
+\usepackage[english]{babel}
+
+\usepackage[small]{titlesec}
+
+\usepackage{latexcolors}
+\usepackage[outputdir=TMP/]{minted}
+\setminted{bgcolor=lavendermist}
+
+\usepackage{ccicons}
+\usepackage{enumitem}
+\setlist{nosep}
+\setlist[itemize]{label=\textendash}
+\setlist[enumerate,1]{label=(\alph*)}
+\setlist[enumerate,2]{label=\roman*.}
+
+\usepackage{xurl}
+\usepackage[colorlinks]{hyperref}
+
+\begin{document}
+\vspace*{-.5in}
+\noindent
+\textbf{\textsf{icite sample file}} --- \cczero\ This
+file is public domain
+
+\section*{Instructions}
+\begin{enumerate}
+\item Start a new document, copy and paste the code that follows.
+\item The default citation command used by \textsf{icite} has been set
+ to \verb|autocite|. Adapt.
+\item The \textsf{biblatex} style file selected is
+ \verb|oxnotes|. Adapt.
+\item Insert the citations in the body text with
+ \mint{latex}|\icite[<pre>][<post>]{<key>}|
+\item Compile the document with \verb|--shell-escape|.\footnote{More
+ information on how to do this: \url{https://texfaq.org/FAQ-spawnprog}}
+\end{enumerate}
+
+\begin{minted}{latex}
+\RequirePackage{filecontents}
+\begin{filecontents*}{\jobname.xdy}
+(merge-rule "\*" "" :eregexp)
+\end{filecontents*}
+%
+\documentclass{article}
+\usepackage[english]{babel}
+
+% load icite
+\usepackage[citecmd=autocite, defaultindex=loccit]{icite}
+\bibinput{bibliography}
+
+% prepare the index
+\usepackage[xindy]{imakeidx}
+\makeindex[%
+ name=loccit,
+ title={Index locorum citatorum},
+ options=-M \jobname.xdy]
+
+% load biblatex
+\usepackage[style=oxnotes]{biblatex}
+\addbibresource{bibliography.bib}
+
+\begin{document}
+
+Your document goes here.
+
+\printindex[loccit]
+\printbibliography
+\end{document}
+\end{minted}
+
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/icite/samples/icite-nobiblatex.pdf b/Master/texmf-dist/doc/latex/icite/samples/icite-nobiblatex.pdf
index 8b0bdb72e5e..ae93aa9debb 100644
--- a/Master/texmf-dist/doc/latex/icite/samples/icite-nobiblatex.pdf
+++ b/Master/texmf-dist/doc/latex/icite/samples/icite-nobiblatex.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/icite/samples/icite-nobiblatex.tex b/Master/texmf-dist/doc/latex/icite/samples/icite-nobiblatex.tex
index 6893247f108..d6f824d020b 100644
--- a/Master/texmf-dist/doc/latex/icite/samples/icite-nobiblatex.tex
+++ b/Master/texmf-dist/doc/latex/icite/samples/icite-nobiblatex.tex
@@ -1,3 +1,8 @@
+\RequirePackage{filecontents}
+\begin{filecontents*}{\jobname.xdy}
+(merge-rule "\*" "" :eregexp)
+(markup-locclass-list :open ": " :sep ", ")
+\end{filecontents*}
% Compile with --shell-escape
\documentclass{article}
\usepackage[english]{babel}
@@ -18,11 +23,15 @@
\setlist[enumerate,2]{label=\roman*.}
\usepackage[defaultindex=none, nobibengine]{icite}
-\IndexSubtypeAs{ancient}{pr-sources}
+\IndexSubtypeAs{ancient}{\jobname-primary}
\bibinput{bibsample}
-\usepackage[xindy]{imakeidx}
-\makeindex[name=pr-sources, title={Index locorum citatorum}]
+\usepackage{classics}
+\newclassic{plat}{#1|#1|#1}
+\newclassic{arist}{#1|\textit{#1}|#1}
+
+\usepackage[xindy,nonewpage]{imakeidx}
+\makeindex[name=\jobname-primary, title={Index locorum citatorum}]
\begin{document}
\DefineShortVerb{\|}
@@ -39,11 +48,15 @@ Bib\LaTeX.
The relevant part of the preamble which is used here follows:
\begin{Verbatim}
\usepackage[defaultindex=none, nobibengine]{icite}
-\IndexSubtypeAs{ancient}{pr-sources}
+\IndexSubtypeAs{ancient}{icite-nobiblatex-primary}
\bibinput{bibsample}
+\usepackage{classics}
+\newclassic{plat}{#1|#1|#1}
+\newclassic{arist}{#1|\textit{#1}|#1}
+
\usepackage[xindy]{imakeidx}
-\makeindex[name=pr-sources, title={Index locorum citatorum}]
+\makeindex[name=icite-nobiblatex-primary, title={Index locorum citatorum}]
\end{Verbatim}
\paragraph{Remarks}
@@ -51,34 +64,36 @@ The relevant part of the preamble which is used here follows:
\item |defaultindex=none| disables indexing by default.
\item |nobibengine| instructs \textsf{icite} to insert the citations
in the body text without using either \hologo{BibTeX} or Bib\LaTeX.
-\item |\IndexSubtypeAs{ancient}{pr-sources}| makes an exception for
- authors whose |entrysubtype| field matches the string |ancient| and
- instructs \textsf{icite} to have them indexed in an index named
- |pr-sources|.
-\item To actually produce the index, |\printindex[pr-sources]| is
- needed at the end of the document.
+\item |\IndexSubtypeAs{ancient}{icite-nobiblatex-primary}| makes an
+ exception for authors whose |entrysubtype| field matches the string
+ |ancient| and instructs \textsf{icite} to have them indexed in an
+ index named\\ |icite-nobiblatex-primary|.
+\item To actually produce the index,
+ |\printindex[icite-nobiblatex-primary]| is needed at the end of the
+ document.
\end{enumerate}
\section*{Body text}
Plato, \emph{Laches}: first
-citation.\footnote{\icite[179a1--4]{Plato:Laches}.} And
-another,\footnote{\icite[179c5--180a1]{Plato:Laches}.}
-and another.\footnote{\icite[181b5--c3]{Plato:Laches}.}
+citation.\footnote{\icite[\plat{179}[a][1--4]]{Plato:Laches}.} And
+another,\footnote{\icite[\plat*{179}[c][5]{180}[a][1]]{Plato:Laches}.}
+and another.\footnote{\icite[\plat*{181}[b][5]{181}[c][3]]{Plato:Laches}.}
Plato, \emph{Theaetetus}: first
-citation.\footnote{\icite[142c2--d3]{Plato:Theaetetus}.}
-And another,\footnote{\icite[142d4--5]{Plato:Theaetetus}.}
-and another.\footnote{\icite[143b5]{Plato:Theaetetus}.}
+citation.\footnote{\icite[\plat*{142}[c][2]{142}[d][3]]{Plato:Theaetetus}.}
+And another,\footnote{\icite[\plat{142}[d][4--5]]{Plato:Theaetetus}.}
+and another.\footnote{\icite[\plat{143}[b][5]]{Plato:Theaetetus}.}
Aristotle, \emph{Politica}: first citation.\footnote{%
- \icite[1252a25--b27]{Aristotle:Politica}.} And
-another,\footnote{\icite[1253a5]{Aristotle:Politica}.} and
-another.\footnote{\icite[1253a30--39]{Aristotle:Politica}.}
+ \icite[\arist*{1252}[a][25]{1252}[b][27]]{Aristotle:Politica}.} And
+another,\footnote{\icite[\arist{1253}[a][5]]{Aristotle:Politica}.}
+and another.\footnote{%
+ \icite[\arist{1253}[a][30--39]]{Aristotle:Politica}.}
This passage should not be
indexed.\footnote{\icite[44--78]{Reynolds.Wilson1994}.}
-\printindex[pr-sources]
+\printindex[\jobname-primary]
\section*{Bibliographical database}
\VerbatimInput{bibsample.bib}