Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add initial doc for journal lists #12406

Merged
merged 3 commits into from
Jan 23, 2025
Merged

Add initial doc for journal lists #12406

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b4ed9b7
Add initial doc
koppor Jan 20, 2025
c596585
Update journal-abbreviations.md
koppor Jan 20, 2025
baccb75
Update docs/code-howtos/journal-abbreviations.md
koppor Jan 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/code-howtos/journal-abbreviations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Journal Abbreviations

## Preparation

- Ensure that `buildres/abbrv.jabref.org` contains data. Otherwise, the submodules were not configured correctly.
- Ensure that `build/resources/main/journals/journal-list.mv` exists. It is generated by gradle task `generateJournalListMV`, which uses `org.jabref.cli.JournalListMvGenerator`.

## Where does the data come from?

The generator uses all `.csv` files from https://github.com/JabRef/abbrv.jabref.org/tree/main/journals, but ignores following ones:

Check failure on line 10 in docs/code-howtos/journal-abbreviations.md

View workflow job for this annotation

GitHub Actions / Markdown

Bare URL used 

docs/code-howtos/journal-abbreviations.md:10:42 MD034/no-bare-urls Bare URL used [Context: "https://github.com/JabRef/abbr..."] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md034.md
koppor marked this conversation as resolved.
Show resolved Hide resolved

```java
Set<String> ignoredNames = Set.of(
// remove all lists without dot in them:
// we use abbreviation lists containing dots in them only (to be consistent)
"journal_abbreviations_entrez.csv",
"journal_abbreviations_medicus.csv",
"journal_abbreviations_webofscience-dotless.csv",

// we currently do not have good support for BibTeX strings
"journal_abbreviations_ieee_strings.csv"
);
```

## Future work

See <https://github.com/JabRef/jabref-issue-melting-pot/issues/41>
Loading