Added support for HTML in JSF UI for file description by stevenwinship · Pull Request #12318 · IQSS/dataverse

stevenwinship · 2026-04-10T14:23:12Z

What this PR does / why we need it: SPA already supports html in file description field. JSF UI also needs this functionality.

Which issue(s) this PR closes: #11397

Closes Feature Request: Allow the file level description field to support HTML #11397

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:

Before:

After:

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

Additional documentation:

coveralls · 2026-04-10T19:48:33Z

coverage: 24.957%. remained the same — 11397-support-html-in-file-level-description into develop

stevenwinship · 2026-07-09T19:10:13Z

@pdurbin There is still a bug

ekraffmiller · 2026-07-09T20:01:31Z

I like the idea of having parity between JSF and the SPA.

That is, I don't like the idea of JSF users becoming accustomed to having clickable links in file descriptions of search cards and then moving over the the SPA where there are no clickable links (and other formatting) because only the plain text version is shown in search cards for the SPA.

So maybe in JSF we should show the plain text version, like we do with the SPA, I'm saying, for search cards.

@sbarbosadataverse what do you think? You were the one who opened #11397.

As I mentioned above, the search API is stripping html from the dataset and collection descriptions, but not the file description. So can we make that change in this PR? Or open a new one?

stevenwinship · 2026-07-09T20:17:36Z

This shows the link working in the files card but not the dataset or collection card as Ellen stated above

qqmyers · 2026-07-09T20:41:39Z

FWIW: As far as I can see, these are all short descriptions. What actually shows in the card is a subset of the description, which may also add highlighting of the search term - seems like both of those could make showing html difficult.

ekraffmiller · 2026-07-09T20:44:59Z

FWIW: As far as I can see, these are all short descriptions. What actually shows in the card is a subset of the description, which may also add highlighting of the search term - seems like both of those could make showing html difficult.

Yes, I agree, that's why I was asking about creating an issue for the search API to make it consistent (ie strip the html for all descriptions)

jggautier · 2026-07-13T15:12:31Z

Hey all. Following talks today at standup about this PR, I thought I'd share this GitHub issue about a bug that affects how Dataverse currently highlights search terms on the search cards: #11410

pdurbin · 2026-07-13T19:29:06Z

                        </div>

-                        <h:outputText value="#{Strings:abbreviate(result.descriptionNoSnippet, descriptionAbbreviationThreshold)}" rendered="#{result.descriptionSnippets.size() eq 0}"/>
+                        <h:outputText value="#{Strings:abbreviate(MarkupChecker:sanitizeBasicHTML(result.descriptionNoSnippet), descriptionAbbreviationThreshold)}" escape="false" rendered="#{result.descriptionSnippets.size() eq 0}"/>


For consistency, we want the search card to not have a clickable link, just like the collection card and dataset card.

stevenwinship · 2026-07-13T19:45:34Z

pdurbin · 2026-07-13T20:07:37Z

Also to be clear, the html is stripped from the description within the search API, so if we want to show it in the results, the API would have to be updated. (It is stripped from dataset and collection results, but not file results)

@ekraffmiller thanks for creating the following issue:

Search API: strip html from file description in search results #12534

pdurbin

I believe this is working the way we want now.

pdurbin · 2026-07-13T20:24:18Z

The HTML in the description for a file landing page is working fine:

As discussed at standup today, we want consistency across search cards. All search cards strip out the HTML like this, which is what we want:

@ekraffmiller created this related issue about the Search API (thanks!):

Search API: strip html from file description in search results #12534

qqmyers · 2026-07-13T20:49:38Z

                        </div>

-                        <h:outputText value="#{Strings:abbreviate(result.descriptionNoSnippet, descriptionAbbreviationThreshold)}" rendered="#{result.descriptionSnippets.size() eq 0}"/>
+                        <h:outputText value="#{Strings:abbreviate(MarkupChecker:stripAllTags(result.descriptionNoSnippet), descriptionAbbreviationThreshold)}" escape="false" rendered="#{result.descriptionSnippets.size() eq 0}"/>


@stevenwinship - this is a change to the Dataset card, but it looks to me like html already didn't show in search cards for datasets, e.g. for the test dataset in https://demo.dataverse.org/dataverse/jms3d where the description is bolded. What am I missing?

github-actions Bot added Feature: Metadata Size: 10 A percentage of a sprint. 7 hours. Type: Feature a feature request labels Apr 10, 2026

stevenwinship self-assigned this Apr 10, 2026

stevenwinship added this to IQSS Dataverse Project Apr 10, 2026

stevenwinship moved this to In Progress 💻 in IQSS Dataverse Project Apr 10, 2026

