Merge "Citation information" and "Citation relations" #13618#14045
Conversation
…"Citations") and removed SciteTab from view in EntryEditor.
…method to new class ScienceAiFetcher.java. Moved SciteTallyModel to jabref.model.sciteTallies and renamed to TalliesResponse.
Hey @Mitkens374!Thank you for contributing to JabRef! Your help is truly appreciated ❤️. We have automatic checks in place, based on which you will soon get automated feedback if any of them are failing. Please re-check our contribution guide in case of any other doubts related to our contribution workflow. |
|
Since this is GUI related, please provide screenshots of "Before" and "After". |
calixtus
left a comment
There was a problem hiding this comment.
Hi, thank you for you PR, we really appreciate it. So far the changes to the code look mostly fine. I put some comments into.
Now we need to talk about the visuals... You designed it after the proposal in the issue description, functionally the important part is done. But the proposal in the issue is not good. Now it looks like everything is just stacked in top of each other.
Idea is: You sure want to indicate that these informations come from different sources: citation relations from semantic scholar and metrics from scite.ai.
Please make a proposal to make this look nice. Look at other software how they do it. Fetch some ideas from ui design forums.
| private static final String SEMANTIC_SCHOLAR_URL = "https://www.semanticscholar.org/"; | ||
| private static final String SCITE_REPORTS_URL_BASE = "https://scite.ai/reports/"; | ||
| private static final String SCITE_URL = "https://scite.ai/"; | ||
|
|
There was a problem hiding this comment.
Please put the URL constants to the dedicated helper class URLs.
|
Thanks for the comments, I will start working on the needed changes. In the case of the "Source branch is other than "main"" check, should I close this request and make a new one with a correctly named branch? |
No, just finish this one. But for next time, remember, that for creating a fix or a feature creating a new branch is git 101. |
…ss. Added nicer styling to the Citations tab.
…ss. Added nicer styling to the Citations tab.
|
Imagine you were just an average user, you have no idea about java programming, scite.ai or semantic scholar. What information would the titles provide? The source of the information. Nice to know, but certainly not the title. Compare your design to other software. Good UI design is likewise important as the code itself and requires planning, effort and interest. |
|
I would add just add a help button/tooltip opening a user documentation page explaining where the data is coming from. |
…explaining the source and linking to the respective page.
| } | ||
|
|
||
| private VBox getMessageBox(String url, Text message) { | ||
| HyperlinkLabel link = new HyperlinkLabel(Localization.lang("See full report at [%0]", url)); |
There was a problem hiding this comment.
I think "See full report" could be in the same line as the other info, right next to "Citing Publications". The url doesn't necessarily have to be shown to the user, as long as they can click somewhere that will lead them to the webpage, so just turn "See full report" into the link itself and it will be possible to remove the useless "at" and the url, thereby saving screenspace and making it a little bit more beautiful.
There was a problem hiding this comment.
Hi, thanks for the idea. I have made the Citation Metrics section into a single line with the report link at the end. For better separation of the text, I broke up the former message into separate elements, which are added to the display with a " | " as a separator. This way the link in the last element always has the same spacing also.
There was a problem hiding this comment.
Much better. And the longer I look at it, i think even the titles themselves can be abolished.
The title: "Metrics" could also sit in the same line as the metrics themselves ("Metrics: Total citations ...").
The "Citation Relations" title is imho superfluous as the table and the table headers should be self describing already.
Question is only, where should the help buttons / the proper credit to the information providers go?
Maybe somewhere also as a small hyperlink ("powered by semantic / scite")? Just thinking loud.
I know, titles are nice and many times, they are really important and needed. But in this case, I think "Citations" in the tab bar is already the best title.
In computer science, the hardest thing is naming things, in ui design, the hardest thing is where to place the names maybe.
There was a problem hiding this comment.
Hi, I removed the labels, and I have put the "provided by" helper buttons at the bottom of the tab.
I think that the separation nicely indicates that the sources for the information are different and that the buttons are related to different parts of the tab. I changed the tooltip message as well to make it a bit more clear ("Metrics/Relations provided by...").
I am not entirely sure about the button next to the "See full report" as it may seem a bit redundant maybe? They pretty much link to the same site, but i think keeping the landing page link for scite.ai, somewehere in the tab is a good choice, as there is a lot of information about the service there. On the other hand maybe removing the helper button and adding the tooltip to the "See full report" link, explaining the source and only linking to the full report would make the tab even more clear. I'll let you be the judge of that :D.
There was a problem hiding this comment.
I am okay with this now! LGTM
…entirely in the Metrics line.
|
Thanks a lot for your contribution and the quick changes! |
|
Thank you for the opportunity and for all the notes about the design. UI design is not my strong suit (as you may have guessed :D) so I am very glad that I gained some experience in that field, and that in the end we managed to create something nice :D. |
…abRef#14045) * Merged scite metrics tab into the Citation Relations Tab (now called "Citations") and removed SciteTab from view in EntryEditor. * Removed SciteTab.java and SciteTabViewModel.java. Moved fetchTallies method to new class ScienceAiFetcher.java. Moved SciteTallyModel to jabref.model.sciteTallies and renamed to TalliesResponse. * Added info to CHANGELOG.md. * CHANGELOG formatting. * Updated CHANGELOG.md after PR comments. Moved URLs to URLs helper class. Added nicer styling to the Citations tab. * Updated CHANGELOG.md after PR comments. Moved URLs to URLs helper class. Added nicer styling to the Citations tab. * Added missing localization keys and removed obsolete localization keys. * Added localization to citation tab labels * Renamed labels in Citations tab and added a help button with a popup explaining the source and linking to the respective page. * Updated Citation Metrics section to a single line * Made Citation Metrics a single line. Also broke up its text into elements to have better separation. * Removed labels in the Citations tab. The provided by buttons are now entirely in the Metrics line. --------- Co-authored-by: Mitkens374 <michal.leso@student.tuke.sk>
…abRef#14045) * Merged scite metrics tab into the Citation Relations Tab (now called "Citations") and removed SciteTab from view in EntryEditor. * Removed SciteTab.java and SciteTabViewModel.java. Moved fetchTallies method to new class ScienceAiFetcher.java. Moved SciteTallyModel to jabref.model.sciteTallies and renamed to TalliesResponse. * Added info to CHANGELOG.md. * CHANGELOG formatting. * Updated CHANGELOG.md after PR comments. Moved URLs to URLs helper class. Added nicer styling to the Citations tab. * Updated CHANGELOG.md after PR comments. Moved URLs to URLs helper class. Added nicer styling to the Citations tab. * Added missing localization keys and removed obsolete localization keys. * Added localization to citation tab labels * Renamed labels in Citations tab and added a help button with a popup explaining the source and linking to the respective page. * Updated Citation Metrics section to a single line * Made Citation Metrics a single line. Also broke up its text into elements to have better separation. * Removed labels in the Citations tab. The provided by buttons are now entirely in the Metrics line. --------- Co-authored-by: Mitkens374 <michal.leso@student.tuke.sk>




Closes #13618
Merged "Citation information" into "Citation relations" tab, now called Citations. Removed old SciteTab and SciteTabViewModel classes, as their logic is now entirely in CitationRelationsTab and CitationRelationsTabViewModel respectively. Created new class ScienceAiFetcher, for fetching tallies from scite.ai, utilizing new TalliesResponse record.
Steps to test
Before:
After:
Mandatory checks
CHANGELOG.mdin a way that is understandable for the average user (if change is visible to the user)