JabRef 5.15 is available on APIdia at https://apidia.net/java/JabRef/5.15 and currently also at https://apidia.net/java/JabRef, which always points to the latest version hosted.
The following issues have been encountered on processing JabRef 5.15. Note that this issue is not a call to action. It primarily serves informational purposes, but also offers an opportunity to discuss and track progress of solutions.
Log of JabRef 5.15
Dependency Report
Dependencies not on APIdia (117)
Documentation Report
org.jabref
Javadoc Processing (6)
org.jabref.gui.fieldeditors.EditorTextArea#initContextMenu(java.util.function.Supplier)
EasyBind#subscribe(ObservableValue, Consumer)
org.jabref.logic.citationkeypattern.BracketedPatternTest#authorsAlpha()
Simplifies LaTeX syntax. {@see org.jabref.logic.layout.format.RemoveLatexCommandsFormatter} for a formatter removing LaTeX commands completely.
@param normEntry A citation to process.
@return A normalized citation marker for deciding which
citations need uniqueLetters.
For details of what "normalized" means: {@see getAuthorYearParenthesisMarker2}
Note: now includes some markup.
BibliographyConsistencyCheckResultCsvWriter#writeFindingsAsCsv(Result, Path, BibEntryTypesManager, BibDatabaseMode)
HTML Processing
Cleans URLs returned by Google search.
<example>
If you copy links from search results from Google, all links will be enriched with search meta data, e.g.
https://www.google.de/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&cad=rja&uact=8&&url=http%3A%2F%2Fwww.inrg.csie.ntu.edu.tw%2Falgorithm2014%2Fhomework%2FWagner-74.pdf&ei=DifeVYHkDYWqU5W0j6gD&usg=AFQjCNFl638rl5KVta1jIMWLyb4CPSZidg&sig2=0hSSMw9XZXL3HJWwEcJtOg
</example>
Converts ordinal numbers to superscripts, e.g. 1st, 2nd or 3rd.
Will replace ordinal numbers even if they are semantically wrong, e.g. 21rd
<example>
1st Conf. Cloud Computing -> 1\textsuperscript{st} Conf. Cloud Computing
</example>
Replaces three or more authors with and others.
<example>
Stefan Kolb -> Stefan Kolb
Stefan Kolb and Simon Harrer -> Stefan Kolb and Simon Harrer
Stefan Kolb and Simon Harrer and Jörg Lenhard -> Stefan Kolb and others
</example>
Remove brackets formatter.
<example>
"{Stefan Kolb}" -> "Stefan Kolb"
</example>
Adds an extension to the given file name. The original extension is not replaced. That means, "demo.bib", ".sav"
gets "demo.bib.sav" and not "demo.sav"
<p>
<emph>Warning! If "ext" is passed, this is literally added. Thus addExtension("tmp.txt", "ext") leads to "tmp.txtext"</emph>
Gets the content of a subnode.
For example,
<item>
<nodeName>content</nodeName>
</item>
Gets the content of a subnode.
For example,
<item>
<nodeName>content</nodeName>
</item>
Gets a list of subnodes with the specified tag name.
For example,
<item>
<node>first hit</node>
<node>second hit</node>
</item>
Gets a list of subnodes with the specified tag name.
For example,
<item>
<node>first hit</node>
<node>second hit</node>
</item>
Gets a list of subnodes with the specified tag name.
For example,
<item>
<node>first hit</node>
<node>second hit</node>
</item>
Gets a the first subnode with the specified tag name.
For example,
<item>
<node>hit</node>
<node>second hit, but not returned</node>
</item>
Gets a the first subnode with the specified tag name.
For example,
<item>
<node>hit</node>
<node>second hit, but not returned</node>
</item>
Gets a the first subnode with the specified tag name.
For example,
<item>
<node>hit</node>
<node>second hit, but not returned</node>
</item>
Returns this entry's ID. It is used internally to distinguish different BibTeX entries.
<p>
It is <emph>not</emph> the citation key (which is stored in the <a href="org.jabref.model.entry.field.InternalField.html#KEY_FIELD" class="jlink"><code class="coderef">InternalField#KEY_FIELD</code></a> and also known as BibTeX key).
Sets the citation key.<div class="admonition"><p class="first">Note
<p class="last">This is <emph>not</emph> the internal Id of this entry.
The internal Id is always present, whereas the citation key might not be present.
</div>
Creates an Optional<DOI> from various schemes including URL, URN, and plain DOIs.
<p>
Useful for suppressing the <c>IllegalArgumentException</c> of the Constructor and checking for Optional.isPresent() instead.
Replaces all platform-dependent line breaks by OS.NEWLINE line breaks.
AKA normalize newlines
<p>
We do NOT use UNIX line breaks as the user explicitly configures its linebreaks and this method is used in bibtex field writing
<example>
Legacy Macintosh \r -> OS.NEWLINE
Windows \r\n -> OS.NEWLINE
</example>
Notes
On dependency report
APIdia is constantly improving: Missing dependencies are filled in every day.
Track this issue to be notified about progress of the dependency tree being resolved.
On inline see
APIdia does support inline use of
@see as follows. For an inline occurrence of
{@see ...},
- the occurrence is replaced by
{@link ...} (program elements)
or wrapped into an html <a> tag (external links) and
- a block tag
@see ... is appended.
This is still logged as an issue, because inline use of
@see is considered invalid Javadoc.
JabRef 5.15 is available on APIdia at https://apidia.net/java/JabRef/5.15 and currently also at https://apidia.net/java/JabRef, which always points to the latest version hosted.
The following issues have been encountered on processing JabRef 5.15. Note that this issue is not a call to action. It primarily serves informational purposes, but also offers an opportunity to discuss and track progress of solutions.
Log of JabRef 5.15
Dependency Report
Dependencies not on APIdia (117)
Documentation Report
org.jabref
Javadoc Processing (6)
failed to resolve link: link in org.jabref.gui.fieldeditors.contextmenu.EditorMenus
failed to resolve link: link in org.jabref.gui.util.BindingsHelper.subscribeFuture
failed to resolve link: link in org.jabref.logic.citationkeypattern.CitationKeyGenerator.DEFAULT_UNWANTED_CHARACTERS
inline see: org.jabref.logic.layout.format.RemoveLatexCommandsFormatter: see in org.jabref.logic.formatter.bibtexfields.LatexCleanupFormatter
Simplifies LaTeX syntax. {@see org.jabref.logic.layout.format.RemoveLatexCommandsFormatter} for a formatter removing LaTeX commands completely.inline see: getAuthorYearParenthesisMarker2: see in org.jabref.logic.openoffice.style.OOBibStyleGetCitationMarker.getNormalizedCitationMarker
failed to resolve link: link in org.jabref.logic.quality.consistency.BibliographyConsistencyCheck.check
HTML Processing
unknown html tag: example in org.jabref.gui.fieldeditors.URLUtil.cleanGoogleSearchURL
unknown html tag: example in org.jabref.logic.formatter.bibtexfields.OrdinalsToSuperscriptFormatter.format
unknown html tag: example in org.jabref.logic.formatter.minifier.MinifyNameListFormatter.format
unknown html tag: example in org.jabref.logic.layout.format.RemoveBrackets
unknown html tag: emph in org.jabref.logic.util.io.FileUtil.addExtension
Adds an extension to the given file name. The original extension is not replaced. That means, "demo.bib", ".sav" gets "demo.bib.sav" and not "demo.sav" <p> <emph>Warning! If "ext" is passed, this is literally added. Thus addExtension("tmp.txt", "ext") leads to "tmp.txtext"</emph>unknown html tag: nodename in org.jabref.logic.util.io.XMLUtil.getNodeContent
Gets the content of a subnode. For example, <item> <nodeName>content</nodeName> </item>unknown html tag: item in org.jabref.logic.util.io.XMLUtil.getNodeContent
Gets the content of a subnode. For example, <item> <nodeName>content</nodeName> </item>unknown html tag: node in org.jabref.logic.util.io.XMLUtil.getNodesByName
Gets a list of subnodes with the specified tag name. For example, <item> <node>first hit</node> <node>second hit</node> </item>unknown html tag: node in org.jabref.logic.util.io.XMLUtil.getNodesByName
Gets a list of subnodes with the specified tag name. For example, <item> <node>first hit</node> <node>second hit</node> </item>unknown html tag: item in org.jabref.logic.util.io.XMLUtil.getNodesByName
Gets a list of subnodes with the specified tag name. For example, <item> <node>first hit</node> <node>second hit</node> </item>unknown html tag: node in org.jabref.logic.util.io.XMLUtil.getNode
Gets a the first subnode with the specified tag name. For example, <item> <node>hit</node> <node>second hit, but not returned</node> </item>unknown html tag: node in org.jabref.logic.util.io.XMLUtil.getNode
Gets a the first subnode with the specified tag name. For example, <item> <node>hit</node> <node>second hit, but not returned</node> </item>unknown html tag: item in org.jabref.logic.util.io.XMLUtil.getNode
Gets a the first subnode with the specified tag name. For example, <item> <node>hit</node> <node>second hit, but not returned</node> </item>unknown html tag: emph in org.jabref.model.entry.BibEntry.getId
unknown html tag: emph in org.jabref.model.entry.BibEntry.setCitationKey
unknown html tag: c in org.jabref.model.entry.identifier.DOI.parse
unknown html tag: example in org.jabref.model.strings.StringUtil.unifyLineBreaks
Notes
On dependency report
APIdia is constantly improving: Missing dependencies are filled in every day. Track this issue to be notified about progress of the dependency tree being resolved.On inline see
APIdia does support inline use of@seeas follows. For an inline occurrence of{@see ...},- the occurrence is replaced by
- a block tag
This is still logged as an issue, because inline use of{@link ...}(program elements) or wrapped into an html<a>tag (external links) and@see ...is appended.@seeis considered invalid Javadoc.