Skip to content

Commit

Permalink
fix: report HTML discouraged constructs as "usage"
Browse files Browse the repository at this point in the history
The HTML discouraged constructs section is non-normative. This PR now
reports use of these constructs as a usage message instead of a warning.

The severity level of `HTM-055` is now `USAGE`.

Fix #1387.
  • Loading branch information
rdeltour committed Dec 12, 2022
1 parent 88e15ec commit c8e9f45
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ private void initialize()
severities.put(MessageId.HTM_052, Severity.ERROR);
severities.put(MessageId.HTM_053, Severity.SUPPRESSED);
severities.put(MessageId.HTM_054, Severity.ERROR);
severities.put(MessageId.HTM_055, Severity.WARNING);
severities.put(MessageId.HTM_055, Severity.USAGE);
severities.put(MessageId.HTM_056, Severity.ERROR);
severities.put(MessageId.HTM_057, Severity.ERROR);
severities.put(MessageId.HTM_058, Severity.ERROR);
Expand Down
7 changes: 2 additions & 5 deletions src/test/resources/epub3/03-resources/resources.feature
Original file line number Diff line number Diff line change
Expand Up @@ -110,16 +110,14 @@
And no errors or warnings are reported

@spec @xref:sec-foreign-resources
Scenario: Report a foreign resource in HTML `embed` with a manifest fallback
Scenario: Allow a foreign resource in HTML `embed` with a manifest fallback
When checking EPUB 'foreign-xhtml-embed-fallback-valid'
And warning HTM-055 is reported (using embed is discouraged)
And no other errors or warnings are reported
Then no errors or warnings are reported

@spec @xref:sec-foreign-resources
Scenario: Report a foreign resource in HTML `embed` with no fallback
When checking EPUB 'foreign-xhtml-embed-no-fallback-error'
Then error RSC-032 is reported
And warning HTM-055 is reported (using embed is discouraged)
And no other errors or warnings are reported

@spec @xref:sec-foreign-resources
Expand Down Expand Up @@ -652,5 +650,4 @@
Scenario: Report an `embed` element with a `type` attribute not matching the publication resource type
When checking EPUB 'type-mismatch-in-embed-warning'
Then warning OPF-013 is reported
And warning HTM-055 is reported (using embed is discouraged)
And no other errors or warnings are reported
Original file line number Diff line number Diff line change
Expand Up @@ -197,12 +197,10 @@ Feature: EPUB 3 — Content Documents — XHTML

Scenario: Verify that a base url can be set
When checking EPUB 'content-xhtml-base-url-valid'
Then warning HTM-055 is reported (side effect of `base` being discouraged)
Then no errors or warnings are reported

Scenario: Report relative paths as remote resources when HTML `base` is set to an extenal URL (issue 155)
When checking EPUB 'content-xhtml-base-url-remote-relative-path-error'
Then warning HTM-055 is reported (side effect of `base` being discouraged)
Then error RSC-006 is reported
And no other errors or warnings are reported

Expand Down Expand Up @@ -978,20 +976,23 @@ Feature: EPUB 3 — Content Documents — XHTML
#### 6.1.4.3 Discouraged Constructs

Scenario: Report `base` as a discouraged construct
Given the reporting level is set to usage
When checking document 'discouraged-base-warning.xhtml'
Then warning HTM-055 is reported
Then usage HTM-055 is reported
And the message contains 'base'
And no other errors or warnings are reported
And no errors or warnings are reported

Scenario: Report `embed` as a discouraged construct
Given the reporting level is set to usage
When checking document 'discouraged-embed-warning.xhtml'
Then warning HTM-055 is reported
Then usage HTM-055 is reported
And the message contains 'embed'
And no other errors or warnings are reported

Scenario: Report `rp` as a discouraged construct
Given the reporting level is set to usage
When checking document 'discouraged-rp-warning.xhtml'
Then warning HTM-055 is reported 2 times
Then usage HTM-055 is reported 2 times
And the message contains 'rp'
And no other errors or warnings are reported

0 comments on commit c8e9f45

Please sign in to comment.