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

Store journal lists in separate directory #10557

Open
koppor opened this issue Oct 23, 2023 · 16 comments · May be fixed by #12544
Open

Store journal lists in separate directory #10557

koppor opened this issue Oct 23, 2023 · 16 comments · May be fixed by #12544
Assignees
Labels
📍 Assigned Assigned by assign-issue-action (or manually assigned) component: journal abbreviations good first issue An issue intended for project-newcomers. Varies in difficulty. 📌 Pinned

Comments

@koppor
Copy link
Member

koppor commented Oct 23, 2023

Background

  • JabRef offers journal abbreviations. They are described at https://docs.jabref.org/advanced/journalabbreviations.
  • JabRef has a data directory. On Windows, it is located at %APPDATA%\..\local\org.jabref\jabref. JabRef should make use of this folder.
  • As default, JabRef offers the "JabRef built in list" only
    a
  • Custom journal abbreviations are shown as file name
    b
  • Currently, the user has to choose the directory for each file

Feature

Journal abbreviation lists should be placed in a single directory.
As default, that directory is %APPDATA%\..\local\org.jabref\jabref\journal-abbreviations` (Windows)

  • User can change the directory (in the preference dialog. The directory is stored as preference)
  • JabRef creates custom.csv in that directory if it does not exist. This way, JabRef always has a .csv available in the preferences, which the user can choose (to add new abbreviations to)
  • JabRef should automatically detect journal lists in that directory and process it:
    • JabRef automatically converts the .csv files there in .mv store files if the timestamp of the csv is newer ("compilation" by JabRef). This especially includes custom.csv from before
    • JabRef knows the lists by listing *.mv in that directory
@koppor koppor added the good first issue An issue intended for project-newcomers. Varies in difficulty. label Oct 23, 2023
@github-project-automation github-project-automation bot moved this to Free to take in Good First Issues Oct 23, 2023
@koppor koppor moved this from Free to take to Reserved in Candidates for University Projects Oct 23, 2023
@koppor koppor moved this from Free to take to Reserved in Good First Issues Oct 23, 2023
@koppor koppor added the FirstTimeCodeContribution Triggers GitHub Greeter Workflow label Oct 23, 2023
@0scvr 0scvr removed their assignment Oct 26, 2023
@MathewKnee
Copy link

Hi all, hope everything is going well! I'm really interested in tackling this issue as a beginner, could I take it?

@ThiloteE
Copy link
Member

Sure, go ahead.

@anii1827
Copy link

anii1827 commented Nov 20, 2023

I have setup the code base on Linux OS. I am looking for the journal abbreviations default list in Linux directory but unable to find. also I downloaded the Jebref from website. I can see the complete journal abbreviations list but in local development running version I can only see one demo entry.

downloaded version.
image

Development version:
development version screenshot

@ThiloteE
Copy link
Member

Koppor answered your question in Gitter I believe.

@Azgharpasha
Copy link

Hi @MathewKnee @koppor regarding Issue #10557
As, mentioned in above steps . I added the new file in my local directory as shown below image .
journalpreferences

I added some journal abbreviations in test.csv file as shown below
image

and I am able to see the journal in my jabref GUI as shown below
image

but I am unable to add abbreviations from jabref but unable to understand what actually explained in Feature in above issue.
I have't done any code level changes .
image

any suggestion to understand it clearly and should be able to journal abbreviations from jabref GUI itself and it should be saved in my custom test.csv file in my custom directory I have implemented.

@koppor
Copy link
Member Author

koppor commented Jan 25, 2024

@Azgharpasha You have to press enter to get the value accepted. External issue: https://bugs.openjdk.org/browse/JDK-8089514

@ThiloteE ThiloteE moved this from Reserved to In Progress in Candidates for University Projects Feb 28, 2024
@Siedlerchr Siedlerchr moved this from In Progress to Free to take in Candidates for University Projects Mar 25, 2024
@Siedlerchr Siedlerchr moved this from Reserved to Free to take in Good First Issues Mar 25, 2024
@Mohamad-e
Copy link

Hey, Is this issue still open? I would like to tackle this task as my first contribution.

@ThiloteE ThiloteE moved this from Free to take to Reserved in Candidates for University Projects Aug 1, 2024
@ThiloteE ThiloteE moved this from Free to take to Reserved in Good First Issues Aug 1, 2024
@JabRef JabRef deleted a comment from github-actions bot Aug 1, 2024
@ThiloteE ThiloteE added FirstTimeCodeContribution Triggers GitHub Greeter Workflow and removed FirstTimeCodeContribution Triggers GitHub Greeter Workflow labels Aug 1, 2024
@koppor koppor removed the FirstTimeCodeContribution Triggers GitHub Greeter Workflow label Feb 17, 2025
@koppor
Copy link
Member Author

koppor commented Feb 17, 2025

This strongly relates to #12364 - and can be seen as pre-condition.

@adhamahmad
Copy link

/assign-me

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

👋 Hey @adhamahmad, 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 21 May 2025). A maintainer can also add the "📌 Pinned"" label to prevent automatic unassignment.

@adhamahmad
Copy link

Hi @koppor,

I'm currently working on implementing the MV file conversion feature for the journal abbreviation lists. At present, the internal list that populates the UI consists of CSV file paths. With the new MV conversion in place, I'm trying to understand the intended design and the purpose of this conversion:

  • Data Transformation:
    Should the CSV data be transformed or restructured in a specific way when generating the .mv files, or is a straightforward conversion acceptable?

  • MV File Conversion Purpose:
    Is the goal for the MV files to completely replace the CSV files (i.e., should the UI be populated from the MV files), or are the MV files meant only as a persistent cache while the UI still uses the CSV file paths?

Any clarification on how the MV file conversion is meant to integrate with the journal abbreviation preferences and the UI would be greatly appreciated.

Thank you!

@adhamahmad adhamahmad linked a pull request Feb 23, 2025 that will close this issue
7 tasks
@koppor
Copy link
Member Author

koppor commented Feb 23, 2025

@adhamahmad Please read the existing code. It should answer both questions.

Spoiler: CSV data is taken mostly as is; CSV should be kept as this is the human readble editable form to modify the data. See abbrv.jabref.org

@ThiloteE ThiloteE moved this from Free to take to Assigned in Candidates for University Projects Feb 25, 2025
@ThiloteE ThiloteE moved this from Free to take to Assigned in Good First Issues Feb 25, 2025
@ThiloteE ThiloteE moved this from Assigned to In Progress in Good First Issues Feb 26, 2025
@koppor koppor moved this from Assigned to In Progress in Candidates for University Projects Mar 16, 2025
@github-actions github-actions bot removed the 📍 Assigned Assigned by assign-issue-action (or manually assigned) label Mar 17, 2025
@koppor koppor added the 📍 Assigned Assigned by assign-issue-action (or manually assigned) label Mar 17, 2025
@JabRef JabRef deleted a comment from github-actions bot Mar 17, 2025
@koppor koppor moved this from In Progress to Assigned in Candidates for University Projects Mar 17, 2025
@koppor koppor moved this from In Progress to Assigned in Good First Issues Mar 17, 2025
@koppor koppor moved this from Assigned to Free to take in Candidates for University Projects Mar 17, 2025
@koppor koppor moved this from Assigned to Free to take in Good First Issues Mar 17, 2025
@koppor koppor moved this from Free to take to Assigned in Candidates for University Projects Mar 17, 2025
@koppor koppor moved this from Free to take to Assigned in Good First Issues Mar 17, 2025
@koppor koppor moved this from Assigned to In Progress in Good First Issues Mar 17, 2025
@koppor koppor moved this from Assigned to In Progress in Candidates for University Projects Mar 17, 2025
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 good first issue An issue intended for project-newcomers. Varies in difficulty. 📌 Pinned
Projects
Status: In Progress
Status: In Progress
10 participants