Functionality to modify CSL bibliography title and format #12784

priyanshu16095 · 2025-03-20T08:09:01Z

Closes #12663

This PR adds the functionality to modfy CSL bibliography title and format.

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.

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

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

src/main/java/org/jabref/logic/openoffice/OpenOfficePreferences.java

priyanshu16095 · 2025-03-20T08:36:59Z

Recording.2025-03-20.mp4

Works fine!

src/main/java/org/jabref/logic/openoffice/Format.java

src/main/java/org/jabref/logic/openoffice/OpenOfficePreferences.java

src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java

subhramit · 2025-03-20T09:15:48Z

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

@@ -176,7 +178,7 @@ public void insertBibliography(XTextCursor cursor, CitationStyle selectedStyle,
            throws WrappedTargetException, CreationException {
        boolean isNumericStyle = selectedStyle.isNumericStyle();

-        OOText title = OOFormat.paragraph(OOText.fromString(CSLFormatUtils.DEFAULT_BIBLIOGRAPHY_TITLE), CSLFormatUtils.DEFAULT_BIBLIOGRAPHY_HEADER_PARAGRAPH_FORMAT);
+        OOText title = OOFormat.paragraph(OOText.fromString(openOfficePreferences.getBibliographyTitle().get()), openOfficePreferences.getHeaderFormat().get());


Instead of fetching the properties via preferences here (which would cause introduction of preferences), once you move the format definitions to CSLFormatUtils, get them from preferences there itself, then use them here (static access).

@priyanshu16095 Why is this marked resolved even though I still see raw preferences being imported and used here?

I don't mind repeating review comments for first-time contributors, but please understand that right now you are expected to act with a sense of ownership. It takes patience to repeat review comments, more so to check, find and "unresolve" old comments when it seems something has been asked for before. I think I have also repeated to you thrice now - do not resolve comments before they are completely addressed.

Apologies, I had previously modified the code based on the review, but as per this comment (#12784), I need to use these again. They were resolved earlier.

In this commit bbe688d, I did this as per review .

This is not clear to me. How do I get them from preferences.

src/main/java/org/jabref/logic/openoffice/OpenOfficePreferences.java

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

subhramit · 2025-03-22T17:08:25Z

I see most changes addressed. I am a bit busy, will give more feedback once I find some time this week.

subhramit

Few more changes.

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

src/main/java/org/jabref/logic/openoffice/OpenOfficePreferences.java

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

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

src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java

src/main/java/org/jabref/logic/openoffice/OpenOfficePreferences.java

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

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

subhramit · 2025-03-25T09:18:55Z

Please request a review once you have addressed all the comments above.

subhramit · 2025-03-25T14:02:36Z

Answering #12784 (comment) here:
This is more of a thought to preserve the design of linear dependency chain withnout jumps, such that all options related to text formatting should be retrieved by CSLCitationOOAdapter from CSLFormatUtils, and not directly from OpenOfficePreferences.

What you have to do is, get the preferences in CSLFormatUtils (import OpenOfficePreferences in that class if not already imported, and not in the adapter) and maybe create two functions with appropriate names, and internally return openOfficePreferences.getBibliographyTitle().get() etc. there. In the adapter, the preference thus should be obtained by a static call without the optional unwrap (get()), e.g.

OOFormat.paragraph(OOText.fromString(CSLFormatUtils.getBibliographyTitle(), CSLFormatUtils.getBibliographyHeaderFormat());

Let me know if this is clear.

subhramit · 2025-03-25T14:21:08Z

Let me know if this is clear.

Even better way:

public class CSLFormatUtils {
    
    public static String BIBLIOGRAPHY_TITLE;
    public static String BIBLIOGRAPHY_HEADER_FORMAT;

    public CSLFormatUtils(OpenOfficePreferences openOfficePreferences) {
        BIBLIOGRAPHY_TITLE = openOfficePreferences.cslBibliographyTitle().get();
        BIBLIOGRAPHY_HEADER_FORMAT = openOfficePreferences.cslBibliographyTitle().get();
    }
...

No need of extra functions, and can directly use CSLFormatUtils.BIBLIOGRAPHY_TITLE and so on in the adapter.

I am adding some more review comments to get rid of get() as early as possible.

subhramit · 2025-03-26T18:33:59Z

@priyanshu16095 currently actionable items (as I see) would be the fxml button and localization of strings. I will probably handle the design part later on. Please request me or Ruslan for a review once done (and tested).

…bref into titleAndFormat

subhramit

Tested, can get this in.

subhramit · 2025-03-27T20:31:18Z

My PRs caused this breakage, will fix.

trag-bot · 2025-03-27T20:41:19Z

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

@@ -94,6 +95,7 @@ private void initializeCitationAdapter(XTextDocument doc) throws WrappedTargetEx
            OOStyle initialStyle = openOfficePreferences.getCurrentStyle(); // may be a jstyle, can still be used for detecting subsequent style changes in context of CSL
            cslCitationOOAdapter = new CSLCitationOOAdapter(doc, databasesSupplier, initialStyle);
            cslUpdateBibliography = new CSLUpdateBibliography();
+            CSLFormatUtils.setBibliographyProperties(openOfficePreferences);


The addition of this line in the initializeCitationAdapter method changes the method's behavior, but the JavaDoc for the method has not been updated to reflect this change, violating instruction 1.

subhramit · 2025-03-27T20:44:40Z

@Siedlerchr can you test this once? I think it would be mergeable now.

trag-bot · 2025-03-29T16:37:02Z

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

subhramit · 2025-03-29T16:57:48Z

Since Ruslan did the second review and I tested it, I am letting this in.

obsolete

* Functionality to modify title and header format * Add CHANGELOG.md entry, rename Formats to Format and address the reviews * Fix typo in CHANGELOG.md entry * Rename variables * Rename variable, remove two methods, fix check * Rename variables and fix the check * Rename classes * Some minor changes * Renamed variables * Rename variable * Remove hardcoded value from constructor * Rename variable * Use CSLFormatUtils for title and format * Remove preference from constructor * Update JabRefCliPreferences.java Co-authored-by: Subhramit Basu <subhramit.bb@live.in> * Update JabRefCliPreferences.java Co-authored-by: Subhramit Basu <subhramit.bb@live.in> * Update ModifyCSLBibliographyTitleDialogViewModel.java Co-authored-by: Subhramit Basu <subhramit.bb@live.in> * Update ModifyCSLBibliographyTitleDialogViewModel.java Co-authored-by: Subhramit Basu <subhramit.bb@live.in> * Remove static import * Remove DEFAULT from variable names * Use getters * Remove unused methods * Elaborate changelog entry * Shorten changelog entry * Restore methods * Reduce use of `get()`, better naming for methods * Use correct function * Rename controller to view as per MVVM * More renaming * Consistent naming in `CliPreferences` * Fix functionality * Tragbot comment - resolve architectural violation * Variable naming convention and Tragbot comment - resolve encapsulation * Fix preferences * Remove Heading from Format * Update CHANGELOG.md Co-authored-by: Ruslan <ruslanpopov1512@gmail.com> * Use localized strings * Fix preferences initialization pipeline --------- Co-authored-by: Subhramit Basu <subhramit.bb@live.in> Co-authored-by: Ruslan <ruslanpopov1512@gmail.com>

Functionality to modify title and header format

4d44da1

trag-bot bot reviewed Mar 20, 2025

View reviewed changes

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

priyanshu16095 added 2 commits March 20, 2025 13:57

Add CHANGELOG.md entry, rename Formats to Format and address the reviews

77a038e

Merge branch 'main' into titleAndFormat

2cf8338

trag-bot bot reviewed Mar 20, 2025

View reviewed changes

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

trag-bot bot reviewed Mar 20, 2025

View reviewed changes

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

priyanshu16095 commented Mar 20, 2025

View reviewed changes

src/main/java/org/jabref/logic/openoffice/OpenOfficePreferences.java Outdated Show resolved Hide resolved

Fix typo in CHANGELOG.md entry

4c31d87

subhramit requested changes Mar 20, 2025

View reviewed changes

subhramit added the component: libre-office label Mar 20, 2025

Rename variables

bbe688d

trag-bot bot reviewed Mar 20, 2025

View reviewed changes

src/main/java/org/jabref/logic/openoffice/OpenOfficePreferences.java Outdated Show resolved Hide resolved

priyanshu16095 added 2 commits March 21, 2025 04:05

Rename variable, remove two methods, fix check

7ec30bb

Rename variables and fix the check

e1f6f5c

trag-bot bot reviewed Mar 20, 2025

View reviewed changes

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

Rename classes

595adf2

Some minor changes

9b62cab

subhramit requested changes Mar 24, 2025

View reviewed changes

priyanshu16095 commented Mar 24, 2025

View reviewed changes

src/main/java/org/jabref/logic/openoffice/OpenOfficePreferences.java Outdated Show resolved Hide resolved

Renamed variables

e3d0f64

trag-bot bot reviewed Mar 25, 2025

View reviewed changes

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

trag-bot bot reviewed Mar 25, 2025

View reviewed changes

src/main/java/org/jabref/logic/openoffice/oocsltext/CSLFormatUtils.java Outdated Show resolved Hide resolved

priyanshu16095 added 3 commits March 25, 2025 15:42

Rename variable

e0c4255

Remove hardcoded value from constructor

9b028db

Rename variable

18bcf95

This was referenced Mar 26, 2025

CSL4LibreOffice - A [GSoC '24] #11477

Merged

Tiny CSL architectural cleanup #12834

Merged

subhramit added status: changes required Pull requests that are not yet complete and removed status: awaiting second review For non-trivial changes labels Mar 26, 2025

priyanshu16095 added 2 commits March 27, 2025 11:31

Use localized strings

21f031c

Merge branch 'titleAndFormat' of https://github.com/priyanshu16095/ja…

8f6f308

…bref into titleAndFormat

priyanshu16095 requested a review from subhramit March 27, 2025 10:35

subhramit previously approved these changes Mar 27, 2025

View reviewed changes

subhramit added status: awaiting second review For non-trivial changes and removed status: changes required Pull requests that are not yet complete labels Mar 27, 2025

Merge branch 'main' into titleAndFormat

f1d28fa

Fix preferences initialization pipeline

d8cb06c

subhramit dismissed their stale review via d8cb06c March 27, 2025 20:39

trag-bot bot reviewed Mar 27, 2025

View reviewed changes

subhramit approved these changes Mar 27, 2025

View reviewed changes

Merge branch 'main' into titleAndFormat

cb7fb06

subhramit enabled auto-merge March 29, 2025 16:57

subhramit added this pull request to the merge queue Mar 29, 2025

subhramit removed the status: awaiting second review For non-trivial changes label Mar 29, 2025

Merged via the queue into JabRef:main with commit 993b223 Mar 29, 2025
1 check passed

subhramit mentioned this pull request May 2, 2025

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

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Functionality to modify CSL bibliography title and format #12784

Functionality to modify CSL bibliography title and format #12784

priyanshu16095 commented Mar 20, 2025 •

edited

Loading

priyanshu16095 commented Mar 20, 2025 •

edited

Loading

subhramit Mar 20, 2025

subhramit Mar 25, 2025 •

edited

Loading

priyanshu16095 Mar 25, 2025 •

edited

Loading

priyanshu16095 Mar 25, 2025

subhramit commented Mar 22, 2025

subhramit left a comment

subhramit commented Mar 25, 2025

subhramit commented Mar 25, 2025 •

edited

Loading

subhramit commented Mar 25, 2025

subhramit commented Mar 26, 2025 •

edited

Loading

subhramit left a comment

subhramit commented Mar 27, 2025

trag-bot bot Mar 27, 2025

subhramit commented Mar 27, 2025

trag-bot bot commented Mar 29, 2025

subhramit commented Mar 29, 2025

Functionality to modify CSL bibliography title and format #12784

Functionality to modify CSL bibliography title and format #12784

Conversation

priyanshu16095 commented Mar 20, 2025 • edited Loading

Closes #12663

Mandatory checks

priyanshu16095 commented Mar 20, 2025 • edited Loading

subhramit Mar 20, 2025

Choose a reason for hiding this comment

subhramit Mar 25, 2025 • edited Loading

Choose a reason for hiding this comment

priyanshu16095 Mar 25, 2025 • edited Loading

Choose a reason for hiding this comment

priyanshu16095 Mar 25, 2025

Choose a reason for hiding this comment

subhramit commented Mar 22, 2025

subhramit left a comment

Choose a reason for hiding this comment

subhramit commented Mar 25, 2025

subhramit commented Mar 25, 2025 • edited Loading

subhramit commented Mar 25, 2025

subhramit commented Mar 26, 2025 • edited Loading

subhramit left a comment

Choose a reason for hiding this comment

subhramit commented Mar 27, 2025

trag-bot bot Mar 27, 2025

Choose a reason for hiding this comment

subhramit commented Mar 27, 2025

trag-bot bot commented Mar 29, 2025

subhramit commented Mar 29, 2025

priyanshu16095 commented Mar 20, 2025 •

edited

Loading

priyanshu16095 commented Mar 20, 2025 •

edited

Loading

subhramit Mar 25, 2025 •

edited

Loading

priyanshu16095 Mar 25, 2025 •

edited

Loading

subhramit commented Mar 25, 2025 •

edited

Loading

subhramit commented Mar 26, 2025 •

edited

Loading