Double click on citation opens LaTeX editor #12044

u7465990 · 2024-10-21T03:04:52Z

Fixes #11996

I think I make the function works. The viewModel in LatexCitationTab is to store those entries as DoubleClickOnlyListWrapper. The variable citationsDisplay is the Listener of viewModel'. I use citationsDisplayto catch the double click event. If it's click the right entry, I use thePushToApplicationto call thejumpToLine. I found the set up ways in the PushToApplicationCommand. After the setup, the publicJumpToLinewill be called, it usejumpStringto get the command and use the newprocessBuilder` to run the command. It should works for TeXstudio.

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 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.

ThiloteE · 2024-10-21T09:56:12Z

To ease organizational workflows, I have linked the pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message. The pull request must be on the default branch.

close

closes

closed

fix

fixes

fixed

resolve

resolves

resolved

If you use a keyword to reference a pull request comment in another pull request, the pull requests will be linked. Merging the referencing pull request also closes the referenced pull request.

The syntax for closing keywords depends on whether the issue is in the same repository as the pull request.

Example:

✅ Fix #xyz links pull-request to issue. Merging the PR will close the Issue.
✅ Fix https://github.com/JabRef/jabref/issues/xyz links pull-request to issue. Merging the PR will close the Issue.
✅ Fix https://github.com/Koppor/jabref/issues/xyz links pull-request to issue. Merging the PR will close the Issue.
❌ Fix [#xyz](https://github.com/JabRef/jabref/issues/xyz) links pull-request to issue. Merging the PR will NOT close the Issue.

u7465990 · 2024-10-21T09:59:33Z

Fix #11996

koppor

Many obsolte code comments, some methods seem be left-overs from trial and error.

Please also fix sub module errors: https://devdocs.jabref.org/code-howtos/faq.html#submodules

koppor · 2024-10-21T11:24:07Z

src/main/java/org/jabref/gui/push/PushToApplicationCommand.java

+//    private void jump(Path fileName, int line, int column) {
+//        BibDatabaseContext database = stateManager.getActiveDatabase().orElseThrow(() -> new NullPointerException("Database null"));
+//        application.publicJumpToLine(database, stateManager.getSelectedEntries(), getKeyString(stateManager.getSelectedEntries(), application.getDelimiter()));
+//    }


Is this commented-out code needed?

koppor · 2024-10-21T11:24:17Z

src/main/java/org/jabref/gui/push/AbstractPushToApplication.java

+            ProcessBuilder processBuilder = new ProcessBuilder(command);
+            processBuilder.start();
+        } catch (IOException e) {
+            // Use robust logging instead of printStackTrace()


Remove comment

koppor · 2024-10-21T11:24:31Z

src/main/java/org/jabref/gui/push/AbstractPushToApplication.java

+            // Use robust logging instead of printStackTrace()
+            LOGGER.error("Could not open TeXstudio at the specified location.", e);
+
+            // Show an error dialog to the user


This is clear from the line below - remove comment

koppor · 2024-10-21T11:25:00Z

src/main/java/org/jabref/gui/push/AbstractPushToApplication.java

+            LOGGER.error("Could not open TeXstudio at the specified location.", e);
+
+            // Show an error dialog to the user
+            dialogService.showErrorDialogAndWait("Error", "Could not open TeXstudio at the specified location.");


Use localization. Paramterize the tool using %0. See https://devdocs.jabref.org/code-howtos/localization.html for details.

koppor · 2024-10-21T11:25:26Z

src/main/java/org/jabref/gui/push/AbstractPushToApplication.java

+    protected void jumpToLine(Path fileName, int line, int column) {
+        commandPath = preferences.getPushToApplicationPreferences().getCommandPaths().get(this.getDisplayName());
+
+        // Check if a path to the command has been specified


Please remove these kinds of comments - there are clear form the code.

koppor · 2024-10-21T11:26:28Z

src/main/java/org/jabref/gui/push/AbstractPushToApplication.java

+    protected String[] jumpString(Path fileName, int line, int column) {
+        return new String[0];
+    }
+
+    public void publicJumpToLine(Path fileName, int line, int column) {
+        jumpToLine(fileName, line, column);
+    }


What are these methods for? I think, they can be deleted?

u7465990 · 2024-10-22T06:23:17Z

The fetcher tests is failled. But I didn't change any code relate to the internet. How should I fix it?

Siedlerchr · 2024-10-22T06:32:21Z

You can ignore the fetcher tests if you did not change the fetchers Ricky-Du ***@***.***> schrieb am Di., 22. Okt. 2024, 08:23:

…

The fetcher tests is failled. But I didn't change any code relate to the internet. How should I fix it? — Reply to this email directly, view it on GitHub <#12044 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACOFZB4QZIBHJ54WHXWHGTZ4XVOZAVCNFSM6AAAAABQJFOXXWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMRYGM2TOOJYHA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

u7465990 · 2024-10-22T07:09:04Z

You can ignore the fetcher tests if you did not change the fetchers Ricky-Du @.> schrieb am Di., 22. Okt. 2024, 08:23:
…
The fetcher tests is failled. But I didn't change any code relate to the internet. How should I fix it? — Reply to this email directly, view it on GitHub <#12044 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACOFZB4QZIBHJ54WHXWHGTZ4XVOZAVCNFSM6AAAAABQJFOXXWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMRYGM2TOOJYHA . You are receiving this because you are subscribed to this thread.Message ID: @.>

Thanks

…11996 # Conflicts: # .github/workflows/on-review-submitted.yml # src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java # src/main/java/org/jabref/logic/bibtex/InvalidFieldValueException.java # src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java

koppor · 2024-10-23T08:45:44Z

@u7465990 I assume you used git rebase. Please use git merge upstream/main, this performs better. -- I fixed the merge conflicts for you to let the CI do its work here.

koppor · 2024-10-23T08:46:03Z

src/main/java/org/jabref/gui/entryeditor/LatexCitationsTabViewModel.java

@@ -154,6 +160,26 @@ public void onDirectoryDelete(File directory) {
        };
    }

+    // Handle mouse click event


Remove obsolete comment - next line states the same

koppor · 2024-10-23T08:46:09Z

src/main/java/org/jabref/gui/entryeditor/LatexCitationsTabViewModel.java

@@ -154,6 +160,26 @@ public void onDirectoryDelete(File directory) {
        };
    }

+    // Handle mouse click event
+    public void handleMouseClick(MouseEvent event, CitationsDisplay citationsDisplay) {
+        // Get the currently selected item


Remove obsolete comment - next line states the same

koppor · 2024-10-23T08:46:14Z

src/main/java/org/jabref/gui/entryeditor/LatexCitationsTabViewModel.java

+        // Get the currently selected item
+        Citation selectedItem = citationsDisplay.getSelectionModel().getSelectedItem();
+
+        // Check if the left mouse button was double-clicked


Remove obsolete comment - next line states the same

koppor · 2024-10-23T08:46:28Z

src/main/java/org/jabref/gui/entryeditor/LatexCitationsTabViewModel.java

+
+        // Check if the left mouse button was double-clicked
+        if (event.getButton() == MouseButton.PRIMARY && event.getClickCount() == 2 && selectedItem != null) {
+            // Perform a jump or other actions


Remove obsolete comment - next line states the same

koppor · 2024-10-23T08:46:36Z

src/main/java/org/jabref/gui/push/AbstractPushToApplication.java

+    /**
+     * This function is to jump to a specific line due to different editor.
+     *
+     */


Remove obsolete comment - next line states the same

koppor · 2024-10-23T08:49:45Z

src/main/java/org/jabref/gui/push/AbstractPushToApplication.java

+     * This function is to jump to a specific line due to different editor.
+     *
+     */
+    protected void jumpToLine(Path fileName, int line, int column, ProcessBuilder processBuilder) {


Never overridden. Not sure why it is separated of jumpToLine(Path fileName, int line, int column). Inline it to

public void jumpToLine(Path fileName, int line, int column) {

src/main/java/org/jabref/gui/push/AbstractPushToApplication.java

src/main/java/org/jabref/gui/push/PushToApplicationCommand.java

koppor · 2024-10-23T08:52:57Z

src/main/java/org/jabref/gui/push/PushToTeXstudio.java

+    /**
+     * Method to open TeXstudio at the given line number in the specified LaTeX file.
+     */


Remove obsolete comment - next line states the same

…ke TeXworks works for this feature

…990/jabref into feature-latex-editor#11996 Do the update.

koppor

Something was wrong when doing git merge upstream/main.

Fix submodules - follow the steps at https://devdocs.jabref.org/code-howtos/faq.html#fix
feature-latex-editor#11996 file.

koppor · 2024-10-23T10:31:30Z

.github/workflows/on-review-submitted.yml

@@ -0,0 +1,21 @@
+name: On reviewed PR


Why is this appearing - I removed in main. Please remove this file from your branch.

koppor · 2024-10-23T10:34:05Z

src/main/java/org/jabref/gui/push/PushToEmacs.java

@@ -147,4 +148,9 @@ protected String getCommandName() {
    public PushToApplicationSettings getSettings(PushToApplication application, PushToApplicationPreferences preferences) {
        return new PushToEmacsSettings(application, dialogService, this.preferences.getFilePreferences(), preferences);
    }
+
+    @Override
+    protected String[] jumpString(Path fileName, int line, int column) {


Rename to jumpToLineCommandlineArguments (or similar)

koppor · 2024-10-23T10:34:27Z

src/main/java/org/jabref/gui/push/PushToTeXstudio.java

+
+    @Override
+    public String[] jumpString(Path fileName, int line, int column) {
+        // Construct the TeXstudio command


Remvoe comment. It is clear from the context.

koppor · 2024-10-23T10:36:04Z

src/main/java/org/jabref/gui/push/PushToTeXworks.java

+
+    @Override
+    protected String[] jumpString(Path fileName, int line, int column) {
+        // didn't find any command to jump to a specific line


Suggested change

// didn't find any command to jump to a specific line

// No command known to jump to a specific line

Please enter the commit message for your changes. Lines starting

…I hope it's working.

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".

…11996

koppor · 2024-10-23T18:04:03Z

I fixed merge conflicts with upstream/main and refactored some code. The vim code looks strange. The other method has "--remote-send", the new method does not make use of "--remote-send". However, this is not important, can be refined in a follow-up PR (if users have suggestions).

koppor

Tested with TeXsudio. Works.

koppor

Works. Needed to add CHANGELOG.md entry.

u7465990 · 2024-10-23T23:16:04Z

Thanks. I plan to add the vscode as a push target. Should I open a new issue for this?

Siedlerchr · 2024-10-24T05:32:21Z

Just create a new pr

u7465990 added 6 commits October 20, 2024 22:17

First version of the double click issue

066bbab

First version to use double click to open TeXstudio

b0821bf

Merge branch 'main' into feature-latex-editor#11996

87b5750

change the click count to two

84fdf95

I set the GitHub page for the test

7f95c8b

Replace exec() with ProcessBuilder and printStackTrace() with LOGGER

a41d5dd

ThiloteE changed the title ~~Feature latex editor#11996~~ Double click on citation opens LaTeX editor Oct 21, 2024

koppor requested changes Oct 21, 2024

View reviewed changes

u7465990 added 3 commits October 22, 2024 15:55

change some useless functions

677c604

I solve the csl-styles submodel problem

52158ee

Solve the avvrv.jabref.org conflict

eef355e

u7465990 and others added 3 commits October 23, 2024 14:45

The double click function works fine for the emacs external program

998659c

The double click function works fine for the TeXworks external program

1c22c56

koppor requested changes Oct 23, 2024

View reviewed changes

u7465990 added 7 commits October 23, 2024 20:22

I changed the required code. I also delete some useless comment. I ma…

8294e73

…ke TeXworks works for this feature

finished texWorks and delete some comments

45c6777

delete some comments

ac62f2d

solve conflicts

0731c36

Merge branch 'feature-latex-editor#11996' of https://github.com/u7465…

1387c4b

…990/jabref into feature-latex-editor#11996 Do the update.

solve untrack files

6bf9f30

I make Sublime Text works for this feature

1372e2a

koppor requested changes Oct 23, 2024

View reviewed changes

I make WinEdt works for this feature

7944ee3

u7465990 added 4 commits October 23, 2024 21:52

Fix csl-styles

d120835

Please enter the commit message for your changes. Lines starting

Fix abbrv.jabref.org submodules

6afaaef

I make Vim works for this feature

b7b2312

I rewrite jumpToLine for TexShop. But I don't hava a Mac OS machine. …

b5040b3

…I hope it's working.

github-actions bot reviewed Oct 23, 2024

View reviewed changes

u7465990 and others added 9 commits October 23, 2024 23:45

Delete the JumpToLine in TeXshop and a comment line in TeXstudio

5d0bbfb

Fix submodules (and wrong file)

ac33148

Merge remote-tracking branch 'origin/main' into feature-latex-editor#…

2d456a5

…11996

Fix empty lines

f48766b

Default should be TeXstudio

b6bbf06

Remvoe "Integer.format" (and add test)

e117247

Fix PushToVim

551b074

Cleanup PushToLyx

61395fa

Refactor PushToVim

aeedbb4

koppor previously approved these changes Oct 23, 2024

View reviewed changes

Add CHANGELOG.md entry

3b9fbac

koppor dismissed their stale review via 3b9fbac October 23, 2024 18:06

koppor enabled auto-merge October 23, 2024 18:06

koppor approved these changes Oct 23, 2024

View reviewed changes

koppor added this pull request to the merge queue Oct 23, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 23, 2024

koppor added this pull request to the merge queue Oct 23, 2024

Merged via the queue into JabRef:main with commit c3e5621 Oct 23, 2024
23 checks passed

u7465990 deleted the feature-latex-editor#11996 branch October 23, 2024 23:17

This was referenced Oct 26, 2024

Add VScode #12089

Merged

Double click citation for te xworks #12106

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Double click on citation opens LaTeX editor #12044

Double click on citation opens LaTeX editor #12044

u7465990 commented Oct 21, 2024 •

edited by ThiloteE

Loading

ThiloteE commented Oct 21, 2024

Linking a pull request to an issue using a keyword

u7465990 commented Oct 21, 2024

koppor left a comment

koppor Oct 21, 2024

koppor Oct 21, 2024

koppor Oct 21, 2024

koppor Oct 21, 2024

koppor Oct 21, 2024

koppor Oct 21, 2024

u7465990 commented Oct 22, 2024

Siedlerchr commented Oct 22, 2024 via email

u7465990 commented Oct 22, 2024

koppor commented Oct 23, 2024

koppor Oct 23, 2024

koppor Oct 23, 2024

koppor Oct 23, 2024

koppor Oct 23, 2024

koppor Oct 23, 2024

koppor Oct 23, 2024

koppor Oct 23, 2024

koppor left a comment

koppor Oct 23, 2024

koppor Oct 23, 2024

koppor Oct 23, 2024

koppor Oct 23, 2024

github-actions bot left a comment

koppor commented Oct 23, 2024

koppor left a comment

koppor left a comment

u7465990 commented Oct 23, 2024

Siedlerchr commented Oct 24, 2024

	// didn't find any command to jump to a specific line
	// No command known to jump to a specific line

Double click on citation opens LaTeX editor #12044

Double click on citation opens LaTeX editor #12044

Conversation

u7465990 commented Oct 21, 2024 • edited by ThiloteE Loading

Mandatory checks

ThiloteE commented Oct 21, 2024

Linking a pull request to an issue using a keyword

Example:

u7465990 commented Oct 21, 2024

koppor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

u7465990 commented Oct 22, 2024

Siedlerchr commented Oct 22, 2024 via email

u7465990 commented Oct 22, 2024

koppor commented Oct 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koppor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

koppor commented Oct 23, 2024

koppor left a comment

Choose a reason for hiding this comment

koppor left a comment

Choose a reason for hiding this comment

u7465990 commented Oct 23, 2024

Siedlerchr commented Oct 24, 2024

u7465990 commented Oct 21, 2024 •

edited by ThiloteE

Loading