CSL4LibreOffice - G [Custom CSL Styles, build-time loading] #12951

subhramit · 2025-04-16T16:38:21Z

Custom CSL Styles & build-time loading

Follow-up to #12472

A. Functionality

The list of available CSL styles is now determined at build-time.
Common metadata (path, title, isNumericStyle) from internal .csl files is pre-fetched and stored in a JSON file (citation-style-catalog.json) via CitationStyleCatalogGenerator. This reduces delays in population of the styles list (and cuts off some parsing overhead) for both the OO/LO integration as well as the preview viewer.

Form:

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

Revamped Select Style dialog UI - now both the CSL and JStyle tabs uniformly use TableView.
Support for external CSL styles:

B. Code quality

Separation of concerns - CitationStyle now only handles modelling of a CSL style. CitationStyleCatalogGenerator along with CSLStyleLoader takes care of loading/removal of styles. CSLStyleUtils handles creation of CSL style instances and parsing.
Lot of refactoring & modularization of code (e.g. in StyleSelectDialogView, the handling of different components is now much more neatly compartmentalized for both CSL styles and JStyles. StyleSelectDialogViewModel has also been refactored for better manageability).
Complete renaming of OOBibStyle to JStyle.
Removal of unified style handling components from the JStyle class.

Closes #12337

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.

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

koppor · 2025-04-18T10:22:26Z

(PR state when ticket-check-action does not work as expected)

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

Siedlerchr · 2025-04-18T14:08:23Z

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

