Copy cite command should respect preferences #10615

koppor · 2023-11-02T22:23:54Z

#10303 introduced a new cite command:

It is parsed at org.jabref.gui.push.AbstractPushToApplication#dissectCiteCommand.

However, in org.jabref.gui.edit.CopyMoreAction#copyCiteKey, this pattern is not used.

This leads to \cite{key1,key2}{Khalaf2007} for key Khalaf2007.

Implementation

Rename org.jabref.logic.citationkeypattern.CitationKeyPatternPreferences to CitationKeyGenerationPreferences.
Modify org.jabref.preferences.ExternalApplicationsPreferences#getCiteCommand to return a record having prefix, delimiter, suffix as string. There, the value is constructed based on the code at org.jabref.gui.push.AbstractPushToApplication#dissectCiteCommand. - No need to introduce caching there. That could be done as next step. (This code does not run for a long time, so no performance issues expected). Name the record CitationCommandStringPreferences.
Add test cases testing (wrong) preference \cite. It should work nevertheless. It should use , as delimiter and { as prefix, and } as suffix (as fallback if nothing was provided). Adapt the code of CitationKeyGenerationPreferences accordingly. If this is successfully done, The command "Push entries to external application" adds a "null" prefix and suffix to an existing Citationkey in LaTeX. #10568 is fixed.
Adapt getCitePrefix(), getDelimiter(), and getCiteSuffix() to use the introduced CitationStringPreferences.
Remove org.jabref.gui.push.AbstractPushToApplication#dissectCiteCommand.
~~Remove org.jabref.gui.push.PushToApplication#getDelimiter~~
- ~~Change parameter at org.jabref.gui.push.PushToApplicationCommand#pushEntries to use CitationCommandStringPreferencess delimiter~~ This is wrong; since application's delimiter has higher precedence than the one of the citaton command.
Adapt org.jabref.gui.edit.CopyMoreAction#copyCiteKey to use the new preference

The text was updated successfully, but these errors were encountered:

ExpPhysU · 2023-11-04T15:19:31Z

I confirm this bug, making version 5.1.1 not usable. Revert to 5.10 and hoping, that it is corrected soon

OvercloudX · 2023-11-07T13:41:05Z

Hello koppor, hope everything's well. This is my first time taking a issue and I wonder if I can take this one? Thanks

keshav2025 · 2023-11-11T21:52:27Z

Hello koppor, I hope you're doing well. This is my first time addressing an issue, and I'm wondering if I can handle this one. Thanks!

ThiloteE · 2023-11-11T21:56:25Z

Sorry for the late reply. I will assign @OvercloudX, because of first come first serve.

@keshav2025 Please choose another issue. We usually only assign one issue per student to avoid trouble further down the road. I am sorry.

OvercloudX · 2023-11-11T21:58:58Z

Sorry for the late reply. I will assign @OvercloudX, because of first come first serve.

@keshav2025 Please choose another issue. We usually only assign one issue per student to avoid trouble further down the road. I am sorry.

Thanks u so much, im gonna start up in it

OvercloudX · 2023-11-22T09:34:23Z

@ExpPhysU @koppor @ThiloteE
Hello everyone, I hope you are doing well.
Could you please tell me how to reproduce the problem? It seems there was a missing image before the implementation part.

ThiloteE · 2023-11-22T09:56:06Z

Indeed. Maybe your browser has issues? Could you try with another one? I use Mozilla Firefox and I can see the image. What happens, if you click on that image link?

OvercloudX · 2023-11-22T10:02:14Z

Indeed. Maybe your browser has issues? Could you try with another one? I use Mozilla Firefox and I can see the image. What happens, if you click on that image link?

I use edge, and I tried Firefox but it had the same problem. When I click the image link it shows 404 not found.

ThiloteE · 2023-11-22T10:22:21Z

Ok, I think I fixed it. Apparently the links to those images were copied from a private protected GitHub repository. I uploaded new images, which you now should be able to see. Could you please confirm, if you can see them now?

OvercloudX · 2023-11-22T10:44:14Z

Ok, I think I fixed it. Apparently the links to those images were copied from a private protected GitHub repository. I uploaded new images, which you now should be able to see. Could you please confirm, if you can see them now?

