Entry preview not rendering the citation properly

[adrianocorrea]

JabRef version

5.4 (latest release)

Operating system

Windows

Details on version and operating system

Windows 11 21H2

Checked with the latest development build

• I made a backup of my libraries before testing the latest development version.
• I have tested the latest development version and the problem persists

Steps to reproduce the behaviour

1. Go to Options > Preferences > Entry Preview.
2. Add "American Psychological Association 7th Edition" or "American Psychological Association 6th Edition".
3. Click Save.
4. Open a library containing an article with both volume and number fields.
5. Double click the entry to see the Entry Preview. Check if entry preview is set to the "American Psychological Association 7th Edition" style guide.

You will notice that instead of showing the entry as "Smith, B., Jones, B., & Williams, J. (2016). Title of the test entry. BibTeX Journal, 34(3), 45–67. https://doi.org/10.1001/bla.blubb", the Entry Preview shows it as "Smith, B., Jones, B., & Williams, J. (2016). Title of the test entry. BibTeX Journal, 34, 45–67. https://doi.org/10.1001/bla.blubb" (i.e. without the number inside parenthesis). In the Options menu, however, the entry rendering appears to follow the style guide.

Until version 5.3, the entry preview was showing as expected. The issue appears only in versions 5.4 and 5.5 (so far).

Appendix

BibTex source:

@Article{,
  author  = {Smith, B. and Jones, B. and Williams, J.},
  journal = {BibTeX Journal},
  title   = {Title of the test entry},
  year    = {2016},
  number  = {3},
  pages   = {45--67},
  volume  = {34},
  doi     = {bla.blubb},
}

Screenshot of error:

[ThiloteE]

This comes to mind:

• Observable Preferences J (Preview) and minor refactor #8370
• In CSL preview, journal title and series name are duplicated #8279

[calixtus]

Hi @adrianocorrea , thanks for creating this issue.
Could you test please, what is being exportet via the right click menu?

@ThiloteE #8370 has just been created yesterday and is not merged yet into the main branch.

[adrianocorrea]

Hi @calixtus , thank you for your prompt response.
The export is consistent with the preview. The result is:

"Smith, B., Jones, B., & Williams, J. (2016). Title of the test entry. BibTeX Journal, 34, 45–67. https://doi.org/bla.blubb"

[ThiloteE]

I tested the pullrequest #8370 and the issue persists

JabRef 5.5-PullRequest8370.22--2021-12-29--707c014
Windows 10 10.0 amd64
Java 16.0.2
JavaFX 17.0.1+1

The interesting thing is that the number is depicted correctly under options>preferences>entry preview, but wrongly at entry editor>preview, so i was hoping your pull-request was making a difference :D

[calixtus]

Im a bit confused too, since the preview is constructed in the same way in the preview panel as well as in the preferences.

[Siedlerchr]

Maybe the sample bibtex entry used in the preferences preview misses some fields?

[adrianocorrea]

We know that the entry preview was working as expected until version 5.3. Do you know what changed in the entry preview code base between versions 5.3 and 5.4? Maybe running a diff between the versions code base could provide some insights on the source of the bug.

[calixtus]

I can't remember that we changed anything in the preview panel between versions 5.3 und 5.4 besides regular update of the csl-files. We'll investigate...

[calixtus]

git diff v5.3..v5.4 .\src\main\java\org\jabref\gui\preview
shows little refactoring:

• injection of IndexingTaskManager in the constructor
• a bugfix for opening links inside the preview viewer

git diff v5.3..v5.4 .\src\main\java\org\jabref\logic\preview\

• introduction of method containsCaseIndependent for search

[Siedlerchr]

Edit:// If you change "number" to "issue" it's fine
With issue field:

Options -> Preferences uses a different entry, it has the TestEntry:

jabref/src/main/java/org/jabref/logic/util/TestEntry.java

Lines 16 to 39 in bb011c9

	BibEntry entry = new BibEntry(StandardEntryType.Article);
	entry.setCitationKey("Smith2016");
	entry.setField(StandardField.AUTHOR, "Smith, Bill and Jones, Bob and Williams, Jeff");
	entry.setField(StandardField.EDITOR, "Taylor, Phil");
	entry.setField(StandardField.TITLE, "Title of the test entry");
	entry.setField(StandardField.NUMBER, "3");
	entry.setField(StandardField.VOLUME, "34");
	entry.setField(StandardField.ISSUE, "3");
	entry.setField(StandardField.YEAR, "2016");
	entry.setField(StandardField.PAGES, "45--67");
	entry.setField(StandardField.MONTH, "July");
	entry.setField(StandardField.FILE, ":testentry.pdf:PDF");
	entry.setField(StandardField.JOURNAL, "BibTeX Journal");
	entry.setField(StandardField.PUBLISHER, "JabRef Publishing");
	entry.setField(StandardField.ADDRESS, "Trondheim");
	entry.setField(StandardField.URL, "https://github.com/JabRef");
	entry.setField(StandardField.DOI, "10.1001/bla.blubb");
	entry.setField(StandardField.ABSTRACT,
	"This entry describes a test scenario which may be useful in JabRef. By providing a test entry it is possible to see how certain things will look in this graphical BIB-file mananger.");
	entry.setField(StandardField.COMMENT, "Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et " +
	"dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. " +
	"Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non " +
	"proident, sunt in culpa qui officia deserunt mollit anim id est laborum.");
	entry.putKeywords(Arrays.asList("KeyWord1", "KeyWord2", "KeyWord3", "Keyword4"), ';');

[ThiloteE]

Interesting.

• When changing number = {3}, to issue = {3}, it is depicted correctly in the entry editor>preview.
• When BOTH number = {3}, AND issue = {3}, are present, then it is depicted correctly.
• When only number field is present, then it is depicted wrongly.

I will create an issue at citeproc. I think the code that was changed for #8279 at michel-kraemer/citeproc-java@ad20fc4 could be the culprit, but Michel will know better.

[ThiloteE]

Ah and current behaviour is also this:

when issue and number differ, then issue takes precedence over number.
Example:

@Article{test,
issue = {99},
number = {3},
}

--> only issue will show.

[ThiloteE]

As a general reminder about the difference between number and issue, the biblatex documentation (https://ctan.kako-dev.de/macros/latex/contrib/biblatex/doc/biblatex.pdf) on page 22 shows this:

issue field (literal)
The issue of a journal. This field is intended for journals whose individual issues
are identified by a designation such as ‘Spring’ or ‘Summer’ rather than the month
or a number. The placement of issue is similar to month and number. Integer
ranges and short designators are better written to the number field. See also month,
number and §§ 2.3.10 and 2.3.11.

and on page 23:

number field (literal)
The number of a journal or the volume/number of a book in a series. See also
issue as well as §§ 2.3.7, 2.3.10, 2.3.11. With @patent entries, this is the number or
record token of a patent or patent request. Normally this field will be an integer or an
integer range, but it may also be a short designator that is not entirely numeric such
as “S1”, “Suppl. 2”, “3es”. In these cases the output should be scrutinised carefully.
Since number is—maybe counterintuitively given its name—a literal field, sorting
templates will not treat its contents as integers, but as literal strings, which means
that “11” may sort between “1” and “2”. If integer sorting is desired, the field can be
declared an integer field in a custom data model (see § 4.5.4). But then the sorting of
non-integer values is not well defined.

[michel-kraemer]

@ThiloteE Thanks for the in-depth analysis. I think you're right and the change in michel-kraemer/citeproc-java@ad20fc4 could be the cause for your issue. Let me quickly explain what changed:

Previously, both issue and number were mapped to the CSL field issue. Additionally, number was also mapped to number:

builder.number(entries.get(FIELD_NUMBER));
if (entries.containsKey(FIELD_ISSUE)) {
    builder.issue(entries.get(FIELD_ISSUE));
} else {
    builder.issue(entries.get(FIELD_NUMBER));
}

https://github.com/michel-kraemer/citeproc-java/blob/f4f6da7089653eef21848ef0994e45c720923ff3/citeproc-java/src/main/java/de/undercouch/citeproc/bibtex/BibTeXConverter.java#L245-L250

Now, due to duplicate series names in the preview (michel-kraemer/citeproc-java#111), number is mapped to number and issue is mapped to issue:

builder.number(entries.get(FIELD_NUMBER));
builder.issue(entries.get(FIELD_ISSUE));

https://github.com/michel-kraemer/citeproc-java/blob/ad20fc45cae262bc5044bea4d1f6edfcc6be8d19/citeproc-java/src/main/java/de/undercouch/citeproc/bibtex/BibTeXConverter.java#L241-L242

IMHO, this is the correct behaviour.

Whether the selected CSL style (in this case APA) displays issue or not is up to the style and cannot be influenced by citeproc-java or JabRef.

As a matter of fact, if you select the IEEE style, the entry should be displayed as follows:

[1]B. Smith, B. Jones, and J. Williams, “Title of the test entry,” BibTeX Journal, vol. 34, Art. no. 3, 2016, doi: bla.blubb.

Here, number is rendered as Art. no., which is probably not what you want. If you change number to issue, it will be rendered as follows:

[1]B. Smith, B. Jones, and J. Williams, “Title of the test entry,” BibTeX Journal, vol. 34, no. 3, pp. 45–67, 2016, doi: bla.blubb.

So, from my point of view, issue should be preferred here. I guess, the meaning/behaviour of issue and number is just slightly different in BibTeX and CSL.

Let me know if this helps!