-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[6574] Added support for biblatex-software
Added change to changelog md checkstyle fixed checkstyle fixed
- Loading branch information
Showing
10 changed files
with
232 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# \[Added Native Support for BibLatex-Sotware\] | ||
|
||
* Status: Proposed | ||
* Deciders: Oliver Kopp | ||
|
||
Technical Story: [6574-Adding support for biblatex-software](https://github.com/JabRef/jabref/issues/6574) | ||
|
||
## Context and Problem Statement | ||
|
||
JabRef does not right now have support for Biblatex-Software out of the box , users have to add custome entry type. | ||
With citing software becoming fairly comen , native support would be helpful. | ||
|
||
|
||
## Decision Drivers | ||
|
||
* The new entry types definitions should be added to the Select Entry Pane and be separated by a divider | ||
* None of the existing flows should be impacted | ||
|
||
## Considered Options | ||
|
||
* Adding the new entry types to the existing biblatex types , but it conflicted with an already existing type(software) | ||
* Add a divider with label Biblatex-Software underwhich the new entries are listed : Native support for Biblatex-Software | ||
* Support via customized entry types : A user can load a customized bib file | ||
|
||
## Decision Outcome | ||
|
||
Chosen option: Yet to be decided. | ||
|
||
### Positive Consequences | ||
|
||
* Inbuilt coverage for a entry type that is getting more and more importance | ||
|
||
### Negative Consequences | ||
|
||
* Adds a little bit more clutter to the Add Entry pane | ||
|
||
## Pros and Cons of the Options | ||
|
||
### Adding the new entry types to the existing biblatex types | ||
|
||
* Good, since ther is no need for a new category in the add entry pane | ||
|
||
### Add a divider with label Biblatex-Software with relevant types | ||
|
||
* Good, since this gives the user a bit more clarity | ||
|
||
### Support via customized entry types | ||
|
||
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
53 changes: 53 additions & 0 deletions
53
src/main/java/org/jabref/model/entry/types/BiblatexSoftwareEntryTypeDefinitions.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
package org.jabref.model.entry.types; | ||
|
||
import java.util.Arrays; | ||
import java.util.List; | ||
|
||
import org.jabref.model.entry.BibEntryType; | ||
import org.jabref.model.entry.BibEntryTypeBuilder; | ||
import org.jabref.model.entry.field.OrFields; | ||
import org.jabref.model.entry.field.StandardField; | ||
|
||
public class BiblatexSoftwareEntryTypeDefinitions { | ||
private static final BibEntryType SOFTWARE = new BibEntryTypeBuilder() | ||
.withType(StandardEntryType.Software) | ||
.withImportantFields(StandardField.DATE, StandardField.DOI, StandardField.EPRINTTYPE, StandardField.EPRINTCLASS, StandardField.EPRINT, | ||
StandardField.EDITOR, StandardField.FILE, StandardField.HALID, StandardField.HALVERSION, StandardField.INSTITUTION, StandardField.INTRODUCEDIN, | ||
StandardField.LICENSE, StandardField.MONTH, StandardField.NOTE, StandardField.ORGANIZATION, StandardField.PUBLISHER, StandardField.RELATED, | ||
StandardField.RELATEDSTRING, StandardField.REPOSITORY, StandardField.SWHID, StandardField.URLDATE, StandardField.VERSION) | ||
.withRequiredFields(new OrFields(StandardField.AUTHOR, StandardField.EDITOR), StandardField.TITLE, StandardField.URL, StandardField.VERSION, StandardField.YEAR) | ||
.build(); | ||
|
||
private static final BibEntryType SOFTWAREVERSION = new BibEntryTypeBuilder() | ||
.withType(StandardEntryType.SoftwareVersion) | ||
.withImportantFields(StandardField.DATE, StandardField.EPRINTCLASS, StandardField.EPRINTTYPE, StandardField.HALID, StandardField.HALVERSION, | ||
StandardField.INSTITUTION, StandardField.INTRODUCEDIN, StandardField.LICENSE, StandardField.MONTH, StandardField.NOTE, StandardField.ORGANIZATION, | ||
StandardField.PUBLISHER, StandardField.RELATED, StandardField.RELATEDTYPE, StandardField.RELATEDSTRING, | ||
StandardField.REPOSITORY, StandardField.SWHID, StandardField.SUBTITLE, StandardField.URLDATE) | ||
.withRequiredFields(new OrFields(StandardField.AUTHOR, StandardField.EDITOR), StandardField.TITLE, StandardField.URL, StandardField.YEAR, StandardField.VERSION) | ||
.withDetailFields(StandardField.DATE, StandardField.EPRINTCLASS, StandardField.EPRINTTYPE, StandardField.HALID, StandardField.HALVERSION, | ||
StandardField.INSTITUTION, StandardField.INTRODUCEDIN, StandardField.LICENSE, StandardField.MONTH, StandardField.NOTE, StandardField.ORGANIZATION, | ||
StandardField.PUBLISHER, StandardField.RELATED, StandardField.RELATEDTYPE, StandardField.RELATEDSTRING, | ||
StandardField.REPOSITORY, StandardField.SWHID, StandardField.SUBTITLE, StandardField.URLDATE) | ||
.withRequiredFields(new OrFields(StandardField.AUTHOR, StandardField.EDITOR), StandardField.TITLE, StandardField.URL, StandardField.YEAR) | ||
.build(); | ||
private static final BibEntryType SOFTWAREMODULE = new BibEntryTypeBuilder() | ||
.withType(StandardEntryType.SoftwareModule) | ||
.withImportantFields(StandardField.DATE, StandardField.DOI, StandardField.EPRINTTYPE, StandardField.EPRINTCLASS, StandardField.EPRINT, | ||
StandardField.EDITOR, StandardField.FILE, StandardField.HALID, StandardField.HALVERSION, StandardField.INSTITUTION, StandardField.INTRODUCEDIN, | ||
StandardField.LICENSE, StandardField.MONTH, StandardField.NOTE, StandardField.ORGANIZATION, StandardField.PUBLISHER, StandardField.RELATED, | ||
StandardField.RELATEDSTRING, StandardField.REPOSITORY, StandardField.SWHID, StandardField.URLDATE, StandardField.VERSION) | ||
.withRequiredFields(StandardField.AUTHOR, StandardField.SUBTITLE, StandardField.URL, StandardField.YEAR) | ||
.build(); | ||
|
||
private static final BibEntryType CODEFRAGMENT = new BibEntryTypeBuilder() | ||
.withType(StandardEntryType.CodeFragment) | ||
.withImportantFields(StandardField.DATE, StandardField.DOI, StandardField.EPRINTTYPE, StandardField.EPRINTCLASS, StandardField.EPRINT, | ||
StandardField.EDITOR, StandardField.FILE, StandardField.HALID, StandardField.HALVERSION, StandardField.INSTITUTION, StandardField.INTRODUCEDIN, | ||
StandardField.LICENSE, StandardField.MONTH, StandardField.NOTE, StandardField.ORGANIZATION, StandardField.PUBLISHER, StandardField.RELATED, | ||
StandardField.RELATEDSTRING, StandardField.REPOSITORY, StandardField.SWHID, StandardField.URLDATE, StandardField.VERSION) | ||
.withRequiredFields(StandardField.URL) | ||
.build(); | ||
|
||
public static final List<BibEntryType> ALL = Arrays.asList(SOFTWAREVERSION, SOFTWARE, SOFTWAREMODULE, CODEFRAGMENT); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
@softwareversion {delebecque:hal-02090402-condensed, | ||
title = {Scilab}, | ||
author = {Delebecque, Fran{\c c}ois and Gomez, Claude and Goursat, Maurice | ||
and Nikoukhah, Ramine and Steer, Serge and Chancelier, Jean-Philippe}, | ||
url = {https://www.scilab.org/}, | ||
date = {1994-01}, | ||
file = {https://hal.inria.fr/hal-02090402/file/scilab-1.1.tar.gz}, | ||
institution = {Inria}, | ||
license = {Scilab license}, | ||
hal_id = {hal-02090402}, | ||
hal_version = {v1}, | ||
swhid = {swh:1:dir:1ba0b67b5d0c8f10961d878d91ae9d6e499d746a; | ||
origin=https://hal.archives-ouvertes.fr/hal-02090402}, | ||
version = {1.1}, | ||
note = {First Scilab version. It was distributed by anonymous ftp.}, | ||
repository= {https://github.com/scilab/scilab}, | ||
abstract = {Software for Numerical Computation freely distributed.} | ||
} | ||
@software {delebecque:hal-02090402, | ||
title = {Scilab}, | ||
author = {Delebecque, Fran{\c c}ois and Gomez, Claude and Goursat, Maurice | ||
and Nikoukhah, Ramine and Steer, Serge and Chancelier, Jean-Philippe}, | ||
date = {1994}, | ||
institution = {Inria}, | ||
license = {Scilab license}, | ||
hal_id = {hal-02090402}, | ||
hal_version = {v1}, | ||
url = {https://www.scilab.org/}, | ||
abstract = {Software for Numerical Computation freely distributed.}, | ||
repository= {https://github.com/scilab/scilab}, | ||
} | ||
|
||
@softwareversion {delebecque:hal-02090402v1, | ||
version = {1.1}, | ||
date = {1994-01}, | ||
file = {https://hal.inria.fr/hal-02090402/file/scilab-1.1.tar.gz}, | ||
swhid = {swh:1:dir:1ba0b67b5d0c8f10961d878d91ae9d6e499d746a; | ||
origin=https://hal.archives-ouvertes.fr/hal-02090402}, | ||
note = {First Scilab version. It was distributed by anonymous ftp.}, | ||
crossref = {delebecque:hal-02090402} | ||
} | ||
@software {cgal, | ||
title = {The Computational Geometry Algorithms Library}, | ||
author = {{The CGAL Project}}, | ||
editor = {{CGAL Editorial Board}}, | ||
date = {1996}, | ||
url = {https://cgal.org/} | ||
} | ||
|
||
@softwareversion{cgal:5-0-2, | ||
crossref = {cgal}, | ||
version = {{5.0.2}}, | ||
url = {https://docs.cgal.org/5.02}, | ||
date = {2020}, | ||
swhid = {swh:1:rel:636541bbf6c77863908eae744610a3d91fa58855; | ||
origin=https://github.com/CGAL/cgal/} | ||
} | ||
|
||
@softwaremodule{cgal:lp-gi-20a, | ||
crossref = {cgal:5-0-2}, | ||
author = {Menelaos Karavelas}, | ||
subtitle = {{2D} Voronoi Diagram Adaptor}, | ||
license = {GPL}, | ||
introducedin = {cgal:3-1}, | ||
url = {https://doc.cgal.org/5.0.2/Manual/packages.html#PkgVoronoiDiagram2}, | ||
} | ||
@softwaremodule{cgal:lp-gi-20a-condensed, | ||
title = {The Computational Geometry Algorithms Library}, | ||
subtitle = {{2D} Voronoi Diagram Adaptor}, | ||
author = {Menelaos Karavelas}, | ||
editor = {{CGAL Editorial Board}}, | ||
license = {GPL}, | ||
version = {{5.0.2}}, | ||
introducedin = {cgal:3-1}, | ||
date = {2020}, | ||
swhid = {swh:1:rel:636541bbf6c77863908eae744610a3d91fa58855; | ||
origin=https://github.com/CGAL/cgal/}, | ||
url = {https://doc.cgal.org/5.0.2/Manual/packages.html#PkgVoronoiDiagram2}, | ||
} | ||
@software {parmap, | ||
title = {The Parmap library}, | ||
author = {Di Cosmo, Roberto and Marco Danelutto}, | ||
date = {2020}, | ||
version = {1.1.1}, | ||
institution = {{Inria} and {University of Paris} and {University of Pisa}}, | ||
license = {LGPL-2.0}, | ||
url = {https://rdicosmo.github.io/parmap/}, | ||
repository= {https://github.com/rdicosmo/parmap}, | ||
} | ||
|
||
@codefragment {simplemapper, | ||
subtitle = {Core mapping routine}, | ||
swhid = {swh:1:cnt:43a6b232768017b03da934ba22d9cc3f2726a6c5; | ||
lines=192-228; | ||
origin=https://github.com/rdicosmo/parmap}, | ||
crossref = {parmap} | ||
} |