yes, it works, thank you for your help

koppor · 2023-11-23T11:45:48Z

Could you please tell me how to reproduce the problem?

Can you now reproduce the issue?

You can open the example BibTeX file https://github.com/JabRef/jabref/blob/main/src/test/resources/testbib/jabref-authors.bib.

And then you can go to an entry and try to do "Copy \cite{citationkey}". I think, even this context menu item text needs to be adapted based on the preferences.

OvercloudX · 2023-11-26T18:27:39Z

Could you please tell me how to reproduce the problem?

Can you now reproduce the issue?

You can open the example BibTeX file https://github.com/JabRef/jabref/blob/main/src/test/resources/testbib/jabref-authors.bib.

And then you can go to an entry and try to do "Copy \cite{citationkey}". I think, even this context menu item text needs to be adapted based on the preferences.

Yes, I've succeeded reproduce the issue I think. I saw that it was different when I imported to TEX Studio using two methods.

Thank you for the help.

OvercloudX · 2023-12-02T22:10:48Z

@koppor @ThiloteE Hello I have a question about the step3. It is said that the default prefix should be "{" but when I check the defaultCiteCommand in the java/org/jabref/preferences/ExternalApplicationsPreferences.java, I found it was "\cite{key1,key2}" so I wonder if the default prefix is "\cite{" or "{" ?

OvercloudX · 2023-12-02T22:13:40Z

@koppor @ThiloteE Hello I have a question about the step3. It is said that the default prefix should be "{" but when I check the defaultCiteCommand in the java/org/jabref/preferences/ExternalApplicationsPreferences.java, I found it was "\cite{key1,key2}" so I wonder if the default prefix is "\cite{" or "{" ?

Please forgive me if I made any silly mistake because I'm new in code.

koppor · 2023-12-04T12:21:22Z

@koppor @ThiloteE Hello I have a question about the step3. It is said that the default prefix should be "{" but when I check the defaultCiteCommand in the java/org/jabref/preferences/ExternalApplicationsPreferences.java, I found it was "\cite{key1,key2}" so I wonder if the default prefix is "\cite{" or "{" ?

You can reproduce by

Unisntalling JabRef
Isntalling JabRef 5.10
Reset preferences in JabRef 5.10
Close JabRef
Start JabRef from maikn
Check the preference

Now, you should see \cite instead of \cite{key1,key2}.

See https://github.com/JabRef/jabref/pull/10303/files#diff-42a07fbc47ff359873a26e31184338ddf82ddcecf188dac16da1ef103eae3833R703 for the change introduced in the PR

Please note that I linked the PR in the first words of the issue description

You need to click on "Files changed"

Then scroll down to src/main/java/org/jabref/preferences/JabRefPreferences.java. You can also click a the "file explorer"

Is it now more clear?

koppor · 2023-12-04T12:22:53Z

@OvercloudX Did you do step 2 - and modify org.jabref.preferences.ExternalApplicationsPreferences#getCiteCommand?

Can we see it a draft pull request?

OvercloudX · 2023-12-04T21:06:28Z

@OvercloudX Did you do step 2 - and modify org.jabref.preferences.ExternalApplicationsPreferences#getCiteCommand?

Can we see it a draft pull request?

Yes, I think I may successfully finished the part 2 and I'd like to make a draft PR to you. I changed the method and created a record(CitationCommandStringPreferences).
Now I'm stuck in testing, I used JUnit for the test.

Siedlerchr · 2023-12-04T21:35:32Z

@OvercloudX You probably have to mock the preferences with prefs = mock(ExternalApplicationsPreferences.class) and then using when(prefs.getCiteCommand).thenReturn...

OvercloudX · 2023-12-04T21:57:17Z

@OvercloudX You probably have to mock the preferences with prefs = mock(ExternalApplicationsPreferences.class) and then using when(prefs.getCiteCommand).thenReturn...

Thank you for the help, gonna that right now

OvercloudX · 2023-12-04T22:05:02Z

