Skip to content

Conversation

@Yubo-Cao
Copy link
Collaborator

Closes https://github.com/JabRef/jabref-issue-melting-pot/issues/786

Steps to test

Open JabRef > Citation key tab

image

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • I manually tested my changes in running JabRef (always required)
  • [/] I added JUnit tests for changes (if applicable)
  • I added screenshots in the PR description (if change is visible to the user)
  • I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
  • [/] I checked the user 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 updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

setOnAction(_ -> new HelpAction(helpFile, dialogService, externalApplicationsPreferences).execute());
}

public final StringProperty helpUrlProperty() {
Copy link
Member

@Siedlerchr Siedlerchr Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the idea behind this? updating the help url dynamically?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that we can set this in the FXML :)

@subhramit
Copy link
Member

Localization, rest lgtm

HBox.hgrow="ALWAYS"/>
</HBox>
<HelpButton
helpUrl="https://docs.jabref.org/setup/citationkeypatterns#replace-via-regular-expression"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move this as a constant to URL class to have it in a single place

text="%Key patterns"/>
<VBox alignment="BOTTOM_CENTER" >
<HelpButton
helpUrl="https://docs.jabref.org/setup/citationkeypatterns"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here, move it to Urls class so that there is a single class with all urls, easier for changing

@Siedlerchr
Copy link
Member

still not a fan of putting the direct URLs in the FXML.

@calixtus
Copy link
Member

calixtus commented Oct 9, 2025

Might be great if this can be optional. Is almost ready, we should talk briefly in the next devcall and make a decision here - even finalize it, so we can move forward here.

@calixtus calixtus added component: ui status: devcall component: preferences status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers labels Oct 9, 2025
Copy link
Member

@koppor koppor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should discuss. I think having the URLs at the help buttons makes it easy to add new ones. Having the URLs separately, maintenance could be improved (but we have Ctrl+Shift+F to search for URLs needed to change).

<HBox alignment="BOTTOM_LEFT" spacing="8.0">
<Label styleClass="sectionHeader" text="%Key patterns"/>
<Button fx:id="keyPatternHelp" styleClass="icon-button,narrow" />
<HelpButton helpUrl="https://docs.jabref.org/setup/citationkeypatterns"/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the improvement. Reads nice!

@calixtus
Copy link
Member

Question is, how often do we think, these urls will change?

@subhramit
Copy link
Member

Question is, how often do we think, these urls will change?

I have a very workaround-ish idea to deal with that.
In the docs repo, we create an md file with these links.
Then we configure linkinspektor to run biweekly or monthly on the repository to periodically check if the links still work.
If not, somebody changed the link, so these should be modified as well in the main repo.

We can list and check all such links (not limited to this PR) that are used in fxmls.

@calixtus calixtus changed the title fix: Slightly improved visual consistency of the CitationkeyTab Slightly improved visual consistency of the CitationkeyTab Oct 20, 2025
Siedlerchr and others added 2 commits October 20, 2025 22:08
* upstream/main:
  New study.yml format (JabRef#13844)
  Separate issue linking workflows, make them run on `edited` (JabRef#14121)
calixtus
calixtus previously approved these changes Oct 20, 2025
@calixtus
Copy link
Member

Decision was made with @Siedlerchr to move forward without the tooltip, to get moving.

@calixtus calixtus added this pull request to the merge queue Oct 20, 2025
Merged via the queue into JabRef:main with commit e727dd9 Oct 20, 2025
46 checks passed
merlinymy pushed a commit to merlinymy/jabref that referenced this pull request Nov 19, 2025
)

* fix: Slightly improved visual consistency of the CitationkeyTab

* docs: Update CHANGELOG

* docs: Update CHANGELOG.md

Co-authored-by: Subhramit Basu <[email protected]>

* fix: Make the HelpButton's weird method more clear

* Small fixes

* line breaks

* Remove artifact

* Remove artifact

* l10n

---------

Co-authored-by: Subhramit Basu <[email protected]>
Co-authored-by: Christoph <[email protected]>
Co-authored-by: Carl Christian Snethlage <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component: preferences component: ui status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants