Skip to content

Commit

Permalink
Fix linting issues
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor committed Aug 28, 2020
1 parent 4455fe8 commit 10e0feb
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 10 deletions.
20 changes: 12 additions & 8 deletions CONTRIBUTING.md
Expand Up @@ -9,34 +9,38 @@ In any case, you need a [GitHub account](https://github.com/login).
If you don't feel comfortable to touch the lists and create a pull request, [open an issue](https://github.com/JabRef/abbrv.jabref.org/issues) listing the errors and proposed changes or missing entries.

With a little extra effort you can directly edit one of the journal abbreviation files and create a pull request:
1. Go to https://github.com/JabRef/abbrv.jabref.org/tree/master/journals and select the correct file that is most appropriate to your subject area. If none of the files fits your subject, edit `journal_abbreviations_general.csv`.

1. Go to <https://github.com/JabRef/abbrv.jabref.org/tree/master/journals> and select the correct file that is most appropriate to your subject area. If none of the files fits your subject, edit `journal_abbreviations_general.csv`.
2. Use the *pencil icon* to start editing the file.
3. Make your corrections. If you add a journal, keep in mind that the list is ordered alphabetically. Make sure to adhere to the [format described below](#format-of-the-file).
4. When done editing, fill out the commit description at the bottom and click *Commit changes*.
5. Create a pull request for your changes.
6. You should now find it in the list of [pull requests](https://github.com/JabRef/abbrv.jabref.org/pulls).

***Note:** For use in JabRef, the topical lists are merged alphabetically with preference given to the last occurence of duplicate journal titles. The general list currently overrides all other lists. Also, an abbreviation might be present in several lists. If you are submitting a correction, check if it exists in several lists due to overlapping subjects or in the general list and make sure all occurences are corrected.*
**Note:** For use in JabRef, the topical lists are merged alphabetically with preference given to the last occurence of duplicate journal titles. The general list currently overrides all other lists. Also, an abbreviation might be present in several lists. If you are submitting a correction, check if it exists in several lists due to overlapping subjects or in the general list and make sure all occurences are corrected.*

## Adding a journal list

1. Get a [GitHub account/sign in](https://github.com/login).
2. Add the file to https://github.com/JabRef/abbrv.jabref.org/tree/master/journals (make sure to use the `.csv` format [described below](#format-of-the-file); for importing TXT data files, you should use [this script](../convert_txt2csv.py) before).
3. Add the file to https://github.com/JabRef/abbrv.jabref.org/blob/master/journals/README.md (sorted in alphabetically).
2. Add the file to <https://github.com/JabRef/abbrv.jabref.org/tree/master/journals> (make sure to use the `.csv` format [described below](#format-of-the-file); for importing TXT data files, you should use [this script](../convert_txt2csv.py) before).
3. Add the file to <https://github.com/JabRef/abbrv.jabref.org/blob/master/journals/README.md> (sorted in alphabetically).
4. Create a pull request on this repository.


## Format of the file

Since October 2019, the data files are in CSV format (using semicolons as separators):

<full name>;<abbreviation>[;<shortest unique abbreviation>[;<frequency>]]
```csv
<full name>;<abbreviation>[;<shortest unique abbreviation>[;<frequency>]]
```

The abbreviation should follow the ISO4 standard, see <https://marcinwrochna.github.io/abbrevIso/> for details on the abbreviation rules and a search form for title word abbreviations.
The abbreviation should follow the ISO4 standard, see <https://marcinwrochna.github.io/abbrevIso/> for details on the abbreviation rules and a search form for title word abbreviations.
The last two fields are optional, and you can safely omit them.
JabRef supports the third field, which contains the "shortest unique abbreviation".
The last field is not currently used; its intention is to give publication frequency (e.g., `M` for monthly).

For instance:

Accounts of Chemical Research;Acc. Chem. Res.;ACHRE4;M
```csv
Accounts of Chemical Research;Acc. Chem. Res.;ACHRE4;M
```
9 changes: 7 additions & 2 deletions README.md
Expand Up @@ -7,7 +7,9 @@ Currently, a number of [journal lists](journals/) are offered.

Since October 2019, the data files are in CSV format (using semicolons as separators):

<full name>;<abbreviation>[;<shortest unique abbreviation>[;<frequency>]]
```csv
<full name>;<abbreviation>[;<shortest unique abbreviation>[;<frequency>]]
```

The abbreviation should follow the ISO4 standard, see <https://marcinwrochna.github.io/abbrevIso/> for details on the abbreviation rules and a search form for title word abbreviations.
The last two fields are optional, and you can safely omit them.
Expand All @@ -16,7 +18,9 @@ The last field is not currently used; its intention is to give publication frequ

For instance:

Accounts of Chemical Research;Acc. Chem. Res.;ACHRE4;M
```csv
Accounts of Chemical Research;Acc. Chem. Res.;ACHRE4;M
```

*If you want to **add a list or submit corrections**, see the [contribution guidelines](CONTRIBUTING.md).*

Expand All @@ -28,6 +32,7 @@ To set up these lists, choose Options -> Manage journal abbreviations.
See <https://docs.jabref.org/fields/journalabbreviations> for an extensive documentation.

At each release of JabRef, the available journal lists are combined into two lists that are made available to the users:

* ``journalList.csv`` - contains all lists that follow the ISO4 standard with dots (currently ``acs``, ``ams``, ``geology_physics``, ``mathematics``, ``mechanical``, ``meteorology``, ``sociology``, and ``general``)
* ``journalList_dotless.csv`` - contains all lists that follow the ISO4 standard without dots (currently ``entrez`` and ``medicus``)

Expand Down

0 comments on commit 10e0feb

Please sign in to comment.