2016-08-24 21:57:48 +00:00
# authorarchive
2018-02-18 16:49:36 +00:00
> A LaTeX style for producing author self-archiving copies of
> (academic) papers.
2018-01-28 19:31:57 +00:00
<!-- toc -->
2018-06-23 11:33:07 +00:00
- [authorarchive ](#authorarchive )
2018-08-10 06:46:21 +00:00
- [Installation ](#installation )
- [Usage ](#usage )
- [Boolean Switches ](#boolean-switches )
- [Key/Value Options ](#key-value-options )
- [Embedding Bibliography Entries ](#embedding-bibliography-entries )
- [Notes on Self-Archiving ](#notes-on-self-archiving )
- [LNCS ](#lncs )
2019-05-27 22:19:40 +00:00
- [Usage at arXiv.org ](#usage-at-arxivorg )
2018-08-10 06:46:21 +00:00
- [Other publishers ](#other-publishers )
- [Alternative Packages ](#alternative-packages )
- [Authors ](#authors )
- [Contributors ](#contributors )
- [License ](#license )
- [Master Repository ](#master-repository )
2018-01-28 19:31:57 +00:00
<!-- tocstop -->
2016-08-24 22:25:49 +00:00
2018-08-10 06:46:21 +00:00
## Installation
2018-04-09 02:59:08 +00:00
2018-04-25 08:57:54 +00:00
Copy `authorarchive.sty` and the directory `icons` in a directory that
2019-05-19 21:46:15 +00:00
is searched by LaTeX (e.g., either your `texmf` tree or the local
directory with your main LaTeX file).
2016-08-25 23:57:16 +00:00
## Usage
2018-04-09 02:59:08 +00:00
2016-10-17 21:22:33 +00:00
A simple use for LNCS-formatted papers is as follows:
2018-08-10 06:46:21 +00:00
2016-10-17 21:22:33 +00:00
```tex
\usepackage[LNCS,
key=brucker-authorarchive-2016,
year=2016,
2018-03-06 07:39:35 +00:00
publication={Anonymous et al.\ (eds). Proceedings of the International
2019-05-19 21:09:21 +00:00
Conference on LaTeX-Hacks, LNCS~42. Some Publisher}
2016-10-17 21:22:33 +00:00
startpage={42},
doi={00/00_00},
doiText={0/00\_00},
nocopyright
]{authorarchive}
```
2016-08-24 22:25:49 +00:00
2016-10-18 21:26:49 +00:00
The following layout-styles are pre-defined:
2018-08-10 06:46:21 +00:00
- `ACM` for the two-column layout used by many ACM conferences
- `ENTCS` for the Elsevier ENTCS layout
- `IEEE` for the two-column layout used by many IEEE conferences
- `LNCS` for the LNCS layout (as used by Springer)
- `LNI` for the Lecture Notes in Informatics, published by the GI
2016-10-18 21:26:49 +00:00
2016-10-19 19:26:02 +00:00
By re-defining the font command (`authorcrfont{}`) and the command that is
2018-08-10 06:46:21 +00:00
used for positioning the copyright text (`\authorat{}`), the package can
2016-10-19 19:26:02 +00:00
be adapted easily to other layouts. For example,
2018-08-10 06:46:21 +00:00
2016-10-19 19:26:02 +00:00
```tex
\renewcommand{\authorcrfont}{\scriptsize}
\renewcommand{\authorat}[1]{\put(25,56.5){#1}}
```
2018-08-10 06:46:21 +00:00
2018-01-28 17:11:54 +00:00
works nicely for Acta Informatica.
2018-01-28 19:31:57 +00:00
### Boolean Switches
2018-04-09 02:59:08 +00:00
2018-04-25 08:57:54 +00:00
| Switch | Meaning |
| -- | -- |
| `nocopyright` | If present, no publisher's copyright notice is printed. Usual case for LNCS. |
| `nourl` | If present, no link to the publication is inserted. |
| `nobib` | If present, no embedding of bibliographic entries is made. |
| `orcidicon` | For layouts displaying the author's ORCID identifiers as text, replace the ORCID identifier by the ORICD iD icon and a hyperlink (currently only supported for LNCS). |
2018-01-28 19:31:57 +00:00
### Key/Value Options
2018-04-09 02:59:08 +00:00
2018-01-28 19:31:57 +00:00
| Option | Default | Meaning |
| -- | -- | -- |
| `bibtexdir` | `.` | The directory where the bibliography entries are listed. |
2018-08-10 06:46:21 +00:00
| `baseurl` | < https: // git . logicalhacking . com / adbrucker / authorarchive / src / master > | The URL used as prefix for building the links. |
2018-01-28 19:31:57 +00:00
| `suffix` | `.pdf` | The suffix to use at links. |
| `publisher` | `UNKOWN PUBLISHER` | The name of the publisher. Default values are set by the series (`LNCS`, ...). |
| `year` | `UNKOWN YEAR` | The year of the publication. |
| `key` | empty | The basename of the filename. Used also to generate links. |
| `doi` | empty | The DOI of the publication. Used to generate the DOI link. |
| `doiText` | The value of `doi` | In case a DOI contains underscores, the displayed text differs from the DOI. |
| `publisherurl` | empty | In case no DOI is provided, one can provide a link to the publisher. |
| `startpage` | 1 | The pagenumber of the first page of the paper. |
| `publication` | `UNKNOWN PUBLICATION` | Information on the publication. |
2018-02-18 16:27:58 +00:00
The package also defines a command `\authorsetup{}` which allows to
define key value options dynamically. Moreover, if a file
`authorarchive.config` exists in the LaTeX search path, it will be
2018-02-18 16:49:36 +00:00
loaded automatically. This allows for configuring defaults (e.g., the
baseurl) easily.
2018-02-18 16:27:58 +00:00
2018-01-28 17:11:54 +00:00
## Embedding Bibliography Entries
2018-04-09 02:59:08 +00:00
2018-02-18 16:40:07 +00:00
Mostly, it is hard for scientists to find the correct bibtex entry for
a paper. One solution to this issue is to embed the respective `.bib`
(BibTeX, for LaTeX users), `.enw` (Endnote), `.ris` , or `.word.xml`
(Word 2007 or later) file in the PDF directly. In case any of these
file exist in `bibtexdir` , it gets embedded in the PDF.
You can use the
2018-02-26 14:15:11 +00:00
[bibutils ](https://sourceforge.net/p/bibutils/home/Bibutils/ ) for
2018-02-18 16:40:07 +00:00
converting between these different formats for bibliographic
2018-08-10 06:46:21 +00:00
references easily.
2018-01-28 17:11:54 +00:00
2018-02-25 20:32:48 +00:00
## Notes on Self-Archiving
2018-04-09 02:59:08 +00:00
2018-02-25 20:32:48 +00:00
Before using this package, please check with your signed copyright form,
2018-06-18 13:00:01 +00:00
which rights you have. Especially whether you may self-archive the preprint
2018-08-10 06:46:21 +00:00
or the postprint. For more information on that, read on at
2018-06-18 13:00:01 +00:00
< https: / / blogs . scientificamerican . com / information-culture / understanding-your-rights-pre-prints-post-prints-and-publisher-versions / > .
None of the authors might be hold liable for copyright
2018-02-25 20:32:48 +00:00
violations by using this package.
### LNCS
2018-04-09 02:59:08 +00:00
2018-02-25 20:32:48 +00:00
Sprinter states in his [Springer's Consent to Publish v3 ](http://resource-cms.springer.com/springer-cms/rest/v1/content/731196/data/v3 ):
2018-08-10 06:46:21 +00:00
> Author may only post his/her own version, provided acknowledgment is given
> to the original source of publication and a link is inserted to the published
2018-04-09 02:59:08 +00:00
> article on Springer’ s website.
2018-08-10 06:46:21 +00:00
> The link must be provided by inserting the DOI number of the article in the
2018-04-09 02:59:08 +00:00
> following sentence:
2018-08-10 06:46:21 +00:00
> "The final publication is available at Springer via
2018-04-09 02:59:08 +00:00
> `http://dx.doi.org/[insert DOI]`".
2019-05-27 22:19:40 +00:00
2018-04-09 02:59:08 +00:00
The DOI (Digital Object Identifier) can be found at the bottom of the first
2018-08-10 06:46:21 +00:00
page of the published paper.
2018-02-25 20:32:48 +00:00
2018-08-10 06:46:21 +00:00
This package uses `https://doi.org` as `http://dx.doi.org`
2018-04-09 02:59:08 +00:00
[is deprecated ](https://www.doi.org/factsheets/DOIIdentifierSpecs.html ).
2018-02-25 20:32:48 +00:00
Thus, the proposed configuration for Springer is as follows:
```latex
\usepackage[LNCS,
key=brucker-authorarchive-2016,
year=2016,
2018-04-03 05:26:34 +00:00
publication={Anonymous et al.\ (eds). Proceedings of the International
2018-02-25 20:32:48 +00:00
Conference on LaTeX-Hacks, LNCS~42. Springer, 2016.}
startpage={42},
doi={10.1038/authorarchive},
nocopyright
]{authorarchive}
```
2019-05-27 22:19:40 +00:00
## Usage at arXiv.org
arXiv.org deletes bib files when submitting a pre print. As workaround, this package
supports using the file suffix `.bibtex` . When no `.bib` is found, but a `.bibtex`
file, this file is used and embedded as `.bib` file into the PDF.
2018-02-25 22:00:47 +00:00
## Other publishers
2018-04-09 02:59:08 +00:00
2018-08-10 06:46:21 +00:00
In general, one does not need to specify a certain publisher (or LaTeX document class).
2018-04-09 03:07:36 +00:00
The default setting just prints the note centered at the bottom of the first page.
2018-02-25 22:00:47 +00:00
```latex
\usepackage[
key=brucker-authorarchive-2017,
year=2017,
2018-04-03 05:26:34 +00:00
publication={Anonymous et al.\ (eds). Proceedings of the International
2018-02-25 22:00:47 +00:00
Conference on LaTeX-Hacks, CEUR-WS Vol~42, 2017.}
startpage={42},
doi={10.1039/authorarchive},
nocopyright
]{authorarchive}
```
2018-04-09 03:07:36 +00:00
Still, for some used document classes (e.g., `acmart` ) there are specific
package options available hat produce an alternative layout.
2016-10-18 21:26:49 +00:00
2018-01-28 19:31:57 +00:00
## Alternative Packages
2018-04-09 02:59:08 +00:00
2018-02-18 16:49:36 +00:00
The package [coverpage ](https://ctan.org/pkg/coverpage ) prepends a
separate PDF page before the first page of the paper. That page
contains the bibliographic information as BibTeX entry. One is forced
to have a `.bib` file ready and multiple institutions are not well
supported. With `authorarchive` , the information is printed at the
bottom of the first page of the paper and required links to the
publisher are generated.
The package
2018-02-25 20:28:21 +00:00
[llncsconf ](https://ctan.org/pkg/llncsconf ) is a
2018-02-18 16:49:36 +00:00
light-weight alternative to this package. It supports
[LNCS ](http://www.springer.com/de/it-informatik/lncs ) only. In
comparison to `authorarchive` , it provides support for the additional
publication states "intended-to-submit" and "submitted", but no QR
code and links to the author's archive URL.
2018-01-28 19:31:57 +00:00
2018-02-18 16:46:29 +00:00
## Authors
2018-04-09 02:59:08 +00:00
2018-02-18 16:46:29 +00:00
Main author: [Achim D. Brucker ](http://www.brucker.ch/ )
### Contributors
2018-04-09 02:59:08 +00:00
2018-08-10 06:46:21 +00:00
- [Oliver Kopp ](https://github.com/koppor/ )
2018-02-18 16:46:29 +00:00
2016-08-24 22:25:49 +00:00
## License
2018-04-09 02:59:08 +00:00
2016-08-24 22:25:49 +00:00
If not otherwise stated, all sub-projects are dual-licensed under a
2018-08-10 06:46:21 +00:00
2-clause BSD-style license and/or the LPPL version 1.3c or (at your
2018-03-30 20:38:45 +00:00
opinion) any later version.
2018-04-03 05:26:34 +00:00
2020-09-02 00:27:33 +00:00
```yaml
2018-04-03 05:26:34 +00:00
SPDX-License-Identifier: LPPL-1.3c+ OR BSD-2-Clause
2020-09-02 00:27:33 +00:00
```
2018-06-23 11:33:07 +00:00
2022-03-13 18:32:19 +00:00
## Upstream Repository
2018-06-23 11:33:07 +00:00
2022-03-13 18:32:19 +00:00
The upstream git repository, i.e., the single source of truth, for this
project is hosted by the
[Software Assurance & Security Research Team ](https://logicalhacking.com ) at
2018-07-04 22:56:02 +00:00
< https: / / git . logicalhacking . com / adbrucker / authorarchive > .