Be more friendly when using journal alias field #2364

koppor · 2016-12-11T17:37:55Z

I'd like to copy bibtex entries to biblatex databases and vice versa. When using required fields only, this works perfectly. When in biblatex mode, JabRef does not display the value of journal in the required fields, because JabRef demands the field journaltitle. This is not only confusing for me, but also for other users: #2209.

I know that a clean solution is #521. This, however, won't happen this year.

I also know that a bibtex-to-biblatex converter and biblatex-to-bibtex converter is another solution. This, however, forces users to run these when copying and pasting between databases. This could be solved by running these converters silently when copying and pasting. When JabRef is used in parallel to other software (such as Notepad++), this does not help. I cannot force everyone to use JabRef. Thus, simply supporting journal in JabRef is the solution for me.

The biblatex manual states:

journal field (literal)
An alias for journaltitle, provided for BibTeX compatibility. See § 2.2.2.

Thus, it is not deprecated, but an alias and should IMHO be considered as full alternative for journaltitle.

I am aware that this patch makes it hard for users using full biblatex with journaltitle instead of journal. I am assuming that not much users are aware of the different modes of JabRef and that they switch back and forth for the same file or for the bibentries.

We now show both journaltitle and journal if these fields exists in as required fields.

This whole discussion somehow refs #160

Minor improvement: Enhanced integrity checks testing for biblatex-only fields to be aware of more fields (e.g., location).
All fetchers return now bibtex. (Before: ArXiv and msbib created biblatex)

Screenshot: Current JabRef

Screenshot: Updated JabRef

Checklist

Change in CHANGELOG.md described
Tests created for changes
Screenshots added (for bigger UI changes)
Manually tested changed features in running JabRef
[n/A] Check documentation status (Issue created for outdated help page at help.jabref.org?)
[n/a] If you changed the localization: Did you run gradle localizationUpdate?

lenhard · 2016-12-11T17:46:14Z

Hehe, let us see how political this will get :-)

Code-wise the PR looks fine and I give my +1 for merging. The only blocker is that, for some reason, the GUI tests are failing. EDIT: I restartet the build for the push, let's see if it works on a second try.

Siedlerchr · 2016-12-11T17:48:50Z

You could also create a discussion point at https://github.com/plk/biblatex

koppor · 2016-12-11T20:16:02Z

In case, I want to start a discussion, I'm going to do that on the DANTE e.V. mailing list or same DANTE e.V. event. 😇

koppor · 2016-12-11T20:25:43Z

The GUI tests are also failing on master: https://travis-ci.org/JabRef/jabref/builds/183054056

Refs #1700

matthiasgeiger · 2016-12-11T20:26:39Z

I don't like this.

Despite I'm not using the Biblatex mode I think it is the wrong approach to use the "deprecated" field instead of the intended field only because we are too lazy to implement our fetchers in the right way or because the user is too lazy to convert copied BibTeX entries to biblatex 😉

tobiasdiez · 2016-12-11T20:38:53Z

journaltitle is the main biblatex field for journal names and hence JabRef should support it as a first class citizen. This means, it should be displayed as a required field and "to biblatex" should convert journal to journaltitle. Moreover, the journal is not the only controversial field: date is the preferred way to store the publication date but bibtex only supports year and month. In my opinion, we shouldn't reinterpret the "biblatex standard" just because some users have problems.

But of course I can see that the new conventions are sometimes inconvenient if users switch between BibTeX and BibLaTeX. As far as I see it, the main problem is that "journal" lands in "deprecated" although it is an alias to a required field. Would it be a solution to show the journal field right below "journaltitle" in "required" if it has a value? Then it would work similar to year+month vs date.

koppor · 2016-12-11T21:14:46Z

@matthiasgeiger journal is not deprecated, it is just an alias field.

koppor · 2016-12-11T21:16:51Z

@tobiasdiez Yes, that would be a solution.

matthiasgeiger · 2016-12-11T21:29:35Z

Therefore I put it in quotes ;-)

…TeX mode

tobiasdiez

Minor comments but in general LGTM

tobiasdiez · 2016-12-12T08:43:25Z

src/main/java/net/sf/jabref/logic/importer/fetcher/ArXiv.java

