Skip to content

Commit

Permalink
further adaptions regarding citationkey
Browse files Browse the repository at this point in the history
  • Loading branch information
matthiasgeiger committed Sep 6, 2020
1 parent 621b69c commit 5dde449
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions en/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@ Upon the first start of JabRef the main user interface is showing up the main el
A "library" is the main file that saves all the information about your collection of references. The storage format of the file is text-based in the Bibtex standard.

{% hint style="info" %}
The usage of a text-based file format has some advantages:
The usage of a text-based file format has some advantages:

- The file is "human readable" and editable with every text editor
- the text format allows for an easy tracking of changes with every common version control protocol (e.g., git)
- and finally: the format is dedicated for the usage with LaTeX; so you do not need to convert it to any other format but you can just directly link to your JabRef library

{% endhint %}

To create a new library, just select the "New library" menu item in the "File" menu:
Expand All @@ -42,8 +44,8 @@ After clicking on the "Article" button, the dialog closes and the so called "Ent
![Main window now showing the entry editor](.gitbook/assets/getting-started-entry-editor.png)

The most important information about the references to be added can now be entered in the "Required Fields" tab.
"Author", "Title", "Journal", and "Year" should be self-explanatory - however, a "bibtexkey", might not be familiar to you if you have not worked with Bibtex so far.
Basically, the idea of the "bibtexkey" is to have an unique identifier for each entry, which allows for referencing within a document you might be creating using the stored information in your library. Moreover, also within JabRef this "key" (also called `citationkey`) is used for example for cross-references to other related entries or to determine file names for full-text references.
"Author", "Title", "Journal", and "Year" should be self-explanatory - however, a "citationkey", might not be familiar to you.
Basically, the idea of the "citationkey" (formerly called "bibtexkey") is coming from working with Bibtex, where it is necessary to have an unique identifier for each entry. This allows for referencing within a document you might be creating using the stored information in your library. Moreover, also within JabRef this "key" is used for example for cross-references to other related entries or to determine file names for full-text references.

The key usually follows a global pattern and can be easily created automatically by clicking on the "generate" button next to the field.

Expand Down

0 comments on commit 5dde449

Please sign in to comment.