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

Blog post: CSL4LibreOffice #97

Merged
merged 19 commits into from
Aug 26, 2024
Merged

Blog post: CSL4LibreOffice #97

merged 19 commits into from
Aug 26, 2024

Conversation

_posts/2024-08-23-GSoC-CSL.md Outdated Show resolved Hide resolved
_posts/2024-08-23-GSoC-CSL.md Outdated Show resolved Hide resolved
_posts/2024-08-23-GSoC-CSL.md Outdated Show resolved Hide resolved
@subhramit subhramit requested a review from koppor August 24, 2024 13:28

If you are interested in the technical details of how this project was undertaken, do check out the [wiki](https://github.com/JabRef/jabref/wiki/GSoC-2024-%E2%80%90-Improved-CSL-Support-%28and-more-LibreOffice%E2%80%90JabRef-integration-enhancements%29).

I hope this new feature enhances your research and writing process. As always, [we welcome your feedback and suggestions for further improvements](https://discourse.jabref.org/c/feedback/3).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use passive voice in second part. "We" sounds strange, b/c all other parts are "I". Since you also welcome feedback too I suggest passive voice

Change to passive voice
@subhramit subhramit requested a review from koppor August 24, 2024 16:58
Copy link
Member

@koppor koppor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more one reads, the more ideas one has 😅


[Citation Style Language](https://citationstyles.org/) (CSL) is a popular open-source specification language that standardizes the formatting of citations and bibliographies. It supports thousands of standard citation styles used in academia, including *American Psychological Association* (APA), *Modern Language Association* (MLA), *Chicago Manual of Style* (CMS), *Institute of Electrical and Electronics Engineers* (IEEE), *Springer - Lecture Notes in Computer Science* and *Vancouver* to name a few. If you've ever cited a source in an academic paper, chances are you've used a CSL-based style.

For several years, JabRef users have been requesting support for CSL in its LibreOffice integration. Tackling this problem statement this summer as a part of my project, I am excited to announce that this highly anticipated feature is now available!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its --> JabRef's


With this integration, JabRef users can now:

1. **Choose a CSL Style**: Select from a vast array of CSL styles to match the requirements of your academic work.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

array? Maybe "collection"?

With this integration, JabRef users can now:

1. **Choose a CSL Style**: Select from a vast array of CSL styles to match the requirements of your academic work.
2. **Cite with Flexibility**: Insert citations as well as in-text citations (similar to LaTeX's `\cite` and `\citet` commands) directly into your LibreOffice document.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Insert usual citiations"...

It reads strange that no attribute for "citations" first, but we have no word for "non-intext.citations", do we?

Replace "LaTeX's" by "natbib's" and link https://ctan.org/pkg/natbib.

Copy link
Member Author

@subhramit subhramit Aug 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Usual citations" sounds odd. Plus, "usual" can have wide connotation till the reader gets to the natbib part.
How about this ^ (check changes).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If not this, the other alternative - "insert citations directly into..." (remove in-text, as citations is generic and can encompass all types).

Copy link
Member

@koppor koppor Aug 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then also remove link to natbib, because there is no distinction any more

Does not solve the issue that for the first, there is no adjective. - @thilote is the text for you Ok or should we just remove "in-text" and natbib completely?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think Thilo isn't tagged properly so @ThiloteE

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which sentence, Thilo?
Your suggestion would be to remove mentioning natbib (or LaTeX) altogether?
Are you referring to case 1, case 1 with natbib removed, or case 2?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure what case 1 or case 2 are.

Ideally, I would prefer splitting up Cite and Cite-in-Text into separate sections, but it's fine, if that is explained more in detail in the documentation.
The way it is now with natbib is ok. We have many LaTeX users, so Natbib might ring a bell.

Copy link
Member Author

@subhramit subhramit Aug 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you check if the current sentence is okay? Or if I should revert it and bring back the distinctions and natbib refrences? (Reason was to make it more readable to a wider audience, including those who don't use LaTeX).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest, I don't have a strong opinion here. Your choice :-)

Copy link
Member Author

@subhramit subhramit Aug 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright.
@koppor Then I suggest the going with the current:
"Cite with ease: Insert citations directly into your LibreOffice document."
Looks cleaner (and more digestible for a general audience, even for students like me who didn't use LaTeX during the college course, the story of which I mentioned in the blog's introductory paragraph).
Also changed "flexibility"->"ease".

@subhramit subhramit requested a review from koppor August 25, 2024 11:04
@subhramit subhramit requested a review from ThiloteE August 25, 2024 21:33
@subhramit
Copy link
Member Author

subhramit commented Aug 26, 2024

Hey, if everyone's alright with it, let's publish today (formally it's my last submission date)
@koppor @Siedlerchr @ThiloteE

I will then link it at the end of my report.

Copy link
Member

@Siedlerchr Siedlerchr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from my point of view lgtm

Copy link
Member

@ThiloteE ThiloteE left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose to slightly reword a few sentences. Also I propose to add dots at the end of full sentences in (numbered) bullet point lists, based on https://www.microsoft.com/en-us/microsoft-365-life-hacks/writing/punctuating-bullet-point-lists


As a student, I first came across pre-defined citation formats during my freshman year of college, when our professor instructed that the references in our project report must follow the "APA style".

I remember manually generating and copying citations in that style from some citation generation website, and oh was it tedious. Whether you are a student like me or a seasoned researcher in academia, you must have grappled with various citation styles throughout your academic journey.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember manually generating and copying citations in that style from a citation generation website, and oh was it tedious. Whether you are a student like me or a seasoned researcher in academia, you must have grappled with various citation styles throughout your academic journey.


I remember manually generating and copying citations in that style from some citation generation website, and oh was it tedious. Whether you are a student like me or a seasoned researcher in academia, you must have grappled with various citation styles throughout your academic journey.

[Citation Style Language](https://citationstyles.org/) (CSL) is a popular open-source specification language that standardizes the formatting of citations and bibliographies. It supports thousands of standard citation styles used in academia, including *American Psychological Association* (APA), *Modern Language Association* (MLA), *Chicago Manual of Style* (CMS), *Institute of Electrical and Electronics Engineers* (IEEE), *Springer - Lecture Notes in Computer Science* and *Vancouver* to name a few. If you've ever cited a source in an academic paper, chances are you've used a CSL-based style.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation Style Language (CSL) is a popular open-source specification language that standardizes the formatting of citations and bibliographies. It supports thousands of standard citation styles used in academia, including American Psychological Association (APA), Modern Language Association (MLA), Chicago Manual of Style (CMS), Institute of Electrical and Electronics Engineers (IEEE), Springer - Lecture Notes in Computer Science and Vancouver to name a few. If you've ever cited a source in an academic paper, chances are you've used a style that is supported by the CSL community and its specification.

3. Click on "Select style" from the panel
4. Choose your preferred CSL style from the list and click OK
5. Select an entry (or a group of entries) and click "Cite" to insert citations into the document
6. Click on the "Make/Sync bibliography" on the panel to auto-generate a bibliography section in your document based on your citations and the selected CSL style
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Press the "Make/Sync bibliography" button to auto-generate a bibliography section in your document based on your citations and the selected CSL style.

2. Connect to a running LibreOffice document instance from the [Libre/OpenOffice Panel](https://docs.jabref.org/cite/openofficeintegration)
3. Click on "Select style" from the panel
4. Choose your preferred CSL style from the list and click OK
5. Select an entry (or a group of entries) and click "Cite" to insert citations into the document
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Select an entry (or a group of entries) and click the "Cite" button to insert citations into the document.

1. Download the [development version of JabRef](https://builds.jabref.org/main/)
2. Connect to a running LibreOffice document instance from the [Libre/OpenOffice Panel](https://docs.jabref.org/cite/openofficeintegration)
3. Click on "Select style" from the panel
4. Choose your preferred CSL style from the list and click OK
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Choose your preferred CSL style from the list and click "OK".


1. Download the [development version of JabRef](https://builds.jabref.org/main/)
2. Connect to a running LibreOffice document instance from the [Libre/OpenOffice Panel](https://docs.jabref.org/cite/openofficeintegration)
3. Click on "Select style" from the panel
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Click on "Select style".

To start using this new feature:

1. Download the [development version of JabRef](https://builds.jabref.org/main/)
2. Connect to a running LibreOffice document instance from the [Libre/OpenOffice Panel](https://docs.jabref.org/cite/openofficeintegration)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Connect to a running LibreOffice document instance by either clicking the "Connect" or "Manual Connect" button in the Libre/OpenOffice Panel in the side pane.


To start using this new feature:

1. Download the [development version of JabRef](https://builds.jabref.org/main/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@subhramit
Copy link
Member Author

@ThiloteE I have acted on your review. I have used "Click" instead of "Press" to keep consistency.

@subhramit subhramit requested a review from ThiloteE August 26, 2024 12:34
@koppor koppor merged commit 949cb04 into JabRef:main Aug 26, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants