IQSS / IQSS/dataverse

Feature Request: DataCite HTML Transformer

Open
#12,625 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Overview of the Feature Request

The Dataverse description field supports the following HTML tags:
<a>, <b>, <blockquote>, <br>, <code>, <del>, <dd>, <dl>, <dt>, <em>, <hr>, <h1>-<h3>, <i>, <img>, <kbd>, <li>, <ol>, <p>, <pre>, <s>, <sup>, <sub>, <strong>, <strike>, <u>, <ul>

DataCite description only supports this HTML tags:
<strong>, <em>, <b>, <i>, <code>, <pre>, <sub>, <sup>, <br>

(See Martin Fenners post on 2017.08.14:
https://groups.google.com/g/datacite-metadata/c/Di5TSstfafU
Note: Officially, only <br> is supported)

It would be good if HTML tags that are not handled by Datacite were stripped during export. For <li> elements, it might also be a good idea to replace them with indentation and <br> so that they are not simply displayed on a single line.

What inspired the request?
#12624

Are you thinking about creating a pull request for this feature?
no

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 by tracing the DataCite export path and review issue #12624 for the motivating case. Compare the supported DataCite tags with the Dataverse description tags, then verify that unsupported tags are stripped and that list items retain readable separation. The payload names no files or tests, so locating the relevant export code is part of the work.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.