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 support for biblatex-software #6574

Closed
koppor opened this issue Jun 1, 2020 · 8 comments · Fixed by #6747
Closed

Add support for biblatex-software #6574

koppor opened this issue Jun 1, 2020 · 8 comments · Fixed by #6747
Labels
bib(la)tex good first issue An issue intended for project-newcomers. Varies in difficulty. type: enhancement

Comments

@koppor
Copy link
Member

koppor commented Jun 1, 2020

See https://www.softwareheritage.org/2020/05/26/citing-software-with-style/

biblatex-software is actually a bibliography style extension, which means that one can add support for these four software entry types to any other BibLaTeX style used in documents typeset in LaTeX, like the biblatex styles for ACM articles. It requires the Biber back end, though, so do not try it with pure BibTeX.

We should add the new types and fields in BibLaTeX mode.

@koppor koppor added good first issue An issue intended for project-newcomers. Varies in difficulty. type: enhancement labels Jun 1, 2020
@hemantgs
Copy link
Contributor

Hi @koppor
Is this issue available, for me to work on ?

@koppor
Copy link
Member Author

koppor commented Jul 27, 2020

Sure, shouldn't be too hard. - The hard part is to understand the style and the idea/implementation of JabRef's pre-defined types. The code itself will be may be 10 to 50 LOC.

@hemantgs
Copy link
Contributor

Cool,

The hard part is to understand the style and the idea/implementation of JabRef's pre-defined types

I was just going through the code at avery high level, figured adding the new biblatex-software entries to the StandardField enum would make it available for BibEntry.java
Am I on the right track ?

@koppor
Copy link
Member Author

koppor commented Jul 27, 2020

Does the GUI behave differently then? - This is a good first issue, because one needs to go through the code and understand, what's happening why. And why somewthing does not happen if one changes something. I assume, you know the "call hierarchy" feature etc? Ctrl+Mouse-click

@hemantgs
Copy link
Contributor

hemantgs commented Jul 28, 2020

Does the GUI behave differently then?

Ah it did not ,so I was wrong ! I think I am getting the hang of it , I was looking at the code , so a new entry for each of biblatex-software extension's

  • software
  • software versions
  • software modules
  • code fragments
    Need to appear in the New Entry pane , With the corresponding fields from the style documentation. An entry for Software is already there , the others need to be added to the BibLatex entry definitions along with their fields and types. The GUI renders all that is defined . I'll go ahead and add/make those changes , along with unit tests ?

This is a good first issue, because one needs to go through the code and understand,

Agreed , I am new to JabRef and oss contribution . Hopefully I am in the right path getting know the codebase.

EDIT: The Software entry that is in existence does not seem to be the same entry as in biblatex-software (the fields vary) , what do we do here

@koppor
Copy link
Member Author

koppor commented Jul 29, 2020

The "Software" might come from the IEEE style. Could you make a table showing the different fields. Column A: field name; column B field in IEEE present (exiting in jabref), column C field present in biblatex-software. Then a cross if it exists, empty else?

It would be helpful if the examples of https://packages.oth-regensburg.de/ctan/macros/latex/contrib/biblatex-contrib/biblatex-software/sample-use-sty.pdf were included in the tests. Maybe as a bib file in https://github.com/JabRef/jabref/tree/master/src/test/resources/testbib?

