Skip to content
Snippets Groups Projects
Commit 513615b7 authored by Marvin Ewald's avatar Marvin Ewald
Browse files

Improve readme

parent 63af1b87
No related branches found
No related tags found
No related merge requests found
# Papers and .bib Files
## Files Missing
- ITC27 2015 (never got any)
- ITC20 2007 (marked as no rights)
......@@ -13,32 +14,37 @@
**NOTE:** install dependencies using `pip install -r requirements.txt`.
Adds keywords and URL attributs to bibtex files.<br/>
Adds keywords and URL attributs to bibtex files and creates a new file `<filename>_bibsonomy.bib` in the same directory.<br/>
See `bibtex.py --help` for more info.
Creates a new file `<filename>_bibsonomy.bib` in the same directory.
**Important Notes**
* Must be run from `itc-publications-public` repo directory.
* Make sure to set the correct keyword separator if the original file already has keywords.
* Make sure to set the correct keyword separator on the bibsonomy upload page.
* If exceptions occur, make sure the original bib file is UTF-8 encoded and has
## Important Notes
- `bibtex.py` must be run from `itc-publications-public` repo root directory.
- Make sure to set the correct keyword separator if the original file already has keywords.
- Make sure to set the correct keyword separator on the bibsonomy upload page.
- If exceptions occur, make sure the original bib file is UTF-8 encoded and has
no errors.
* The PDF file search order is:
1. Existing URL entry
2. Existing URL entry but in the corresponding itc directory
3. `<Bib ID>.pdf` in ITC directory
- The PDF file search order is:
1. Existing URL entry
2. Existing URL entry but in the corresponding itc directory
3. `<Bib ID>.pdf` in ITC directory
**Example usage:**
## Example usage
```sh
# Make sure to read the important notes above!
# Run from repo root!
$ ls
itc01 itc06 itc07 itc08 itc09 itc10 itc11 itc12 itc13 itc14 itc15 itc16
itc17 itc19 itc20 itc21 itc22 itc23 itc24 itc25 itc26 itc27 itc28 itc29
itc30 itc31 README.txt
# Creates itc31/itc31_bibsonomy.bib
# Make sure the correct tag separator is set using `-s` flag!
# Create itc31/itc31_bibsonomy.bib
$ ./bibtex.py itc31 itc31/itc31.bib
# Create itc32/itc32_bibsonomy.bib
$ ./bibtex.py -s "," itc32 itc32/itc32.bib
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment