forked from JabRef/jabref
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add small text on BibTeX handling (JabRef#11946)
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
parent: Code Howtos | ||
--- | ||
# JabRef's handling of BibTeX | ||
|
||
The main class to handle a single BibTeX entry is `org.jabref.model.entry.BibEntry`. | ||
The content of a `.bib` file is handled in `org.jabref.model.database.BibDatabase`. | ||
Things not written in the `.bib` file, but required for handling are stored in `org.jabref.model.database.BibDatabaseContext`. | ||
For instance, this stores the mode of the library, which can be BibTeX or `biblatex`. | ||
|
||
Standard BibTeX fields known to JabRef are modeled in `org.jabref.model.entry.field.StandardField`. | ||
A user-defined field not known to JabRef's code is modelled in `org.jabref.model.entry.field.UnknownField`. | ||
Typically, to get from a String to a `Field`, one needs to use `org.jabref.model.entry.field.FieldFactory#parseField(java.lang.String)`. | ||
|
||
## Cross-references | ||
|
||
BibTeX allows for referencing other entries by the field `crossref` (`org.jabref.model.entry.field.StandardField#CROSSREF`). | ||
Note that BibTeX and `biblatex` handle this differently. | ||
The method `org.jabref.model.entry.BibEntry#getResolvedFieldOrAlias(org.jabref.model.entry.field.Field, org.jabref.model.database.BibDatabase)` handles this difference. |