@koppor @ThiloteE Hello I have a question about the step3. It is said that the default prefix should be "{" but when I check the defaultCiteCommand in the java/org/jabref/preferences/ExternalApplicationsPreferences.java, I found it was "\cite{key1,key2}" so I wonder if the default prefix is "\cite{" or "{" ?

You can reproduce by

Unisntalling JabRef

Isntalling JabRef 5.10

Reset preferences in JabRef 5.10

Close JabRef

Start JabRef from maikn

Check the preference

Now, you should see \cite instead of \cite{key1,key2}.

See https://github.com/JabRef/jabref/pull/10303/files#diff-42a07fbc47ff359873a26e31184338ddf82ddcecf188dac16da1ef103eae3833R703 for the change introduced in the PR

Please note that I linked the PR in the first words of the issue description

You need to click on "Files changed"

Then scroll down to src/main/java/org/jabref/preferences/JabRefPreferences.java. You can also click a the "file explorer"

Is it now more clear?

Thanks, that's more clear, but I still confused with these things:

These procedures are for me to have defaultCiteCommand as "\cite"
So it was \cite before the issue Push to external application config #10303, and after that merged PR it becomes \cite{key1,key2}

Thank you again for taking the time and effort to help me

koppor · 2023-12-05T08:15:04Z

Thanks, that's more clear, but I still confused with these things:

Software Engineering is also about clear requirements. It is good that you try to understand them. I would ask you to read and try to understand existing material. Please take the time to read. No rush. I assume you worked with Microsoft Word and not with LaTeX and JabRef. Then, it takes even more time to understand the whole setting.

In the statements you gave me, I can just write "yes" as answer. Do you ask about the why? From #10303, there is #10133 linked. I try to copy and paste from that.

1. These procedures are for me to have defaultCiteCommand as "\cite"

Yes. JabRef 5.10.

2. So it was \cite before the issue [Push to external application config #10303](https://github.com/JabRef/jabref/pull/10303), and after that merged PR it becomes \cite{key1,key2}

Yes. JabRef 5.10 to 5.11.

Quoting: #10133

I use Pandoc for processing Markdown manuscripts to ODT format. Markdown cite command is [@key] instead of LaTeX \cite{key}. In case of multiple citations this is [@key1; @key2]. Currently the preference for cite command does not include the { and } characters, making it impossible to change it to another cite command that does not use curly brackets. Also, the separating character (,) cannot be modified.

Quoting #10303 with a highlight.

Screenshot of today's JabRef:

Did you click on the question mark?

It leads to https://docs.jabref.org/cite/pushtoapplications

I highlight the important part. It is still worth to read the complete page.

Now click on "Copy \cite{citaton key}"

Result is:

\cite{key1,key2}{lala}

Which is wrong. The issue is about to fix THAT behavior.

OvercloudX · 2023-12-05T10:09:33Z

@koppor Thanks for your advice, I'll read them again.

koppor · 2023-12-18T20:45:15Z

@OvercloudX We did not see any activity on your side. Do you intend to continue?

OvercloudX · 2023-12-18T21:05:32Z

@OvercloudX We did not see any activity on your side. Do you intend to continue?

Hi there, recently I don't have much time to do it. But I still have strong willing to continue after several days.

But if there's anyone who want to take this issue now, I don't mind if you give it to someone else, because I don't want to take up public resources either.

ThiloteE · 2023-12-18T21:59:31Z

Take your time, we will be happy, if you come back to this :-)

Fixes #10615

* Fix Copy cite command should respect preferences Fixes #10615 * add changelog fix checsktyle * Fix CHANGELOG.md * Add missing "citation" to "key" * Add debug message at error in logic in CopyMoreAction * Add fallback if preference could not be parsed * Fix key binding setting * More relaxed parsing * Streamline code in AbstractPushToApplication * Add more test cases for configured citation command * Streamline code for copy action * Update src/main/java/org/jabref/gui/preferences/external/ExternalTabViewModel.java * Fix test --------- Co-authored-by: Oliver Kopp <[email protected]>

koppor added the good first issue An issue intended for project-newcomers. Varies in difficulty. label Nov 2, 2023

koppor added this to Good First Issues and Candidates for University Projects Nov 2, 2023

