Dataset Page: apply markdown transforming only to TEXTBOX type fields #588

ChengShi-1 · 2025-01-24T17:34:02Z

What this PR does / why we need it:

Related issue: IQSS/dataverse-client-javascript#244

We would move html to markdown transformation from js-dataverse repo to this frontend repo in dataset pages. We assume we will get raw dataset summary and metadata info from js-dataverse, and then we'll deal with the format transformation issue. Only if the field is in textbox type, we'll transform html tags into markdown.

Update keepRawField = true parameter so as to getDataset with raw data
Update markdown component, allow transforming HTML to markdown
Update JSMetadataBlockInfoMapper.ts, get type of fields
Apply markdown component if type == 'TEXTBOX'

Which issue(s) this PR closes:

Closes Edit Dataset Page: do not transform metadata values to markdown #587

Special notes for your reviewer:

Suggestions on how to test this:

npm i.& npm run build to update package.json
Check the HTML Tags
Overall, the Edit/Create dataset page should always give html tags and whatever is entered. Some TEXTBOX fields in Dataset (summary/citation metadata) page, should display in HTML format.

Create a Dataset

Fill out the form, and give some html tags to fields. such as  description

TEXTBOX fields, should display HTML include: Description, Related Publication, Notes (EDIT page: Related Material, Related Dataset, Data Source, Origin of Historical Sources, Characteristic of Sources, Documentation and Access to Sources) Other than these fields, should go with plain text .

Check Dataset Summary and MetadataDisplay

On the dataset page, if it's TEXTBOX type, it should shown with the HTML styles and without HTML tags. For instance, test should render correctly as test (bold). (see image below)
If the field is not in TEXTBOX fields, such as subtitle and keywords, should be test included html tag if input tags, not as the rendered bold text or plain text.
Check the format in both summary part and Metadata tab > Citation Metadata

Edit the Dataset Metadata

Verify that when the dataset metadata opens for editing, the pre-filled text in fields matches exactly what was entered during creation, with html tags.
On the edit page, the field should display exactly what you entered: test, always with html tags if they're put, not as the rendered bold text or plain text.

Save Changes and Confirm Updates

After saving the edited metadata, verify that all changes successfully update on the dataset display page.

Check the underscore escaping
refered to IQSS/dataverse-client-javascript#241

Create a Dataset

Fill out the form, and give some underscores and other symbols to fields. such as __description/title__

Check Dataset Summary and MetadataDisplay

On the dataset page, check if the underscore work well without extra characters or symbols.

Edit the Dataset Metadata

Verify that when the dataset metadata opens for editing, the pre-filled text in fields matches exactly what was entered during creation.

Save Changes and Confirm Updates

After saving the edited metadata, verify that all changes successfully update on the dataset display page.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

coveralls · 2025-01-24T17:49:52Z

coverage: 97.324% (+0.1%) from 97.204%
when pulling 8f02002 on 587-edit-dataset-page-do-not-transform-metadata-values-to-markdown
into 27cb2f4 on develop.

g-saracca

Good, approving

ofahimIQSS · 2025-02-18T15:21:29Z

On this step I have come across an observation: On the edit page, the field should display exactly what you entered: test, not as the rendered bold text or plain text.

When I enter my HTML description, it doesn't save the HTML tags when I go back to edit it:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>HTML Elements Example</title>
</head>
<body>

    <a href="https://www.example.com">This is a link</a><br>

    <b>Bold text</b><br>

    <blockquote>This is a blockquote.</blockquote>

    <br> <!-- Line break -->

    <code>console.log("Hello, World!");</code><br>

    <del>Deleted text</del><br>

    <dl>
        <dt>Term 1</dt>

…tadata-values-to-markdown

ChengShi-1 · 2025-02-19T20:11:44Z

@g-saracca Hi German, please help to re-review it, thank you! I forgot add transform function to subfields before, so I apply it to subfields. I didn't add tests because after merging with dev branch, the test coverage pass magically

g-saracca

All good!

ofahimIQSS · 2025-02-21T16:23:46Z

Im still seeing the same issue - if i put in my HTML code as mentioned above, I come back to edit the Collections description, I am unable to see the input with the HTML tags.
Please let me know if i'm misunderstanding anything.

Screen.Recording.2025-02-21.at.11.20.47.AM.mov

ChengShi-1 · 2025-02-21T16:26:38Z

Im still seeing the same issue - if i put in my HTML code as mentioned above, I come back to edit the Collections description, I am unable to see the input with the HTML tags. Please let me know if i'm misunderstanding anything.

Screen.Recording.2025-02-21.at.11.20.47.AM.mov

@ofahimIQSS Hi Omer, thanks for testing. This PR changes only work for Dataset related pages. The collection would be fixed #608 here

g-saracca

Hi @ChengShi-1, remember to install turndown library and don't use the js-dataverse peer dependency turndown library.

package.json

ofahimIQSS · 2025-02-21T17:46:08Z

getting this error now:

ChengShi-1 · 2025-02-21T17:49:53Z

getting this error now:

Hi Omer, please try cd dataverse-frontend to the front end folder and then run npm i again see if it works

g-saracca

Reapproving, thanks cheng!

ofahimIQSS · 2025-02-24T16:40:44Z

testing passed- Merging PR

fix: update keepRawFields to prevent markdown

95c1bf8