@@ -300,8 +300,8 @@ private JStyleSelectViewModel getJStyleOrDefault(String stylePath) {

    public void addJStyleFile() {
        FileDialogConfiguration fileDialogConfiguration = new FileDialogConfiguration.Builder()
-                .addExtensionFilter(Localization.lang("Style file"), StandardFileType.JSTYLE)
-                .withDefaultExtension(Localization.lang("Style file"), StandardFileType.JSTYLE)
+                .addExtensionFilter(Localization.lang("JStyle file"), StandardFileType.JSTYLE)


Maybe %0 file? I'm sure we have it somewhere

Added to localization.
I found:

jabref/src/main/java/org/jabref/gui/externalfiles/FileExtensionViewModel.java

Line 25 in 87984c3

this.description = Localization.lang("%0 file", fileType.getName());

So do you mean:

.addExtensionFilter(Localization.lang("%0 file", StandardFileType.JSTYLE.getName()), StandardFileType.JSTYLE) .withDefaultExtension(Localization.lang("%0 file", StandardFileType.JSTYLE.getName()), StandardFileType.JSTYLE)

That causes %0 to be "LibreOffice layout style". I can change that to "JStyle" and use it.

Commit 45c7d51

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

subhramit · 2025-04-18T14:17:42Z

Visual consistency for JStyles tab:

Comparison with CSL:

Old:

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

trag-bot · 2025-04-18T14:39:19Z

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

+                              if (matchingLayout.isEmpty()) {
+                                  matchingLayout = availableCslLayouts.stream()
+                                                                      .filter(layout -> layout.getDisplayName().equals(citationStyle.getTitle()))
+                                                                      .findFirst();
+                              }


The code uses an else branch to handle the case where matchingLayout is empty. It should return early if matchingLayout is present, following the fail-fast principle.

trag-bot · 2025-04-18T14:39:21Z

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

+        path.map(Path::toAbsolutePath).map(Path::toString).ifPresent(stylePath -> {
+            Optional<CitationStyle> newStyleOptional = cslStyleLoader.addStyleIfValid(stylePath);


The code does not handle the case where path is empty before proceeding with the mapping operation. It should return early if path is not present.

trag-bot · 2025-04-18T14:39:24Z

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

+        path.map(Path::toAbsolutePath).map(Path::toString).ifPresent(stylePath -> {
+            if (jStyleLoader.addStyleIfValid(stylePath)) {


The code does not handle the case where path is empty before proceeding with the mapping operation. It should return early if path is not present.

trag-bot · 2025-04-18T14:39:28Z

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

subhramit added 30 commits April 15, 2025 18:35

Initial implementation - custom CSL

c5c5503

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

Fix illegal character in external path

6bfacc4

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

Refine javadoc

298b6f2

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

Add localization keys, rename StyleLoader->JStyleLoader

fb87900

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

Convert discovery to build-time process

d369b63

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

Refine build task dependencies

6b7186c

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

Use List.of()

4326161

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

Add more javadoc

d251fef

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

Use metadata from json

b1f5cc4

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

Merge branch 'main' of https://github.com/JabRef/jabref into custom-csl

c23e3c3

Extract magic path, remove unused method

71ab8e9

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

Separate logic and model

42c7a3c

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

Make JStyleLoader pure

2bae0ff

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

Fix import order

90dd228

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

Fix import orders

19abd7f

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

Remove clash check

53f1c31

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

Rename jstyle methods, use modern java syntax

e261212

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

Implement deletion

45f7495

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

Don't show paths for internal styles

549881f

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

Convert to local

d9da3bb

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

Add check for empty catalog

8477360

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

Update FAQ

63ecf3d

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

Concise javadoc

3c2c410

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

Format faq

5d699c5

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

Rename method

baedb68

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

Use modern java, refine javadoc

0495fed

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

Rename variable

e313f93

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

Separate logger declaration

f134b10

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

Add changelog entries

e90d44c

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

Add PR number to changelog

f2633af

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

Trigger workflows

d1a7299

koppor mentioned this pull request Apr 18, 2025

Add output "ticketNumber" neofinancial/ticket-check-action#58

Draft

3 tasks

koppor and others added 8 commits April 18, 2025 12:25

Fix variable name

e724f88

Merge branch 'main' into custom-csl

6ff8bb5

Merge branch 'main' into custom-csl

dd17053

Re-write fxml properties, re-order items in view file

9224fac

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

Reorder viewmodel

9b8dccb

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

Make UI uniform

1800212

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

Ordering of properties

3a7b79f

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

Looker style type description

5574af9

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

Siedlerchr reviewed Apr 18, 2025

View reviewed changes

Update l10n

6c6278b

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

subhramit added 2 commits April 18, 2025 20:07

Use StandardFileType.getName()

45c7d51

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

Merge branch 'main' into custom-csl

1461574

trag-bot bot reviewed Apr 18, 2025

View reviewed changes

calixtus approved these changes Apr 18, 2025

View reviewed changes

calixtus added this pull request to the merge queue Apr 18, 2025

Merged via the queue into JabRef:main with commit f50e3e3 Apr 18, 2025
1 check passed

calixtus deleted the custom-csl branch April 18, 2025 18:53

JabRef deleted a comment from priyanshu16095 Apr 19, 2025

subhramit removed the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Apr 19, 2025

This was referenced Apr 19, 2025

Rearrange some CSL methods, add more tests #12968

Merged

Remove usage of Injector in StyleSelectDialogViewModel #12983

Merged

CSL4LibreOffice - H [Non-bibliographic styles] #12996

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CSL4LibreOffice - G [Custom CSL Styles, build-time loading] #12951

CSL4LibreOffice - G [Custom CSL Styles, build-time loading] #12951

subhramit commented Apr 16, 2025 •

edited

Loading

koppor commented Apr 18, 2025

Siedlerchr Apr 18, 2025

subhramit Apr 18, 2025

subhramit Apr 18, 2025

subhramit commented Apr 18, 2025

trag-bot bot Apr 18, 2025

trag-bot bot Apr 18, 2025

trag-bot bot Apr 18, 2025

trag-bot bot commented Apr 18, 2025

		path.map(Path::toAbsolutePath).map(Path::toString).ifPresent(stylePath -> {
		Optional<CitationStyle> newStyleOptional = cslStyleLoader.addStyleIfValid(stylePath);

		path.map(Path::toAbsolutePath).map(Path::toString).ifPresent(stylePath -> {
		if (jStyleLoader.addStyleIfValid(stylePath)) {

CSL4LibreOffice - G [Custom CSL Styles, build-time loading] #12951

CSL4LibreOffice - G [Custom CSL Styles, build-time loading] #12951

Conversation

subhramit commented Apr 16, 2025 • edited Loading

Custom CSL Styles & build-time loading

A. Functionality

B. Code quality

Mandatory checks

koppor commented Apr 18, 2025

Siedlerchr Apr 18, 2025

Choose a reason for hiding this comment

subhramit Apr 18, 2025

Choose a reason for hiding this comment

subhramit Apr 18, 2025

Choose a reason for hiding this comment

subhramit commented Apr 18, 2025

Visual consistency for JStyles tab:

Old:

trag-bot bot Apr 18, 2025

Choose a reason for hiding this comment

trag-bot bot Apr 18, 2025

Choose a reason for hiding this comment

trag-bot bot Apr 18, 2025

Choose a reason for hiding this comment

trag-bot bot commented Apr 18, 2025

subhramit commented Apr 16, 2025 •

edited

Loading