Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support multiple journal abbreviations lists #12364

Open
koppor opened this issue Jan 6, 2025 · 4 comments
Open

Support multiple journal abbreviations lists #12364

koppor opened this issue Jan 6, 2025 · 4 comments
Assignees
Labels
📍 Assigned Assigned by assign-issue-action (or manually assigned) component: journal abbreviations project: gsoc

Comments

@koppor
Copy link
Member

koppor commented Jan 6, 2025

Background

JabREf has suport to abbreviate and unabbreviate journal names: https://docs.jabref.org/advanced/journalabbreviations

With #9504, JabRef has much better internal handling of journal lists.

Feature

The dropdown of JabRef should not show a single "JabRef built in list", but should show the various lists we offer.

Image

Steps:

  1. Create a good title for the list
    1. Option 1: Make https://github.com/JabRef/abbrv.jabref.org/tree/main/journals#readme a table and parse the table
    2. Option 2: Hard-code .csv file and journal list title (This is a quick win)
    3. Option 3: Add title to CSV file (The title could be added (using # which indicates a comment)) - refs second item of Improve journal list handling jabref-koppor#48

Instead of a dropdown, have a list of

  • build-in lists
  • external lists
  • custom list

Similar to "Databases" at SLR:

Image

Or similar to the "Protected Terms File"

Image

Then, one can enable and disable with a click.


Attention: There are dotless and dot abbreviation lists - maybe the UI should distinguish them, too.


  • List of journals will be hard-coded

  • MVStore should store each list in a separate table

  • Converter needs to be adapted

The yellow one should be replaced, the green one should be kept - and updated upon selection change at the yellow one.

Image


Optionally, online lists could be downloaded - User could point to https://github.com/JabRef/abbrv.jabref.org/tree/main/journals and select a list from there - or "just" put a CSV online link.

@Eslam-Radwan
Copy link

/assign-me

@github-actions github-actions bot added the 📍 Assigned Assigned by assign-issue-action (or manually assigned) label Feb 9, 2025
Copy link
Contributor

github-actions bot commented Feb 9, 2025

👋 Hey @Eslam-Radwan, thank you for your interest in this issue! 🎉

We're excited to have you on board. Start by exploring our Contributing guidelines, and don't forget to check out our workspace setup guidelines to get started smoothly.

In case you encounter failing tests during development, please check our developer FAQs!

Having any questions or issues? Feel free to ask here on GitHub. Need help setting up your local workspace? Join the conversation on JabRef's Gitter chat. And don't hesitate to open a (draft) pull request early on to show the direction it is heading towards. This way, you will receive valuable feedback.

Happy coding! 🚀

⏳ Please note, you will be automatically unassigned if the issue isn't closed within 90 days (by 10 May 2025). A maintainer can also add the "📌 Pinned"" label to prevent automatic unassignment.

@Eslam-Radwan
Copy link

@koppor
can you provide more information about the feature and the solution?
I have been reading the code for 2 days and found that there is a JournalAbbreviationRepository class that fetches the abbreviations from somewhere and loads them to the other classes, also I wanted to know what classes should I make or what classes that will be replaced

Thanks in advance

@koppor
Copy link
Member Author

koppor commented Feb 12, 2025

can you provide more information about the feature and the solution?

I currently do not have resources for that. I am sorry.

Note that this is a medium-sized project and requires some understanding of JabRef's code. Maybe move on to another issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📍 Assigned Assigned by assign-issue-action (or manually assigned) component: journal abbreviations project: gsoc
Projects
Status: Free to take
Development

No branches or pull requests

2 participants