ChengShi-1 linked an issue Jan 24, 2025 that may be closed by this pull request

Edit Dataset Page: do not transform metadata values to markdown #587

Closed

ChengShi-1 added bug Something isn't working SPA: Dataset page (View) SPA: Edit Dataset Page GREI Re-arch GREI re-architecture-related SPA.Q1 Not related to any specific Q1 feature FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) labels Jan 24, 2025

fix: update breadcrumb testcase

7110257

ChengShi-1 added Size: 3 A percentage of a sprint. 2.1 hours. Original size: 3 labels Jan 24, 2025

ekraffmiller self-assigned this Jan 24, 2025

This comment was marked as outdated.

Sign in to view

ekraffmiller mentioned this pull request Jan 27, 2025

fix: underscore escape while html transforming IQSS/dataverse-client-javascript#242

Closed

ekraffmiller assigned ChengShi-1 Jan 27, 2025

fix: cancel update title and breadcrumb

8b13d5d

cmbz added the FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) label Jan 30, 2025

pdurbin unassigned ekraffmiller and ChengShi-1 Jan 30, 2025

ChengShi-1 self-assigned this Feb 3, 2025

ChengShi-1 added 3 commits February 5, 2025 12:30

feat: update markdown transformation to textbox fields

a95ab0f

feat: easier way to do markdown transformation

4042cb5

fix: small tweaks

a2368db

ChengShi-1 marked this pull request as ready for review February 5, 2025 18:30

fix: small tweaks

01ac7bf

ChengShi-1 removed their assignment Feb 5, 2025

fix: try to improve coverage

a1ba304

g-saracca self-assigned this Feb 6, 2025

g-saracca previously approved these changes Feb 13, 2025

View reviewed changes

g-saracca unassigned g-saracca and ChengShi-1 Feb 13, 2025

ofahimIQSS self-assigned this Feb 14, 2025

fix: add transformHtmlToMarkdown To subfields

bd12333

ChengShi-1 dismissed g-saracca’s stale review via bd12333 February 18, 2025 16:47

fix: delete console.log

8df7934

ChengShi-1 self-assigned this Feb 19, 2025

Merge branch 'develop' into 587-edit-dataset-page-do-not-transform-me…

9641ff8

…tadata-values-to-markdown

ChengShi-1 assigned g-saracca and unassigned ChengShi-1 Feb 19, 2025

ChengShi-1 requested a review from g-saracca February 19, 2025 20:08

g-saracca approved these changes Feb 19, 2025

View reviewed changes

g-saracca removed their assignment Feb 19, 2025

ChengShi-1 changed the title ~~fix: update keepRawFields to prevent markdown~~ Dataset Page: apply markdown transforming only to TEXTBOX type fields Feb 21, 2025

g-saracca requested changes Feb 21, 2025

View reviewed changes

fix: add turndown service to pacakage.json

2450b95

g-saracca reviewed Feb 21, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

fix: remove caret for turndown

8f02002

g-saracca approved these changes Feb 21, 2025

View reviewed changes

ofahimIQSS merged commit 64ab9a7 into develop Feb 24, 2025
10 of 14 checks passed

ofahimIQSS deleted the 587-edit-dataset-page-do-not-transform-metadata-values-to-markdown branch February 24, 2025 16:40

ofahimIQSS removed their assignment Feb 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dataset Page: apply markdown transforming only to TEXTBOX type fields #588

Dataset Page: apply markdown transforming only to TEXTBOX type fields #588

ChengShi-1 commented Jan 24, 2025 •

edited

Loading

coveralls commented Jan 24, 2025 •

edited

Loading

This comment was marked as outdated.

This comment was marked as outdated.

g-saracca left a comment

ofahimIQSS commented Feb 18, 2025 •

edited

Loading

ChengShi-1 commented Feb 19, 2025

g-saracca left a comment

ofahimIQSS commented Feb 21, 2025

ChengShi-1 commented Feb 21, 2025

g-saracca left a comment

ofahimIQSS commented Feb 21, 2025

ChengShi-1 commented Feb 21, 2025

g-saracca left a comment

ofahimIQSS commented Feb 24, 2025

Dataset Page: apply markdown transforming only to TEXTBOX type fields #588

Dataset Page: apply markdown transforming only to TEXTBOX type fields #588

Conversation

ChengShi-1 commented Jan 24, 2025 • edited Loading

What this PR does / why we need it:

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

coveralls commented Jan 24, 2025 • edited Loading

This comment was marked as outdated.

This comment was marked as outdated.

g-saracca left a comment

Choose a reason for hiding this comment

ofahimIQSS commented Feb 18, 2025 • edited Loading

ChengShi-1 commented Feb 19, 2025

g-saracca left a comment

Choose a reason for hiding this comment

ofahimIQSS commented Feb 21, 2025

ChengShi-1 commented Feb 21, 2025

g-saracca left a comment

Choose a reason for hiding this comment

ofahimIQSS commented Feb 21, 2025

ChengShi-1 commented Feb 21, 2025

g-saracca left a comment

Choose a reason for hiding this comment

ofahimIQSS commented Feb 24, 2025

ChengShi-1 commented Jan 24, 2025 •

edited

Loading

coveralls commented Jan 24, 2025 •

edited

Loading

ofahimIQSS commented Feb 18, 2025 •

edited

Loading