2019-03-05 21:16:48 +01:00
|
|
|
|
---
|
|
|
|
|
author:
|
|
|
|
|
- Robert Alessi
|
|
|
|
|
title: 'The icite package – README file'
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
Overview
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
`icite` is designed to produce from BibTeX or BibLaTeX bibliographical
|
|
|
|
|
databases the different indices of authors and works cited which are
|
2019-03-11 12:53:43 +01:00
|
|
|
|
called _indices locorum citatorum_. It relies on a specific
|
2019-03-05 21:16:48 +01:00
|
|
|
|
`\icite` command and can operate with either BibTeX or BibLaTeX.
|
|
|
|
|
|
|
|
|
|
License and disclamer
|
|
|
|
|
=====================
|
|
|
|
|
|
|
|
|
|
icite – Indices locorum citatorum
|
|
|
|
|
|
2023-01-24 19:35:19 +01:00
|
|
|
|
Copyright ⓒ 2019, 2020, 2021, 2023 Robert Alessi
|
2023-01-24 17:55:26 +01:00
|
|
|
|
|
|
|
|
|
Permission to use, copy, modify, and distribute this software for any
|
|
|
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
|
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
|
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
|
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
|
|
|
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
|
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
|
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
|
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
2019-03-05 21:16:48 +01:00
|
|
|
|
|
|
|
|
|
Please send error reports and suggestions for improvements to Robert
|
|
|
|
|
Alessi:
|
|
|
|
|
|
|
|
|
|
- email: <alessi@robertalessi.net>
|
|
|
|
|
|
2023-01-24 17:55:26 +01:00
|
|
|
|
- website: <https://sr.ht/~ralessi/icite>
|
2019-03-05 21:16:48 +01:00
|
|
|
|
|
|
|
|
|
- comments, feature requests, bug reports:
|
2023-01-24 17:55:26 +01:00
|
|
|
|
<https://todo.sr.ht/~ralessi/icite>
|
2019-03-05 21:16:48 +01:00
|
|
|
|
|
|
|
|
|
This release of icite consists of the following source files:
|
|
|
|
|
|
|
|
|
|
- `icite.dtx`
|
|
|
|
|
|
2020-03-05 18:51:57 +01:00
|
|
|
|
- `icite.ins`
|
2019-03-05 21:16:48 +01:00
|
|
|
|
|
|
|
|
|
- `Makefile`
|
|
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
============
|
|
|
|
|
|
2020-03-05 18:51:57 +01:00
|
|
|
|
1. Run `'latex icite.ins'` to produce the `icite.sty` file.
|
2019-03-05 21:16:48 +01:00
|
|
|
|
|
|
|
|
|
2. To finish the installation you have to move the `icite.sty` file into
|
2020-03-05 18:51:57 +01:00
|
|
|
|
a directory where LaTeX can find it. See the FAQ on `texfaq.org`
|
2019-03-05 21:16:48 +01:00
|
|
|
|
at <https://texfaq.org/FAQ-inst-wlcf> for more on this.
|
|
|
|
|
|
|
|
|
|
Development, Git Repository
|
|
|
|
|
===========================
|
|
|
|
|
|
|
|
|
|
Browse the code
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
You can browse icite repository on the web:
|
2023-01-24 17:55:26 +01:00
|
|
|
|
<https://git.sr.ht/~ralessi/icite>
|
2019-03-05 21:16:48 +01:00
|
|
|
|
|
|
|
|
|
From this page, you can download all the releases of `icite`. For
|
|
|
|
|
instructions on how to install `icite`, please see above.
|
|
|
|
|
|
|
|
|
|
Comments, Feature requests, Bug Reports
|
|
|
|
|
---------------------------------------
|
|
|
|
|
|
2023-01-24 17:55:26 +01:00
|
|
|
|
<https://todo.sr.ht/~ralessi/icite>
|
2019-03-05 21:16:48 +01:00
|
|
|
|
|
|
|
|
|
Download the repository
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
`icite` development is facilitated by git, a distributed version
|
2023-01-24 17:55:26 +01:00
|
|
|
|
control system. You will need to install git (most Unix/Linux
|
2019-03-05 21:16:48 +01:00
|
|
|
|
distributions package it in their repositories).
|
|
|
|
|
|
|
|
|
|
Use this command to download the repository
|
|
|
|
|
|
2023-01-24 17:55:26 +01:00
|
|
|
|
git clone https://git.sr.ht/~ralessi/icite
|
2019-03-05 21:16:48 +01:00
|
|
|
|
|
|
|
|
|
A new directory named icite will have been created, containing
|
|
|
|
|
`icite`.
|
|
|
|
|
|
|
|
|
|
Git hosting
|
|
|
|
|
-----------
|
|
|
|
|
|
2023-01-24 17:55:26 +01:00
|
|
|
|
Make an account on <https://sr.ht> and navigate (while logged in) to
|
|
|
|
|
<https://git.sr.ht/~ralessi/icite>. Click *Clone repo to your account*
|
|
|
|
|
and you will have in your account your own repository of `icite` where
|
|
|
|
|
you will be able to make whatever changes you like to.
|
2019-03-05 21:16:48 +01:00
|
|
|
|
|