[6574] Added support for biblatex-software #6747

hemantgs · 2020-08-09T07:52:32Z

Added change to changelog
Fixes #6574

This PR is in reference to #6574
Added the new biblatex software entries under a new divider like the below image

Change in CHANGELOG.md described (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

hemantgs · 2020-08-09T08:03:23Z

Hi @koppor
I have gone ahead and made a draft set of changes for #6747 ,

Created a divider like in IEEETran for BibTex and added the software entries under it
I am yet a little un-clear on the Customized Entry type flow , so I have not progressed on that , do give your thoughts

calixtus · 2020-08-09T12:05:15Z

Hi @hemantgs ,
on first sight codewise your changes look good to me.
Thank you very much for your work on this feature.

I also was thinking about abstraction of this feature in the mid to far future, maybe something to decide on JabCon2020, so don't think of it in this PR: One could activate native support for biblatex-software or IEEE or for music or other biblatex drivers as an additional feature in the preferences.

Siedlerchr · 2020-08-09T12:42:55Z

Yep codewise looks already good!

hemantgs · 2020-08-09T17:39:46Z

@calixtus @Siedlerchr Cool 👍
Would it make sense to add change to the documentation page also ?

Siedlerchr · 2020-08-09T17:47:42Z

Yes, I think that makes sense and to have a nice newer screenshot for here and the entry id manually
https://docs.jabref.org/collect/add-entry-manually
And it would then be nice if you could add a hint that the New Entry types dialogue content is dependent on the bibdatabase mode
https://docs.jabref.org/collect/add-entry-using-an-id

Added change to changelog md checkstyle fixed checkstyle fixed

Siedlerchr

Thanks, looks good to me!

koppor

Thank you for working on it. I have some refinemenets to the adr.

koppor · 2020-08-18T18:18:20Z

docs/adr/0013-add-native-support-biblatex-software.md

+
+## 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.


Suggested change

JabRef does not right now have support for Biblatex-Software out of the box , users have to add custome entry type.

JabRef does not right now have support for Biblatex-Software out of the box, users have to add custome entry type.

koppor · 2020-08-18T18:18:40Z

docs/adr/0013-add-native-support-biblatex-software.md

+## 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.


Suggested change

With citing software becoming fairly comen , native support would be helpful.

With citing software becoming fairly common, native support is helpful.

koppor · 2020-08-18T18:19:47Z

docs/adr/0013-add-native-support-biblatex-software.md

+
+## Decision Drivers
+
+* The new entry types definitions should be added to the Select Entry Pane and be separated by a divider


I think, this line should be removed. It is not a "global driver", but one implementation option.

The other point is OK. - Even if it is a single one.

koppor · 2020-08-18T18:20:14Z

docs/adr/0013-add-native-support-biblatex-software.md

+
+## Considered Options
+
+* Adding the new entry types to the existing biblatex types , but it conflicted with an already existing type(software)


Suggested change

* Adding the new entry types to the existing biblatex types , but it conflicted with an already existing type(software)

* Add the new entry types to the existing biblatex types

koppor · 2020-08-18T18:20:39Z

docs/adr/0013-add-native-support-biblatex-software.md

+
+### 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


Suggested change

* Good, since ther is no need for a new category in the add entry pane

* Good, because there is no need for a new category in the add entry pane

* Bad, because it conflicts with an already existing type (software)

koppor · 2020-08-18T18:23:42Z

src/test/resources/testbib/biblatex-software.bib

+  note = {First Scilab version. It was distributed by anonymous ftp.},
+  crossref = {delebecque:hal-02090402}
+}
+ @software {cgal,


Please add an empty line before

koppor · 2020-08-18T18:23:51Z

src/test/resources/testbib/biblatex-software.bib

+  introducedin = {cgal:3-1},
+  url = {https://doc.cgal.org/5.0.2/Manual/packages.html#PkgVoronoiDiagram2},
+ }
+ @softwaremodule{cgal:lp-gi-20a-condensed,


Please add an empty line before

koppor · 2020-08-18T18:23:58Z

src/test/resources/testbib/biblatex-software.bib

+           origin=https://github.com/CGAL/cgal/},
+  url = {https://doc.cgal.org/5.0.2/Manual/packages.html#PkgVoronoiDiagram2},
+ }
+@software {parmap,


Please add an empty line before

koppor · 2020-08-18T18:24:40Z

docs/adr/0013-add-native-support-biblatex-software.md

+## 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


Suggested change

* Add a divider with label Biblatex-Software underwhich the new entries are listed : Native support for Biblatex-Software

* Add a divider with label Biblatex-Software under which the new entries are listed: Native support for Biblatex-Software

koppor · 2020-08-18T18:24:55Z

docs/adr/0013-add-native-support-biblatex-software.md

+
+## Decision Outcome
+
+Chosen option: Yet to be decided.


Suggested change

Chosen option: Yet to be decided.

Chosen option: Add a new devider, because comes out best (see below).

hemantgs · 2020-08-19T14:09:46Z

Thank you for working on it. I have some refinemenets to the adr.

Hi @koppor I have updated the ADR per the review comments , please do have a look

Siedlerchr · 2020-08-22T14:33:34Z

Thank you very much for your contribution and for creating an ADR!

* upstream/master: Streamline new library command (#6773) [6574] Added support for biblatex-software (#6747) Updated the eclipse doc with a note and image on how to add the run/debug configuration. (#6776) New Crowdin updates (#6774)

koppor · 2020-08-23T20:57:32Z

Id id not the final check on the PR. We missed two things now breaking master:

Unit test related to this PR fail

markdown-lint

This is an easy fix. (Linter ensure consistent formatting of all files)

koppor · 2020-08-23T20:59:44Z

markdown-lint is already fixed in master 🎉

koppor · 2020-08-23T21:01:48Z

Not sure why the other PR complained ther: https://github.com/JabRef/jabref/runs/1016112813?check_suite_focus=true

Siedlerchr · 2020-08-23T21:39:27Z

Markdown was fixed. I overlooked the unit test probably because of the failing architecture thing.
Probably need to add those b iblatex software somehow to the test. Can look into this tomorrow

Siedlerchr · 2020-08-23T21:57:35Z

Fixed by @calixtus

koppor · 2020-08-23T22:05:06Z

Test fixed at #6780.

hemantgs · 2020-08-24T06:42:20Z

Looks like I overlooked the unit test , apologies guys

calixtus · 2020-08-24T07:06:07Z

We did so too, no need to apologize. 😉

hemantgs marked this pull request as ready for review August 9, 2020 17:35

[6574] Added support for biblatex-software

7f8df6b

Added change to changelog md checkstyle fixed checkstyle fixed

hemantgs force-pushed the biblatex-software branch from 2ccfd10 to 7f8df6b Compare August 10, 2020 05:59

hemantgs mentioned this pull request Aug 10, 2020

Added doc changes for biblatex-software issue 6574 JabRef/user-documentation#289

Merged

Siedlerchr approved these changes Aug 18, 2020

View reviewed changes

Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Aug 18, 2020

koppor requested changes Aug 18, 2020

View reviewed changes

Added changes to the ADR

5bd56e8

hemantgs requested a review from koppor August 19, 2020 14:09

Siedlerchr approved these changes Aug 22, 2020

View reviewed changes

Merge branch 'master' into biblatex-software

dfe161e

Siedlerchr merged commit 9d17101 into JabRef:master Aug 22, 2020


		## 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.
	With citing software becoming fairly common, native support is helpful.


		## Decision Drivers

		* The new entry types definitions should be added to the Select Entry Pane and be separated by a divider


		## Considered Options

		* Adding the new entry types to the existing biblatex types , but it conflicted with an already existing type(software)

	* Adding the new entry types to the existing biblatex types , but it conflicted with an already existing type(software)
	* Add the new entry types to the existing biblatex types


		### 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

	* Good, since ther is no need for a new category in the add entry pane
	* Good, because there is no need for a new category in the add entry pane
	* Bad, because it conflicts with an already existing type (software)

	* Add a divider with label Biblatex-Software underwhich the new entries are listed : Native support for Biblatex-Software
	* Add a divider with label Biblatex-Software under which the new entries are listed: Native support for Biblatex-Software

	Chosen option: Yet to be decided.
	Chosen option: Add a new devider, because comes out best (see below).

Uh oh!

[6574] Added support for biblatex-software #6747

[6574] Added support for biblatex-software #6747

Uh oh!

Conversation

hemantgs commented Aug 9, 2020 • edited by Siedlerchr Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hemantgs commented Aug 9, 2020

Uh oh!

calixtus commented Aug 9, 2020

Uh oh!

Siedlerchr commented Aug 9, 2020

Uh oh!

hemantgs commented Aug 9, 2020

Uh oh!

Siedlerchr commented Aug 9, 2020

Uh oh!

Siedlerchr left a comment

Choose a reason for hiding this comment

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hemantgs commented Aug 19, 2020

Uh oh!

Siedlerchr commented Aug 22, 2020

Uh oh!

koppor commented Aug 23, 2020

Unit test related to this PR fail

markdown-lint

Uh oh!

koppor commented Aug 23, 2020

Uh oh!

koppor commented Aug 23, 2020

Uh oh!

Siedlerchr commented Aug 23, 2020

Uh oh!

Siedlerchr commented Aug 23, 2020

Uh oh!

koppor commented Aug 23, 2020

Uh oh!

hemantgs commented Aug 24, 2020

Uh oh!

calixtus commented Aug 24, 2020

Uh oh!

Uh oh!

hemantgs commented Aug 9, 2020 •

edited by Siedlerchr

Loading