aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2020-03-05 18:51:57 +0100
committerRobert Alessi <alessi@robertalessi.net>2020-03-05 18:51:57 +0100
commit62c39d72e806a4a57861c25c2db459c2fbae8cd9 (patch)
tree5a76c2e381dcd788d6870fbebde85f261316c645
parent66da23898c3b4393e8c1fca9e4c288061f36c658 (diff)
downloadicite-62c39d72e806a4a57861c25c2db459c2fbae8cd9.tar.gz
removed icite.ins and README.md from icite.dtx
-rw-r--r--Makefile15
-rw-r--r--README.md12
-rw-r--r--about.html7
-rw-r--r--icite.dtx204
-rw-r--r--icite.ins11
5 files changed, 40 insertions, 209 deletions
diff --git a/Makefile b/Makefile
index e06046e..63e0b26 100644
--- a/Makefile
+++ b/Makefile
@@ -4,6 +4,7 @@ PWD = $(shell pwd)
4VERS = $(shell ltxfileinfo -v $(NAME).dtx|sed -e 's/^v//') 4VERS = $(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)
7CMP = lualatex-dev
7 8
8exts := md bib ins dtx html 9exts := md bib ins dtx html
9texsamples := $(basename $(wildcard $(PWD)/samples/*.tex)) 10texsamples := $(basename $(wildcard $(PWD)/samples/*.tex))
@@ -23,9 +24,13 @@ define dosamples
23 lualatex --output-dir=$(PWD)/TMP --shell-escape $1 >/dev/null 24 lualatex --output-dir=$(PWD)/TMP --shell-escape $1 >/dev/null
24endef 25endef
25 26
26all: $(NAME).pdf 27sty: clean
28 $(CMP) $(NAME).ins
29
30all: clean sty $(NAME).pdf
27# test -e README.md || exit 0 31# test -e README.md || exit 0
28$(NAME).pdf: $(NAME).dtx 32
33$(NAME).pdf: clean sty $(NAME).dtx
29 @ echo "Make documentation..." 34 @ echo "Make documentation..."
30 lualatex --shell-escape --recorder --interaction=batchmode $(NAME).dtx >/dev/null 35 lualatex --shell-escape --recorder --interaction=batchmode $(NAME).dtx >/dev/null
31 biber $(NAME) >/dev/null 36 biber $(NAME) >/dev/null
@@ -42,7 +47,7 @@ $(NAME).pdf: $(NAME).dtx
42 $(foreach file,$(texsamples), $(call dosamples, $(file))) 47 $(foreach file,$(texsamples), $(call dosamples, $(file)))
43 mv TMP/*.pdf samples/ 48 mv TMP/*.pdf samples/
44 49
45samples: 50samples: clean sty
46 if [ ! -d $(PWD)/TMP ]; then mkdir $(PWD)/TMP; fi 51 if [ ! -d $(PWD)/TMP ]; then mkdir $(PWD)/TMP; fi
47 cp $(PWD)/samples/*.bib $(PWD)/TMP 52 cp $(PWD)/samples/*.bib $(PWD)/TMP
48 $(foreach file,$(texsamples), $(call dosamples, $(file))) 53 $(foreach file,$(texsamples), $(call dosamples, $(file)))
@@ -51,7 +56,7 @@ samples:
51lualatex: 56lualatex:
52 lualatex --shell-escape --recorder --interaction=batchmode $(NAME).dtx >/dev/null 57 lualatex --shell-escape --recorder --interaction=batchmode $(NAME).dtx >/dev/null
53 58
54clean: lualatex 59clean:
55 rm -f $(NAME).bib $(PWD)/TMP/*.bib 60 rm -f $(NAME).bib $(PWD)/TMP/*.bib
56 rm -rf .backup 61 rm -rf .backup
57 find -iname "*~" -or -iname "*.pdf" | xargs rm -rf 62 find -iname "*~" -or -iname "*.pdf" | xargs rm -rf
@@ -95,7 +100,7 @@ zip: all
95 100
96package: distclean all 101package: distclean all
97 mkdir $(NAME)/ 102 mkdir $(NAME)/
98 cp Makefile README.md $(NAME).{dtx,pdf} $(NAME)/ 103 cp Makefile README.md $(NAME).{ins,dtx,pdf} $(NAME)/
99 cp -r samples/ $(NAME)/ 104 cp -r samples/ $(NAME)/
100 mkdir -p tex/latex/$(NAME)/ 105 mkdir -p tex/latex/$(NAME)/
101 cp $(NAME).sty tex/latex/$(NAME)/ 106 cp $(NAME).sty tex/latex/$(NAME)/
diff --git a/README.md b/README.md
index a96df41..c70816e 100644
--- a/README.md
+++ b/README.md
@@ -46,9 +46,7 @@ This release of icite consists of the following source files:
46 46
47- `icite.dtx` 47- `icite.dtx`
48 48
49- `icite.ins` (As this file can be generated from `icite.dtx`, it is 49- `icite.ins`
50 not included in CTAN repository, but it is included in the git
51 repository mentioned below for easier installation.)
52 50
53- `Makefile` 51- `Makefile`
54 52
@@ -66,14 +64,10 @@ a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
66Installation 64Installation
67============ 65============
68 66
691. If `icite` was downloaded from CTAN, run `'lualatex --shell-escape 671. Run `'latex icite.ins'` to produce the `icite.sty` file.
70 icite.dtx'` to produce the `icite.sty` file.
71
72 If `icite` was downloaded from the git repository mentioned above,
73 Run `'latex icite.ins'` to produce the `icite.sty` file.
74 68
752. To finish the installation you have to move the `icite.sty` file into 692. To finish the installation you have to move the `icite.sty` file into
76 a directory where LaTeX can find them. See the FAQ on `texfaq.org` 70 a directory where LaTeX can find it. See the FAQ on `texfaq.org`
77 at <https://texfaq.org/FAQ-inst-wlcf> for more on this. 71 at <https://texfaq.org/FAQ-inst-wlcf> for more on this.
78 72
79Development, Git Repository 73Development, Git Repository
diff --git a/about.html b/about.html
index bcba576..508859e 100644
--- a/about.html
+++ b/about.html
@@ -30,7 +30,7 @@
30<p>This release of icite consists of the following source files:</p> 30<p>This release of icite consists of the following source files:</p>
31<ul> 31<ul>
32<li><p><code>icite.dtx</code></p></li> 32<li><p><code>icite.dtx</code></p></li>
33<li><p><code>icite.ins</code> (As this file can be generated from <code>icite.dtx</code>, it is not included in CTAN repository, but it is included in the git repository mentioned below for easier installation.)</p></li> 33<li><p><code>icite.ins</code></p></li>
34<li><p><code>Makefile</code></p></li> 34<li><p><code>Makefile</code></p></li>
35</ul> 35</ul>
36<h2 id="license-applicable-to-the-documentation">License applicable to the documentation</h2> 36<h2 id="license-applicable-to-the-documentation">License applicable to the documentation</h2>
@@ -38,9 +38,8 @@
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> 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> 39<h1 id="installation">Installation</h1>
40<ol style="list-style-type: decimal"> 40<ol style="list-style-type: decimal">
41<li><p>If <code>icite</code> was downloaded from CTAN, run <code>'lualatex --shell-escape icite.dtx'</code> to produce the <code>icite.sty</code> file.</p> 41<li><p>Run <code>'latex icite.ins'</code> to produce the <code>icite.sty</code> file.</p></li>
42<p>If <code>icite</code> was downloaded from the git repository mentioned above, 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 it. 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<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>
44</ol> 43</ol>
45<h1 id="development-git-repository">Development, Git Repository</h1> 44<h1 id="development-git-repository">Development, Git Repository</h1>
46<h2 id="browse-the-code">Browse the code</h2> 45<h2 id="browse-the-code">Browse the code</h2>
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
diff --git a/icite.ins b/icite.ins
index 9b4c415..b56c742 100644
--- a/icite.ins
+++ b/icite.ins
@@ -1,10 +1,6 @@
1%% 1%%
2%% This is file `icite.ins', 2%% icite -- Indices locorum citatorum
3%% generated with the docstrip utility. 3%% Copyright (C) 2016--2020 Robert Alesssi
4%%
5%% The original source files were:
6%%
7%% icite.dtx (with options: `install')
8%% 4%%
9%% Copyright (C) 2019-2020 by Robert Alessi <alessi@robertalessi.net> 5%% Copyright (C) 2019-2020 by Robert Alessi <alessi@robertalessi.net>
10%% 6%%
@@ -35,6 +31,9 @@
35\askforoverwritefalse 31\askforoverwritefalse
36\preamble 32\preamble
37 33
34icite -- Indices locorum citatorum
35Copyright (C) 2016--2020 Robert Alesssi
36
38Copyright (C) 2019-2020 by Robert Alessi <alessi@robertalessi.net> 37Copyright (C) 2019-2020 by Robert Alessi <alessi@robertalessi.net>
39 38
40Please send error reports and suggestions for improvements to Robert 39Please send error reports and suggestions for improvements to Robert