diff options
Diffstat (limited to 'about.html')
-rw-r--r-- | about.html | 101 |
1 files changed, 57 insertions, 44 deletions
@@ -1,63 +1,76 @@ | |||
1 | <!DOCTYPE html> | ||
2 | <html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang=""> | ||
3 | <head> | ||
4 | <meta charset="utf-8" /> | ||
5 | <meta name="generator" content="pandoc" /> | ||
6 | <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> | ||
7 | <meta name="author" content="Robert Alessi" /> | ||
8 | <title>The icite package – README file</title> | ||
9 | <style type="text/css"> | ||
10 | code{white-space: pre-wrap;} | ||
11 | span.smallcaps{font-variant: small-caps;} | ||
12 | span.underline{text-decoration: underline;} | ||
13 | div.column{display: inline-block; vertical-align: top; width: 50%;} | ||
14 | </style> | ||
15 | </head> | ||
16 | <body> | ||
17 | <header> | ||
18 | <h1 class="title">The icite package – README file</h1> | ||
19 | <p class="author">Robert Alessi</p> | ||
20 | </header> | ||
21 | <h1 id="overview">Overview</h1> | 1 | <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> | 2 | <p><code>icite</code> is designed to produce from BibTeX or BibLaTeX |
3 | bibliographical databases the different indices of authors and works | ||
4 | cited which are called <em>indices locorum citatorum</em>. It relies on | ||
5 | a specific <code>\icite</code> command and can operate with either | ||
6 | BibTeX or BibLaTeX.</p> | ||
23 | <h1 id="license-and-disclamer">License and disclamer</h1> | 7 | <h1 id="license-and-disclamer">License and disclamer</h1> |
24 | <p>icite – Indices locorum citatorum</p> | 8 | <p>icite – Indices locorum citatorum</p> |
25 | <p>Copyright ⓒ 2019–2020 Robert Alessi</p> | 9 | <p>Copyright ⓒ 2019, 2020, 2021, 2023 Robert Alessi</p> |
26 | <p>Please send error reports and suggestions for improvements to Robert Alessi:</p> | 10 | <p>Permission to use, copy, modify, and distribute this software for any |
11 | purpose with or without fee is hereby granted, provided that the above | ||
12 | copyright notice and this permission notice appear in all copies.</p> | ||
13 | <p>THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL | ||
14 | WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES | ||
15 | OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE | ||
16 | FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY | ||
17 | DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER | ||
18 | IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING | ||
19 | OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS | ||
20 | SOFTWARE.</p> | ||
21 | <p>Please send error reports and suggestions for improvements to Robert | ||
22 | Alessi:</p> | ||
27 | <ul> | 23 | <ul> |
28 | <li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li> | 24 | <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> | 25 | 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> | 26 | <li><p>website: <a href="https://sr.ht/~ralessi/icite" |
27 | class="uri">https://sr.ht/~ralessi/icite</a></p></li> | ||
28 | <li><p>comments, feature requests, bug reports: <a | ||
29 | href="https://todo.sr.ht/~ralessi/icite" | ||
30 | class="uri">https://todo.sr.ht/~ralessi/icite</a></p></li> | ||
31 | </ul> | 31 | </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> | ||
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> | ||
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> | ||
35 | <p>This release of icite consists of the following source files:</p> | 32 | <p>This release of icite consists of the following source files:</p> |
36 | <ul> | 33 | <ul> |
37 | <li><p><code>icite.dtx</code></p></li> | 34 | <li><p><code>icite.dtx</code></p></li> |
38 | <li><p><code>icite.ins</code></p></li> | 35 | <li><p><code>icite.ins</code></p></li> |
39 | <li><p><code>Makefile</code></p></li> | 36 | <li><p><code>Makefile</code></p></li> |
40 | </ul> | 37 | </ul> |
41 | <h2 id="license-applicable-to-the-documentation">License applicable to the documentation</h2> | ||
42 | <p>Copyright ⓒ 2019–2020 Robert Alessi</p> | ||
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> | ||
44 | <h1 id="installation">Installation</h1> | 38 | <h1 id="installation">Installation</h1> |
45 | <ol type="1"> | 39 | <ol type="1"> |
46 | <li><p>Run <code>'latex icite.ins'</code> to produce the <code>icite.sty</code> file.</p></li> | 40 | <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> | 41 | <code>icite.sty</code> file.</p></li> |
42 | <li><p>To finish the installation you have to move the | ||
43 | <code>icite.sty</code> file into a directory where LaTeX can find it. | ||
44 | See the FAQ on <code>texfaq.org</code> at <a | ||
45 | href="https://texfaq.org/FAQ-inst-wlcf" | ||
46 | class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on | ||
47 | this.</p></li> | ||
48 | </ol> | 48 | </ol> |
49 | <h1 id="development-git-repository">Development, Git Repository</h1> | 49 | <h1 id="development-git-repository">Development, Git Repository</h1> |
50 | <h2 id="browse-the-code">Browse the code</h2> | 50 | <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> | 51 | <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> | 52 | href="https://git.sr.ht/~ralessi/icite" |
53 | <h2 id="comments-feature-requests-bug-reports">Comments, Feature requests, Bug Reports</h2> | 53 | class="uri">https://git.sr.ht/~ralessi/icite</a></p> |
54 | <p><a href="https://gitlab.com/ralessi/icite/issues" class="uri">https://gitlab.com/ralessi/icite/issues</a></p> | 54 | <p>From this page, you can download all the releases of |
55 | <code>icite</code>. For instructions on how to install | ||
56 | <code>icite</code>, please see above.</p> | ||
57 | <h2 id="comments-feature-requests-bug-reports">Comments, Feature | ||
58 | requests, Bug Reports</h2> | ||
59 | <p><a href="https://todo.sr.ht/~ralessi/icite" | ||
60 | class="uri">https://todo.sr.ht/~ralessi/icite</a></p> | ||
55 | <h2 id="download-the-repository">Download the repository</h2> | 61 | <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> | 62 | <p><code>icite</code> development is facilitated by git, a distributed |
63 | version control system. You will need to install git (most Unix/Linux | ||
64 | distributions package it in their repositories).</p> | ||
57 | <p>Use this command to download the repository</p> | 65 | <p>Use this command to download the repository</p> |
58 | <pre><code>git clone http://git.robertalessi.net/icite</code></pre> | 66 | <pre><code>git clone https://git.sr.ht/~ralessi/icite</code></pre> |
59 | <p>A new directory named icite will have been created, containing <code>icite</code>.</p> | 67 | <p>A new directory named icite will have been created, containing |
68 | <code>icite</code>.</p> | ||
60 | <h2 id="git-hosting">Git hosting</h2> | 69 | <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> | 70 | <p>Make an account on <a href="https://sr.ht" |
62 | </body> | 71 | class="uri">https://sr.ht</a> and navigate (while logged in) to <a |
63 | </html> | 72 | href="https://git.sr.ht/~ralessi/icite" |
73 | class="uri">https://git.sr.ht/~ralessi/icite</a>. Click <em>Clone repo | ||
74 | to your account</em> and you will have in your account your own | ||
75 | repository of <code>icite</code> where you will be able to make whatever | ||
76 | changes you like to.</p> | ||