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
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions _data/authors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,20 @@ houssem:
url: https://github.com/HoussemNasri

ruslan:
name: Ruslan
name: Ruslan
url: https://github.com/InAnYan

david:
name: David
name: David
url: https://github.com/davidemdot

teertinker:
name: Felix Wilke
url: https://github.com/teertinker

subhramit:
name: Subhramit Basu
url: https://github.com/subhramit

mentee:
name: JabRef GSoC Mentee
name: JabRef GSoC Mentee
65 changes: 65 additions & 0 deletions _posts/2024-08-23-GSoC-CSL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: JabRef's new CSL Integration for LibreOffice
tags: [gsoc, csl]
author: subhramit
---

Hi, I am Subhramit. I am a Google Summer of Code (GSoC) student at JabRef this year, and I'll be walking you through JabRef's new CSL Integration for LibreOffice.

## Background

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.


[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.


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


## What's New?

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"?

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".

3. **Auto-generate Bibliographies**: Watch as your bibliography automatically populates based on your citations, with just a single click.
4. **Update Bibliographies**: Easily refresh your bibliography as you add new citations to your document.

## Getting Started

To start using this new feature:

1. Update to the latest version and start JabRef
subhramit marked this conversation as resolved.
Show resolved Hide resolved
2. Connect to a running LibreOffice document instance from the OpenOffice Panel
subhramit marked this conversation as resolved.
Show resolved Hide resolved
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".

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".

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.

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.


### Demo

#### Selecting a style

![Selecting a style](../img/selecting-a-style.gif)

#### Inserting citations

![Inserting citations](../img/cite.gif)

#### Generating bibliography

![Generating bibliography](../img/bibliography.gif)

#### Updating bibliography

![Updating bibliography](../img/refresh.gif)

## Summary

We hope this new feature enhances your research and writing process. As always, we welcome your feedback and suggestions for further improvements.
subhramit marked this conversation as resolved.
Show resolved Hide resolved

This CSL integration is a direct result of working on valuable user feedback, addressing long-standing feature requests ([#119](https://github.com/JabRef/jabref/issues/119) and [#2146](https://github.com/JabRef/jabref/issues/2146) on our GitHub).

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).

Happy citing!
Binary file added img/bibliography.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/cite.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/refresh.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/selecting-a-style.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.