CSL4LibreOffice - H [Non-bibliographic styles] by subhramit · Pull Request #12996 · JabRef/jabref

subhramit · 2025-04-24T15:28:34Z

Follow-up to #12951
Fixes #12990 (comment)

Support for non-bibliographic styles

Certain styles specified in our internal .csl files had a missing "bibliography" format specification section. Turns out there are styles that specify only citation formatting without bibliography.
[Fun fact: Some of these styles happen to be "note" citation styles (characterized by citation-format="note" in the source)].

This PR introduces support for such styles, thus enabling support for 82 new styles like "Oxford Art Journal", "Journal of Law, Medicine & Ethics", "Australian Historical Studies", "Business and Human Rights Journal", "Bluebook Law Review", "Journal of Applied Philosophy", "The Journal of Clinical Ethics", "South African Law Journal", "International Review of the Red Cross" and so on.

We now support a total of 2680 built-in styles.

The entire list of additions can be found below:

Details

- Agora
- AIB Studi
- Ancilla Iuris
- Art History
- Australian Historical Studies
- Bluebook Inline
- Bluebook Law Review
- Brumaire Verlag
- Business and Human Rights Journal
- Byzantine and Modern Greek Studies
- Cambridge Quarterly of Healthcare Ethics
- Catholic Biblical Association
- Chaucer Review
- Common Market Law Review
- Comparativ
- Comparative Politics
- Developing World Bioethics
- Early Medieval Europe
- Early Music History
- Ephemerides Theologicae Lovanienses
- Ethics Book Reviews
- Geopolitics
- Geschichte und Gesellschaft
- Health and Human Rights Journal
- Henoch
- History and Theory
- Humanistica Lovaniensia Journal of Neo-Latin Studies
- Instrumenta Patristica et Mediaevalia
- International Affairs
- International Relations
- International Review of the Red Cross
- International Security
- ISO 690 (Note, Czech version)
- Journal for the History of Astronomy
- Journal of Applied Philosophy
- Journal of Early Christian Studies
- Journal of International Peacekeeping
- Journal of Law, Medicine & Ethics
- Journal of Political Ideologies
- Journal of Political Philosophy
- Journal of the History of Collections
- Journal of the Indian Law Institute
- Journal of the Warburg and Courtauld Institutes
- Journal of Value Inquiry
- Leonardo
- London Review of International Law
- Mediaeval Studies
- Medical History
- Mercatus Center
- Oxford Art Journal
- Past and Present
- Philosophy and Public Affairs
- Pisa University Press
- Politix
- Refugee Survey Quarterly
- Review of International Studies
- Schweizerische Zeitschrift für Geschichte (Swiss Journal of History)
- Social History of Medicine
- Société Française d'Égyptologie
- South African Law Journal
- Speculum
- Stellenbosch Law Review
- Studia Theologica
- Textual Practice
- The British Journal for the History of Science
- The Chinese Journal of International Politics
- The Historical Journal
- The Journal of Clinical Ethics
- The Journal of Comparative Law
- Thomson Reuters Legal Tax and Accounting Australia
- Transnational Environmental Law
- U Schyłku Starożytności (In the Late Antiquity)
- United Nations Development Programme ICCA Legal Review
- Zeitgeschichte
- Zeitschrift für Antikes Christentum (Journal of Ancient Christianity)
- Zeitschrift für die Geschichte des Oberrheins
- Zeitschrift für Geschichtsdidaktik
- Zeitschrift für Medien und Kulturforschung
- Zeitschrift für Medienwissenschaft
- Zeitschrift für Ostmitteleuropa-Forschung
- Zeitschrift für Parlamentsfragen
- Zeitschrift für Politik

Note:

The Make/Sync bibliography button will be disabled when such a style is selected.
The preview viewer will display the citation instead of the bibliography preview for these styles.
Tests added for these new variants.
The JSON entries in the generated CSL catalog now have an additional field:

{
  "path" : "academy-of-management-review.csl",
  "isNumeric" : false,
  "hasBibliography" : true,
  "title" : "Academy of Management Review"
}

Other improvements

