HTML5 outline validity on CI

Development
1

Hi!

Context

A few days ago, a lot of HTML5 validation errors have shown up in CI, such as:
https://ci.xwiki.org/job/XWiki/job/xwiki-platform/job/master/8346/testReport/junit/org.xwiki.test.webstandards.framework/DefaultValidationTest/Platform_Builds___main___distribution___flavor_test_webstandards___Build_for_Flavor_Test___Webstandards___Validating_HTML5_validity_for__http___127_0_0_1_8080_xwiki_bin_view_XWiki_XWikiSyntaxHeadings__executed_with_credentials_Admin_admin_2/

This happened because of an update to the nu validator:

implementing the sentence

Each heading following another heading lead in the outline must have a heading level that is less than, equal to, or 1 greater than lead’s heading level.

from the HTML Standard

I agree that it’s an important part of the standard and we should not overlook it.
However most of those errors have probably been in XWiki for years, and we got little user feedback about it.

Proposed solution

I don’t think it becomes a high priority because of the reduced impact it has on the end users.
IMO we can report those as bugs and toggle the validation for them OFF for now (by filtering errors by message content). Then once all the bugs have been fixed, we toggle the validation back ON.
This way we can take note of where to improve our HTML compliance without cluttering the CI results with lower priority bugs (usually things that are caught on CI are regressions or critical :slight_smile: ).

What do you think of this solution?

Thanks!
Lucas C.

2

I’ll start moving on with this solution right now, this discussion is also here to keep track of our decision process on this.

3

+1

4

+1

5

+1 thx

6

+1 thanks

7

A <h3> following a <h1> is an accessibility issue. You won’t succeed a bitv test (it’s like wcag in germany) with this issue.

This is the reason why our selfmade toc panel definitely will show ugly empty list item dots on missing headings in the hierarchy. This way it shows there is something wrong.