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

Add an option to add "Cited on pages" in JStyle bibliography #11691

Closed
subhramit opened this issue Aug 31, 2024 · 5 comments · Fixed by #11732 or JabRef/user-documentation#516
Closed
Assignees
Labels

Comments

@subhramit
Copy link
Member

subhramit commented Aug 31, 2024

There exists a mechanism in JabRef to add "Cited on pages: ..." to bibliography entries when using JStyle citations.
However, this is presently not accessible to the user to be triggered, thus rendering the feature useless.

Suggestion would be to provide an option to the user to use this feature.

Solution

The solution is simple, albeit will have multiple parts - will require work both on the UI and the backend.

Frontend:

Add an option to use this feature ONLY when a JStyle is selected, maybe somewhere in the OpenOffice Panel Settings:

image

Hint: Use a listener for style type

Backend:

In the OOBibBase class, we have a boolean alwaysAddCitedOnPages, which is presently always set to false:

// Shall we add "Cited on pages: ..." to resolved bibliography entries?
private final boolean alwaysAddCitedOnPages;

Use this to convey the selected option through syncOptions.
Refs. TODO comments added in #11690

Additional:

It would be even better if this can be added as a user preference.
Hint: As an example, see how getOpenOfficePreferences().getSyncWhenCiting() is used to store a similar preference selected from the OO Panel settings.

@subhramit
Copy link
Member Author

subhramit commented Aug 31, 2024

This is a very good issue for anybody fairly well-versed with Java, who wants to get exposed to many aspects of JabRef development. Although this is more of a "good third issue" rather than a "good first issue". It contains three subparts, each of which can individually count as a "good first issue" when it comes to depth of exploration needed.

@subhramit subhramit added component: ui component: libre-office component: preferences good first issue An issue intended for project-newcomers. Varies in difficulty. labels Aug 31, 2024
@github-project-automation github-project-automation bot moved this to Normal priority in JabRef UI Improvements Aug 31, 2024
@github-project-automation github-project-automation bot moved this to Free to take in Good First Issues Aug 31, 2024
@subhramit subhramit changed the title Add an option to add "Always cited on pages" in JStyle bibliography Add an option to add "Cited on pages" in JStyle bibliography Sep 1, 2024
@github-project-automation github-project-automation bot moved this from Free to take to Done in Good First Issues Sep 6, 2024
@github-project-automation github-project-automation bot moved this from Normal priority to Closed in JabRef UI Improvements Sep 6, 2024
@subhramit
Copy link
Member Author

Was this resolved? @Siedlerchr

@Siedlerchr Siedlerchr reopened this Sep 6, 2024
@github-project-automation github-project-automation bot moved this from Closed to Normal priority in JabRef UI Improvements Sep 6, 2024
@github-project-automation github-project-automation bot moved this from Done to In Progress in Good First Issues Sep 6, 2024
@Siedlerchr
Copy link
Member

Siedlerchr commented Sep 6, 2024

Oh no that was accidentally. You can probably help the guy in the gutter chat

@heyitsdross
Copy link
Contributor

Will implement

@ThiloteE ThiloteE moved this from In Progress to Reserved in Good First Issues Sep 6, 2024
@ThiloteE ThiloteE added the FirstTimeCodeContribution Triggers GitHub Greeter Workflow label Sep 6, 2024
Copy link
Contributor

github-actions bot commented Sep 6, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Archived in project
4 participants