Clean up defintions of entry types #11013

koppor · 2024-03-12T21:43:18Z

We have org.jabref.model.entry.types.BiblatexEntryTypeDefinitions, which defines all known BibLaTeX entry types. However, when diving into details, it is a WTF, because fields were added as important and as detail. Or as required and important. This was confusing.

This PR cleans up duplicate entries and keeps the more higher ranked (required > optional-important > optional-detail).

This also reorders to required/optionalImportant/optionalDetail in the code and adapts the names.

Mandatory checks

Change in CHANGELOG.md described in a way that is understandable for the average user (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 developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

Also reorderer to required/optionalImport/optionalDetail

calixtus · 2024-03-12T22:01:00Z

Test is failing.

Im wondering it did not correspond with the specification in https://ftp.rrzn.uni-hannover.de/pub/mirror/tex-archive/macros/latex/contrib/biblatex/doc/biblatex.pdf before...

koppor · 2024-03-12T22:09:55Z

Test is failing.

Was green on Windows, but now on NixOS I can reproduce 🤣🤣

Im wondering it did not correspond with the specification in ftp.rrzn.uni-hannover.de/pub/mirror/tex-archive/macros/latex/contrib/biblatex/doc/biblatex.pdf before...

git blame game? 🤣 -- The distinction between importantOptional and detailedOptional was introduced at #5148.

koppor · 2024-03-12T22:11:23Z

Siedlerchr · 2024-03-12T22:12:37Z

We have to be really careful here, when changing the fields around as this could break existing configurations for users. And also the naming in the entry editor. Carl Christian Snethlage ***@***.***> schrieb am Di., 12. März 2024, 23:01:

…

Test is failing. Im wondering it did not correspond with the specification in https://ftp.rrzn.uni-hannover.de/pub/mirror/tex-archive/macros/latex/contrib/biblatex/doc/biblatex.pdf before... — Reply to this email directly, view it on GitHub <#11013 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACOFZB5455A3PJAHGCGWD3YX53LFAVCNFSM6AAAAABETA5CSWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOJSGY2TONJQHA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

src/main/java/org/jabref/model/entry/types/IEEETranEntryTypeDefinitions.java

koppor · 2024-03-12T22:16:18Z

We have to be really careful here, when changing the fields around

I remove duplicate fields. - I wonder why it worked at all ^^. - JabRef did not display fields twice, because of the use of Set.

Siedlerchr · 2024-03-13T19:45:34Z

conflicts in the javadoc, apart from that okay

Siedlerchr · 2024-03-13T19:46:27Z

src/main/java/org/jabref/model/entry/BibEntryTypeBuilder.java

    private SequencedSet<OrFields> requiredFields = new LinkedHashSet<>();
+    private SequencedSet<BibField> optionalFields = new LinkedHashSet<>();
+
+    private Set<Field> seenFields = new HashSet<>();


What is seen fields now?

We are in the context of the Builder. The builder should raise an IllegalArgumentException of arguments are wrong. Therefore, the builder needs to know what it has seen.

Siedlerchr · 2024-03-13T19:47:15Z

src/main/java/org/jabref/model/entry/BibEntryTypeBuilder.java

-        this.fields = Streams.concat(fields.stream(), newFields.stream().map(field -> new BibField(field, FieldPriority.IMPORTANT)))
-                             .collect(Collectors.toCollection(LinkedHashSet::new));
+        List<Field> containedFields = containedInSeenFields(newFields);
+        if (!containedFields.isEmpty()) {


Isn't the idea of a set to prevent duplicates. Why the check here

Because of "throw new IllegalArgumentException". To warn dumb callers.

github-actions · 2024-03-14T16:56:59Z

The build for this PR is no longer available. Please visit https://builds.jabref.org/main/ for the latest build.

* upstream/main: Convert RemoveBracesFormatterTest to @ParameterizedTest (JabRef#11033) Update teaching.md Remove non-existing recipe (JabRef#11029) Update CSL styles (JabRef#11031) Clean up defintions of entry types (JabRef#11013) Fix log file path on Windows (JabRef#11028) Change to rolling logs (JabRef#11023)

* upstream/main: (26 commits) Speed up failure reporting (#11030) Importing of BibDesk Groups and Linked Files (#10968) Convert RemoveBracesFormatterTest to @ParameterizedTest (#11033) Update teaching.md Remove non-existing recipe (#11029) Update CSL styles (#11031) Clean up defintions of entry types (#11013) Fix log file path on Windows (#11028) Change to rolling logs (#11023) chore: remove repetitive words (#11015) Fix test names (#11014) Remove obsolete "Comments" tab configuration (#11011) Fix "Other fields" tab respecting custom tabs (#11012) [WIP] Extract PDF References (#10437) Fixed jump to entry from crossref (#11009) fix suggestion provider for crossref field (#10962) Use SequencedSet for required and optional fields (#11007) Bump io.github.classgraph:classgraph from 4.8.165 to 4.8.168 (#11005) Bump org.glassfish.hk2:hk2-api from 3.0.6 to 3.1.0 (#11006) Bump org.apache.logging.log4j:log4j-to-slf4j from 2.23.0 to 2.23.1 (#11003) ... # Conflicts: # src/main/resources/csl-styles

…link * upstream/main: Bump org.apache.pdfbox:fontbox from 3.0.1 to 3.0.2 (JabRef#11042) Bump com.dlsc.gemsfx:gemsfx from 2.2.0 to 2.4.0 (JabRef#11044) Bump org.apache.pdfbox:xmpbox from 3.0.1 to 3.0.2 (JabRef#11041) Bump com.googlecode.plist:dd-plist from 1.23 to 1.28 (JabRef#11040) Bump gittools/actions from 0.13.4 to 1.1.1 (JabRef#11039) Change copy-paste function to handle string constants (follow up PR) (JabRef#11037) Fixes Zotero file handling for absolute paths (JabRef#11038) Speed up failure reporting (JabRef#11030) Importing of BibDesk Groups and Linked Files (JabRef#10968) Convert RemoveBracesFormatterTest to @ParameterizedTest (JabRef#11033) Update teaching.md Remove non-existing recipe (JabRef#11029) Update CSL styles (JabRef#11031) Clean up defintions of entry types (JabRef#11013) Fix log file path on Windows (JabRef#11028) Change to rolling logs (JabRef#11023) chore: remove repetitive words (JabRef#11015) Fix test names (JabRef#11014)

* upstream/main: (40 commits) Improve citation relations (JabRef#11016) Keep enclosing braces of authors (JabRef#11034) Bump org.apache.pdfbox:fontbox from 3.0.1 to 3.0.2 (JabRef#11042) Bump com.dlsc.gemsfx:gemsfx from 2.2.0 to 2.4.0 (JabRef#11044) Bump org.apache.pdfbox:xmpbox from 3.0.1 to 3.0.2 (JabRef#11041) Bump com.googlecode.plist:dd-plist from 1.23 to 1.28 (JabRef#11040) Bump gittools/actions from 0.13.4 to 1.1.1 (JabRef#11039) Change copy-paste function to handle string constants (follow up PR) (JabRef#11037) Fixes Zotero file handling for absolute paths (JabRef#11038) Speed up failure reporting (JabRef#11030) Importing of BibDesk Groups and Linked Files (JabRef#10968) Convert RemoveBracesFormatterTest to @ParameterizedTest (JabRef#11033) Update teaching.md Remove non-existing recipe (JabRef#11029) Update CSL styles (JabRef#11031) Clean up defintions of entry types (JabRef#11013) Fix log file path on Windows (JabRef#11028) Change to rolling logs (JabRef#11023) chore: remove repetitive words (JabRef#11015) Fix test names (JabRef#11014) ...

koppor added 11 commits March 12, 2024 14:04

Clean up defintions of entry types

ea2f698

Also reorderer to required/optionalImport/optionalDetail

More comments

e9d30a1

Add "Publisher"

33225ff

Adapt naming important/detail also to methods

5bc868d

Add test

1c9edc1

Add log output when using customized type

6469f79

Fix test method names

5c1879c

Add another test case

5d4e514

Fix names

a4720a5

Revert adding "publisher" to article

0e94dc0

Reorder with...

f2c3062

Fix test

38dc44f

Siedlerchr reviewed Mar 12, 2024

View reviewed changes

src/main/java/org/jabref/model/entry/types/IEEETranEntryTypeDefinitions.java Show resolved Hide resolved

koppor enabled auto-merge March 12, 2024 22:40

koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Mar 12, 2024

Siedlerchr reviewed Mar 13, 2024

View reviewed changes

Merge branch 'main' into refine-bibentrytypes

9b6c050

koppor mentioned this pull request Mar 14, 2024

Support for (biblatex) langid field in entry editor #10868

Open

Siedlerchr approved these changes Mar 14, 2024

View reviewed changes

koppor added this pull request to the merge queue Mar 14, 2024

Merged via the queue into main with commit 5cb70df Mar 14, 2024
20 of 21 checks passed

koppor deleted the refine-bibentrytypes branch March 14, 2024 17:35

This was referenced Apr 2, 2024

Custom entry types might crash JabRef on start #11127

Closed

Fix importing of custom entry types with duplicate fields #11132

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up defintions of entry types #11013

Clean up defintions of entry types #11013

koppor commented Mar 12, 2024

calixtus commented Mar 12, 2024

koppor commented Mar 12, 2024

koppor commented Mar 12, 2024

Siedlerchr commented Mar 12, 2024 via email

koppor commented Mar 12, 2024

Siedlerchr commented Mar 13, 2024

Siedlerchr Mar 13, 2024

koppor Mar 13, 2024

Siedlerchr Mar 13, 2024

koppor Mar 13, 2024

github-actions bot commented Mar 14, 2024 •

edited

Clean up defintions of entry types #11013

Clean up defintions of entry types #11013

Conversation

koppor commented Mar 12, 2024

Mandatory checks

calixtus commented Mar 12, 2024

koppor commented Mar 12, 2024

koppor commented Mar 12, 2024

Siedlerchr commented Mar 12, 2024 via email

koppor commented Mar 12, 2024

Siedlerchr commented Mar 13, 2024

Siedlerchr Mar 13, 2024

Choose a reason for hiding this comment

koppor Mar 13, 2024

Choose a reason for hiding this comment

Siedlerchr Mar 13, 2024

Choose a reason for hiding this comment

koppor Mar 13, 2024

Choose a reason for hiding this comment

github-actions bot commented Mar 14, 2024 • edited

github-actions bot commented Mar 14, 2024 •

edited