diff options
Diffstat (limited to 'about.html')
-rw-r--r-- | about.html | 253 |
1 files changed, 226 insertions, 27 deletions
@@ -6,58 +6,257 @@ | |||
6 | <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> | 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> |
7 | <meta name="author" content="Robert Alessi" /> | 7 | <meta name="author" content="Robert Alessi" /> |
8 | <title>The icite package – README file</title> | 8 | <title>The icite package – README file</title> |
9 | <style type="text/css"> | 9 | <style> |
10 | code{white-space: pre-wrap;} | 10 | html { |
11 | span.smallcaps{font-variant: small-caps;} | 11 | line-height: 1.5; |
12 | span.underline{text-decoration: underline;} | 12 | font-family: Georgia, serif; |
13 | div.column{display: inline-block; vertical-align: top; width: 50%;} | 13 | font-size: 20px; |
14 | color: #1a1a1a; | ||
15 | background-color: #fdfdfd; | ||
16 | } | ||
17 | body { | ||
18 | margin: 0 auto; | ||
19 | max-width: 36em; | ||
20 | padding-left: 50px; | ||
21 | padding-right: 50px; | ||
22 | padding-top: 50px; | ||
23 | padding-bottom: 50px; | ||
24 | hyphens: auto; | ||
25 | overflow-wrap: break-word; | ||
26 | text-rendering: optimizeLegibility; | ||
27 | font-kerning: normal; | ||
28 | } | ||
29 | @media (max-width: 600px) { | ||
30 | body { | ||
31 | font-size: 0.9em; | ||
32 | padding: 1em; | ||
33 | } | ||
34 | h1 { | ||
35 | font-size: 1.8em; | ||
36 | } | ||
37 | } | ||
38 | @media print { | ||
39 | body { | ||
40 | background-color: transparent; | ||
41 | color: black; | ||
42 | font-size: 12pt; | ||
43 | } | ||
44 | p, h2, h3 { | ||
45 | orphans: 3; | ||
46 | widows: 3; | ||
47 | } | ||
48 | h2, h3, h4 { | ||
49 | page-break-after: avoid; | ||
50 | } | ||
51 | } | ||
52 | p { | ||
53 | margin: 1em 0; | ||
54 | } | ||
55 | a { | ||
56 | color: #1a1a1a; | ||
57 | } | ||
58 | a:visited { | ||
59 | color: #1a1a1a; | ||
60 | } | ||
61 | img { | ||
62 | max-width: 100%; | ||
63 | } | ||
64 | h1, h2, h3, h4, h5, h6 { | ||
65 | margin-top: 1.4em; | ||
66 | } | ||
67 | h5, h6 { | ||
68 | font-size: 1em; | ||
69 | font-style: italic; | ||
70 | } | ||
71 | h6 { | ||
72 | font-weight: normal; | ||
73 | } | ||
74 | ol, ul { | ||
75 | padding-left: 1.7em; | ||
76 | margin-top: 1em; | ||
77 | } | ||
78 | li > ol, li > ul { | ||
79 | margin-top: 0; | ||
80 | } | ||
81 | blockquote { | ||
82 | margin: 1em 0 1em 1.7em; | ||
83 | padding-left: 1em; | ||
84 | border-left: 2px solid #e6e6e6; | ||
85 | color: #606060; | ||
86 | } | ||
87 | code { | ||
88 | font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace; | ||
89 | font-size: 85%; | ||
90 | margin: 0; | ||
91 | } | ||
92 | pre { | ||
93 | margin: 1em 0; | ||
94 | overflow: auto; | ||
95 | } | ||
96 | pre code { | ||
97 | padding: 0; | ||
98 | overflow: visible; | ||
99 | overflow-wrap: normal; | ||
100 | } | ||
101 | .sourceCode { | ||
102 | background-color: transparent; | ||
103 | overflow: visible; | ||
104 | } | ||
105 | hr { | ||
106 | background-color: #1a1a1a; | ||
107 | border: none; | ||
108 | height: 1px; | ||
109 | margin: 1em 0; | ||
110 | } | ||
111 | table { | ||
112 | margin: 1em 0; | ||
113 | border-collapse: collapse; | ||
114 | width: 100%; | ||
115 | overflow-x: auto; | ||
116 | display: block; | ||
117 | font-variant-numeric: lining-nums tabular-nums; | ||
118 | } | ||
119 | table caption { | ||
120 | margin-bottom: 0.75em; | ||
121 | } | ||
122 | tbody { | ||
123 | margin-top: 0.5em; | ||
124 | border-top: 1px solid #1a1a1a; | ||
125 | border-bottom: 1px solid #1a1a1a; | ||
126 | } | ||
127 | th { | ||
128 | border-top: 1px solid #1a1a1a; | ||
129 | padding: 0.25em 0.5em 0.25em 0.5em; | ||
130 | } | ||
131 | td { | ||
132 | padding: 0.125em 0.5em 0.25em 0.5em; | ||
133 | } | ||
134 | header { | ||
135 | margin-bottom: 4em; | ||
136 | text-align: center; | ||
137 | } | ||
138 | #TOC li { | ||
139 | list-style: none; | ||
140 | } | ||
141 | #TOC ul { | ||
142 | padding-left: 1.3em; | ||
143 | } | ||
144 | #TOC > ul { | ||
145 | padding-left: 0; | ||
146 | } | ||
147 | #TOC a:not(:hover) { | ||
148 | text-decoration: none; | ||
149 | } | ||
150 | code{white-space: pre-wrap;} | ||
151 | span.smallcaps{font-variant: small-caps;} | ||
152 | div.columns{display: flex; gap: min(4vw, 1.5em);} | ||
153 | div.column{flex: auto; overflow-x: auto;} | ||
154 | div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} | ||
155 | ul.task-list{list-style: none;} | ||
156 | ul.task-list li input[type="checkbox"] { | ||
157 | width: 0.8em; | ||
158 | margin: 0 0.8em 0.2em -1.6em; | ||
159 | vertical-align: middle; | ||
160 | } | ||
161 | .display.math{display: block; text-align: center; margin: 0.5rem auto;} | ||
14 | </style> | 162 | </style> |
163 | <!--[if lt IE 9]> | ||
164 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
165 | <![endif]--> | ||
15 | </head> | 166 | </head> |
16 | <body> | 167 | <body> |
17 | <header> | 168 | <header id="title-block-header"> |
18 | <h1 class="title">The icite package – README file</h1> | 169 | <h1 class="title">The icite package – README file</h1> |
19 | <p class="author">Robert Alessi</p> | 170 | <p class="author">Robert Alessi</p> |
20 | </header> | 171 | </header> |
21 | <h1 id="overview">Overview</h1> | 172 | <h1 id="overview">Overview</h1> |
22 | <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 <em>indices locorum citatorum</em>. It relies on a specific <code>\icite</code> command and can operate with either BibTeX or BibLaTeX.</p> | 173 | <p><code>icite</code> is designed to produce from BibTeX or BibLaTeX |
174 | bibliographical databases the different indices of authors and works | ||
175 | cited which are called <em>indices locorum citatorum</em>. It relies on | ||
176 | a specific <code>\icite</code> command and can operate with either | ||
177 | BibTeX or BibLaTeX.</p> | ||
23 | <h1 id="license-and-disclamer">License and disclamer</h1> | 178 | <h1 id="license-and-disclamer">License and disclamer</h1> |
24 | <p>icite – Indices locorum citatorum</p> | 179 | <p>icite – Indices locorum citatorum</p> |
25 | <p>Copyright ⓒ 2019–2020 Robert Alessi</p> | 180 | <p>Copyright ⓒ 2019–2021 Robert Alessi</p> |
26 | <p>Please send error reports and suggestions for improvements to Robert Alessi:</p> | 181 | <p>Please send error reports and suggestions for improvements to Robert |
182 | Alessi:</p> | ||
27 | <ul> | 183 | <ul> |
28 | <li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li> | 184 | <li><p>email: <a href="mailto:alessi@robertalessi.net" |
29 | <li><p>website: <a href="http://www.robertalessi.net/icite" class="uri">http://www.robertalessi.net/icite</a></p></li> | 185 | class="email">alessi@robertalessi.net</a></p></li> |
30 | <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> | 186 | <li><p>website: <a href="http://www.robertalessi.net/icite" |
187 | class="uri">http://www.robertalessi.net/icite</a></p></li> | ||
188 | <li><p>comments, feature requests, bug reports: <a | ||
189 | href="https://gitlab.com/ralessi/icite/issues" | ||
190 | class="uri">https://gitlab.com/ralessi/icite/issues</a></p></li> | ||
31 | </ul> | 191 | </ul> |
32 | <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> | 192 | <p>This program is free software: you can redistribute it and/or modify |
33 | <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> | 193 | it under the terms of the GNU General Public License as published by the |
34 | <p>You should have received a copy of the GNU General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses/" class="uri">http://www.gnu.org/licenses/</a>.</p> | 194 | Free Software Foundation, either version 3 of the License, or (at your |
195 | option) any later version.</p> | ||
196 | <p>This program is distributed in the hope that it will be useful, but | ||
197 | WITHOUT ANY WARRANTY; without even the implied warranty of | ||
198 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General | ||
199 | Public License for more details.</p> | ||
200 | <p>You should have received a copy of the GNU General Public License | ||
201 | along with this program. If not, see <a | ||
202 | href="http://www.gnu.org/licenses/" | ||
203 | class="uri">http://www.gnu.org/licenses/</a>.</p> | ||
35 | <p>This release of icite consists of the following source files:</p> | 204 | <p>This release of icite consists of the following source files:</p> |
36 | <ul> | 205 | <ul> |
37 | <li><p><code>icite.dtx</code></p></li> | 206 | <li><p><code>icite.dtx</code></p></li> |
38 | <li><p><code>icite.ins</code></p></li> | 207 | <li><p><code>icite.ins</code></p></li> |
39 | <li><p><code>Makefile</code></p></li> | 208 | <li><p><code>Makefile</code></p></li> |
40 | </ul> | 209 | </ul> |
41 | <h2 id="license-applicable-to-the-documentation">License applicable to the documentation</h2> | 210 | <h2 id="license-applicable-to-the-documentation">License Applicable to |
42 | <p>Copyright ⓒ 2019–2020 Robert Alessi</p> | 211 | the Documentation</h2> |
43 | <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> | 212 | <p>Copyright ⓒ 2020–2021 Robert Alessi</p> |
213 | <p>The documentation file <code>icite.pdf</code> that is generated from | ||
214 | the <code>icite.dtx</code> source file is licensed under the GNU Free | ||
215 | Documentation License, as follows:—</p> | ||
216 | <p>Permission is granted to copy, distribute and/or modify this document | ||
217 | under the terms of the GNU Free Documentation License, Version 1.3 or | ||
218 | any later version published by the Free Software Foundation; with no | ||
219 | Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | ||
220 | copy of the license is included in the section entitled “GNU Free | ||
221 | Documentation License”.</p> | ||
44 | <h1 id="installation">Installation</h1> | 222 | <h1 id="installation">Installation</h1> |
45 | <ol type="1"> | 223 | <ol type="1"> |
46 | <li><p>Run <code>'latex icite.ins'</code> to produce the <code>icite.sty</code> file.</p></li> | 224 | <li><p>Run <code>'latex icite.ins'</code> to produce the |
47 | <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> | 225 | <code>icite.sty</code> file.</p></li> |
226 | <li><p>To finish the installation you have to move the | ||
227 | <code>icite.sty</code> file into a directory where LaTeX can find it. | ||
228 | See the FAQ on <code>texfaq.org</code> at <a | ||
229 | href="https://texfaq.org/FAQ-inst-wlcf" | ||
230 | class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on | ||
231 | this.</p></li> | ||
48 | </ol> | 232 | </ol> |
49 | <h1 id="development-git-repository">Development, Git Repository</h1> | 233 | <h1 id="development-git-repository">Development, Git Repository</h1> |
50 | <h2 id="browse-the-code">Browse the code</h2> | 234 | <h2 id="browse-the-code">Browse the code</h2> |
51 | <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> | 235 | <p>You can browse icite repository on the web: <a |
52 | <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> | 236 | href="http://git.robertalessi.net/icite" |
53 | <h2 id="comments-feature-requests-bug-reports">Comments, Feature requests, Bug Reports</h2> | 237 | class="uri">http://git.robertalessi.net/icite</a></p> |
54 | <p><a href="https://gitlab.com/ralessi/icite/issues" class="uri">https://gitlab.com/ralessi/icite/issues</a></p> | 238 | <p>From this page, you can download all the releases of |
239 | <code>icite</code>. For instructions on how to install | ||
240 | <code>icite</code>, please see above.</p> | ||
241 | <h2 id="comments-feature-requests-bug-reports">Comments, Feature | ||
242 | requests, Bug Reports</h2> | ||
243 | <p><a href="https://gitlab.com/ralessi/icite/issues" | ||
244 | class="uri">https://gitlab.com/ralessi/icite/issues</a></p> | ||
55 | <h2 id="download-the-repository">Download the repository</h2> | 245 | <h2 id="download-the-repository">Download the repository</h2> |
56 | <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> | 246 | <p><code>icite</code> development is facilitated by git, a distributed |
247 | version control system. You will need to install git (most GNU/Linux | ||
248 | distributions package it in their repositories).</p> | ||
57 | <p>Use this command to download the repository</p> | 249 | <p>Use this command to download the repository</p> |
58 | <pre><code>git clone http://git.robertalessi.net/icite</code></pre> | 250 | <pre><code>git clone http://git.robertalessi.net/icite</code></pre> |
59 | <p>A new directory named icite will have been created, containing <code>icite</code>.</p> | 251 | <p>A new directory named icite will have been created, containing |
252 | <code>icite</code>.</p> | ||
60 | <h2 id="git-hosting">Git hosting</h2> | 253 | <h2 id="git-hosting">Git hosting</h2> |
61 | <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> | 254 | <p>Make an account on <a href="https://gitlab.com" |
255 | class="uri">https://gitlab.com</a> and navigate (while logged in) to <a | ||
256 | href="https://gitlab.com/ralessi/icite" | ||
257 | class="uri">https://gitlab.com/ralessi/icite</a>. Click <em>Fork</em> | ||
258 | and you will have in your account your own repository of | ||
259 | <code>icite</code> where you will be able to make whatever changes you | ||
260 | like to.</p> | ||
62 | </body> | 261 | </body> |
63 | </html> | 262 | </html> |