CSL4LibreOffice - E [Add re-distribution of numeric CSL citations]

[subhramit]

Fixes subhramit#22
Follow-up to #11521, #11577

• Proper sync of citation numbers throughout the document
• Refactoring (for consistent conventions, removal of redundant conditions, etc.)
• Documentation updates

sameLineTest.mp4

multiLineTest.mp4

groups.mp4

Limitations:

1. Fix does not work for grouped citations (it is a more difficult problem, refs. [WIP] CSL citations: Fix sync numbering #11688) (Solved)
2. Can be broken by moving a reference mark within the boundary of another, since there is no safety implemented for "cursor in protected area" as present in JStyles.
   • [issue crafting needed].
   • Work-around - make the reference marks visible to avoid accidents (LibreOffice:[Ctrl-F8] orLibreOffice:[menu:View]/[Field Shadings]) (refs. https://devdocs.jabref.org/code-howtos/openoffice/overview.html)

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]

@koppor @Siedlerchr Please merge this before 6.0-alpha release.

[ThiloteE]

I tested this PR. The only way that I found how to destroy its functionality was to select a numeric CSL style, to cite / cite-in-text and then to select the default numeric JStyle and cite / cite-in-text and then to delete some of the priorly cited references. Then pressed "Make/Sync Bibliography". This caused the JStyle reference list at the end of the document to update, but the CSL Style reference list to remain unchanged.

[github-actions]

Your code currently does not meet JabRef's code guidelines.
We use OpenRewrite to ensure "modern" Java coding practices.
The issues found can be automatically fixed.
Please execute the gradle task rewriteRun, check the results, commit, and push.

You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".

[subhramit]

I tested this PR. The only way that I found how to destroy its functionality was to select a numeric CSL style, to cite / cite-in-text and then to select the default numeric JStyle and cite / cite-in-text and then to delete some of the priorly cited references. Then pressed "Make/Sync Bibliography". This caused the JStyle reference list at the end of the document to update, but the CSL Style reference list to remain unchanged.

Hey, thanks for trying out. Yes, the jstyle and csl style citation detection, parsing, bibliography section population and syncing pipelines are completely independent of each other and can't be (or rather isn't recommended to be) used together (one of the reasons being the reference mark format being different - Jstyles don't start with "JABREF_" as you may have noticed with csl). After working with jstyles, if you switch back to a csl style and press refresh, the bibliography for csl would update again, keeping the jstyle section independent in that case (i mean to say behavior is symmetrical the other way around as well).

[ThiloteE]

I tested this PR. The only way that I found how to destroy its functionality was to select a numeric CSL style, to cite / cite-in-text and then to select the default numeric JStyle and cite / cite-in-text and then to delete some of the priorly cited references. Then pressed "Make/Sync Bibliography". This caused the JStyle reference list at the end of the document to update, but the CSL Style reference list to remain unchanged.

Hey, thanks for trying out. Yes, the jstyle and csl style citation detection, parsing, bibliography section population and syncing pipelines are completely independent of each other and can't be (or rather isn't recommended to be) used together (one of the reasons being the reference mark format being different - Jstyles don't start with "JABREF_" as you may have noticed with csl). After working with jstyles, if you switch back to a csl style and press refresh, the bibliography for csl would update again, keeping the jstyle section independent in that case (i mean to say behavior is symmetrical the other way around as well).

I think it would be good to add this piece of information to the documentation. It is an edge case and not many people will use both csl and jstyle in one document, but when they do, they will run into this.

[subhramit]

I tested this PR. The only way that I found how to destroy its functionality was to select a numeric CSL style, to cite / cite-in-text and then to select the default numeric JStyle and cite / cite-in-text and then to delete some of the priorly cited references. Then pressed "Make/Sync Bibliography". This caused the JStyle reference list at the end of the document to update, but the CSL Style reference list to remain unchanged.

Hey, thanks for trying out. Yes, the jstyle and csl style citation detection, parsing, bibliography section population and syncing pipelines are completely independent of each other and can't be (or rather isn't recommended to be) used together (one of the reasons being the reference mark format being different - Jstyles don't start with "JABREF_" as you may have noticed with csl). After working with jstyles, if you switch back to a csl style and press refresh, the bibliography for csl would update again, keeping the jstyle section independent in that case (i mean to say behavior is symmetrical the other way around as well).

I think it would be good to add this piece of information to the documentation. It is an edge case and not many people will use both csl and jstyle in one document, but when they do, they will run into this.

Good idea. On my list.
We also need to add the information on how to make reference marks visible in the user documentation.
https://github.com/JabRef/user-documentation (Keeping this here)

[ThiloteE]

Yes, I opened an issue here for the CSL additions: JabRef/user-documentation#509.
Instead of collecting this stuff in pull-requests, it would be better to open a PR to the docs directly and collect there or at least collect data that requires changes to documentation in the issue I linked.