pdurbin changed the title ~~Added Suport for HTML in JSF UI for file description~~ Added support for HTML in JSF UI for file description Apr 10, 2026

stevenwinship removed their assignment Apr 10, 2026

stevenwinship moved this from In Progress 💻 to Ready for Review ⏩ in IQSS Dataverse Project Apr 10, 2026

stevenwinship force-pushed the 11397-support-html-in-file-level-description branch from bf89748 to 96433e0 Compare April 10, 2026 19:35

stevenwinship force-pushed the 11397-support-html-in-file-level-description branch 4 times, most recently from f6d772c to 094b9d4 Compare April 21, 2026 15:20

cmbz added FY26 Sprint 21 FY26 Sprint 21 (2026-04-08 - 2026-04-22) FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) labels Apr 22, 2026

stevenwinship force-pushed the 11397-support-html-in-file-level-description branch 3 times, most recently from f2a16f3 to bf5b3b9 Compare May 2, 2026 14:12

stevenwinship force-pushed the 11397-support-html-in-file-level-description branch from bf5b3b9 to be235cb Compare May 6, 2026 18:10

cmbz added the FY26 Sprint 23 FY26 Sprint 23 (2026-05-06 - 2026-05-20) label May 6, 2026

stevenwinship force-pushed the 11397-support-html-in-file-level-description branch 5 times, most recently from 93e4138 to 80faa68 Compare May 13, 2026 19:23

sekmiller self-assigned this May 19, 2026

sekmiller moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project May 19, 2026

sekmiller reviewed May 19, 2026

View reviewed changes

Comment thread src/main/webapp/file.xhtml Outdated

stevenwinship self-assigned this Jul 9, 2026

stevenwinship force-pushed the 11397-support-html-in-file-level-description branch from 97a9f8c to 6f66c9d Compare July 13, 2026 13:23

stevenwinship removed their assignment Jul 13, 2026

stevenwinship force-pushed the 11397-support-html-in-file-level-description branch from 6f66c9d to 3bb0cc6 Compare July 13, 2026 17:40

pdurbin assigned stevenwinship Jul 13, 2026

pdurbin reviewed Jul 13, 2026

View reviewed changes

Comment thread src/main/webapp/search-include-fragment.xhtml

stevenwinship added 5 commits July 13, 2026 14:42

Added Suport for HTML in JSF UI for file description

5a7c14b

change markup Checking from advanced to basic

4619c0b

add sanitizeBasicHTML to file-info-fragment

2183134

added html supported description to search page

a08540c

handle html in search-include-fragment

c1e3bca

stevenwinship force-pushed the 11397-support-html-in-file-level-description branch from 3bb0cc6 to c1e3bca Compare July 13, 2026 18:42

pdurbin reviewed Jul 13, 2026

View reviewed changes

Comment thread src/main/webapp/search-include-fragment.xhtml Outdated

pdurbin reviewed Jul 13, 2026

View reviewed changes

fix to strip link off description on search cards

8b92009

pdurbin approved these changes Jul 13, 2026

View reviewed changes

github-project-automation Bot moved this from QA ✅ to Ready for QA ⏩ in IQSS Dataverse Project Jul 13, 2026

pdurbin merged commit 6108e3a into develop Jul 13, 2026
8 of 9 checks passed

pdurbin deleted the 11397-support-html-in-file-level-description branch July 13, 2026 20:25

github-project-automation Bot moved this from Ready for QA ⏩ to Merged 🚀 in IQSS Dataverse Project Jul 13, 2026

qqmyers reviewed Jul 13, 2026

View reviewed changes

Uh oh!

Conversation

stevenwinship commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

stevenwinship commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ekraffmiller commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stevenwinship commented Jul 9, 2026

Uh oh!

qqmyers commented Jul 9, 2026

Uh oh!

ekraffmiller commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jggautier commented Jul 13, 2026

Uh oh!

Uh oh!

Uh oh!

pdurbin Jul 13, 2026

Choose a reason for hiding this comment

Uh oh!

stevenwinship commented Jul 13, 2026

Uh oh!

pdurbin commented Jul 13, 2026

Uh oh!

pdurbin left a comment

Choose a reason for hiding this comment

Uh oh!

pdurbin commented Jul 13, 2026

Uh oh!

Uh oh!

qqmyers Jul 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

stevenwinship commented Apr 10, 2026 •

edited

Loading

coveralls commented Apr 10, 2026 •

edited

Loading

stevenwinship commented Jul 9, 2026 •

edited

Loading

ekraffmiller commented Jul 9, 2026 •

edited

Loading

ekraffmiller commented Jul 9, 2026 •

edited

Loading