diff options
author | Robert Alessi <alessi@robertalessi.net> | 2020-03-05 18:51:57 +0100 |
---|---|---|
committer | Robert Alessi <alessi@robertalessi.net> | 2020-03-05 18:51:57 +0100 |
commit | 62c39d72e806a4a57861c25c2db459c2fbae8cd9 (patch) | |
tree | 5a76c2e381dcd788d6870fbebde85f261316c645 /icite.dtx | |
parent | 66da23898c3b4393e8c1fca9e4c288061f36c658 (diff) | |
download | icite-62c39d72e806a4a57861c25c2db459c2fbae8cd9.tar.gz |
removed icite.ins and README.md from icite.dtx
Diffstat (limited to 'icite.dtx')
-rw-r--r-- | icite.dtx | 204 |
1 files changed, 19 insertions, 185 deletions
@@ -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 | % |
8 | author: | 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 |
10 | title: '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 | % | |
13 | Overview | 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. |
17 | databases the different indices of authors and works cited which are | 17 | % |
18 | called _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/>. | |
21 | License and disclamer | ||
22 | ===================== | ||
23 | |||
24 | icite – Indices locorum citatorum | ||
25 | |||
26 | Copyright ⓒ 2019--2020 Robert Alessi | ||
27 | |||
28 | Please send error reports and suggestions for improvements to Robert | ||
29 | Alessi: | ||
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 | |||
38 | This program is free software: you can redistribute it and/or modify it | ||
39 | under the terms of the GNU General Public License as published by the | ||
40 | Free Software Foundation, either version 3 of the License, or (at your | ||
41 | option) any later version. | ||
42 | |||
43 | This program is distributed in the hope that it will be useful, but | ||
44 | WITHOUT ANY WARRANTY; without even the implied warranty of | ||
45 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General | ||
46 | Public License for more details. | ||
47 | |||
48 | You should have received a copy of the GNU General Public License along | ||
49 | with this program. If not, see <http://www.gnu.org/licenses/>. | ||
50 | |||
51 | This 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 | |||
61 | License applicable to the documentation | ||
62 | --------------------------------------- | ||
63 | |||
64 | Copyright ⓒ 2019--2020 Robert Alessi | ||
65 | |||
66 | The documentation file `icite.pdf` that is generated from the | ||
67 | `icite.dtx` source file is licensed under the Creative Commons | ||
68 | Attribution-ShareAlike 4.0 International License. To view a copy of this | ||
69 | license, visit <http://creativecommons.org/licenses/by-sa/4.0/> or send | ||
70 | a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. | ||
71 | |||
72 | Installation | ||
73 | ============ | ||
74 | |||
75 | 1. 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 | |||
81 | 2. 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 | |||
86 | Development, Git Repository | ||
87 | =========================== | ||
88 | |||
89 | Browse the code | ||
90 | --------------- | ||
91 | |||
92 | You can browse icite repository on the web: | ||
93 | <http://git.robertalessi.net/icite> | ||
94 | |||
95 | From this page, you can download all the releases of `icite`. For | ||
96 | instructions on how to install `icite`, please see above. | ||
97 | |||
98 | Comments, Feature requests, Bug Reports | ||
99 | --------------------------------------- | ||
100 | |||
101 | <https://gitlab.com/ralessi/icite/issues> | ||
102 | |||
103 | Download the repository | ||
104 | ----------------------- | ||
105 | |||
106 | `icite` development is facilitated by git, a distributed version | ||
107 | control system. You will need to install git (most GNU/Linux | ||
108 | distributions package it in their repositories). | ||
109 | |||
110 | Use this command to download the repository | ||
111 | |||
112 | git clone http://git.robertalessi.net/icite | ||
113 | |||
114 | A new directory named icite will have been created, containing | ||
115 | `icite`. | ||
116 | |||
117 | Git hosting | ||
118 | ----------- | ||
119 | |||
120 | Make an account on <https://gitlab.com> and navigate (while logged in) | ||
121 | to <https://gitlab.com/ralessi/icite>. Click *Fork* and you will | ||
122 | have in your account your own repository of `icite` where you will | ||
123 | be 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 | |||
139 | Copyright (C) 2019-2020 by Robert Alessi <alessi@robertalessi.net> | ||
140 | |||
141 | Please send error reports and suggestions for improvements to Robert | ||
142 | Alessi <alessi@robertalessi.net> | ||
143 | |||
144 | This program is free software: you can redistribute it and/or modify | ||
145 | it under the terms of the GNU General Public License as published by | ||
146 | the Free Software Foundation, either version 3 of the License, or | ||
147 | (at your option) any later version. | ||
148 | |||
149 | This program is distributed in the hope that it will be useful, but | ||
150 | WITHOUT ANY WARRANTY; without even the implied warranty of | ||
151 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
152 | General Public License for more details. | ||
153 | |||
154 | You should have received a copy of the GNU General Public License | ||
155 | along with this program. If not, see | ||
156 | <http://www.gnu.org/licenses/>. | ||
157 | |||
158 | This work consists of the file icite.dtx, icite.ins and a Makefile. | ||
159 | Running "make" generates the derived files README.md, icite.pdf and icite.sty. | ||
160 | Running "make inst" installs the files in the user's TeX tree. | ||
161 | Running "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 |