CSL4LibreOffice - A [GSoC '24] by subhramit · Pull Request #11477 · JabRef/jabref

subhramit · 2024-07-10T00:23:52Z

Functionality to use CSL Style citations in OO/LO

Closes #8893
Closes #2146

[PR-A of the GSoC '24 CSL4LibreOffice Project]

Summary:

Added functionality to select a CSL style from the "Select style" dialog
Added functionality to preview the selected CSL style (in bibliography form on a test entry) in the dialog
Added functionality to insert citations and bibliographic entries into a running LibreOffice document with the selected CSL style [by transforming HTML generated by citeproc-java into a format that can be parsed by OOTextIntoOO#write].

To insert a CSL Style Citation into the document:

Open a library in JabRef
Connect it to a running LibreOffice document instance (https://docs.jabref.org/cite/openofficeintegration)
Press the "Select Style" button on the OpenOffice panel
You will see the following window with two tabs, representing CSL Styles and JStyles. By default, the "CSL Styles" tab will be active. Select a CSL Style:
In the library, select an entry or a group of entries to cite
Press "Cite" in the OO Panel to insert bibliography, or press "Cite in-text" to insert in-text citation

Follow-up: #11521

Mandatory checks

Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
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.

…, Cleanup

…tead of index, basis for preferences)

…pipeline

subhramit · 2024-07-11T13:08:54Z

When I reopen the dialog "Style selection", the previously selected style should be selected.

This one seems slightly more complex. Planning on a separate PR for this.
Could @koppor or @LoayGhreeb outline some steps?
A slightly easier approach seems to be to render the title and preview of the last selected style in the Preview section below in the Style Select dialog, and then letting the user select it again. Would this suffice?

LoayGhreeb · 2024-07-11T13:25:26Z

When I reopen the dialog "Style selection", the previously selected style should be selected.

This one seems slightly more complex. Planning on a separate PR for this.

You can use the "Global Search window" as an example for this. Instead of creating a new dialog every time, you can create one dialog show and hide it. This approach will prevent losing the selection state.

checkout:

jabref/src/main/java/org/jabref/gui/search/GlobalSearchBar.java

Lines 295 to 304 in 0e7c1ff

    
           openGlobalSearchButton.setOnAction(evt -> { 
        
               globalSearchActive.setValue(true); 
        
               if (globalSearchResultDialog == null) { 
        
                   globalSearchResultDialog = new GlobalSearchResultDialog(undoManager, tabContainer); 
        
               } 
        
               stateManager.activeGlobalSearchQueryProperty().setValue(searchQueryProperty.get()); 
        
               updateSearchQuery(); 
        
               dialogService.showCustomDialogAndWait(globalSearchResultDialog); 
        
               globalSearchActive.setValue(false); 
        
           });

koppor · 2024-07-11T13:37:25Z

You can use the "Global Search window" as an example for this. Instead of creating a new dialog every time, you can create one dialog show and hide it. This approach will prevent losing the selection state.

Nice. After restart of JabRef, the style should also be selected. I assume that that style to be used is stored in the preferences? Is it stored in LibreOffice only? I would put it into the preferences and based on that lookup it the table.

(Haven't looked into the code itself. Just assumptions. If I looked in the code I would search for: Where is the reference of the current style held. Where does the dialog put it? Can the dialog also read it from there? If not, where can it be persisted?)

Siedlerchr · 2024-07-11T16:17:43Z

Current selected style should be stored in Open Office Preferences

koppor · 2024-07-15T19:21:03Z

Follow-up PR: ~~subhramit#7~~

koppor

DevCall: This is OK to go through, JavaDoc for the OO thing is very optional (it was existing before). Let's focus on

a) the architecture (subhramit#7) and
b) preferences (should be done in the next days)

subhramit · 2024-07-15T20:39:47Z

DevCall: This is OK to go through, JavaDoc for the OO thing is very optional (it was existing before). Let's focus on

a) the architecture (subhramit#7) and b) preferences (should be done in the next days)

Refinement for future reference: OO thing refers to possible tests of XTextDocument doc and XTextCursor cursor.
These tests would be dependent on description of these parameters, which would be added soon. However, since these parameters were existing already since OOBibStyle existed (pipeline to push JStyle bibliography into OO) and being used, the tests were deemed optional for our present purposes.

subhramit · 2024-07-15T20:44:12Z

DevCall: This is OK to go through, JavaDoc for the OO thing is very optional (it was existing before). Let's focus on

a) the architecture (subhramit#7) and b) preferences (should be done in the next days)

More context: The preferences storage feature subhramit#6 (b) is currently dependent on the architecture (a), so both of the above are coupled, hence we'll try to finish them both together [PR - B of the project].
c) A preliminary blog post to be written giving a walkthrough regarding how to use the current CSL Bibliography features.
d) Pending JavDoc documentation.

* upstream/main: Fix NPE when saving preferences (JabRef#11509) Switch to stream-based loading (JabRef#11479) Save unlinked local files dialog prefs (JabRef#11493) Add minimal support for biblatex data annotations (JabRef#11506) Fix handling of relative-file storage and auto linking (JabRef#11492) New Crowdin updates (JabRef#11504) Add missing issue numbers CSL4LibreOffice - A [GSoC '24] (JabRef#11477) Bump src/main/resources/csl-styles from `b2be5ae` to `fd6cb3e` (JabRef#11501) Bump gittools/actions from 1.1.1 to 1.2.0 (JabRef#11500) Bump com.kohlschutter.junixsocket:junixsocket-core from 2.9.1 to 2.10.0 (JabRef#11498) Bump commons-logging:commons-logging from 1.3.2 to 1.3.3 (JabRef#11499) Bump org.jsoup:jsoup from 1.17.2 to 1.18.1 (JabRef#11497) Bump com.kohlschutter.junixsocket:junixsocket-mysql from 2.9.1 to 2.10.0 (JabRef#11496) Bump org.openrewrite.recipe:rewrite-recipe-bom from 2.14.0 to 2.15.0 (JabRef#11495) FAQ updates (JabRef#11486) Update Gradle Wrapper from 8.8 to 8.9. Fix Chocolate.bib (JabRef#11491) # Conflicts: # src/main/java/org/jabref/gui/openoffice/OOBibBase.java # src/main/java/org/jabref/gui/openoffice/OpenOfficePanel.java # src/main/java/org/jabref/gui/openoffice/StyleSelectDialogView.java # src/main/java/org/jabref/gui/openoffice/StyleSelectDialogViewModel.java # src/main/java/org/jabref/preferences/JabRefPreferences.java

subhramit · 2024-07-21T18:21:40Z

Follow-up PR: #11521

subhramit · 2025-03-26T18:37:44Z

Pending ADR based on comment #12784 (comment), behind the introduction of CSLCItationOOAdapter.

subhramit added 30 commits May 31, 2024 20:24

Finish CSL Style selection Tab

8be7489

Preview Section (To Diagnose)

175b5a0

Rename preview boxes

014aa67

Fixed CSL Style Preview as per suggestions

dfe725f

Resize CSL Prveiw box height, Comply with Checkstyle

ff4810e

Merge branch 'main' of https://github.com/subhramit/jabref into CSL-GUI

76e2ac6

IntelliJ refactoring & Add back filter functionality

b20619d

Draft Commit: Establish Basic Framework

b1e0baa

Draft Commit: Establish Basic Framework

88c871f

Connect UI with CSL Logic (Phase 1), Improve HTML Formatter (Phase 2)…

6a2d103

…, Cleanup

Add logging of Cited Style Name for Testing

f4814a3

Add preliminary test support for in-text citations

6031be0

Refine Implementation: Refactoring [1]

e044a59

Improve Logging

9085b24

Major CSL Formatting improvements

667c603

Fix test, OpenRewrite

afaeeac

Remove in-text citation test

32a6fe6

Fix architecture test: Move business logic from model to logic directory

82e1315

Fix order of imports

30a0142

Extend CSL Citation feature to manually selected library entries

ba56927

Don't assume Databasecontext

e93c460

Major bug fix: Using Filter Seelcted entries from start (Use name ins…

3ce315f

…tead of index, basis for preferences)

Implement extensible selection of Style categories, Reconnect JStyle …

f563c96

…pipeline

Proper notification of selected style

aae88e4

Separation of bibliographic and in-text citation handling

c3327ed

Log instead of throwing exceptions while citing

3c5fe88

Handle the case of margins (gap between citation number and text)

64f535f

Refactoring, Localization

897969c

Submodules

617458d

Changelog

f78b39a

subhramit added 7 commits July 11, 2024 03:39

Adjust changelog

4bd1aee

Optimize transformHtml

4f73125

Add parameterized logging

fb449bf

Remove thrown exception, replace by logger

4ec8499

Add a return statement (enforced)

cc8a9d0

Remove unused fields

98599f5

openRewrite

6c722ab

Remove boilerplate comment

8401c6e

koppor added this to the 6.0-alpha milestone Jul 15, 2024

koppor enabled auto-merge July 15, 2024 19:24

koppor approved these changes Jul 15, 2024

View reviewed changes

koppor added this pull request to the merge queue Jul 15, 2024

Merged via the queue into JabRef:main with commit 003587c Jul 15, 2024

koppor mentioned this pull request Jul 15, 2024

Add missing issue numbers #11503

Merged

6 tasks

subhramit mentioned this pull request Jul 21, 2024

CSL4LibreOffice - B [GSoC '24] #11521

Merged

6 tasks

subhramit added the [outdated] type: feature label Jul 21, 2024

subhramit mentioned this pull request Aug 16, 2024

CSL4LibreOffice - D [GSoC '24] #11636

Merged

6 tasks

subhramit mentioned this pull request Sep 2, 2024

Change ADR title #11699

Merged

6 tasks

subhramit mentioned this pull request Apr 18, 2025

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

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

CSL4LibreOffice - A [GSoC '24]#11477

CSL4LibreOffice - A [GSoC '24]#11477
koppor merged 59 commits into
JabRef:mainfrom
subhramit:oo-csl

subhramit commented Jul 10, 2024 •

edited

Loading

Uh oh!

subhramit commented Jul 11, 2024 •

edited

Loading

Uh oh!

LoayGhreeb commented Jul 11, 2024

Uh oh!

koppor commented Jul 11, 2024

Uh oh!

Siedlerchr commented Jul 11, 2024

Uh oh!

koppor commented Jul 15, 2024 •

edited by subhramit

Loading

Uh oh!

koppor left a comment

Uh oh!

subhramit commented Jul 15, 2024 •

edited

Loading

Uh oh!

subhramit commented Jul 15, 2024 •

edited

Loading

Uh oh!

subhramit commented Jul 21, 2024

Uh oh!

subhramit commented Mar 26, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

subhramit commented Jul 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Functionality to use CSL Style citations in OO/LO

Summary:

Mandatory checks

Uh oh!

subhramit commented Jul 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LoayGhreeb commented Jul 11, 2024

Uh oh!

koppor commented Jul 11, 2024

Uh oh!

Siedlerchr commented Jul 11, 2024

Uh oh!

koppor commented Jul 15, 2024 • edited by subhramit Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

subhramit commented Jul 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subhramit commented Jul 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subhramit commented Jul 21, 2024

Uh oh!

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

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

subhramit commented Jul 10, 2024 •

edited

Loading

subhramit commented Jul 11, 2024 •

edited

Loading

koppor commented Jul 15, 2024 •

edited by subhramit

Loading

subhramit commented Jul 15, 2024 •

edited

Loading

subhramit commented Jul 15, 2024 •

edited

Loading

subhramit commented Mar 26, 2025 •

edited

Loading