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

Allow user to choose CSL Bibliography title and format #12663

Open
2 tasks
subhramit opened this issue Mar 9, 2025 · 6 comments
Open
2 tasks

Allow user to choose CSL Bibliography title and format #12663

subhramit opened this issue Mar 9, 2025 · 6 comments
Assignees
Milestone

Comments

@subhramit
Copy link
Member

subhramit commented Mar 9, 2025

This is a "contextual" introductory issue for people wanting to dive into JabRef's LibreOffice integration.
It is a small/medium-sized task with the overall difficulty of a good third or fourth issue.

Context

Pre-requisites

Refer to this blog article for an introduction to how CSL styles are used with JabRef's LibreOffice integration.

Issue

Currently, we have a hardcoded default title and its paragraph format for the CSL Bibliography as given in CSLFormatUtils:

// TODO: These are static final fields right now, should add the functionality to let user select these and store them in preferences.
public static final String DEFAULT_BIBLIOGRAPHY_TITLE = "References";
public static final String DEFAULT_BIBLIOGRAPHY_HEADER_PARAGRAPH_FORMAT = "Heading 2";

We wish to provide flexibility to users such that they can set a different title for the list of references (e.g. "Bibliography", or some other word/phrase in English or other languages) as well as choose its formatting.

The current workaround is that the user manually modifies it themselves once all their work is over - as otherwise the title will get reset every time the bibliography is refreshed (due to addition/deletion/rearrangement of citations, or manual trigger).

In case of JStyles, this problem does not exist as they are custom styles, and the user can provide their intended values when making the .jstyle file:

PROPERTIES
Title="References"
IsSortByPosition="false"
IsNumberEntries="false"
ReferenceParagraphFormat="Text body"
ReferenceHeaderParagraphFormat="Heading 2"

Task

  1. Add an option in the "CSL Styles" tab of the "Select Style" window (in the OpenOffice/LibreOffice Panel) to "modify bibliography title". On clicking that, the user should be given options to set the text for the title and its format

    Image

    • The options for format should be available via a dropdown, and should consist of the popular presets in paragraph style formatting options as available in LibreOffice:

      Image
      The mechanism to apply the formatting does not need to be written, as it is already present. Just specifying the format name is enough. The default (if unchanged), however, should still remain "Heading 2".

  2. These settings should be saved as user preferences in OpenOfficePreferences.

Test for completion

  • The specified text should be rendered as the bibliography title on generating bibliography via CSL styles.
  • The options should be stored across JabRef sessions.
@IvanPetkov23
Copy link
Contributor

/assign-me

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

👋 Hey @IvanPetkov23, 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 45 days (by 24 April 2025). A maintainer can also add the "📌 Pinned"" label to prevent automatic unassignment.

@IvanPetkov23
Copy link
Contributor

/unassign-me

@github-actions github-actions bot removed the 📍 Assigned Assigned by assign-issue-action (or manually assigned) label Mar 13, 2025
Copy link
Contributor

👋 Hey @IvanPetkov23, you've been automatically unassigned from this issue due to inactivity.

Note

If you'd like to be re-assigned, just leave another comment or ask a maintainer to assign you again.
If you're still actively working on the issue, let us know by commenting, and we can pin it to prevent automatic unassignment.

@priyanshu16095
Copy link
Contributor

/assign-me

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

👋 Hey @priyanshu16095, 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 there is not a (draft) pull request within 14 days (by 31 March 2025).

@koppor koppor moved this from Free to take to Assigned 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
Projects
Status: Assigned
Development

No branches or pull requests

4 participants