Skip to content

Commit c345f87

Browse files
committed
Fixed the main README
Reverted to before the merge with DES
1 parent 5759b05 commit c345f87

File tree

1 file changed

+5
-16
lines changed

1 file changed

+5
-16
lines changed

README.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -88,23 +88,12 @@ To generate the `author.xml` for INSPIRE (<https://github.com/inspirehep/author.
8888
```shell
8989
mkauthlist -f --sort -j author.xml --orcid -pr https://arxiv.org/abs/YYMM.XXXXX example_alphabetical.csv example_alphabetical.xml
9090
```
91-
> mkauthlist --sort example_author_list.csv example_author_list.tex
92-
```
93-
Additionally, it is possible to alphabetically sort only the authors identified as "builders" (`JoinedAsBuilder == 'True'`) using the `-sb, --sort-builder` flag (for DES author lists this is usually already done in the generation of the CSV file).
94-
```
95-
> mkauthlist --sort-builder example_author_list.csv example_author_list.tex
96-
```
97-
It is often necessary to place a few key authors at the front of the author list. This can be done using an auxiliary author order file (i.e., `--aux order.csv`). Here, `order.csv` is a one-per-line list of author last names (and optionally, first names). Authors with names in `order.csv` will be moved to the front of the author list and placed in the order specified in `order.csv`.
98-
```
99-
> mkauthlist --aux order.csv example_author_list.csv example_author_list.tex
100-
```
101-
It is possible to combine options in order to place several authors first and order the rest of the list alphabetically
102-
103-
### Adding ORCID
91+
It is worth including the ORCID information by using the `--orcid` option.
92+
**NB**: Excluding the collaboration name will produce an invalid XML file.
10493

105-
If the input CSV file provides ORCIDs for authors, they can be added to the output latex formatted author list with the `--orcid` option:
106-
```
107-
> mkauthlist --orcid example_author_list.csv example_author_list.tex
94+
Another option is to use the `mkauthorxml.py` script to create the author.xml file that APS journals may request. Here is the syntax:
95+
```shell
96+
python mkauthorxml.py paper.tex -o paper.xml
10897
```
10998
Note there are also options for adding the collaboration name and an arxiv link. Use `-h` to get information about other command line parameters.
11099

0 commit comments

Comments
 (0)