aboutsummaryrefslogtreecommitdiff
path: root/icite.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'icite.dtx')
-rw-r--r--icite.dtx204
1 files changed, 19 insertions, 185 deletions
diff --git a/icite.dtx b/icite.dtx
index d89d012..6bd98e8 100644
--- a/icite.dtx
+++ b/icite.dtx
@@ -1,189 +1,23 @@
1% \iffalse meta-comment 1% \iffalse meta-comment
2% vim: textwidth=75 2% icite -- Indices locorum citatorum
3%<*internal> 3% Copyright (C) 2016--2020 Robert Alesssi
4\iffalse 4%
5%</internal> 5% Please send error reports and suggestions for improvements to Robert
6%<*readme> 6% Alessi <alessi@robertalessi.net>
7--- 7%
8author: 8% This program is free software: you can redistribute it and/or modify
9- Robert Alessi 9% it under the terms of the GNU General Public License as published by
10title: 'The icite package – README file' 10% the Free Software Foundation, either version 3 of the License, or
11--- 11% (at your option) any later version.
12 12%
13Overview 13% This program is distributed in the hope that it will be useful, but
14======== 14% WITHOUT ANY WARRANTY; without even the implied warranty of
15 15% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16`icite` is designed to produce from BibTeX or BibLaTeX bibliographical 16% General Public License for more details.
17databases the different indices of authors and works cited which are 17%
18called _indices locorum citatorum_. It relies on a specific 18% You should have received a copy of the GNU General Public License
19`\icite` command and can operate with either BibTeX or BibLaTeX. 19% along with this program. If not, see
20 20% <http://www.gnu.org/licenses/>.
21License and disclamer
22=====================
23
24icite – Indices locorum citatorum
25
26Copyright ⓒ 2019--2020 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 <http://www.gnu.org/licenses/>.
50
51This release of icite consists of the following source files:
52
53- `icite.dtx`
54
55- `icite.ins` (As this file can be generated from `icite.dtx`, it is
56 not included in CTAN repository, but it is included in the git
57 repository mentioned below for easier installation.)
58
59- `Makefile`
60
61License applicable to the documentation
62---------------------------------------
63
64Copyright ⓒ 2019--2020 Robert Alessi
65
66The documentation file `icite.pdf` that is generated from the
67`icite.dtx` source file is licensed under the Creative Commons
68Attribution-ShareAlike 4.0 International License. To view a copy of this
69license, visit <http://creativecommons.org/licenses/by-sa/4.0/> or send
70a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
71
72Installation
73============
74
751. If `icite` was downloaded from CTAN, run `'lualatex --shell-escape
76 icite.dtx'` to produce the `icite.sty` file.
77
78 If `icite` was downloaded from the git repository mentioned above,
79 Run `'latex icite.ins'` to produce the `icite.sty` file.
80
812. To finish the installation you have to move the `icite.sty` file into
82 a directory where LaTeX can find them. See the FAQ on `texfaq.org`
83 at <https://texfaq.org/FAQ-inst-wlcf> for more on this.
84
85
86Development, Git Repository
87===========================
88
89Browse the code
90---------------
91
92You can browse icite repository on the web:
93<http://git.robertalessi.net/icite>
94
95From this page, you can download all the releases of `icite`. For
96instructions on how to install `icite`, please see above.
97
98Comments, Feature requests, Bug Reports
99---------------------------------------
100
101<https://gitlab.com/ralessi/icite/issues>
102
103Download the repository
104-----------------------
105
106`icite` development is facilitated by git, a distributed version
107control system. You will need to install git (most GNU/Linux
108distributions package it in their repositories).
109
110Use this command to download the repository
111
112 git clone http://git.robertalessi.net/icite
113
114A new directory named icite will have been created, containing
115`icite`.
116
117Git hosting
118-----------
119
120Make an account on <https://gitlab.com> and navigate (while logged in)
121to <https://gitlab.com/ralessi/icite>. Click *Fork* and you will
122have in your account your own repository of `icite` where you will
123be able to make whatever changes you like to.
124
125%</readme>
126%<*internal>
127\fi
128\def\nameofplainTeX{plain}
129\ifx\fmtname\nameofplainTeX\else
130 \expandafter\begingroup
131\fi
132%</internal>
133%<*install>
134\input docstrip.tex
135\keepsilent
136\askforoverwritefalse
137\preamble
138
139Copyright (C) 2019-2020 by Robert Alessi <alessi@robertalessi.net>
140
141Please send error reports and suggestions for improvements to Robert
142Alessi <alessi@robertalessi.net>
143
144This program is free software: you can redistribute it and/or modify
145it under the terms of the GNU General Public License as published by
146the Free Software Foundation, either version 3 of the License, or
147(at your option) any later version.
148
149This program is distributed in the hope that it will be useful, but
150WITHOUT ANY WARRANTY; without even the implied warranty of
151MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
152General Public License for more details.
153
154You should have received a copy of the GNU General Public License
155along with this program. If not, see
156<http://www.gnu.org/licenses/>.
157
158This work consists of the file icite.dtx, icite.ins and a Makefile.
159Running "make" generates the derived files README.md, icite.pdf and icite.sty.
160Running "make inst" installs the files in the user's TeX tree.
161Running "make install" installs the files in the local TeX tree.
162
163\endpreamble
164
165\usedir{tex/latex/icite}
166\generate{
167 \file{\jobname.sty}{\from{\jobname.dtx}{package}}
168}
169%</install>
170%<install>\endbatchfile
171%<*internal>
172\usedir{source/latex/icite}
173\generate{
174 \file{\jobname.ins}{\from{\jobname.dtx}{install}}
175}
176\nopreamble\nopostamble
177\usedir{doc/latex/icite}
178\generate{
179 \file{README.md}{\from{\jobname.dtx}{readme}}
180}
181\ifx\fmtname\nameofplainTeX
182 \expandafter\endbatchfile
183\else
184 \expandafter\endgroup
185\fi
186%</internal>
187% \fi 21% \fi
188% 22%
189% \iffalse 23% \iffalse
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-26 16:56:09 +0000