IQSS / IQSS/dataverse

Suggestion: Send series information to DataCite as RelatedItem of type "IsPublishedIn” instead of description of type "SeriesInformation"

Open
#12,228 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Suggestion
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Suggestion

We've received a request to change the way information in the "Series" metadata field (citation block) is sent to DataCite.

Currently, it is sent as a description of type "SeriesInformation":

<description descriptionType="SeriesInformation">My Series</description> 

(https://github.com/IQSS/dataverse/blob/develop/src/main/java/edu/harvard/iq/dataverse/pidproviders/doi/XmlMetadataTemplate.java#L1365-L1383)

The DataCite schema PDF states that

SeriesInformation
Definition: Information about a repeating series, such as volume, issue, number.
Usage Notes: The information previously encoded as a description with this type should now be explicitly provided in tagged fields using the new 20. RelatedItem property with relationType “IsPublishedIn” selected.

(since version 4.4 update)

https://datacite-metadata-schema.readthedocs.io/_/downloads/en/4.5/pdf/

What existing behavior do you want changed?

We'd like to suggest changing the XML sent to DataCite to use the new format (RelatedItem property with relationType “IsPublishedIn”) when sending the "Series" metadata.

Any open or closed issues related to this suggestion?

Didn't find any

Are you thinking about creating a pull request for this issue?
Help is always welcome, is this idea something you or your organization plan to implement?

Yes, we would open a PR for this

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/main/java/edu/harvard/iq/dataverse/pidproviders/doi/XmlMetadataTemplate.java at lines 1365-1383, then compare the current Series mapping with the DataCite 4.5 schema guidance for RelatedItem and relationType “IsPublishedIn”. Done means the Series metadata is emitted using the requested RelatedItem format rather than a SeriesInformation description.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.