Project

General

Profile

Actions

feature request #10240

closed

Improve DOI formatting for references

Added by Andreas Müller about 1 year ago. Updated 3 months ago.

Status:
Closed
Priority:
Highest
Assignee:
Category:
cdmlib
Target version:
Start date:
Due date:
% Done:

100%

Estimated time:
Severity:
major

Description

AM:

im Kontext der Flora von Griechenland kommt gerade eine Frage zur Formatierung von DOI Angaben bei Referenzen auf.

Folgender Fall: Die frisch erschiene 1. PDF der Flora of Greece Volume 1 (https://doi.org/10.3372/fog.v1.arec.ed1) gibt als recommended citation folgendes an:

Turland N. J. 2023: Arecaceae (ed. 1). – In: Flora of Greece Editorial Committee, Flora of
Greece Volume 1. – Hellenic Botanical Society and Botanic Garden and Botanical Museum
Berlin. https://doi.org/10.3372/fog.v1.arec.ed1

Daraus ergibt sich die Anforderung, dass Referenzen mit DOIs so formatiert werden sollten, dass die DOI mit im Zitat erscheint. Bislang machen wir das noch nicht so, sondern verlinken lediglich mit einem Symbol auf die DOI:

Andreas K. war wohl der Meinung, dass die Verlinkung über Symbol eher die zukunftsweisendere ist. Wenn ich allerdings https://www.firmennest.de/unkategorisiert/externe-links-kennzeichnen-fuer-usability/ lese oder mit Wikipedia anschauen, denke ich eher, dass in diesem Fall eher angesagt ist, sowohl die DOI anzugeben als auch das Symbol (bzw. das Symbol für externe Links

) und beides zu verlinken.

Zu klären wäre also erstmal, ob

• die DOI grundsätzlich immer als Volltext angezeigt werden soll
• wenn ja, was mit besonders langen DOIs passiert, also soll es eine bestimmte Anzahl Zeichen geben ab dem ein Truncating stattfindet?
• ob zusätzlich das Symbol für externe Links mit verwendet werden soll
• wenn beide, ob auch beide verlinkt sein sollen
• ob das für online- und printpublication gleichermaßen gilt
• ob es konfigurierbar sein soll je nach Projekt

====

Nak:

ich finde die Formatierung mit der DOI wie in dem Flora of Greece Beispiel besser, so mache ich das auch in der Bibliographie für Caryophyllales (manuell) und verlinke mit der DOI.
Für Print-Publikationen ist das auch sehr nützlich.

  • die DOI grundsätzlich immer als Volltext angezeigt werden soll

    ich finde, ja

  • wenn ja, was mit besonders langen DOIs passiert, also soll es eine bestimmte Anzahl Zeichen geben ab dem ein Truncating stattfindet?

    da bräuchten wir vielleicht ein Beispiel

  • ob zusätzlich das Symbol für externe Links mit verwendet werden soll

    das wäre vielleicht gut, wenn es keine DOI ist, sondern eine URL

  • wenn beide, ob auch beide verlinkt sein sollen

    Ich würde sagen, wenn DOI, dann ist die verlinkt, ohne zusätzliches Symbol

  • ob das für online- und printpublication gleichermaßen gilt

    für print ist das auch sehr nützlich

  • ob es konfigurierbar sein soll je nach Projekt

    wir könnten uns für ein Default entscheiden, und es kann konfigurierbar sein

NoK:

ich teile die Meinung von Nadja zu den angefragten Punkten

WGB:

ich bin übrigens dafür, die DOI als Link anzugeben, wenn das möglich ist, also ohne Symbol.

WHK:

die Ausgabe der DOI-URI finde ich aus user Sicht wichtig, da sie zur weiteren Recherche kopiert werden kann. Häufig sehe ich Links, die nicht funktionieren oder bei denen der Zugriff beschränkt ist. Deshalb würde mir ein Symbol nicht reichen.
Inzwischen habe ich References nach dem Turland-Bespiel in so vielen Journals gefunden, dass ich davon ausging, dass das fast so etwas wie ein Standard ist.


Files

clipboard-202302011737-26mfd.png (21.5 KB) clipboard-202302011737-26mfd.png Andreas Müller, 02/01/2023 05:37 PM
clipboard-202302011738-dmvcq.png (373 Bytes) clipboard-202302011738-dmvcq.png Andreas Müller, 02/01/2023 05:38 PM

Related issues

Related to EDIT - bug #10455: Improve DOI formatting for references in cdm-lightNewKatja Luther

Actions
Actions #1

Updated by Andreas Müller about 1 year ago

  • Description updated (diff)
Actions #2

Updated by Andreas Müller about 1 year ago

  • Description updated (diff)

We need to decide if we add the DOI at all to the cdmlib formatter or if it should be handled separately by the publication softwares. If we use cdmlib-formatting we need to distinguish formatting with/without html.
It is possible to not add it as it seems to be always at the end.

Actions #3

Updated by Andreas Müller about 1 year ago

  • Description updated (diff)
Actions #4

Updated by Andreas Müller about 1 year ago

  • Description updated (diff)
Actions #5

Updated by Andreas Müller about 1 year ago

  • Target version changed from Unassigned CDM tickets to Release 5.44
Actions #6

Updated by Katja Luther about 1 year ago

We also need a method to get an html representation of the source (see sourceAsHtml() in ManifestComposer/cdmlib-remote)

Actions #7

Updated by Andreas Müller 8 months ago

Katja Luther wrote in #note-6:

We also need a method to get an html representation of the source (see sourceAsHtml() in ManifestComposer/cdmlib-remote)

How far is this related to this ticket? To me it seems to be a general issue related to the ManifestComposer. If so I guess it is better to create a new ticket for this (with some more explanation).

Actions #8

Updated by Andreas Müller 4 months ago

  • Assignee changed from Andreas Müller to Katja Luther
  • Priority changed from New to Highest
  • Target version changed from Release 5.44 to Release 5.42
  • Severity changed from normal to major
Actions #9

Updated by Katja Luther 3 months ago

  • Status changed from New to Resolved
  • Assignee changed from Katja Luther to Andreas Müller

There is a first unconfigurable implementation available. Please have a look. For a configurable version I would create a folow up ticket.
As an example you can use Taraxacum aequilobum in cichorieae test database or https://int.e-taxonomy.eu/dataportal/integration/reference/?q=cdm_dataportal/taxon/c6716cee-2039-4ba8-a239-4b1b353f9c84/synonymy

Actions #10

Updated by Andreas Müller 3 months ago

  • Status changed from Resolved to Feedback
  • Assignee changed from Andreas Müller to Katja Luther
  • % Done changed from 0 to 60

The given example is a bit misleading as it is not a typical reference with author, year, title, maybe in-reference, etc. So maybe we can link an example from with more realistic data.

However, even with the given example it can be seen that probably a separator is missing. So, if the formatted reference itself does not have a "." at the end (or at least another separator like "," or ";" which usually should not be the case) a "." should be added before the space.

Actions #11

Updated by Andreas Müller 3 months ago

Also we need a separate ticket for the implementation in cdm-light / print publications (#10455)

Actions #12

Updated by Katja Luther 3 months ago

  • Status changed from Feedback to Resolved
  • Assignee changed from Katja Luther to Andreas Müller

Andreas Müller wrote in #note-10:

The given example is a bit misleading as it is not a typical reference with author, year, title, maybe in-reference, etc. So maybe we can link an example from with more realistic data.

However, even with the given example it can be seen that probably a separator is missing. So, if the formatted reference itself does not have a "." at the end (or at least another separator like "," or ";" which usually should not be the case) a "." should be added before the space.

this is fixed, please review.

Actions #13

Updated by Katja Luther 3 months ago

  • Related to bug #10455: Improve DOI formatting for references in cdm-light added
Actions #14

Updated by Katja Luther 3 months ago

Now the doi is added with external link and if no separator is at the end of the reference a point is added. If an internal link is shown, this is behind the point and between reference and doi.

Actions #15

Updated by Andreas Müller 3 months ago

  • Status changed from Resolved to Closed
  • Assignee changed from Andreas Müller to Katja Luther
  • % Done changed from 60 to 100

I think we can close this for now. If there will be detail refinement requests they can be discussed and implemented later.

Actions

Also available in: Atom PDF