Fix CSL rendering in case of article

[koppor]

Fixes #8372
Fixes JabRef#514
Fixes https://discourse.jabref.org/t/unable-to-edit-my-bibtex-file-that-i-used-before-vers-5-1/2390/4
Fixes https://discourse.jabref.org/t/jabref-5-6-need-help-with-export-from-jabref-to-microsoft-word-entry-preview-of-apa-7-not-rendering-correctly/3462/6

Currently, only test cases showing the intended output are added. We still need to discuss where to put the translation logic. Since the CSL processor is not aware of bibtex/biblatex, we should do the translation based on the context. The translation logic is shown at #8372 (comment). The horizontal arrows mean: put at that place if not existant. A similar translationlogic (excel table style) is shown in #8607 (comment)

Next steps:

• Implement translation logic
• Check if test cases match.
• If tests do not match, think of the edge cases and fix them

---

• Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
• Tests created for changes (if applicable)
• Manually tested changed features in running JabRef (always required)
• Screenshots added in PR description (for UI changes)
• Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

[Siedlerchr]

The logic for "translating" would be needed here: A while back I already passed down the bibdatabasecontext so we can get the mode.:

jabref/src/main/java/org/jabref/logic/citationstyle/CSLAdapter.java

Lines 97 to 126 in b16160e

	/**
	* Converts the {@link BibEntry} into {@link CSLItemData}.
	*/
	private static CSLItemData bibEntryToCSLItemData(BibEntry bibEntry, BibDatabaseContext bibDatabaseContext, BibEntryTypesManager entryTypesManager) {
	String citeKey = bibEntry.getCitationKey().orElse("");
	BibTeXEntry bibTeXEntry = new BibTeXEntry(new Key(bibEntry.getType().getName()), new Key(citeKey));
	// Not every field is already generated into latex free fields
	RemoveNewlinesFormatter removeNewlinesFormatter = new RemoveNewlinesFormatter();
	Optional<BibEntryType> entryType = entryTypesManager.enrich(bibEntry.getType(), bibDatabaseContext.getMode());
	Set<Field> fields = entryType.map(BibEntryType::getAllFields).orElse(bibEntry.getFields());
	for (Field key : fields) {
	bibEntry.getResolvedFieldOrAlias(key, bibDatabaseContext.getDatabase())
	.map(removeNewlinesFormatter::format)
	.map(LatexToUnicodeAdapter::format)
	.ifPresent(value -> {
	if (StandardField.MONTH.equals(key)) {
	// Change month from #mon# to mon because CSL does not support the former format
	value = bibEntry.getMonth().map(Month::getShortName).orElse(value);
	}
	bibTeXEntry.addField(new Key(key.getName()), new DigitStringValue(value));
	});
	}
	return BIBTEX_CONVERTER.toItemData(bibTeXEntry);

[koppor]

Current state: At test 13, we pass both issue and number to CSL Proc, but not a "page", it is not displayed.

We tried to put "777" in the pages, it works. "Article 777" in pages has maybe issues...

[ThiloteE]

BibTeX	BibLaTeX	EntryPreview/CSL	proposed logic, conditions and info
volume	volume	volume
number	issue	issue	For conversion to CSL or BibTeX: BibLaTeX number takes priority and supersedes BibLaTeX issue
number	number	issue	For conversion to CSL or BibTeX: BibLaTeX number takes priority and supersedes BibLaTeX issue
pages	eid	number	Some journals put the article-number (= eid) into the pages field. If BibLaTeX eid exists, provide csl number to the style. If pages exists, provide csl page. If eid WITHIN the pages field exists, detect the eid and provide csl number. If both eid and pages exists, ideally provide both csl number and csl page. Ideally the citationstyle should be able to flexibly choose the rendering. If this is not possible then map biblatex eid to CSL page, since this is sufficient to comply with APA 7th edition, but will break other citationstyles (e.g. IEEE)
pages	pages	page	Some journals put the article-number (= eid) into the pages field. If BibLaTeX eid exists, provide csl number to the style. If pages exists, provide csl page. If eid WITHIN the pages field exists, detect the eid and provide csl number. If both eid and pages exists, ideally provide both csl number and csl page. Ideally the citationstyle should be able to flexibly choose the rendering. If this is not possible then map biblatex eid to CSL page, since this is sufficient to comply with APA 7th edition, but will break other citationstyles (e.g. IEEE)

[Siedlerchr]

TIL: Apa CSL has no field number

[ThiloteE]

Known problems of this implementation (edited):

1. A negative tradeoff between rendering IEEE or APA style correctly. The CSL APA citationstyle is not able to render "number" (even though it should. This is tracked in Issue vs Number APA 7th edition; Number and Issue not shown under certain conditions citation-style-language/styles#5827) How to deal with this? - For JabRef, the first option would be to map eid to the page field, otherwise eid will not get rendered at all. Unfortunately this would mean that the IEEE citationstyle now renders article numbers in the pages field and in the eid field with p. prefixed. Since users have the option to move data from the eid field to the pages field with JabRef's new "automatic entry editor", they will be able to render article numbers even with APA style via workaround. Hence, I went with the second option, mapping Biblatex eid to CSL number, which is the correct thing to do if purely following the Biblatex and CSL standards documentation. Once CSL APA style supports the "number" field, JabRef will only have to update a few test cases, but not change its biblatex to csl translation logic.

2. The biblatex issue field will only get rendered, if there is no number field present in the entry. If both are present, the biblatex number field takes priority.

Overall though, I would suggest this to be an improvement to the status quo.

[ThiloteE]

Waiting a little bit for CSL maintainers to potentially refactor the APA Styles. Tracked in citation-style-language/styles#5827. We have time until JabRef 5.8 will be released anyway....

Obsolete now