@@ -345,10 +343,9 @@ public BibEntry toBibEntry(Character keywordDelimiter) {
            abstractText.ifPresent(abstractContent -> bibEntry.setField(FieldName.ABSTRACT, abstractContent));
            getDate().ifPresent(date -> bibEntry.setField(FieldName.DATE, date));
            primaryCategory.ifPresent(category -> bibEntry.setField(FieldName.EPRINTCLASS, category));
-            journalReferenceText.ifPresent(journal -> bibEntry.setField(FieldName.JOURNALTITLE, journal));
-            getPdfUrl().ifPresent(url -> (new TypedBibEntry(bibEntry, BibDatabaseMode.BIBLATEX))
+            journalReferenceText.ifPresent(journal -> bibEntry.setField(FieldName.JOURNAL, journal));


Please leave journaltitle here since the returned entry is in biblatex format (see date above)

Done. Although I assume that even with a bibtex database, I get a biblatex entry.

tobiasdiez · 2016-12-12T08:46:21Z

src/main/java/net/sf/jabref/model/entry/BibEntry.java

+        }
+
+        this.setField(FieldName.FILE, newValue);
+        return Optional.of(new FieldChange(this, FieldName.FILE, oldValue.orElse(""), newValue));


return this.setField should be enough

tobiasdiez · 2016-12-12T08:50:00Z

src/main/java/net/sf/jabref/logic/integrity/NoBibtexFieldChecker.java


 import net.sf.jabref.logic.integrity.IntegrityCheck.Checker;
 import net.sf.jabref.logic.l10n.Localization;
 import net.sf.jabref.model.entry.BibEntry;
+import net.sf.jabref.model.entry.EntryConverter;
 import net.sf.jabref.model.entry.FieldName;

 public class NoBibtexFieldChecker implements Checker {


Rename to NoBibLatex ?

Added class comment

This checker checks whether the entry does not contain any field appearing only in BibLaTeX (and not in BibTex)

Thus, the name is IMHO correct.

tobiasdiez · 2016-12-12T08:51:13Z

src/test/java/net/sf/jabref/logic/integrity/NoBibTexFieldCheckerTest.java

+    public void journaltitleIsRecognizedAsBibLaTeXOnlyField() {
+        BibEntry entry = new BibEntry();
+        entry.setField("journaltitle", "test");
+        assertNotEquals(Collections.emptyList(), checker.check(entry));


This and location should report an error, shouldn't they?

Why? journaltitle and location are BibLaTeX only. Thus, everything is allright.

Maybe I just don't understand what the check is doing, but "This checker checks whether the entry does not contain any field appearing only in BibLaTeX" implies for me that I get an error if I use a field (journaltitle) which is only defined in BibLatex and not in Bibtex, right?

It was implemented in #2059.

Yes, you get an error if you use a field (journaltitle) which is only defined in BibLatex and not in Bibtex.

~~Therefore, I wrote assertNOTequals(emptylist). That means, there is an error.~~

Fixed in c7841a6

koppor · 2016-12-13T20:53:19Z

All comments addressed. Should be good to go now.

koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Dec 11, 2016

koppor requested a review from tobiasdiez December 11, 2016 17:39

koppor force-pushed the removeJournalTitle branch from 217764a to 0137c5a Compare December 11, 2016 18:13

koppor force-pushed the removeJournalTitle branch from 2f14b88 to 75f38bb Compare December 11, 2016 20:26

koppor removed the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Dec 11, 2016

koppor changed the title ~~Replace journaltitle by journal~~ [WIP] Replace journaltitle by journal Dec 11, 2016

koppor changed the title ~~[WIP] Replace journaltitle by journal~~ [WIP] Be more friendly when using journal alias field Dec 12, 2016

koppor force-pushed the removeJournalTitle branch from 7fa3cd9 to 697b05f Compare December 12, 2016 02:22

koppor changed the title ~~[WIP] Be more friendly when using journal alias field~~ Be more friendly when using journal alias field Dec 12, 2016

Entry editor shows both journal and journaltitle in the case of BibLa…

7e57775

…TeX mode

koppor force-pushed the removeJournalTitle branch from 697b05f to 7e57775 Compare December 12, 2016 02:40

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

tobiasdiez requested changes Dec 12, 2016

View reviewed changes

Incorporate feedback

d38bd97

koppor force-pushed the removeJournalTitle branch from 7b77d29 to 7f68ccb Compare December 13, 2016 07:53

Make test for journaltitle and location more readable

c7841a6

koppor force-pushed the removeJournalTitle branch from 7f68ccb to c7841a6 Compare December 13, 2016 07:53

Fix checktyle

f58ba14

koppor added this to the v3.8 milestone Dec 13, 2016

koppor merged commit a6b25c5 into master Dec 16, 2016

koppor deleted the removeJournalTitle branch December 16, 2016 14:36

koppor added bib(la)tex and removed status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers labels Jun 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Be more friendly when using journal alias field #2364

Be more friendly when using journal alias field #2364

koppor commented Dec 11, 2016 •

edited

Loading

lenhard commented Dec 11, 2016 •

edited

Loading

Siedlerchr commented Dec 11, 2016

koppor commented Dec 11, 2016

koppor commented Dec 11, 2016

matthiasgeiger commented Dec 11, 2016

tobiasdiez commented Dec 11, 2016

koppor commented Dec 11, 2016

koppor commented Dec 11, 2016

matthiasgeiger commented Dec 11, 2016

tobiasdiez left a comment

tobiasdiez Dec 12, 2016

koppor Dec 12, 2016

tobiasdiez Dec 12, 2016

koppor Dec 12, 2016

tobiasdiez Dec 12, 2016

koppor Dec 12, 2016

tobiasdiez Dec 12, 2016

koppor Dec 12, 2016

tobiasdiez Dec 12, 2016 •

edited

Loading

koppor Dec 12, 2016 •

edited

Loading

koppor Dec 13, 2016

koppor commented Dec 13, 2016

Be more friendly when using journal alias field #2364

Be more friendly when using journal alias field #2364

Conversation

koppor commented Dec 11, 2016 • edited Loading

Screenshot: Current JabRef

Screenshot: Updated JabRef

Checklist

lenhard commented Dec 11, 2016 • edited Loading

Siedlerchr commented Dec 11, 2016

koppor commented Dec 11, 2016

koppor commented Dec 11, 2016

matthiasgeiger commented Dec 11, 2016

tobiasdiez commented Dec 11, 2016

koppor commented Dec 11, 2016

koppor commented Dec 11, 2016

matthiasgeiger commented Dec 11, 2016

tobiasdiez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tobiasdiez Dec 12, 2016 • edited Loading

Choose a reason for hiding this comment

koppor Dec 12, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koppor commented Dec 13, 2016

koppor commented Dec 11, 2016 •

edited

Loading

lenhard commented Dec 11, 2016 •

edited

Loading

tobiasdiez Dec 12, 2016 •

edited

Loading

koppor Dec 12, 2016 •

edited

Loading