Preferences: Add manual prompt control for cross-references in Copy To #12526

benlevycmp · 2025-02-18T02:58:30Z

This adds an option to "General->User Interface" to manually enable/disable the prompt that asks the user if they would like to include cross-references when using "Copy to".

This is primarily to allow users to re-enable the prompts if they have disabled them from within the prompt.

Closes #12501

Mandatory checks

I own the copyright of the code submitted and I licence 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 (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.

…s-references when using Copy To

…nto confirm-crossreff-copy-option

…s-references when using Copy To

…nto confirm-crossreff-copy-option

…s-references when using Copy To

…nto confirm-crossreff-copy-option

subhramit · 2025-02-18T08:16:11Z

Do not force-push! Force push is off limits and very bad style when working together on a project. (Mainly because it is not supported well by GitHub istself.) Commits will be lost, comments on commits will loose their context. This makes it harder to review. In the end, all commits will be squashed either way before being merged into the `main`` branch.

False alarm? @koppor

subhramit · 2025-02-18T09:55:11Z

Instead of the prompt, I think the issue asks for a preference whether to "Include cross-referenced entries when using the 'Copy To' option".
cc: @priyanshu16095

I think a prompt every time we copy an entry/ are copying multiple entries is useless if we have such a preference in the first place.
If we really want to use prompts, we can ask the user just once after jabref installation, or just once for each session when he tries to copy.

subhramit · 2025-02-18T09:56:38Z

src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java

        inspectionWarningDuplicateProperty.setValue(workspacePreferences.shouldWarnAboutDuplicatesInInspection());

        confirmDeleteProperty.setValue(workspacePreferences.shouldConfirmDelete());
+        shouldAskForIncludingCrossReferencesProperty.setValue(preferences.getCopyToPreferences().getShouldAskForIncludingCrossReferences());


(Unrelated to PR)
@calixtus shouldn't this preference have gone to WorkspacePreferences instead of the root preference class?

Always depends on how complex it is. If possible, maintain flat hierarchies. If necessary, introduce a new preference class. Otherwise you wont find anything anymore and it gets harder for newcomers to read the code.

#12526 (comment)

@subhramit, after the updates, should I move this to Workspace Preferences or not?

koppor · 2025-02-18T11:04:21Z

Related to issue #12501

What does this mean?

Does it close the issue or just contribute to a part of it?

(We as maintainers should not be forced to read the issue itself - we should invest our time in providing feedback to the code or keep the development setup running)

koppor · 2025-02-18T11:40:47Z

Do not force-push! Force push is off limits and very bad style when working together on a project. (Mainly because it is not supported well by GitHub istself.) Commits will be lost, comments on commits will loose their context. This makes it harder to review. In the end, all commits will be squashed either way before being merged into the `main`` branch.

False alarm? @koppor

Should be fixed.

benlevycmp · 2025-02-19T00:21:11Z

Related to issue #12501

What does this mean?

Sorry, I should have been more specific. The issue brings up that once you ask not to be given the prompt again, there's no way to undo that. This fixes that problem, even though it doesn't implement the feature requested in the issue. This is why I said "related to" rather than "closes". I plan to make another pull request that closes the issue.

benlevycmp · 2025-02-19T00:35:55Z

I think a prompt every time we copy an entry/ are copying multiple entries is useless if we have such a preference in the first place.
If we really want to use prompts, we can ask the user just once after jabref installation, or just once for each session when he tries to copy.

I can envision a scenario where a user is doing multiple copies and wants to include cross-refs for some but not others. In this case the user might have to open up the preferences many times to switch back and forth if there's no prompt. Also, if the prompt is easy to disable then it won't be an annoyance to users who don't need it.

subhramit · 2025-02-19T08:12:17Z

I can envision a scenario where a user is doing multiple copies and wants to include cross-refs for some but not others. In this case the user might have to open up the preferences many times to switch back and forth if there's no prompt. Also, if the prompt is easy to disable then it won't be an annoyance to users who don't need it.

You have a point.

priyanshu16095 · 2025-02-19T13:46:06Z

@benlevycmp @subhramit In that scenario, user can select the entries which they want to copy and can choose whether they want to include cross-referenced entries or not, next time the same process, the dialog box will appear always until he chooses to not to show the dialog box.

This is what I mean.

Recording.2025-02-19.mp4

Have I understood the scenario correctly?

subhramit · 2025-02-19T15:35:43Z

@benlevycmp @subhramit In that scenario, user can select the entries which they want to copy and can choose whether they want to include cross-referenced entries or not, next time the same process, the dialog box will appear always until he chooses to not to show the dialog box.

This is what I mean.

Recording.2025-02-19.mp4

Have I understood the scenario correctly?

Yep, this works.
This should be it.
So only a preference for the prompt.

subhramit · 2025-02-21T21:57:49Z

@benlevycmp do you have any questions, after the discussion above?

@priyanshu16095 maybe you can guide him and help him complete the PR? I think the problem is clear now more or less. If possible, (in case I forget) - once this is merged, try to migrate "copy to" to a workspace preference. Tag this comment in the description, a separate issue isn't needed since it's a minor code quality fix.

priyanshu16095 · 2025-02-21T22:24:30Z

I have tried this, it works fine and solves the issue.
I will migrate the preferences to workspace preferences.

benlevycmp · 2025-02-21T22:58:20Z

Is there anything else I need to do?

subhramit

Just one comment

subhramit · 2025-02-21T23:45:29Z

CHANGELOG.md

 - The LibreOffice integration for CSL styles is now more performant. [#12472](https://github.com/JabRef/jabref/pull/12472)
 - The "automatically sync bibliography when citing" feature of the LibreOffice integration is now disabled by default (can be enabled in settings). [#12472](https://github.com/JabRef/jabref/pull/12472)
 - For the Citation key generator patterns, we reverted how `[authorsAlpha]` would behave to the original pattern and renamed the LNI-based pattern introduced in V6.0-alpha to `[authorsAlphaLNI]`. [#12499](https://github.com/JabRef/jabref/pull/12499)
+- Added option to "General->User Interface" to enable/disable the prompt for including cross-references when using "Copy To".


Remove changelog entry. "Copy to" is a feature introduced in an unreleased version. Also uncheck the mandatory check.
[Note that even if we were to keep it, we would have had to refine it using more context - "in preferences" etc.]

…nto confirm-crossreff-copy-option

subhramit · 2025-02-28T07:53:55Z

@benlevycmp almost there, can you resolve the conflicts?

benlevycmp · 2025-02-28T09:32:45Z

@subhramit done, thank you for your help.

benlevycmp and others added 8 commits February 17, 2025 17:45

Adds ability to manually enable/disable the prompt for including cros…

46ac20b

…s-references when using Copy To

Merge branch 'JabRef:main' into confirm-crossreff-copy-option

801188b

Adds ability to manually enable/disable the prompt for including cros…

6f45d43

…s-references when using Copy To

Merge remote-tracking branch 'origin/confirm-crossreff-copy-option' i…

bf567de

…nto confirm-crossreff-copy-option

Adds ability to manually enable/disable the prompt for including cros…

5271de5

…s-references when using Copy To

Merge remote-tracking branch 'origin/confirm-crossreff-copy-option' i…

e2ab5ed

…nto confirm-crossreff-copy-option

Adds ability to manually enable/disable the prompt for including cros…

b68a0ca

…s-references when using Copy To

Merge remote-tracking branch 'origin/confirm-crossreff-copy-option' i…

b844703

…nto confirm-crossreff-copy-option

This comment was marked as outdated.

Sign in to view

subhramit reviewed Feb 18, 2025

View reviewed changes

This comment was marked as resolved.

Sign in to view

Merge branch 'main' into confirm-crossreff-copy-option

89ab466

subhramit requested changes Feb 21, 2025

View reviewed changes

ThiloteE changed the title ~~Adds option to manually enable/disable the prompt for including cross-references when using Copy To~~ Add manual prompt control for cross-references in Copy To Feb 24, 2025

ThiloteE changed the title ~~Add manual prompt control for cross-references in Copy To~~ Preferences: Add manual prompt control for cross-references in Copy To Feb 25, 2025

ThiloteE added the component: preferences label Feb 25, 2025

benlevycmp added 2 commits February 27, 2025 18:35

remove changelog entry

7e5d64a

Merge remote-tracking branch 'origin/confirm-crossreff-copy-option' i…

10d107b

…nto confirm-crossreff-copy-option

Merge branch 'main' into confirm-crossreff-copy-option

a178818

subhramit approved these changes Feb 28, 2025

View reviewed changes

Siedlerchr approved these changes Feb 28, 2025

View reviewed changes

Siedlerchr added this pull request to the merge queue Feb 28, 2025

Merged via the queue into JabRef:main with commit 85e9478 Feb 28, 2025

benlevycmp deleted the confirm-crossreff-copy-option branch March 11, 2025 01:18

subhramit mentioned this pull request Mar 28, 2025

Fix "Copy to" preferences #12843

Closed

Uh oh!

Preferences: Add manual prompt control for cross-references in Copy To #12526

Preferences: Add manual prompt control for cross-references in Copy To #12526

Uh oh!

Conversation

benlevycmp commented Feb 18, 2025 • edited by ThiloteE Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Mandatory checks

Uh oh!

This comment was marked as outdated.

Uh oh!

subhramit commented Feb 18, 2025

Uh oh!

subhramit commented Feb 18, 2025

Uh oh!

subhramit Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

calixtus Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

priyanshu16095 Feb 28, 2025

Choose a reason for hiding this comment

Uh oh!

koppor commented Feb 18, 2025

Uh oh!

koppor commented Feb 18, 2025

Uh oh!

This comment was marked as resolved.

Uh oh!

benlevycmp commented Feb 19, 2025

Uh oh!

benlevycmp commented Feb 19, 2025

Uh oh!

subhramit commented Feb 19, 2025

Uh oh!

priyanshu16095 commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subhramit commented Feb 19, 2025

Uh oh!

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

Uh oh!

Uh oh!

priyanshu16095 commented Feb 21, 2025

Uh oh!

benlevycmp commented Feb 21, 2025

Uh oh!

subhramit left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

subhramit commented Feb 28, 2025

Uh oh!

benlevycmp commented Feb 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

benlevycmp commented Feb 18, 2025 •

edited by ThiloteE

Loading

priyanshu16095 commented Feb 19, 2025 •

edited

Loading

subhramit commented Feb 21, 2025 •

edited

Loading

subhramit Feb 21, 2025 •

edited

Loading