github-project-automation bot moved this to Free to take in Good First Issues Nov 2, 2023

github-project-automation bot moved this to Free to take in Candidates for University Projects Nov 2, 2023

koppor added the bug Confirmed bugs or reports that are very likely to be bugs label Nov 5, 2023

ThiloteE assigned OvercloudX Nov 11, 2023

ThiloteE moved this from Free to take to Reserved in Candidates for University Projects Nov 11, 2023

ThiloteE moved this from Free to take to Reserved in Good First Issues Nov 11, 2023

ThiloteE added the preferences label Nov 11, 2023

koppor mentioned this issue Dec 5, 2023

Draft Pull Request about #10615 Copy cite command should respect preferences #10690

Closed

6 tasks

koppor added this to the 5.12 milestone Dec 5, 2023

Siedlerchr added a commit that referenced this issue Dec 21, 2023

Fix Copy cite command should respect preferences

f85c393

Fixes #10615

Siedlerchr mentioned this issue Dec 21, 2023

Fix Copy cite command should respect preferences #10707

Merged

6 tasks

koppor unassigned OvercloudX Dec 21, 2023

Siedlerchr closed this as completed in #10707 Dec 22, 2023

github-project-automation bot moved this from Reserved to Done in Good First Issues Dec 22, 2023

github-project-automation bot moved this from Reserved to Done in Candidates for University Projects Dec 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Copy cite command should respect preferences #10615

Copy cite command should respect preferences #10615

koppor commented Nov 2, 2023 •

edited

Loading

ExpPhysU commented Nov 4, 2023

OvercloudX commented Nov 7, 2023

keshav2025 commented Nov 11, 2023

ThiloteE commented Nov 11, 2023

OvercloudX commented Nov 11, 2023

OvercloudX commented Nov 22, 2023

ThiloteE commented Nov 22, 2023 •

edited

Loading

OvercloudX commented Nov 22, 2023

ThiloteE commented Nov 22, 2023 •

edited

Loading

OvercloudX commented Nov 22, 2023

koppor commented Nov 23, 2023

OvercloudX commented Nov 26, 2023

OvercloudX commented Dec 2, 2023

OvercloudX commented Dec 2, 2023

koppor commented Dec 4, 2023

koppor commented Dec 4, 2023

OvercloudX commented Dec 4, 2023

Siedlerchr commented Dec 4, 2023

OvercloudX commented Dec 4, 2023

OvercloudX commented Dec 4, 2023

koppor commented Dec 5, 2023

OvercloudX commented Dec 5, 2023

koppor commented Dec 18, 2023

OvercloudX commented Dec 18, 2023

ThiloteE commented Dec 18, 2023

Copy cite command should respect preferences #10615

Copy cite command should respect preferences #10615

Comments

koppor commented Nov 2, 2023 • edited Loading

Implementation

ExpPhysU commented Nov 4, 2023

OvercloudX commented Nov 7, 2023

keshav2025 commented Nov 11, 2023

ThiloteE commented Nov 11, 2023

OvercloudX commented Nov 11, 2023

OvercloudX commented Nov 22, 2023

ThiloteE commented Nov 22, 2023 • edited Loading

OvercloudX commented Nov 22, 2023

ThiloteE commented Nov 22, 2023 • edited Loading

OvercloudX commented Nov 22, 2023

koppor commented Nov 23, 2023

OvercloudX commented Nov 26, 2023

OvercloudX commented Dec 2, 2023

OvercloudX commented Dec 2, 2023

koppor commented Dec 4, 2023

koppor commented Dec 4, 2023

OvercloudX commented Dec 4, 2023

Siedlerchr commented Dec 4, 2023

OvercloudX commented Dec 4, 2023

OvercloudX commented Dec 4, 2023

koppor commented Dec 5, 2023

OvercloudX commented Dec 5, 2023

koppor commented Dec 18, 2023

OvercloudX commented Dec 18, 2023

ThiloteE commented Dec 18, 2023

koppor commented Nov 2, 2023 •

edited

Loading

ThiloteE commented Nov 22, 2023 •

edited

Loading

ThiloteE commented Nov 22, 2023 •

edited

Loading