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

Default journal abbreviation setting #11305

Open
tobiasdiez opened this issue May 20, 2024 · 7 comments
Open

Default journal abbreviation setting #11305

tobiasdiez opened this issue May 20, 2024 · 7 comments

Comments

@tobiasdiez
Copy link
Member

Is your suggestion for improvement related to a problem? Please describe.

It is possible to change the abbreviation of a journal using the button next to the journal or journaltitle field. However, it is not possible to declare once and for all that one would like to always have abbreviated journals, which then should be respected by the importer and fetchers.

Describe the solution you'd like

  • An option in the preferences to make "(un)abbreviated journals" the default
  • Fetchers automatically convert the api responses to adhere to this setting
  • Add option in "Cleanup entries" to (un)abbreviate journal titles
@MattBryantt
Copy link

Hi, I'd like to take on this issue as part of my university assignment if it's still available! Thanks very much.

@ThiloteE ThiloteE moved this from Free to take to Assigned in Candidates for University Projects Oct 10, 2024
@ThiloteE ThiloteE added the FirstTimeCodeContribution Triggers GitHub Greeter Workflow label Oct 10, 2024
Copy link
Contributor

Welcome to the vibrant world of open-source development with JabRef!

Newcomers, 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! 🚀

@koppor
Copy link
Member

koppor commented Oct 16, 2024

* Add option in "Cleanup entries" to (un)abbreviate journal titles

@tobiasdiez Is this really necessary? We already have this in the "Quality" menu.

Image

@tobiasdiez
Copy link
Member Author

It's perhaps not super important but it's more convenient. Once you have configured your preferred abbreviation in the cleanup dialog, it's only one click after an import to properly format all fields of all new entries. Otherwise you have to remember to also abbreviate the journal names after the import + cleanup.

(We might want to remove these abbreviation commands under "Quality" once they can be run via the cleanup.)

@koppor
Copy link
Member

koppor commented Oct 19, 2024

The sub task "Add option in "Cleanup entries" to (un)abbreviate journal titles" is not part of this issue any more. It is a seperate issue #11791.

The other two subtasks remain.

The settings goes to "Web Search"

Image

Put the functionality into org.jabref.logic.importer.ParserFetcher#doPostCleanup.

One needs to move the functionality of org.jabref.gui.journals.UndoableAbbreviator#abbreviate to a cleanup action. This is also done at #11791 (comment), but I don't know, when this is finished.

@MattBryantt
Copy link

To clarify, should the functionality for the second subtask:

* Fetchers automatically convert the api responses to adhere to this setting

be placed in org.jabref.logic.importer.ParserFetcher#doPostCleanup as mentioned? Or is this only referring to the now separate 3rd subtask? If so, I'm confused as to where the functionality for abbreviating journals should be placed. The most relevant fetcher I can identify is org.jabref.logic.importer.fetcher.JournalInformationFetcher, however this doesn't currently access the ImporterPreferences (to check if a user wants to have abbreviated journals as per the first subtask), so I am unsure about this approach. Thanks!

@koppor
Copy link
Member

koppor commented Oct 20, 2024

To clarify, should the functionality for the second subtask:\n\n* Fetchers automatically convert the api responses to adhere to this setting\nbe placed in org.jabref.logic.importer.ParserFetcher#doPostCleanup as mentioned

Yes.

See https://devdocs.jabref.org/code-howtos/fetchers.html for information about fetchers. Maybe you can try out some to see that nearly all of them return @article.

@github-project-automation github-project-automation bot moved this to Normal priority in Prioritization Nov 13, 2024
@koppor koppor removed the FirstTimeCodeContribution Triggers GitHub Greeter Workflow label Dec 9, 2024
@koppor koppor moved this from In Progress to Free to take in Candidates for University Projects Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Free to take
Status: Normal priority
Development

Successfully merging a pull request may close this issue.

4 participants