aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2019-03-05 21:16:48 +0100
committerRobert Alessi <alessi@robertalessi.net>2019-03-05 21:16:48 +0100
commitda60a4f5c772acb67e5ed681d2335651d1dbbcd6 (patch)
tree1eb89357441797d9f5cec51d41de396a1b9c1671
parent144c4c8662089094eac38d906f571e3f5aefbee6 (diff)
downloadicite-da60a4f5c772acb67e5ed681d2335651d1dbbcd6.tar.gz
done documenting icite
Diffstat
-rw-r--r--Makefile36
-rw-r--r--README.md112
-rw-r--r--about.html58
-rw-r--r--icite.dtx392
-rw-r--r--icite.ins8
5 files changed, 563 insertions, 43 deletions
diff --git a/Makefile b/Makefile
index 237b560..da0eb07 100644
--- a/Makefile
+++ b/Makefile
@@ -5,24 +5,28 @@ VERS = $(shell ltxfileinfo -v $(NAME).dtx|sed -e 's/^v//')
5LOCAL = $(shell kpsewhich --var-value TEXMFLOCAL) 5LOCAL = $(shell kpsewhich --var-value TEXMFLOCAL)
6UTREE = $(shell kpsewhich --var-value TEXMFHOME) 6UTREE = $(shell kpsewhich --var-value TEXMFHOME)
7all: $(NAME).pdf 7all: $(NAME).pdf
8 test -e README.txt && mv README.txt README || exit 0 8# test -e README.md || exit 0
9$(NAME).pdf: $(NAME).dtx 9$(NAME).pdf: $(NAME).dtx
10 lualatex --shell-escape --recorder --interaction=batchmode $(NAME).dtx >/dev/null 10 lualatex --shell-escape --recorder --interaction=batchmode $(NAME).dtx >/dev/null
11 biber $(NAME) >/dev/null 11 biber $(NAME) >/dev/null
12 if [ -f $(NAME).glo ]; then makeindex -q -s gglo.ist -o $(NAME).gls $(NAME).glo; fi 12 if [ -f $(NAME).glo ]; then makeindex -q -s gglo.ist -o $(NAME).gls $(NAME).glo; fi
13 if [ -f $(NAME).idx ]; then makeindex -q -s gind.ist -o $(NAME).ind $(NAME).idx; fi 13 if [ -f $(NAME).idx ]; then makeindex -q -s gind.ist -o $(NAME).ind $(NAME).idx; fi
14 texindy loccit.idx >/dev/null 14 if [ -f loccit.idx ]; then texindy -M icite.xdy loccit.idx >/dev/null; fi
15 if [ -f primary.idx ]; then texindy -M icite.xdy primary.idx >/dev/null; fi
15 lualatex --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null 16 lualatex --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
16 lualatex --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null 17 lualatex --shell-escape --recorder --interaction=nonstopmode $(NAME).dtx > /dev/null
17clean: 18lualatex:
18 rm -f $(NAME).{aux,fls,glo,gls,hd,idx,ilg,ind,log,out,toc,listing,bcf,bib,bbl,blg,run.xml} 19 lualatex --shell-escape --recorder --interaction=batchmode $(NAME).dtx >/dev/null
19 rm -f loccit.* 20clean: lualatex
21 rm -f $(NAME).{aux,fls,glo,gls,hd,idx,ilg,ind,log,out,toc,xdy,listing,bcf,bib,bbl,blg,run.xml}
22 rm -f loccit.* primary.*
20 rm -f *~ 23 rm -f *~
21 rm -rf auto/ 24 rm -rf auto/
22distclean: clean uninst 25distclean: clean uninst
23 rm -rf _minted-* 26 rm -rf _minted-*
24 rm -f $(NAME).{pdf,sty} README 27 rm -f $(NAME).{pdf,sty}
25 rm -f *.zip *.tar.gz 28 rm -f *.zip *.tar.gz
29 pandoc -s README.md -o about.html
26inst: uninst all 30inst: uninst all
27 mkdir -p $(UTREE)/{tex,source,doc}/latex/$(NAME) 31 mkdir -p $(UTREE)/{tex,source,doc}/latex/$(NAME)
28 cp $(NAME).dtx $(UTREE)/source/latex/$(NAME) 32 cp $(NAME).dtx $(UTREE)/source/latex/$(NAME)
@@ -34,25 +38,29 @@ local: uninst
34 cp $(NAME).sty $(UTREE)/tex/latex/$(NAME) 38 cp $(NAME).sty $(UTREE)/tex/latex/$(NAME)
35uninst: 39uninst:
36 rm -rf $(UTREE)/{tex,source,doc}/latex/$(NAME) 40 rm -rf $(UTREE)/{tex,source,doc}/latex/$(NAME)
37#install: all 41install: all
38# sudo mkdir -p $(LOCAL)/{tex,source,doc}/latex/$(NAME) 42 sudo mkdir -p $(LOCAL)/{tex,source,doc}/latex/$(NAME)
39# sudo cp $(NAME).dtx $(LOCAL)/source/latex/$(NAME) 43 sudo cp $(NAME).dtx $(LOCAL)/source/latex/$(NAME)
40# sudo cp $(NAME).sty $(LOCAL)/tex/latex/$(NAME) 44 sudo cp $(NAME).sty $(LOCAL)/tex/latex/$(NAME)
41# sudo cp $(NAME).pdf $(LOCAL)/doc/latex/$(NAME) 45 sudo cp $(NAME).pdf $(LOCAL)/doc/latex/$(NAME)
46uninstall:
47 rm -rf $(LOCAL)/{tex,source,doc}/latex/$(NAME)
42zip: all 48zip: all
43 ln -sf . $(NAME) 49 ln -sf . $(NAME)
44 zip -Drq $(PWD)/$(NAME)-$(VERS).zip $(NAME)/{README,$(NAME).{pdf,dtx}} 50 zip -Drq $(PWD)/$(NAME)-$(VERS).zip $(NAME)/{README.md,$(NAME).{pdf,dtx,ins}}
45 rm $(NAME) 51 rm $(NAME)
46package: distclean all 52package: distclean all
47 mkdir $(NAME)/ 53 mkdir $(NAME)/
48 cp README $(NAME).{dtx,ins,pdf} $(NAME)/ 54 cp Makefile README.md $(NAME).{dtx,ins,pdf} $(NAME)/
49 mkdir -p tex/latex/$(NAME)/ 55 mkdir -p tex/latex/$(NAME)/
50 cp $(NAME).sty tex/latex/$(NAME)/ 56 cp $(NAME).sty tex/latex/$(NAME)/
51 mkdir -p doc/latex/$(NAME)/ 57 mkdir -p doc/latex/$(NAME)/
52 cp $(NAME).pdf doc/latex/$(NAME)/ 58 cp $(NAME).pdf doc/latex/$(NAME)/
53 mkdir -p source/latex/$(NAME)/ 59 mkdir -p source/latex/$(NAME)/
54 cp Makefile README $(NAME).{dtx,ins} source/latex/$(NAME)/ 60 cp Makefile README.md $(NAME).{dtx,ins} source/latex/$(NAME)/
55 zip -r $(NAME).tds.zip tex doc source 61 zip -r $(NAME).tds.zip tex doc source
56 rm -rf tex/ source/ doc/ 62 rm -rf tex/ source/ doc/
57 tar czf $(NAME)-$(VERS).tar.gz $(NAME).tds.zip $(NAME)/ 63 tar czf $(NAME)-$(VERS).tar.gz $(NAME).tds.zip $(NAME)/
58 rm -rf $(NAME)/ 64 rm -rf $(NAME)/
65
66.PHONY: all clean lualatex distclean inst local uninst install uninstall zip package
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..667ebca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,112 @@
1---
2author:
3- Robert Alessi
4title: 'The icite package – README file'
5---
6
7Overview
8========
9
10`icite` is designed to produce from BibTeX or BibLaTeX bibliographical
11databases the different indices of authors and works cited which are
12called \emph{indices locorum citatorum}. It relies on a specific
13`\icite` command and can operate with either BibTeX or BibLaTeX.
14
15License and disclamer
16=====================
17
18icite – Indices locorum citatorum
19
20Copyright ⓒ 2019 Robert Alessi
21
22Please send error reports and suggestions for improvements to Robert
23Alessi:
24
25- email: <alessi@robertalessi.net>
26
27- website: <http://www.robertalessi.net/icite>
28
29- comments, feature requests, bug reports:
30 <https://gitlab.com/ralessi/icite/issues>
31
32This program is free software: you can redistribute it and/or modify it
33under the terms of the GNU General Public License as published by the
34Free Software Foundation, either version 3 of the License, or (at your
35option) any later version.
36
37This program is distributed in the hope that it will be useful, but
38WITHOUT ANY WARRANTY; without even the implied warranty of
39MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
40Public License for more details.
41
42You should have received a copy of the GNU General Public License along
43with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.
44
45This release of icite consists of the following source files:
46
47- `icite.dtx`
48
49- `icite.ins`
50
51- `Makefile`
52
53License applicable to the documentation
54---------------------------------------
55
56Copyright ⓒ 2019 Robert Alessi
57
58The documentation file `icite.pdf` that is generated from the
59`icite.dtx` source file is licensed under the Creative Commons
60Attribution-ShareAlike 4.0 International License. To view a copy of this
61license, visit <http://creativecommons.org/licenses/by-sa/4.0/> or send
62a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
63
64Installation
65============
66
671. Run `'latex icite.ins'` to produce the `icite.sty`
68 file;
69
702. To finish the installation you have to move the `icite.sty` file into
71 a directory where LaTeX can find them. See the FAQ on `texfaq.org`
72 at <https://texfaq.org/FAQ-inst-wlcf> for more on this.
73
74Development, Git Repository
75===========================
76
77Browse the code
78---------------
79
80You can browse icite repository on the web:
81<http://git.robertalessi.net/icite>
82
83From this page, you can download all the releases of `icite`. For
84instructions on how to install `icite`, please see above.
85
86Comments, Feature requests, Bug Reports
87---------------------------------------
88
89<https://gitlab.com/ralessi/icite/issues>
90
91Download the repository
92-----------------------
93
94`icite` development is facilitated by git, a distributed version
95control system. You will need to install git (most GNU/Linux
96distributions package it in their repositories).
97
98Use this command to download the repository
99
100 git clone http://git.robertalessi.net/icite
101
102A new directory named icite will have been created, containing
103`icite`.
104
105Git hosting
106-----------
107
108Make an account on <https://gitlab.com> and navigate (while logged in)
109to <https://gitlab.com/ralessi/icite>. Click *Fork* and you will
110have in your account your own repository of `icite` where you will
111be able to make whatever changes you like to.
112
diff --git a/about.html b/about.html
new file mode 100644
index 0000000..4c88021
--- /dev/null
+++ b/about.html
@@ -0,0 +1,58 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 <meta http-equiv="Content-Style-Type" content="text/css" />
6 <meta name="generator" content="pandoc" />
7 <meta name="author" content="Robert Alessi" />
8 <title>The icite package – README file</title>
9 <style type="text/css">code{white-space: pre;}</style>
10</head>
11<body>
12<div id="header">
13<h1 class="title">The icite package – README file</h1>
14<h2 class="author">Robert Alessi</h2>
15</div>
16<h1 id="overview">Overview</h1>
17<p><code>icite</code> is designed to produce from BibTeX or BibLaTeX bibliographical databases the different indices of authors and works cited which are called . It relies on a specific <code>\icite</code> command and can operate with either BibTeX or BibLaTeX.</p>
18<h1 id="license-and-disclamer">License and disclamer</h1>
19<p>icite – Indices locorum citatorum</p>
20<p>Copyright ⓒ 2019 Robert Alessi</p>
21<p>Please send error reports and suggestions for improvements to Robert Alessi:</p>
22<ul>
23<li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li>
24<li><p>website: <a href="http://www.robertalessi.net/icite" class="uri">http://www.robertalessi.net/icite</a></p></li>
25<li><p>comments, feature requests, bug reports: <a href="https://gitlab.com/ralessi/icite/issues" class="uri">https://gitlab.com/ralessi/icite/issues</a></p></li>
26</ul>
27<p>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.</p>
28<p>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.</p>
29<p>You should have received a copy of the GNU General Public License along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</p>
30<p>This release of icite consists of the following source files:</p>
31<ul>
32<li><p><code>icite.dtx</code></p></li>
33<li><p><code>icite.ins</code></p></li>
34<li><p><code>Makefile</code></p></li>
35</ul>
36<h2 id="license-applicable-to-the-documentation">License applicable to the documentation</h2>
37<p>Copyright ⓒ 2019 Robert Alessi</p>
38<p>The documentation file <code>icite.pdf</code> that is generated from the <code>icite.dtx</code> source file is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit <a href="http://creativecommons.org/licenses/by-sa/4.0/" class="uri">http://creativecommons.org/licenses/by-sa/4.0/</a> or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</p>
39<h1 id="installation">Installation</h1>
40<ol style="list-style-type: decimal">
41<li><p>Run <code>'latex icite.ins'</code> to produce the <code>icite.sty</code> file;</p></li>
42<li><p>To finish the installation you have to move the <code>icite.sty</code> file into a directory where LaTeX can find them. See the FAQ on <code>texfaq.org</code> at <a href="https://texfaq.org/FAQ-inst-wlcf" class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on this.</p></li>
43</ol>
44<h1 id="development-git-repository">Development, Git Repository</h1>
45<h2 id="browse-the-code">Browse the code</h2>
46<p>You can browse icite repository on the web: <a href="http://git.robertalessi.net/icite" class="uri">http://git.robertalessi.net/icite</a></p>
47<p>From this page, you can download all the releases of <code>icite</code>. For instructions on how to install <code>icite</code>, please see above.</p>
48<h2 id="comments-feature-requests-bug-reports">Comments, Feature requests, Bug Reports</h2>
49<p><a href="https://gitlab.com/ralessi/icite/issues" class="uri">https://gitlab.com/ralessi/icite/issues</a></p>
50<h2 id="download-the-repository">Download the repository</h2>
51<p><code>icite</code> 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).</p>
52<p>Use this command to download the repository</p>
53<pre><code>git clone http://git.robertalessi.net/icite</code></pre>
54<p>A new directory named icite will have been created, containing <code>icite</code>.</p>
55<h2 id="git-hosting">Git hosting</h2>
56<p>Make an account on <a href="https://gitlab.com" class="uri">https://gitlab.com</a> and navigate (while logged in) to <a href="https://gitlab.com/ralessi/icite" class="uri">https://gitlab.com/ralessi/icite</a>. Click <em>Fork</em> and you will have in your account your own repository of <code>icite</code> where you will be able to make whatever changes you like to.</p>
57</body>
58</html>
diff --git a/icite.dtx b/icite.dtx
index f977239..3772420 100644
--- a/icite.dtx
+++ b/icite.dtx
@@ -4,17 +4,119 @@
4\iffalse 4\iffalse
5%</internal> 5%</internal>
6%<*readme> 6%<*readme>
7| 7---
8-------:| ----------------------------------------------------------------- 8author:
9 icite:| Make Indices locorum citatorum 9- Robert Alessi
10 Author:| Robert Alessi 10title: 'The icite package – README file'
11 E-mail:| alessi@robertalessi.net 11---
12License:| Released under the GNU General Public License v3 or later
13 See:| http://www.gnu.org/licenses/
14 12
13Overview
14========
15
16`icite` is designed to produce from BibTeX or BibLaTeX bibliographical
17databases the different indices of authors and works cited which are
18called \emph{indices locorum citatorum}. It relies on a specific
19`\icite` command and can operate with either BibTeX or BibLaTeX.
20
21License and disclamer
22=====================
23
24icite – Indices locorum citatorum
25
26Copyright ⓒ 2019 Robert Alessi
27
28Please send error reports and suggestions for improvements to Robert
29Alessi:
30
31- email: <alessi@robertalessi.net>
32
33- website: <http://www.robertalessi.net/icite>
34
35- comments, feature requests, bug reports:
36 <https://gitlab.com/ralessi/icite/issues>
37
38This program is free software: you can redistribute it and/or modify it
39under the terms of the GNU General Public License as published by the
40Free Software Foundation, either version 3 of the License, or (at your
41option) any later version.
42
43This program is distributed in the hope that it will be useful, but
44WITHOUT ANY WARRANTY; without even the implied warranty of
45MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
46Public License for more details.
47
48You should have received a copy of the GNU General Public License along
49with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.
50
51This release of icite consists of the following source files:
52
53- `icite.dtx`
54
55- `icite.ins`
56
57- `Makefile`
58
59License applicable to the documentation
60---------------------------------------
61
62Copyright ⓒ 2019 Robert Alessi
63
64The documentation file `icite.pdf` that is generated from the
65`icite.dtx` source file is licensed under the Creative Commons
66Attribution-ShareAlike 4.0 International License. To view a copy of this
67license, visit <http://creativecommons.org/licenses/by-sa/4.0/> or send
68a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
69
70Installation
71============
72
731. Run `'latex icite.ins'` to produce the `icite.sty`
74 file;
75
762. To finish the installation you have to move the `icite.sty` file into
77 a directory where LaTeX can find them. See the FAQ on `texfaq.org`
78 at <https://texfaq.org/FAQ-inst-wlcf> for more on this.
79
80
81Development, Git Repository
82===========================
83
84Browse the code
85---------------
86
87You can browse icite repository on the web:
88<http://git.robertalessi.net/icite>
89
90From this page, you can download all the releases of `icite`. For
91instructions on how to install `icite`, please see above.
92
93Comments, Feature requests, Bug Reports
94---------------------------------------
95
96<https://gitlab.com/ralessi/icite/issues>
97
98Download the repository
99-----------------------
100
101`icite` development is facilitated by git, a distributed version
102control system. You will need to install git (most GNU/Linux
103distributions package it in their repositories).
104
105Use this command to download the repository
106
107 git clone http://git.robertalessi.net/icite
108
109A new directory named icite will have been created, containing
110`icite`.
111
112Git hosting
113-----------
114
115Make an account on <https://gitlab.com> and navigate (while logged in)
116to <https://gitlab.com/ralessi/icite>. Click *Fork* and you will
117have in your account your own repository of `icite` where you will
118be able to make whatever changes you like to.
15 119
16Short description:
17Some text about the package: probably the same as the abstract.
18%</readme> 120%</readme>
19%<*internal> 121%<*internal>
20\fi 122\fi
@@ -48,8 +150,8 @@ You should have received a copy of the GNU General Public License
48along with this program. If not, see 150along with this program. If not, see
49<http://www.gnu.org/licenses/>. 151<http://www.gnu.org/licenses/>.
50 152
51This work consists of the file icite.dtx and a Makefile. 153This work consists of the file icite.dtx, icite.ins and a Makefile.
52Running "make" generates the derived files README, icite.pdf and icite.sty. 154Running "make" generates the derived files README.md, icite.pdf and icite.sty.
53Running "make inst" installs the files in the user's TeX tree. 155Running "make inst" installs the files in the user's TeX tree.
54Running "make install" installs the files in the local TeX tree. 156Running "make install" installs the files in the local TeX tree.
55 157
@@ -69,7 +171,7 @@ Running "make install" installs the files in the local TeX tree.
69\nopreamble\nopostamble 171\nopreamble\nopostamble
70\usedir{doc/latex/icite} 172\usedir{doc/latex/icite}
71\generate{ 173\generate{
72 \file{README.txt}{\from{\jobname.dtx}{readme}} 174 \file{README.md}{\from{\jobname.dtx}{readme}}
73} 175}
74\ifx\fmtname\nameofplainTeX 176\ifx\fmtname\nameofplainTeX
75 \expandafter\endbatchfile 177 \expandafter\endbatchfile
@@ -91,6 +193,9 @@ Running "make install" installs the files in the local TeX tree.
91%<*driver> 193%<*driver>
92\documentclass{ltxdoc} 194\documentclass{ltxdoc}
93\usepackage{filecontents} 195\usepackage{filecontents}
196\begin{filecontents*}{\jobname.xdy}
197(markup-locclass-list :open "\tabto{3.5cm}" :sep ", ")
198\end{filecontents*}
94\begin{filecontents*}{\jobname.bib} 199\begin{filecontents*}{\jobname.bib}
95@Book{Bürgel2016, 200@Book{Bürgel2016,
96 shorttitle = {Ärztliches Leben\ldots}, 201 shorttitle = {Ärztliches Leben\ldots},
@@ -117,6 +222,61 @@ Running "make install" installs the files in the local TeX tree.
117 pages = {367--390} 222 pages = {367--390}
118} 223}
119 224
225@Book{IAUMuller,
226 sortname = {Ibn abi Usaybia},
227 editor = {Müller, August},
228 author = {\prname{ibn 'abI 'u.saybi`aT}},
229 shorteditor = {Müller},
230 date = {1882/1884},
231 title = {\arb[trans]{\uc{`u}yUn al-'anbA' fI .tabaqAt
232 al-'a.tibbA'}},
233 shorttitle = {\arb[trans]{\uc{`u}yUn al-'anbA'}},
234 shorthand = {\prname{ibn 'abI 'u.saybi`aT},
235 \arb[trans]{\uc{`u}yUn al-'anbA'}},
236 entrysubtype = {classical},
237 location = {Königsberg and Cairo},
238 volumes = 2
239}
240
241@MVBook{al-Nadim,
242 author = {\prname{ibn al-nadIm}},
243 title = {\arb[trans]{\uc{f}ihrist}},
244 sortname = {Nadim},
245 date = {1871/1872},
246 shorthand = {\arb[trans]{\uc{f}ihrist}},
247 editor = {Flügel, Gustav},
248 volumes = 2,
249 location = {Leipzig},
250 entrysubtype = {classical}
251}
252
253@Book{al-Qifti,
254 sortname = {Qifti},
255 entrysubtype = {classical},
256 shorthand = {\prname{al-qif.tiyy}, \arb[trans]{\uc{t}a'rI_h}},
257 location = {Leipzig},
258 editor = {Lippert, Julius},
259 date = 1903,
260 title = {\arb[trans]{\uc{t}a'rI_h al-.hukamA'}},
261 author = {\prname{ibn al-qif.tiyy}}
262}
263
264@Book{RaziShukuk,
265 author = {\prname{al-rAziyy}, \prname{mu.hammad
266 ibn zakariyyA'}},
267 title = {\arb[trans]{\uc{k}itAb al-^sukUk `al_A
268 \uc{^g}AlInUs}},
269 indextitle = {\arb[trans]{\uc{^s}ukUk}},
270 sortname = {Razi},
271 date = 1993,
272 shorthand = {\prname{al-rAziyy}, \arb[trans]{\uc{^s}ukUk}},
273 editor = {Mehdi Mohaghegh},
274 publisher = {International Institute of Islamic Thought and
275 Civilization},
276 location = {Tehran},
277 entrysubtype = {classical}
278}
279
120@Book{Ullmann1970, 280@Book{Ullmann1970,
121 location = {Leiden}, 281 location = {Leiden},
122 publisher = {Brill}, 282 publisher = {Brill},
@@ -138,7 +298,7 @@ Running "make install" installs the files in the local TeX tree.
138 pages = {3--152} 298 pages = {3--152}
139} 299}
140 300
141@software{usebib, 301@Software{usebib,
142 title = {The Usebib package}, 302 title = {The Usebib package},
143 subtitle = {A simple bibliography processor}, 303 subtitle = {A simple bibliography processor},
144 author = {Gregorio, Enrico}, 304 author = {Gregorio, Enrico},
@@ -177,12 +337,21 @@ Running "make install" installs the files in the local TeX tree.
177\CodelineIndex 337\CodelineIndex
178\usepackage[citecmd=autocite,defaultindex]{\jobname} 338\usepackage[citecmd=autocite,defaultindex]{\jobname}
179\usepackage{cleveref} 339\usepackage{cleveref}
340\IndexSubtypeAs{classical}{primary}
180\bibinput{icite} 341\bibinput{icite}
181\usepackage[nonewpage,xindy]{imakeidx} 342\usepackage[nonewpage,xindy]{imakeidx}
182\indexsetup{level=\section} 343\indexsetup{level=\subsubsection*}
183\makeindex[columns=3] 344\makeindex
184\makeindex[columns=3,name=loccit, title=Index of Passages Cited 345\makeindex[name=loccit, title=Index of Passages Cited (modern authors)]
185(modern authors)\label{ind:loccit}] 346\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}
351\usepackage{classics}
352\newclassic{iau}{\classicsRoman{#1}|, #1|.#1}
353\newclassic{razi}{#1|.#1}
354\newclassic{nadim}{\classicsRoman{#1}|.#1|, #1}
186\usepackage[scale=1.5]{ccicons} 355\usepackage[scale=1.5]{ccicons}
187\usepackage{dox} 356\usepackage{dox}
188\doxitem{Option}{option}{options} 357\doxitem{Option}{option}{options}
@@ -563,23 +732,24 @@ Running "make install" installs the files in the local TeX tree.
563 \section*{\cs{icite} in action} 732 \section*{\cs{icite} in action}
564 Let us start with four citations of the same reference, to make sure 733 Let us start with four citations of the same reference, to make sure
565 that they are all indexed and sorted properly: 734 that they are all indexed and sorted properly:
566 one\icite[123]{Ullmann1970}, two,\icite[231]{Ullmann1970} 735 one\icite[123]{Ullmann1970}, two\icite[231]{Ullmann1970},
567 three,\icite[81]{Ullmann1970} and four.\icite[18]{Ullmann1970} 736 three\icite[81]{Ullmann1970} and four\icite[18]{Ullmann1970}.
568 737
569 Let us continue with four other citations out of two other 738 Let us continue with four other citations out of two other
570 references: one,\icite[90]{Bürgel2016} two,\icite[370]{Dols1987} 739 references: one\icite[90]{Bürgel2016}, two\icite[370]{Dols1987},
571 three,\icite[205]{Bürgel2016} and four.\icite[380]{Dols1987} 740 three\icite[205]{Bürgel2016} and four\icite[380]{Dols1987}.
572 741
573 Finally, let us have \cs{icite} use \cs{textcite} to cite 742 Finally, let us have \cs{icite} use \cs{textcite} to cite
574 \icite[123]{Endress1992}[textcite], and again, this time in a 743 \icite[123]{Endress1992}[textcite], and again, this time in a
575 footnote.\icite[86]{Endress1992} 744 footnote\icite[86]{Endress1992}.
576\end{example} 745\end{example}
577% \iffalse 746% \iffalse
578%</example> 747%</example>
579% \fi 748% \fi
580% 749%
581% The resulting \emph{Index of passages cited} can be found below 750% All indices and the contents of the \hologo{BibTeX} file that has
582% (\vref{ind:loccit} \vpageref{ind:loccit}). As can be seen from the 751% been used can be found below in the appendix (\vref{ref:indices}
752% and \vref{ref:icite-bib} respectively). As can be seen from the
583% bibliography generated in the footnotes, \package{icite} prints as 753% bibliography generated in the footnotes, \package{icite} prints as
584% expected the abbridged forms of the titles when they are 754% expected the abbridged forms of the titles when they are
585% available. Furthermore, as a default citation command set in the 755% available. Furthermore, as a default citation command set in the
@@ -590,10 +760,182 @@ Running "make install" installs the files in the local TeX tree.
590% before 123. 760% before 123.
591% 761%
592% \section{Refined use} 762% \section{Refined use}
763% When references are made not only to modern authors but also to
764% authors and works from classical antiquity or from the Middle Ages,
765% it is commonly agreed that at least two separate indices of passages
766% cited should be made. Another option is not to index passages cited
767% from modern authors at all.
768%
769% \DescribeMacro{\IndexSubtypeAs} \package{icite} is able to
770% differentiate between sources by drawing from the bibliographical
771% database the exact string that may be found in the |entrysubtype|
772% entry field. To that end, the \cs{IndexSubtypeAs} command is
773% provided. It takes to madatory arguments, like so:--- %
774% \iffalse
775%<*example>
776% \fi
777\begin{code}
778 \IndexSubtypeAs{<subtype>}{<index_name>}
779\end{code}
780% \iffalse
781%</example>
782% \fi
783% Where |<subtype>| is any given string used to specify an
784% |entrysubtype| in the bibliographical database, and |<index_name>|
785% the name of the index which the authors matching that subtype must
786% go into. This command is to be found in the preamble only.
787%
788% Of course different subtypes can be associated with a single index
789% or with different indices. That said, one should keep in mind that
790% any entry the actual subtype of which is not associated with an
791% index is processed as if it had no subtype at all. Examples
792% follow:--- %
793% \iffalse
794%<*example>
795% \fi
796\begin{code}
797 % load icite, and have cited authors indexed in an index named
798 % 'secondary':
799 \usepackage[defaultindex=secondary]{icite}
800 % except for authors whose 'entrysubtype' field matches the string
801 % 'classical': have them indexed in an index named 'primary':
802 \IndexSubtypeAs{classical}{primary}
803 % authors whose 'entrysubtype' field matches the string 'medieval'
804 % should go into the same index:
805 \IndexSubtypeAs{medieval}{primary}
806\end{code}
807% \iffalse
808%</example>
809% \fi
810% Or:
811% \iffalse
812%<*example>
813% \fi
814\begin{code}
815 % load icite, but do not index passages cited with \icite:
816 \usepackage[defaultindex=none]{icite}
817 % except for authors whose 'entrysubtype' field matches the string
818 % 'classical': have them indexed in an index named 'primary':
819 \IndexSubtypeAs{classical}{primary}
820 % authors whose 'entrysubtype' field matches the string 'medieval'
821 % should go into the same index:
822 \IndexSubtypeAs{medieval}{primary}
823\end{code}
824% \iffalse
825%</example>
826% \fi
827%
828% \paragraph{Example} In the following example, modern authors, namely
829% those whose |entrysubtype| field does not match the string
830% |classical| should go into the default |loccit| index. As for those
831% whose |entrysubtype| matches |classical|, they should to into an
832% index named |primary|. Furthermore, the \package{classics} package
833% is used to format references in which a volume number is used. In
834% this way, \package{xindy} only has numbers to handle:--- %
835% \iffalse
836%<*example>
837% \fi
838\begin{code}
839 % preamble
840 \usepackage[style=oxnotes]{biblatex}
841 \addbibresource{bibliography.bib}
842
843 \usepackage[xindy]{imakeidx}
844 \makeindex[name=loccit, title=Index of passages cited (modern
845 authors)]
846 \makeindex[name=primary, title=\emph{Index locorum citatorum}]
847
848 \usepackage{classics}
849 \newclassic{iau}{\classicsRoman{#1}|, #1|.#1}
850 \newclassic{razi}{#1|.#1}
851 \newclassic{nadim}{\classicsRoman{#1}|.#1|, #1}
852
853 \usepackage[citecmd=autocite,defaultindex]{icite}
854 \IndexSubtypeAs{classical}{primary}
855\end{code}
856% \iffalse
857%</example>
858% \fi
859%
860% Then \cs{icite} can be used like so:--- %
861% \iffalse
862%<*example>
863% \fi
864\begin{example}
865 \section*{\cs{icite} in action}
866 Let us start with four citations of the same reference, to make sure
867 that they are all indexed and sorted properly:
868 one\icite[123]{Ullmann1970}, two\icite[231]{Ullmann1970},
869 three\icite[81]{Ullmann1970} and four\icite[18]{Ullmann1970}.
870
871 Let us continue with four other citations out of two other
872 references: one\icite[90]{Bürgel2016}, two\icite[370]{Dols1987},
873 three\icite[205]{Bürgel2016} and four\icite[380]{Dols1987}.
874
875 Before concluding, let us insert a few references to medieval Arabic
876 authors: one\icite[\iau{1}[81][32]]{IAUMuller},
877 two\icite[\razi{5}[7--10]]{RaziShukuk}, three\icite[133]{al-Qifti},
878 four\icite[\nadim{3}[7][286]]{al-Nadim},
879 five\icite[\iau{2}[214][20]]{IAUMuller},
880 six\icite[\razi{1}[6--20]]{RaziShukuk},
881 seven\icite[126.15--20]{al-Qifti} and
882 eight\icite[\nadim{3}[7][291]]{al-Nadim}.
883
884 Finally, let us have \cs{icite} use \cs{textcite} to cite
885 \icite[123]{Endress1992}[textcite], and again, this time in a
886 footnote\icite[86]{Endress1992}.
887\end{example}
888% \iffalse
889%</example>
890% \fi
593% 891%
892% 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
894% appendix (\vref{ref:indices} and \vref{ref:icite-bib}
895% respectively). As one can see, \prname{ibn al-nadIm}, \prname{ibn
896% al-qif.tiyy} and \prname{al-rAziyy} have been sorted under the
897% letters N, Q and R respectively and references to classical works
898% have been formatted properly.
899%
900% \section{Appendix}
901% Designing the layout of indices is out of the scope of this
902% documentation. For information, the \package{idxlayout} and
903% \package{tabto} packages have been used in the preamble like
904% so:--- %
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
919%<*example>
920% \fi
921\begin{tcblisting}{minted language=lisp, listing only, title=icite.xdy}
922(markup-locclass-list :open "\tabto{3.5cm}" :sep ", ")
923\end{tcblisting}
924% \iffalse
925%</example>
926% \fi
594% 927%
928% \subsection{Indices}
929% \label{ref:indices}
595% \printindex[loccit] 930% \printindex[loccit]
931% \printindex[primary]
596% 932%
933% \subsection{\texorpdfstring{\hologo{BibTeX}
934% file used in this document}{BibTeX file used in this document}}
935% \label{ref:icite-bib}
936% \tcbinputlisting{minted options={linenos}, minted language=bibtex,
937% listing file=icite.bib, listing only}
938%
597%\StopEventually{} 939%\StopEventually{}
598% 940%
599% \section{Implementation} 941% \section{Implementation}
@@ -651,7 +993,7 @@ Running "make install" installs the files in the local TeX tree.
651% \DescribeMacro{\IndexSubtypeAs} \cs{IndexSubtypeAs} takes two 993% \DescribeMacro{\IndexSubtypeAs} \cs{IndexSubtypeAs} takes two
652% mandatory arguments: 1. Any given keyword used to specify an 994% mandatory arguments: 1. Any given keyword used to specify an
653% \enquote*{entrysubtype} in the bibliographical database and 2. The 995% \enquote*{entrysubtype} in the bibliographical database and 2. The
654% index in which the authors matching that subtype must go. This 996% index which the authors matching that subtype must go into. This
655% command is to be found in the preamble only. 997% command is to be found in the preamble only.
656% \begin{macrocode} 998% \begin{macrocode}
657\NewDocumentCommand{\IndexSubtypeAs}{m m}{% 999\NewDocumentCommand{\IndexSubtypeAs}{m m}{%
diff --git a/icite.ins b/icite.ins
index 0654f14..176b1fd 100644
--- a/icite.ins
+++ b/icite.ins
@@ -25,8 +25,8 @@
25%% along with this program. If not, see 25%% along with this program. If not, see
26%% <http://www.gnu.org/licenses/>. 26%% <http://www.gnu.org/licenses/>.
27%% 27%%
28%% This work consists of the file icite.dtx and a Makefile. 28%% This work consists of the file icite.dtx, icite.ins and a Makefile.
29%% Running "make" generates the derived files README, icite.pdf and icite.sty. 29%% Running "make" generates the derived files README.md, icite.pdf and icite.sty.
30%% Running "make inst" installs the files in the user's TeX tree. 30%% Running "make inst" installs the files in the user's TeX tree.
31%% Running "make install" installs the files in the local TeX tree. 31%% Running "make install" installs the files in the local TeX tree.
32%% 32%%
@@ -54,8 +54,8 @@ You should have received a copy of the GNU General Public License
54along with this program. If not, see 54along with this program. If not, see
55<http://www.gnu.org/licenses/>. 55<http://www.gnu.org/licenses/>.
56 56
57This work consists of the file icite.dtx and a Makefile. 57This work consists of the file icite.dtx, icite.ins and a Makefile.
58Running "make" generates the derived files README, icite.pdf and icite.sty. 58Running "make" generates the derived files README.md, icite.pdf and icite.sty.
59Running "make inst" installs the files in the user's TeX tree. 59Running "make inst" installs the files in the user's TeX tree.
60Running "make install" installs the files in the local TeX tree. 60Running "make install" installs the files in the local TeX tree.
61 61
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-23 09:37:47 +0000