I think, we need a divider in the menu (as we have for IEEE, don't we?) Screenshots should be at https://docs.jabref.org/collect/add-entry-manually, but we currently don't have one.

The other alternative is to add refine the howto for customize entry types and ship a .bib file with the customization included so that each user can load it if he wants to use biblatex-software.

I find software that important so that we should ship support with JabRef as default.

If possible, could you also add an ADR containing the options "Native support in JabRef" and "Support via customized entry types"?

@hemantgs
Copy link
Contributor

Comparison of the both :

Column JabRef-Software biblatex-software
AUTHOR/EDITOR ✔️ ✔️
TITLE ✔️ ✔️
DATE ✔️ ✔️
SUBTITLE ✔️ ✔️
TITLEADDON ✔️
HOWPUBLISHED ✔️
DOI ✔️
EPRINT ✔️
EPRINTCLASS ✔️ ✔️
EPRINTTYPE ✔️ ✔️
URL ✔️ ✔️
URLDATE ✔️ ✔️
HALID ✔️
HALVERSION ✔️
INSTITUTION ✔️
INTRODUCEDIN ✔️
LICENSE ✔️
MONTH ✔️
NOTE ✔️
ORGANIZATION ✔️
PUBLISHER ✔️
RELATED ✔️
RELATEDTYPE ✔️
RELATEDSTRING ✔️
REPOSITORY ✔️
SWHID ✔️

I think, we need a divider in the menu

What should be the text overlay on the divider ? BibTex has IEEETran

ship a .bib file with the customization included so that each user can load it if he wants to use biblatex-software.

Is this a current functionality(if so can you point to an example) or something that we are trying to build with this issue ? If its new , does this mean a new UI component(dropdown?) in the Customized Entry Type dialog to specify which type the new entry inherits from ?

could you also add an ADR

Yes , sure

@Siedlerchr
Copy link
Member

Thanks to @hemantgs this issue is now resolved

koppor pushed a commit that referenced this issue Jul 15, 2023
a97dbb32c5 Update studii-teologice.csl (#6591)
e19e08780e Update acm-sig-proceedings-long-author-list.csl (#6594)
c8abbcdd88 Update acm-sig-proceedings.csl (#6595)
725ace4a40 Create uppsala-university-library-harvard.csl (#6574)
a973041e0e update bluebook-law-review.csl (#6583)
0891cfc49a Update masarykova-univerzita-pravnicka-fakulta.csl (#6589)
80b3861bce Update al-jamiah-journal-of-islamic-studies.csl (#6581)
b6fb00e415 Create arachnologische-mitteilungen.csl (#6375)
2dbc8edf8e Update universitat-basel-iberoromanistik.csl (#6580)
fd230a7073 Create veterinary-clinical-pathology.csl (#6372)
ac0afa3cae Create dedicated Basque APA file (#6370)
fee0677a88 Update chicago-author-date.csl (#6289)
ca1bf2db6e Create van-yuzuncu-yil-universitesi-fen-bilimleri-enstitusu.csl (#6230)
f4116db325 Create Turcica.csl (#6240)
0e4311a802 Create jurnal-teknik-mesin-indonesia.csl (#6211)
e73bf46674 Update vancouver.csl (#6156)
b73c3ef193 Create independent TF AIP Style
befa82e7ef Create harvard-xi-an-jiaotong-liverpool-univeisity.csl (#6181)
048c9bddbc Add csl for SDMI (#6129)
1c2aedd088 Update and rename dependent/energy-research-and-social-science.csl to energy-research-and-social-science.csl (#6567)
b77084255f Update the-quarterly-journal-of-economics.csl (#6572)
cf66f60f25 Update publicatiewijzer-voor-de-archeologie.csl (#6577)
9e9e08c219 Update isara-iso-690.csl (#6578)
4b4e8f442d Create silva-fennica.csl (#6568)
dd8760bb2b Update american-journal-of-botany.csl (#6569)
8b0e505363 Update haute-ecole-de-gestion-de-geneve-iso-690.csl (#6560)
016050c4b7 Update geographie-et-cultures.csl (#6563)
e8b62f1c80 Update and rename dependent/retina.csl to retina.csl (#6565)

git-subtree-dir: buildres/csl/csl-styles
git-subtree-split: a97dbb32c57c8c00e47422dae4ba4f480e753da5
koppor pushed a commit that referenced this issue Aug 1, 2023
0749a19b83 Update journal-of-experimental-botany.csl (#6604)
b1768724fe Update modern-language-association.csl (#6606)
dd364c1815 Create modern-language-association-for-JEI.csl (#6593)
6cb436997b Partial update of APA styles for 1.0.2, including software, legal, most localizations (#6270)
d7c4ebec85 fix film/video authors for american-sociological-association.csl (#6602)
a97dbb32c5 Update studii-teologice.csl (#6591)
e19e08780e Update acm-sig-proceedings-long-author-list.csl (#6594)
c8abbcdd88 Update acm-sig-proceedings.csl (#6595)
725ace4a40 Create uppsala-university-library-harvard.csl (#6574)
a973041e0e update bluebook-law-review.csl (#6583)
0891cfc49a Update masarykova-univerzita-pravnicka-fakulta.csl (#6589)
80b3861bce Update al-jamiah-journal-of-islamic-studies.csl (#6581)
b6fb00e415 Create arachnologische-mitteilungen.csl (#6375)
2dbc8edf8e Update universitat-basel-iberoromanistik.csl (#6580)
fd230a7073 Create veterinary-clinical-pathology.csl (#6372)
ac0afa3cae Create dedicated Basque APA file (#6370)
fee0677a88 Update chicago-author-date.csl (#6289)
ca1bf2db6e Create van-yuzuncu-yil-universitesi-fen-bilimleri-enstitusu.csl (#6230)
f4116db325 Create Turcica.csl (#6240)
0e4311a802 Create jurnal-teknik-mesin-indonesia.csl (#6211)
e73bf46674 Update vancouver.csl (#6156)
b73c3ef193 Create independent TF AIP Style
befa82e7ef Create harvard-xi-an-jiaotong-liverpool-univeisity.csl (#6181)
048c9bddbc Add csl for SDMI (#6129)
1c2aedd088 Update and rename dependent/energy-research-and-social-science.csl to energy-research-and-social-science.csl (#6567)
b77084255f Update the-quarterly-journal-of-economics.csl (#6572)
cf66f60f25 Update publicatiewijzer-voor-de-archeologie.csl (#6577)
9e9e08c219 Update isara-iso-690.csl (#6578)
4b4e8f442d Create silva-fennica.csl (#6568)
dd8760bb2b Update american-journal-of-botany.csl (#6569)
8b0e505363 Update haute-ecole-de-gestion-de-geneve-iso-690.csl (#6560)
016050c4b7 Update geographie-et-cultures.csl (#6563)
e8b62f1c80 Update and rename dependent/retina.csl to retina.csl (#6565)

git-subtree-dir: buildres/csl/csl-styles
git-subtree-split: 0749a19b8306f2e8dcb9bf1a2e3a6992666030ac
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bib(la)tex good first issue An issue intended for project-newcomers. Varies in difficulty. type: enhancement
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants