Issue 13619 Make Citation relations text more clear. by ankamde · Pull Request #13620 · JabRef/jabref

ankamde · 2025-07-31T14:46:47Z

Closes #13619

Make Citation Relations tab panes more descriptive.

Steps to test

Start JabRef
Click on "New exmaple library"
Select "Ding_2006"
Select tab "Citatoin relations"

Mandatory checks

I own the copyright of the code submitted and I license 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 (if change is visible to the user)
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.

koppor · 2025-07-31T14:53:33Z

-        styleLabel(citedByLabel);
+        Label citingLabel = new Label(Localization.lang("References (cites)"));
+        styleLabel(citingLabel, Localization.lang("Works cited by the work at hand"));
+        Label citedByLabel = new Label(Localization.lang("Citations (this paper is cited by)"));


Remove "this paper is" --> consistent with "cites"

Otherwiese,

References (this paper cites)

But this is too long IMHO

koppor

Tried out. Looks fine.

Need to ask @ThiloteE and @subhramit if they also like it.

koppor · 2025-07-31T15:08:17Z

Tooltip screenshots: See PR description

koppor · 2025-07-31T15:22:50Z

+Citations\ (cited\ by)=Citations (cited by)
+References\ (cites)=References (cites)


We need an ADR for that. --> new file at https://github.com/JabRef/jabref/tree/main/docs/decisions

Other developers will come with the final wording - we have some internal discussions now.

This is Option 2

Also link to semantic scholar somethow

Option 3 is the thing as it has been

Option 4

DBLP uses "References" and "Cited by"

See https://dblp.org/rec/conf/zeus/VoigtKW21.html

Option 5

Reason: This lead to discussions and surely will lead to discussions in the future, too. And we need to ensure that the discussions to not start from zereo

The ADR needs to be linked from the code (CitationRelationsTab, line 153)

We did it for ourselves - just for rerence: #13621 - no need for you to work on this.

subhramit

Currently the text and tooltips cover everything we discussed, so IMO this is fine.

koppor

We finally came up with other terms.

Sorry for the additional effort.

koppor · 2025-07-31T20:43:02Z

-        styleLabel(citingLabel);
-        Label citedByLabel = new Label(Localization.lang("Cited By"));
-        styleLabel(citedByLabel);
+        Label citingLabel = new Label(Localization.lang("References (cites)"));


Use "References cited in %0".

For %ß use citationkey of of the bib entry. if not available, use Localization.lang("this entry"). You need to do this assignment at another place - constant field.

koppor · 2025-07-31T20:43:43Z

-        styleLabel(citedByLabel);
+        Label citingLabel = new Label(Localization.lang("References (cites)"));
+        styleLabel(citingLabel, Localization.lang("Works cited by the work at hand"));
+        Label citedByLabel = new Label(Localization.lang("Citations (cited by)"));


Use "References that cite %0". %0 as above.

koppor · 2025-07-31T20:45:08Z

-        Label citedByLabel = new Label(Localization.lang("Cited By"));
-        styleLabel(citedByLabel);
+        Label citingLabel = new Label(Localization.lang("References (cites)"));
+        styleLabel(citingLabel, Localization.lang("Works cited by the work at hand"));


Use

Also called "backward citations"

koppor · 2025-07-31T20:45:22Z

+        Label citingLabel = new Label(Localization.lang("References (cites)"));
+        styleLabel(citingLabel, Localization.lang("Works cited by the work at hand"));
+        Label citedByLabel = new Label(Localization.lang("Citations (cited by)"));
+        styleLabel(citedByLabel, Localization.lang("Works citing the work at hand"));


Use

Also called "forward citations"

koppor · 2025-07-31T20:45:53Z

+Citations\ (cited\ by)=Citations (cited by)
+References\ (cites)=References (cites)


We did it for ourselves - just for rerence: #13621 - no need for you to work on this.

…ontab/CitationRelationsTab.java

trag-bot · 2025-08-02T10:36:32Z

@trag-bot didn't find any issues in the code! ✅✨

* upstream/main: Issue 13619 Make Citation relations text more clear. (#13620) Explain how to handle notifications (#13630) Fix scope of 'determine issue number' job (#13627) Add proper closing (#13626) Implement logic orchestration for Git Pull/Push operations (#13518) Make pattern for issue number more strict Fix "Cannot load file MultiMergeEntries.fxml" (#13624) Add Copy markdown to copy citation (#13387) Add ADR-0047 (#13621) Initial start of implementing a LSP for integrity checks (#13612) Refactor merge entries package structure (#13614) New Crowdin updates (#13616) BibEntry class no longer implements Cloneable (#13615) Fix dark mode in {} of Citation Relations tab of the entry editor (#13609) Update dependency org.kohsuke:github-api to v2.0-rc.4 (#13611) Fix setting of proxy without password (#13605)

ankamde added 3 commits July 31, 2025 16:44

Issue 13619 Make Citation relations text more clear.

2cee4fb

Add missing CHANGELOG.md entry.

1aa4684

Improve javadoc.

e305f99

ankamde marked this pull request as ready for review July 31, 2025 14:50

koppor requested changes Jul 31, 2025

View reviewed changes

Addressing PR comments

f726528

ankamde requested a review from koppor July 31, 2025 15:01

koppor approved these changes Jul 31, 2025

View reviewed changes

koppor reviewed Jul 31, 2025

View reviewed changes

koppor added status: awaiting-second-review For non-trivial changes component: citation-relations labels Jul 31, 2025

subhramit previously approved these changes Jul 31, 2025

View reviewed changes

koppor mentioned this pull request Jul 31, 2025

Add ADR-0047 #13621

Merged

1 task

koppor requested changes Jul 31, 2025

View reviewed changes

koppor removed the status: awaiting-second-review For non-trivial changes label Jul 31, 2025

Addressing PR comments.

c932ea6

ankamde dismissed subhramit’s stale review via c932ea6 August 1, 2025 13:32

ankamde requested review from koppor and subhramit August 1, 2025 13:46

koppor reviewed Aug 2, 2025

View reviewed changes

Comment thread jabgui/src/main/java/org/jabref/gui/entryeditor/citationrelationtab/CitationRelationsTab.java Outdated

Update jabgui/src/main/java/org/jabref/gui/entryeditor/citationrelati…

2d2f0b7

…ontab/CitationRelationsTab.java

koppor previously approved these changes Aug 2, 2025

View reviewed changes

koppor enabled auto-merge August 2, 2025 10:23

Fix language file

271e739

koppor dismissed their stale review via 271e739 August 2, 2025 10:35

koppor approved these changes Aug 2, 2025

View reviewed changes

koppor added this pull request to the merge queue Aug 2, 2025

Merged via the queue into JabRef:main with commit 796b419 Aug 2, 2025
1 check passed

github-actions Bot mentioned this pull request Aug 2, 2025

Make citation relations text more clear #13619

Closed

		Citations\ (cited\ by)=Citations (cited by)
		References\ (cites)=References (cites)

Uh oh!

Conversation

ankamde commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps to test

Mandatory checks

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

koppor commented Jul 31, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

subhramit left a comment

Choose a reason for hiding this comment

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trag-bot Bot commented Aug 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ankamde commented Jul 31, 2025 •

edited

Loading