Project

General

Profile

bug #9618

fix historic NomenclaturalCodeEdition names ICN -> ICBN

Added by Andreas Kohlbecker 6 months ago. Updated 5 months ago.

Status:
Closed
Priority:
New
Category:
cdmlib
Target version:
Start date:
05/10/2021
Due date:
% Done:

100%

Severity:
normal
Found in Version:

Description

As of 2012 the IAPT has renamed the code editions to ICN, older code editions like the Vienna code and former releases are named ICBN.
In the NomenclaturalCodeEdition the enum names of botanical codes erroneously all have the abbreviation ICN.
The names of historic editions should be fixed.

picture859-1.png View (27.4 KB) Andreas Kohlbecker, 05/11/2021 03:09 PM

picture429-1.png View (10.2 KB) Andreas Müller, 05/11/2021 04:35 PM


Related issues

Related to Edit - task #9617: Rename ICNB to ICNP Closed 05/10/2021
Related to Edit - feature request #9640: Updated List ICN/ICBN editions New 06/01/2021

Associated revisions

Revision a306e68c (diff)
Added by Andreas Müller 6 months ago

ref #9618 add NomenclaturalCodeEdition.abbrev (some abbrevs are still guesses)

History

#1 Updated by Andreas Kohlbecker 6 months ago

  • Related to task #9617: Rename ICNB to ICNP added

#2 Updated by Andreas Müller 6 months ago

  • Target version changed from Unassigned CDM tickets to Release 5.25

NomenclaturalCodeEdition entry names are pure enum "names" not used for anything else. So we can rename them but there is no big need for this as they should never be shown to the user in anyway. Having all the same prefix has a certain advantage for sorting. Needs discussion.

