CSL4LibreOffice - I [Bibliography formatting] by subhramit · Pull Request #13074 · JabRef/jabref

subhramit · 2025-05-07T11:46:04Z

Closes #13049, supersedes #13050
Closes https://github.com/JabRef/jabref-issue-melting-pot/issues/894 (internal)
Partially Closes #13051, but does not supersede #13072
Fixes #12784 (comment)

Changes

Added options to format CSL bibliography body:

Examples using IEEE:
- Text body:
- Hanging indent:
- First line indent:
...and so on.
Moved the option to modify CSL bibliography properties to the OO/LO panel, de-coupling it from the Select Style dialog:

(enabled only when a CSL style is selected) (renamed from "Modify bibliography title" to "Bibliography properties")
Added support for "Hanging Indent" in CSL styles that specify it (auto-select as default bibliography body format, "Text body" being the default in all other cases).
The metadata stored in the CSL catalog now includes hanging indent information:

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

Removed "Body Text" format as it is not specified by LO, and used "Text body" consistently.
Added "Bibliography Heading" to the available CSL bibliography header formats.
Removed early bi-directional binding of bibliography properties with preferences and used property.set() methods as otherwise it caused them to be saved even if the "Modify bibliography title" dialog was closed without pressing "OK".
Removed leading spaces which were unnecessarily inserted in CSL bibliography entries.
Miscellaneous variable renaming and code cleanup.

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.

Co-authored-by: DTT12912 <derictonythomas@gmail.com> Co-authored-by: subhramit <subhramit.bb@live.in> Signed-off-by: subhramit <subhramit.bb@live.in>

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

This reverts commit 1174ca0.

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

…aphy-formatting

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

trag-bot · 2025-05-07T11:47:54Z

+        setResultConverter(buttonType -> {
+            if (buttonType == ButtonType.OK) {
+                viewModel.savePreferences();
+            }
+            return null;
+        });


Returning null from a public method is discouraged. Consider using java.util.Optional to avoid potential null pointer exceptions.

trag-bot · 2025-05-07T11:51:05Z

        unmerge.setDisable(!canRefreshDocument || cslStyleSelected);
        manageCitations.setDisable(!canRefreshDocument || cslStyleSelected);
        exportCitations.setDisable(!(isConnectedToDocument && hasDatabase) || cslStyleSelected);
+        modifyBibliographyProperties.setDisable(!cslStyleSelected);


The method 'modifyBibliographyProperties' should not return null. It should use Optional to handle cases where no value is returned.