Redundant variants of overloaded methods were collapsed in CitationStyleGenerator.
Refactored and restructured some existing tests into more appropriate places.
Added test for CitationStyleCatalogGenerator.
Fixed old JavaDoc to adapt to current context post the CSL project.
Simplified RegEx for updating bibliography citation numbers.
De-coupled certain classes that should not be inter-dependent.

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
[/] Screenshots added in PR description (if change is visible to the user)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
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.

… new tests, collapse redundant methods. Signed-off-by: subhramit <subhramit.bb@live.in>

Signed-off-by: subhramit <subhramit.bb@live.in>

This reverts commit d8eff92.

Signed-off-by: subhramit <subhramit.bb@live.in>

trag-bot · 2025-04-24T15:34:13Z

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

                    }
                }
-            LOGGER.info("Loaded {} CSL styles", styleCount);
+                LOGGER.info("Loaded {} CSL styles", styleCount);


The logging statement should not be reformatted unless new statements are added. The patch only changes indentation without adding new logic.

It corrects the indent

trag-bot · 2025-04-24T15:35:04Z

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

+     * Style information record (title, isNumericStyle, hasBibliography) triad for a citation style.
     */
-    public record StyleInfo(String title, boolean isNumericStyle) {
+    public record StyleInfo(String title, boolean isNumericStyle, boolean hasBibliography) {


The JavaDoc for the StyleInfo record was updated to include 'hasBibliography', but the JavaDoc for the createCitationStyleFromSource method was not updated to reflect the change in the CitationStyle constructor.

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

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

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

trag-bot · 2025-04-24T15:41:59Z

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


    @Override
    public String generatePreview(BibEntry entry, BibDatabaseContext databaseContext) {
+        if (!citationStyle.hasBibliography()) {


The patch introduces a duplicate check for 'citationStyle.hasBibliography()' which is already present in the existing code. This results in code duplication and should be refactored to avoid redundancy.

It's just for conservative safety.

Signed-off-by: subhramit <subhramit.bb@live.in>

src/main/java/org/jabref/gui/openoffice/OOBibBase.java

koppor · 2025-04-24T17:08:18Z

src/test/java/org/jabref/logic/citationstyle/CSLStyleLoaderTest.java

+    @Test
+    void discoverInternalCitationStylesNotNull() {
+        List<CitationStyle> styleList = CSLStyleLoader.getInternalStyles();
+        assertNotNull(styleList);


Maybe, assertNotEquals(List.of(), styleList to check that the list has some contents?

Good idea, done

I think assertFalse(styleList.isEmpty()) is equivalent for more brevity, changed to it

subhramit · 2025-04-24T17:12:48Z

src/main/java/org/jabref/logic/openoffice/oocsltext/CSLFormatUtils.java

-    public static String getBibliographyTitle() {
-        return bibliographyTitle;
-    }

-    public static String getBibliographyHeaderFormat() {
-        return bibliographyHeaderFormat;
-    }
+    private static final Pattern YEAR_IN_CITATION_PATTERN = Pattern.compile("(.)(.*), (\\d{4}.*)");

-    public static void setBibliographyProperties(OpenOfficePreferences openOfficePreferences) {
-        bibliographyTitle = openOfficePreferences.getCslBibliographyTitle();
-        bibliographyHeaderFormat = openOfficePreferences.getCslBibliographyHeaderFormat();


Removal as an outcome of discussion at https://github.com/JabRef/jabref/pull/12784/files#r2058893104

Signed-off-by: subhramit <subhramit.bb@live.in>

src/test/java/org/jabref/logic/citationstyle/CSLStyleUtilsTest.java

Signed-off-by: subhramit <subhramit.bb@live.in>

src/test/java/org/jabref/logic/citationstyle/CSLStyleLoaderTest.java

Signed-off-by: subhramit <subhramit.bb@live.in>

src/test/java/org/jabref/logic/citationstyle/CitationStyleGeneratorTest.java

Signed-off-by: subhramit <subhramit.bb@live.in>

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

Signed-off-by: subhramit <subhramit.bb@live.in>

src/main/java/org/jabref/gui/openoffice/OOBibBase.java

Signed-off-by: subhramit <subhramit.bb@live.in>

trag-bot · 2025-04-25T06:06:47Z

@trag-bot didn't find any issues in the code! ✅✨

trag-bot · 2025-04-25T06:08:21Z

@trag-bot didn't find any issues in the code! ✅✨

JabRef/jabref#12996 src/test/java/org/jabref/logic/openoffice/oocsltext/CSLFormatUtilsTest.java

subhramit added 12 commits April 24, 2025 18:52

Large changes - support non-bibliographic styles, clean up tests, add…

1e7969d

… new tests, collapse redundant methods. Signed-off-by: subhramit <subhramit.bb@live.in>

Fix bug in test

acae04f

Signed-off-by: subhramit <subhramit.bb@live.in>

Remove redundant STyleInfo initialization

bdf1fac

Signed-off-by: subhramit <subhramit.bb@live.in>

Restructure tests

5518277

Signed-off-by: subhramit <subhramit.bb@live.in>

Simplify RegEx

d8eff92

Signed-off-by: subhramit <subhramit.bb@live.in>

Revert "Simplify RegEx"

8e1fd97

This reverts commit d8eff92.

Fix negation bug

0ac8147

Signed-off-by: subhramit <subhramit.bb@live.in>

Fix negation bug, simplify RegEx

91fabe2

Signed-off-by: subhramit <subhramit.bb@live.in>

Better test method name

d308c4b

Signed-off-by: subhramit <subhramit.bb@live.in>

Revert newline

afcc830

Signed-off-by: subhramit <subhramit.bb@live.in>

Add changelog entry

4f21033

Signed-off-by: subhramit <subhramit.bb@live.in>

Add PR number

30a9179

Signed-off-by: subhramit <subhramit.bb@live.in>

subhramit requested a review from Siedlerchr April 24, 2025 15:33

trag-bot bot reviewed Apr 24, 2025

View reviewed changes

src/main/java/org/jabref/logic/citationstyle/CitationStyle.java Show resolved Hide resolved

trag-bot bot reviewed Apr 24, 2025

View reviewed changes

src/main/java/org/jabref/logic/citationstyle/CitationStyle.java Show resolved Hide resolved

trag-bot bot reviewed Apr 24, 2025

View reviewed changes

src/main/java/org/jabref/logic/citationstyle/CitationStyleCatalogGenerator.java Show resolved Hide resolved

trag-bot bot reviewed Apr 24, 2025

View reviewed changes

src/main/java/org/jabref/logic/citationstyle/CitationStyleGenerator.java Show resolved Hide resolved

trag-bot bot reviewed Apr 24, 2025

View reviewed changes

subhramit added 2 commits April 24, 2025 21:30

Make utility classes final, fix tests

8bd6463

Signed-off-by: subhramit <subhramit.bb@live.in>

Decouple classes

90650a4

Signed-off-by: subhramit <subhramit.bb@live.in>

trag-bot bot reviewed Apr 24, 2025

View reviewed changes

src/main/java/org/jabref/gui/openoffice/OOBibBase.java Show resolved Hide resolved

koppor previously approved these changes Apr 24, 2025

View reviewed changes

subhramit mentioned this pull request Apr 24, 2025

Functionality to modify CSL bibliography title and format #12784

Merged

7 tasks

subhramit commented Apr 24, 2025

View reviewed changes

Apply Oliver's suggestion

6f2b5e4

Signed-off-by: subhramit <subhramit.bb@live.in>

subhramit dismissed koppor’s stale review via 6f2b5e4 April 24, 2025 17:17

Extend old tests

579cf5f

Signed-off-by: subhramit <subhramit.bb@live.in>

trag-bot bot reviewed Apr 24, 2025

View reviewed changes

src/test/java/org/jabref/logic/citationstyle/CSLStyleUtilsTest.java Show resolved Hide resolved

Simplify comparison

1350809

Signed-off-by: subhramit <subhramit.bb@live.in>

trag-bot bot reviewed Apr 24, 2025

View reviewed changes

src/test/java/org/jabref/logic/citationstyle/CSLStyleLoaderTest.java Show resolved Hide resolved

subhramit added 2 commits April 25, 2025 00:54

OpenRewrite

d967024

Signed-off-by: subhramit <subhramit.bb@live.in>

Rename constant

1536549

Signed-off-by: subhramit <subhramit.bb@live.in>

trag-bot bot reviewed Apr 24, 2025

View reviewed changes

src/test/java/org/jabref/logic/citationstyle/CitationStyleGeneratorTest.java Show resolved Hide resolved