This differs from NomenclaturalCode, where the abbreviation is also used as a title that is shown to users (but there we only use the current code abbreviation for pratical reasons.

#3 Updated by Andreas Müller 6 months ago

  • Assignee changed from Andreas Müller to Andreas Kohlbecker

#4 Updated by Andreas Kohlbecker 6 months ago

Andreas Müller wrote:

NomenclaturalCodeEdition entry names are pure enum "names" not used for anything else. So we can rename them but there is no big need for this as they should never be shown to the user in anyway. Having all the same prefix has a certain advantage for sorting. Needs discussion.

This differs from NomenclaturalCode, where the abbreviation is also used as a title that is shown to users (but there we only use the current code abbreviation for pratical reasons.

These "practical" reasons lead to impractical result, as shown in this screen shot:

There are indeed two problems as there is no way to get the correct representation of the code edition from one of both enums.

  1. For many current codes the NomenclaturalCodeEdition enum name is the only source for the correct code acronym, like "ICN"
  2. There is no way to get the correct code acronym for historic editions, as these are completely missing in the cdm.

Suggestion: We should extend the NomenclaturalCode by year range dependent representation, an additional getLabel methods would have a second paramter:


getLabel(Integer year); 
getLabel(Language language, Integer year); 

that is NomenclaturalCode.ICNAFP.getLabel(2011) would return "ICN", whereas NomenclaturalCode.ICNAFP.getLabel(2005) would return "ICBN"

#5 Updated by Andreas Müller 6 months ago

I was not in cc of this ticket anymore therefore I missed the discussion.

#6 Updated by Andreas Müller 6 months ago

But I do not understand what we need the abbreviation for. It is really an important information to show the abbreviation of the code? In the TaxEditor we do it the following way:

which to me seems fully enough.

However, if there is a user requirement to show the historic code abbreviation then we should add it as a parameter in the enum (which is very easy to create, once someone gives me the full list, e.g. for the 1867 code I have no idea what the abbrev is).
To misuse the enum name for this to me does not seem to be the correct way and is against the general CDM philosophy use enum names neither as names nor as labels.

#7 Updated by Andreas Kohlbecker 6 months ago

  • Assignee changed from Andreas Kohlbecker to Andreas Müller

The Taxeditor is not the only UI we have. There is the UI where I took the screenshot from, therefore I don't quite understand your point.

What if this information is to be shown the Data Portal, would you just write "Cambridge 1935" without stating which code this is about? This is for sure not sufficient.

To misuse the enum name for this to me does not seem to be the correct way and is against the general CDM philosophy use enum names neither as names nor as labels.

I don't understand why you repeat this point, this is already discussed to an end. I made a specific suggestion how this can be solved? Do you need more details on this?

#8 Updated by Andreas Müller 6 months ago

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

You mean the "Suggestion" above?

I do not understand why this needs to be a method for NomenclaturalCode.

Why not simply NomenclaturalCodeEditon.getLabel() . This is what I meant with "if there is a user requirement to show the historic code abbreviation then we should add it as a parameter". I implemented it this way now.

But as I mentioned above I need a full list of all correct abbreviations for all codes. As long as this list does not exist the abbreviations may not be correct.

#9 Updated by Andreas Müller 6 months ago

What if this information is to be shown the Data Portal, would you just write "Cambridge 1935" without stating which code this is about? This is for sure not sufficient.

From my experience taxonomist say "Shenshen code" not "ICN 2017 Shenszhen" therefore I didn't expect that the abbreviation is needed. Also not on the data portal. But I might be wrong.
Also in the phycobank editor I can't really see what the advantage is to add the code abbreviation in the drop down label. But this might become clearer with the context which is missing on the screenshot.

Anyways, the problem should be solved now.

#10 Updated by Andreas Kohlbecker 6 months ago

  • Status changed from Resolved to Closed
  • % Done changed from 0 to 100

Solution accepted. Ticket can be closed.

#11 Updated by Andreas Müller 6 months ago

Andreas Müller wrote:

But as I mentioned above I need a full list of all correct abbreviations for all codes. As long as this list does not exist the abbreviations may not be correct.

This list does not yet exist. Henning, can you provide such a list?

#13 Updated by Wolf-Henning Kusber 6 months ago

Yes, will do two lissts, (i) a short citation, and (ii) correct citations with help of the literature in our library.

#14 Updated by Andreas Kohlbecker 6 months ago

diese Liste dürfte vollständig sein https://www.iapt-taxon.org/historic/list-of-Codes.htm

#15 Updated by Andreas Müller 6 months ago

Andreas Kohlbecker wrote:

diese Liste dürfte vollständig sein https://www.iapt-taxon.org/historic/list-of-Codes.htm

The list only includes botanical codes. All other codes are missing.

#16 Updated by Andreas Kohlbecker 6 months ago

Isn't this a good start? We can add more lists on demand.

#17 Updated by Andreas Müller 6 months ago

Die Liste enthält leider keine Abkürzungen, um die es aber gerade ging. Letztlich kann ich nur raten. War der "Vienna Code" ein Irbn? Es fehlen auch die "Laws" von 1867.

#18 Updated by Andreas Müller 6 months ago

Zudem die Frage, wie mit den Langformen umzugehen ist. Bislang hatten wir uns darauf geeinigt, lediglich DOIs oder URLs in die enum mit aufzunehmen. Langformen sind deutlich problematischer wegen dem Formatierungsproblem. Wenn das wirklich notwendig ist, sollten wir daraus ein separates Ticket machen. Dieses Ticket verstehe ich primär als Ticket für Abkürzungen.

#19 Updated by Wolf-Henning Kusber 6 months ago

Rein inhaltlich. Mindestens für das Projekt PhycoBank benötigen wir den Link zum Vollzitat. Ich gehe davon aus, das defaultmäßig nur das Kurzzitat angezeigt werden soll.

#20 Updated by Andreas Kohlbecker 6 months ago

Andreas Müller wrote:

Die Liste enthält leider keine Abkürzungen, um die es aber gerade ging.

Aus einem Chat mit Henning: "Prima, auf der Basis können wir Kurzzitate erstellen. Da müssten Autor jahr, Kurzzitat, z.B. ICBN und Ort der Konferenz und Jahr der Konferenz rein, eventuell kann man da noch kürzen."
Das ist also in Arbeit.

Letztlich kann ich nur raten.

musst du also nich ;-)

War der "Vienna Code" ein Irbn?

Hierbei steht "International Rules of Botanical Nomenclature" aslo eher nicht, ob das Akromyn nun IRBN ist wird Henning klären.

Es fehlen auch die "Laws" von 1867.

Guter Hinweis und auch ein Task für Henning.

#21 Updated by Andreas Müller 5 months ago

  • Target version changed from Release 5.25 to Release 5.23

#22 Updated by Andreas Müller 5 months ago

looks like the final list is still missing

#23 Updated by Andreas Kohlbecker 5 months ago

Andreas Müller wrote:

Andreas Kohlbecker wrote:

diese Liste dürfte vollständig sein https://www.iapt-taxon.org/historic/list-of-Codes.htm

The list only includes botanical codes. All other codes are missing.

This ticket is only about the botanical codes.

Please create a new ticket for the full reference list of other codes if needed.

#24 Updated by Wolf-Henning Kusber 5 months ago

New Ticket: #9640

#25 Updated by Andreas Müller 5 months ago

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 40 MB)