trag-bot · 2025-05-07T11:52:15Z

    public void storeStylePreferences() {
        // save external jstyles
-        List<String> externalStyles = jStyles.stream()
+        List<String> externalJStyles = jStyles.stream()


The variable name 'externalJStyles' is not camel-case as per Java naming conventions. It should be 'externalJStyles'.

trag-bot · 2025-05-07T11:54:04Z

+     * Style information record (title, numeric nature, has bibliography specification, bibliography uses hanging indent) for a citation style.
     */
-    public record StyleInfo(String title, boolean isNumericStyle, boolean hasBibliography) {
+    public record StyleInfo(String title, boolean isNumericStyle, boolean hasBibliography, boolean usesHangingIndent) {


The JavaDoc for the StyleInfo record is trivial and does not provide additional information beyond the code itself. It should offer a high-level summary or guidance.

trag-bot · 2025-05-07T11:56:08Z

        OOText title = OOFormat.paragraph(OOText.fromString(openOfficePreferences.getCslBibliographyTitle()), openOfficePreferences.getCslBibliographyHeaderFormat());
        OOTextIntoOO.write(document, cursor, OOText.fromString(title.toString()));
-        OOText ooBreak = OOFormat.paragraph(OOText.fromString(""), CSLFormatUtils.DEFAULT_BIBLIOGRAPHY_BODY_PARAGRAPH_FORMAT);
+        OOText ooBreak = OOFormat.paragraph(OOText.fromString(""), openOfficePreferences.getCslBibliographyBodyFormat());


The patch introduces a change to use a method from openOfficePreferences to get the bibliography body format. Ensure that this method returns a valid format and does not return null, as null should not be passed to methods.

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

trag-bot · 2025-05-07T12:00:30Z

        assertTrue(firstStyle.containsKey("title"), "Style entry should have a title");
        assertTrue(firstStyle.containsKey("isNumeric"), "Style entry should have isNumeric flag");
        assertTrue(firstStyle.containsKey("hasBibliography"), "Style entry should have hasBibliography flag");
+        assertTrue(firstStyle.containsKey("usesHangingIndent"), "Style entry should have usesHangingIndent flag");


The test uses assertTrue to check for the presence of a key in a map. It would be more robust to use assertEquals to verify the expected value of the key, ensuring the test checks both existence and correctness.

trag-bot · 2025-05-07T12:01:54Z

        }
        // As the prefs are mocked away, the getExternalStyles still returns the initial one
-        assertFalse(preferences.getExternalStyles().isEmpty());
+        assertFalse(preferences.getExternalJStyles().isEmpty());


The assertion checks for a boolean condition instead of asserting the expected contents of the list, which would provide more informative test results.

…aphy-formatting

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

subhramit · 2025-05-07T13:55:02Z

TODO: Gifs for APA demos in the blog post will need updating.

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

trag-bot · 2025-05-07T17:46:49Z

+     * This is also why we don't let users manually input the name of any pre-set format.
+     * The following two lists below are taken from https://github.com/LibreOffice/core/blob/0891df6b21fd95ec7c9614509d92829c0f17c353/sw/qa/python/check_styles.py#L132
+     */
+    public static final List<String> BIBLIOGRAPHY_TITLE_FORMATS = List.of(


The patch reformats the code without adding new statements, which violates the guideline that code should not be reformatted only because of syntax.

trag-bot · 2025-05-07T17:47:00Z

+            "Heading 4"
+    );
+
+    public static final List<String> BIBLIOGRAPHY_BODY_FORMATS = List.of(


The patch reformats the code without adding new statements, which violates the guideline that code should not be reformatted only because of syntax.

Siedlerchr · 2025-05-07T18:01:16Z

    private final boolean isInternalStyle;

-    public CitationStyle(String filePath, String title, boolean isNumericStyle, boolean hasBibliography, String source, boolean isInternalStyle) {
+    public CitationStyle(String filePath, String title, boolean isNumericStyle, boolean hasBibliography, boolean usesHangingIndent, String source, boolean isInternalStyle) {


We now have so many booleans that one could think about having an Enum and an EnumSet to pass all the options. But that can be done in a further PR

subhramit and others added 30 commits May 6, 2025 17:41

Introduce bibliography body formats (fix code from JabRef#13050)

589900f

Co-authored-by: DTT12912 <derictonythomas@gmail.com> Co-authored-by: subhramit <subhramit.bb@live.in> Signed-off-by: subhramit <subhramit.bb@live.in>

Get hanging indent working

51af117

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

Remove redundant AI comment

190cc93

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

Fix JabRef formatting infra

7452e48

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

Remove redundant comment

12b2ffc

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

Temp commit

1174ca0

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

Revert "Temp commit"

6038f4e

This reverts commit 1174ca0.

Remove unused constant

05e5319

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

Rename adapter, remove redundant comment

d4b44f6

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

Remove commented code

4e5dcfb

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

Swap order of conditions

8b90aff

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

wip

5afe626

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

wip

de1f4ab

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

Selective override of preferences

fa6423b

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

Use list instead of enum

57819dd

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

Rename variables

9fa8947

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

Rename with lambda

289a1a5

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

Add setters

d4f9132

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

Fix bindings introduced in JabRef#12784

e909bf6

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

Simplify button logic

db2b2e1

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

Shift to OO Panel, complete pref behavior

44e296a

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

Add more style options

ce831cc

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

Replace unused variables

d96d3ce

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

Rename variables

5c8538d

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

Remove default indent

acfbc4e

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

Remove unused import

39b9e2d

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

Merge branch 'main' of https://github.com/JabRef/jabref into bibliogr…

c6f3b66

…aphy-formatting

Add comment

1d98e1c

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

Add property button disable condition

c1f55c3

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

Localization keys

25cc86a

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

subhramit changed the title ~~Bibliography formatting~~ CSL4LibreOffice - I [Bibliography formatting] May 7, 2025

trag-bot Bot reviewed May 7, 2025

View reviewed changes

Comment thread jabgui/src/main/java/org/jabref/gui/openoffice/ModifyCSLBibliographyPropertiesDialogView.java

trag-bot Bot reviewed May 7, 2025

View reviewed changes

subhramit mentioned this pull request May 7, 2025

Fix: Increase preview area in style selection dialog to show full citation preview (#13051) #13072

Merged

6 tasks

trag-bot Bot reviewed May 7, 2025

View reviewed changes

Comment thread jabgui/src/main/java/org/jabref/gui/openoffice/OpenOfficePanel.java

trag-bot Bot reviewed May 7, 2025

View reviewed changes

Comment thread jablib/src/main/java/org/jabref/logic/openoffice/oocsltext/CSLFormatUtils.java

Add links to changelog entries

6f44bf5

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

trag-bot Bot reviewed May 7, 2025

View reviewed changes

Merge branch 'main' of https://github.com/JabRef/jabref into bibliogr…

15a2ca4

…aphy-formatting

subhramit added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label May 7, 2025

Refine comment

c8b7f8e

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

subhramit requested a review from Siedlerchr May 7, 2025 13:30

Add note

c762781

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

trag-bot Bot reviewed May 7, 2025

View reviewed changes

Siedlerchr reviewed May 7, 2025

View reviewed changes

Siedlerchr approved these changes May 7, 2025

View reviewed changes

Siedlerchr added this pull request to the merge queue May 7, 2025

Merged via the queue into JabRef:main with commit 0a1d67b May 7, 2025
1 check passed

Siedlerchr deleted the bibliography-formatting branch May 7, 2025 18:46

github-actions Bot mentioned this pull request May 7, 2025

Use Bibliography Heading and Bibliography 1 styles for OO integration #13049

Closed

subhramit added component: libre-office and removed status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers labels May 12, 2025

Uh oh!

Conversation

subhramit commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Examples using IEEE:

Mandatory checks

Uh oh!

Uh oh!

trag-bot Bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trag-bot Bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trag-bot Bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

subhramit commented May 7, 2025

Uh oh!

trag-bot Bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot May 7, 2025

Choose a reason for hiding this comment

Uh oh!

Siedlerchr May 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

subhramit commented May 7, 2025 •

edited

Loading