CSL4LibreOffice - A [GSoC '24]

[subhramit]

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:

1. Open a library in JabRef
2. Connect it to a running LibreOffice document instance (https://docs.jabref.org/cite/openofficeintegration)
3. Press the "Select Style" button on the OpenOffice panel
4. 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:
   
5. In the library, select an entry or a group of entries to cite
6. 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.

[subhramit]

• Feature wish: Double click on a CSL Style should select the style and close the dialog

Feature added.

[subhramit]

• 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]

• 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]

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]

Current selected style should be stored in Open Office Preferences

[koppor]

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]

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]

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.

[subhramit]

Follow-up PR: #11521