CatalogueOfLife / retired_ConversionTool

0 stars 0 forks source link

Read CoL citation from ac-export #18

Open mdoering opened 5 years ago

mdoering commented 5 years ago

Currently the CoL has 3 citations presented here which are based on a credits.ini with 3 blocks.

Propose to reduce the citation to just a single one as we do not have DVDs anymore. We could then bundle the following credits.ini file with the ac-export.zip:


type = "monthly"
edition = "29th January 2019"
citation = "Roskov Y., Ower G., Orrell T., Nicolson D., Bailly N., Kirk P.M., Bourgoin T., DeWalt R.E., Decock W., Nieukerken E. van, Zarucchi J., Penev L., eds. (2019). Species 2000 & ITIS Catalogue of Life, 29th January 2019. Digital resource at www.catalogueoflife.org/col. Species 2000: Naturalis, Leiden, the Netherlands. ISSN 2405-8858."```

Which could then be used to render:

> How to cite the Catalogue of Life monthly edition on the Web:
> Roskov Y., Abucay L., Orrell T., Nicolson D., Bailly N., Kirk P.M., Bourgoin T., DeWalt R.E., Decock W., De Wever A., Nieukerken E. van, Zarucchi J., Penev L., eds. (2019). Species 2000 & ITIS Catalogue of Life, 29th January 2019. Digital resource at www.catalogueoflife.org/col. Species 2000: Naturalis, Leiden, the Netherlands. ISSN 2405-8858.
> 
mdoering commented 5 years ago

ping @gdower @yroskov for comments. I have proposed to remove the annual citation from the monthly edition interface as you look for how to cite the annual edition on the AC interface, not the monthly one.

yroskov commented 5 years ago

Configuration page in CoL Workbench contained two alternative forms/predicates: one for generating "GSG in CoL" citations for monthly edition, another for generating citations for the annual checklist. Each edition contained adopted set of citations.

yroskov commented 5 years ago

I am expecting that CoL+ will have configuration page which allows editor to control the title for monthly edition or for annual checklist. (I have no objection if date will be applied automatically to the title of monthly edition as a date of deployment (or conversion?): "Catalogue of Life, 26th December 2019"). The title and list of editors should be used for automatic generation of 1) whole CoL citation and 2) each GSD in CoL. Example: Yunakov N. (2019). 3i Curculio: 3i taxonomic databases, Curculionidae, subfamily Entiminae (version Jan 2019) [=GSD metadata]. In: Species 2000 & ITIS Catalogue of Life, 2019 Annual Checklist [=title of CoL edition] (Roskov Y., Ower G., Orrell T., Nicolson D., Bailly N., Kirk P.M., Bourgoin T., DeWalt R.E., Decock W., Nieukerken E. van, Zarucchi J., Penev L., eds.) [=list of editors]. Digital resource at www.catalogueoflife.org/annual-checklist/2019. [= permanent URL] Species 2000: Naturalis, Leiden, the Netherlands. [= publisher] ISSN 2405-884X. [= ISSN] plus DOI [see also Sp2000/AC_Interface#4].

mdoering commented 5 years ago

@ruud-altenburg how do the GSD citations get created? If they follow a template Id expect that to happen during conversion?

ruud-altenburg commented 5 years ago

The ini file is read and copied into the database (_credits table). Based on the current setting (0/1), these are displayed on the web site.

ruud-altenburg commented 5 years ago

Haven't heard from you for a while. What's the planning for a rollout?

mdoering commented 5 years ago

we are planning right now trying to get an overview of the outstanding issues. Our hope is first week of december...

mdoering commented 5 years ago

I am getting slightly confused about what information needs to be supplied to create all citations on the portal.

1) We currently have 3 CoL citations (DVD, annual web, monthly web). We definitely want to remove the DVD one which does not exist anymore. I did propose at the top to also merge the two CoL citations to just one, but it seems this is not liked. So let's continue with the 2 web ones. We do not plan to use this temporary CoL+ conversion route for another annual CoL, so that can remain static I believe. That basically leaves the monthly citation which should be supplied from the CoL+ system.

@ruud-altenburg @gdower can you please shed some light on this? How about supplying the entire _credits table information directly as a CSV instead of the ini file?

ruud-altenburg commented 5 years ago

The credits differ for monthly

Roskov Y., Ower G., Orrell T., Nicolson D., Bailly N., Kirk P.M., Bourgoin T., DeWalt R.E., Decock W., Nieukerken E. van, Zarucchi J., Penev L., eds. ([year]). Species 2000 & ITIS Catalogue of Life, [edition]. Digital resource at www.catalogueoflife.org/col. Species 2000: Naturalis, Leiden, the Netherlands. ISSN 2405-8858.

and annual

Roskov Y., Ower G., Orrell T., Nicolson D., Bailly N., Kirk P.M., Bourgoin T., DeWalt R.E., Decock W., Nieukerken E. van, Zarucchi J., Penev L., eds. ([edition]). Species 2000 & ITIS Catalogue of Life, 2019 Annual Checklist. Digital resource at www.catalogueoflife.org/annual-checklist/[edition]. Species 2000: Naturalis, Leiden, the Netherlands. ISSN 2405-884X.

If you intend to keep both editions, I guess you'll have to keep those.

As you can see, the placeholders are replaced with actual data for the info pages.

Check https://github.com/Sp2000/AC_Interface/blob/master/application/models/AModel.php for setCredit and setEdition and also notice the lastest git commit message :)

mdoering commented 5 years ago

Thanks Ruud, but I am utterly lost. I simply try to understand what extra information we need to pass to the conversion tool so it can generate all citations without us modifying any (github) files.

Might I be correct that the only thing needed is the release date? The rest including CoL authors won't really change in the next months.

yroskov commented 5 years ago

Please note, list of editors is not static. It may vary from one month to another, and I need a template to change this information. Ruud's ini file worked well in the past.

mdoering commented 5 years ago

Unless someone objects I would like to supply the entire citation directly into the ini file like this:

current_edition = "monthly" ; monthly/annual

[monthly]
citation = "Roskov Y., Ower G., Orrell T., Nicolson D., Bailly N., Kirk P.M., Bourgoin T., DeWalt R.E., Decock W., Nieukerken E. van, Zarucchi J., Penev L., eds. (2019). Species 2000 & ITIS Catalogue of Life, 29th January 2019. Digital resource at www.catalogueoflife.org/col. Species 2000: Naturalis, Leiden, the Netherlands. ISSN 2405-8858."

[annual]
citation = "Roskov Y., Ower G., Orrell T., Nicolson D., Bailly N., Kirk P.M., Bourgoin T., DeWalt R.E., Decock W., Nieukerken E. van, Zarucchi J., Penev L., eds. (2019). Species 2000 & ITIS Catalogue of Life, 2019 Annual Checklist. Digital resource at www.catalogueoflife.org/annual-checklist/2019. Species 2000: Naturalis, Leiden, the Netherlands. ISSN 2405-884X."

Note there is no edition var anymore. Would that work, @ruud-altenburg ?

yroskov commented 5 years ago

Let see how it work in a nearest conversion cycle.

ruud-altenburg commented 5 years ago

@mdoering, the edition is static now (29th January 2019), that will change of course. We have iterated over this a couple of times and at the time this was the best "template". I can't tell in which way you offer Yuri the option to change the string?

yroskov commented 5 years ago

Remember, I have no access to the Workbench@webmin anymore and cannot control title, info pages, interface headings and texts.

mdoering commented 5 years ago

if you do not need the {edition} variable for anything else than the citation I prefer to generate the full citation in CoL+

ruud-altenburg commented 5 years ago

Fine with me!

ruud-altenburg commented 4 years ago

Now incorporated from credits.ini in archive