Ability to format Citation

[vchendrix]

For the ESS-DIVE project we have overridden the citation view to use the following datacite format

Creators (PublicationYear): Title. Publisher. Identifier

e.g. Rogers A; Serbin S; Ely K; Wu J; Wolfe B; Dickman T; Collins A; Detto M; Grossiord C; McDowell N; Michaletz S (2017): CO2 response (ACi) gas exchange, calculated Vcmax & Jmax parameters, Feb2016-May2016, PA-SLZ, PA-PNM: Panama. PUBLISHER. http://dx.doi.org/10.15486/ngt/1411867

We modified the metcat ui in the following way to achieve this.

• Override CitationView.render() - This allowed us to format the citation as specified by ESS-DIVE.
• Add project solr field to search results - publisher EML entity is not indexed by metacat and thus was not available via a Solr query. We decided to use the project as the publisher since that field was index by Metacat in Solr. This change required us to override the following functions to add project to the search results.
  • SolrResult.getCitationView()
  • SolrResult.getInfo
  • DataCatalogView.getResults()

This issue might result in two enhancements.

1. Provide the ability to change the citation format without overriding CitationView.render()
2. Provide the ability to modifiy the Solr fields returned for a query

[mbjones]

@rushirajnenuji I thought that you were working on this ability to format citations using CSL formatting styles. Is there another ticket that is tracking its progress?

[vchendrix]

@csjx Found that we already logged this issue that we discuss in our tech meeting. To capture what we said in our tech meeting:

The goal is to reduce technical debt for ESS-DIVE (CitationView - making it configurable for what fields show up in the citation., solr result configuration)

Are the authors configurable (how to treat it if there are lots of authors)

[laijasmine]

Adding an example from the ADC that also needs this citation formatting feature:

We want to update our record with the DOI from EOL as the series id. EOL still has authority over this dataset but we have a copy at ADC.

1. How the citation is displayed at the ADC:
   Carin J. Ashjian and Robert G. Campbell. Mesozooplankton Abundance and Biomass [Ashjian, C. and R. Campbell]. Arctic Data Center. urn:uuid:a4b4aa8c-f600-4fd1-a0e2-c259cc8aa83d.

2. DOI citation from datacite (EOL) is formatted as:
   Ashjian, C., & Campbell, R. (2007). Mesozooplankton Abundance and Biomass. Version 1.0 (Version 1.0) [Data set]. UCAR/NCAR - Earth Observing Laboratory. https://doi.org/10.5065/D6PZ5768

There is currently a difference in the ‘Publisher’ listed between the EOL and Arctic Data Center citations? We want to ensure that our copy of the metadata produces a citation string that is compatible with what is produced by the DOI.

[robyngit]

@vchendrix - You said you'd like "the ability to change the citation format without overriding CitationView.render()" - I agree that we should build a better way to configure this. Do you have any thoughts as to how the citation format should ideally be specified?

[mbjones]

If we're going to go down the flexible citation rendering approach, I think CSL makes most sense. @rushirajnenuji worked on that for a bit, and there are some existing javascript libraries that handle it. We haven't touched on this in a while, but discussed this approach in #973

[vchendrix]

@vchendrix - You said you'd like "the ability to change the citation format without overriding CitationView.render()" - I agree that we should build a better way to configure this. Do you have any thoughts as to how the citation format should ideally be specified?

@robyngit - I haven't thought too deeploy about it but I was thinking some kind of templating approach with the ability to map different fields to the citation parts.

@mbjones what is CSL?

[mbjones]

CSL is Citation Style Language, the industry standard for flexibly formatting citations, and in use by all major bibliographic software. Details in the issue I linked.