IQSS / IQSS/dataverse

displayFormat code appears in the Version Differences Details table

Open
#8,410 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

What steps does it take to reproduce the issue?

  • When does this issue occur?
    When viewing the "Version Differences Details" table of a dataset whose metadata has changed and that metadata has displayFormat code that includes HTML tags, such as the Related Publication URL field, the Producer URL field, and the Producer Logo URL field.

  • Which page(s) does it occurs on?
    On the "Version Differences Details" table in the Versions tab of the dataset page.

  • What happens?
    Instead of only the child field's value, we also see the HTML tags from the field's displayFormat (defined in the metadatablock's TSV file).

    For example, the displayFormat for the Related Publication URL field is defined in the citation.tsv file as: <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a>, and if https://doi.org/12345 is entered in the Related Publication URL field of a draft dataset version, what appears in that draft version's "Version Differences Details" table is <a href="#VALUE" target="_blank" rel="noopener">https://doi.org/12345</a>

  • To whom does it occur (all users, curators, superusers)?
    All users, but I think it might be particularly unhelpful to users who don't know why those HTML tags are there

  • What did you expect to happen?
    Should only what the user entered in the field be displayed? Should it be plain text or should the HTML in the displayFormat be used in the table as well, such as to render the text as a link? My guess would be that it would be easier to compare changes across dataset versions if the user saw only what they changed, and since they have no control over the displayFormat code they wouldn't be able to change that.

Which version of Dataverse software are you using?
v6.3 and earlier versions

Any related open or closed issues to this bug report?
https://github.com/IQSS/dataverse/issues/1981

Screenshots:

  • What a user might enter in certain metadata fields whose displayFormats include HTML tags:
    Screen Shot 2022-02-09 at 12 27 54 PM

    Screen Shot 2022-02-09 at 12 28 05 PM

    Screen Shot 2022-02-09 at 12 28 16 PM

  • What's shown in the "Version Differences Details" table in the Versions tab of the dataset page
    Screen Shot 2022-02-09 at 12 15 40 PM

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 reproducing the issue in the Version Differences Details table on the dataset page's Versions tab, using a metadata field whose displayFormat contains HTML, such as the Related Publication URL in citation.tsv. Trace how the table displays the changed field value and confirm the expected result with the existing related issue. Done means the table no longer exposes displayFormat HTML tags and clearly shows the user's value.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.