Skip to content

Commit

Permalink
Rephrase RSC-005/016/017
Browse files Browse the repository at this point in the history
because the previous phrasing was a bit misleading and had redundant apostrophes

RSC_005=Error while parsing file '%1$s'.
Example: Error while parsing file 'element "package" incomplete; missing required element "spine"'.

The error didn’t appear in file '%1$s' but instead the variable was holding the error message which appeared when parsing the file. The filename however was never part of the message.
New phrasing should be clearer now:

RSC_005=Error while parsing file: %1$s
Example: Error while parsing file: element "package" incomplete; missing required element "spine"
  • Loading branch information
tofi86 committed Feb 2, 2017
1 parent 8cb8970 commit 5ef4497
Show file tree
Hide file tree
Showing 35 changed files with 70 additions and 67 deletions.
9 changes: 6 additions & 3 deletions src/main/java/com/adobe/epubcheck/xml/XMLParser.java
Original file line number Diff line number Diff line change
Expand Up @@ -333,22 +333,25 @@ public void error(SAXParseException ex)
else
{
report.message(MessageId.RSC_005,
EPUBLocation.create(path, ex.getLineNumber(), ex.getColumnNumber()), message);
EPUBLocation.create(path, ex.getLineNumber(), ex.getColumnNumber()),
message);
}
}

public void fatalError(SAXParseException ex)
throws SAXException
{
report.message(MessageId.RSC_016,
EPUBLocation.create(path, ex.getLineNumber(), ex.getColumnNumber()), ex.getMessage());
EPUBLocation.create(path, ex.getLineNumber(), ex.getColumnNumber()),
ex.getMessage());
}

public void warning(SAXParseException ex)
throws SAXException
{
report.message(MessageId.RSC_017,
EPUBLocation.create(path, ex.getLineNumber(), ex.getColumnNumber()), ex.getMessage());
EPUBLocation.create(path, ex.getLineNumber(), ex.getColumnNumber()),
ex.getMessage());
}

public void characters(char[] arg0, int arg1, int arg2)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ RSC_001=File '%1$s' could not be found.
RSC_002=Required META-INF/container.xml resource could not be found.
RSC_003=No rootfile tag with media type 'application/oebps-package+xml' was found in the container.
RSC_004=File '%1$s' could not be decrypted.
RSC_005=Error while parsing file '%1$s'.
RSC_005=Error while parsing file: %1$s
RSC_006=Remote resource reference not allowed; resource must be placed in the OCF.
RSC_006_SUG=Only audio and video remote resources are permitted.
RSC_007=Referenced resource '%1$s' could not be found in the EPUB.
Expand All @@ -286,8 +286,8 @@ RSC_012=Fragment identifier is not defined.
RSC_013=Fragment identifier is used in a reference to a stylesheet resource.
RSC_014=Fragment identifier defines an incompatible resource type.
RSC_015=A fragment identifier is required for svg use tag references.
RSC_016=Fatal Error while parsing file '%1$s'.
RSC_017=Warning while parsing file '%1$s'.
RSC_016=Fatal Error while parsing file: %1$s
RSC_017=Warning while parsing file: %1$s
RSC_018=Alternative image file '%1$s' could not be found.
RSC_019=EPUBs with Multiple Renditions should contain a META-INF/metadata.xml file.
RSC_020='%1$s' is not a valid URI.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ RSC-001 ERROR File '%1$s' could not be found.
RSC-002 FATAL Required META-INF/container.xml resource could not be found.
RSC-003 ERROR No rootfile tag with media type 'application/oebps-package+xml' was found in the container.
RSC-004 ERROR File '%1$s' could not be decrypted.
RSC-005 ERROR Error while parsing file '%1$s'.
RSC-005 ERROR Error while parsing file: %1$s
RSC-006 ERROR Remote resource reference not allowed; resource must be placed in the OCF. Only audio and video remote resources are permitted.
RSC-007 ERROR Referenced resource '%1$s' could not be found in the EPUB.
RSC-008 ERROR Referenced resource '%1$s' is not declared in the OPF manifest.
Expand All @@ -205,8 +205,8 @@ RSC-012 ERROR Fragment identifier is not defined.
RSC-013 ERROR Fragment identifier is used in a reference to a stylesheet resource.
RSC-014 ERROR Fragment identifier defines an incompatible resource type.
RSC-015 ERROR A fragment identifier is required for svg use tag references.
RSC-016 FATAL Fatal Error while parsing file '%1$s'.
RSC-017 WARNING Warning while parsing file '%1$s'.
RSC-016 FATAL Fatal Error while parsing file: %1$s
RSC-017 WARNING Warning while parsing file: %1$s
RSC-018 WARNING Alternative image file '%1$s' could not be found.
SCP-001 USAGE Use of Javascript eval() function in EPUB scripts is a security risk.
SCP-002 USAGE Use of XMLHttpRequest in EPUB scripts is a security risk.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'Exactly one manifest item must declare the 'nav' property (number of 'nav' items: 0).'.",
"message" : "Error while parsing file: Exactly one manifest item must declare the 'nav' property (number of 'nav' items: 0).",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand All @@ -213,7 +213,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'package dcterms:modified meta element must occur exactly once'.",
"message" : "Error while parsing file: package dcterms:modified meta element must occur exactly once",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
<version>3.0.1</version>
<status>Not well-formed</status>
<messages>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file 'package dcterms:modified meta element must occur exactly once'.], OPS/content.opf (3-57)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file 'Exactly one manifest item must declare the 'nav' property (number of 'nav' items: 0).'.], OPS/content.opf (8-13)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file: package dcterms:modified meta element must occur exactly once], OPS/content.opf (3-57)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file: Exactly one manifest item must declare the 'nav' property (number of 'nav' items: 0).], OPS/content.opf (8-13)</message>
<message severity="error" subMessage="HTM-004">HTM-004, ERROR, [Irregular DOCTYPE: found '-//W3C//DTD XHTML 1.1//EN', expected '&lt;!DOCTYPE html&gt;'.], OPS/page01.xhtml</message>
<message severity="info" subMessage="HTM-010">HTM-010, HINT, [Namespace uri 'http://www.daisy.org/z3986/2005/ncx/' was found.], OPS/toc.ncx (2-68)</message>
<message severity="info" subMessage="ACC-008">ACC-008, HINT, [Navigation Document has no 'landmarks nav' element.], Epub2_marked_v3.epub</message>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'attribute \"properties\" not allowed here; expected attribute \"fallback\", \"fallback-style\", \"href\", \"media-type\", \"required-modules\" or \"required-namespace\"'.",
"message" : "Error while parsing file: attribute \"properties\" not allowed here; expected attribute \"fallback\", \"fallback-style\", \"href\", \"media-type\", \"required-modules\" or \"required-namespace\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand All @@ -211,7 +211,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'attribute \"property\" not allowed here; expected attribute \"content\", \"id\", \"name\", \"scheme\" or \"xml:lang\"'.",
"message" : "Error while parsing file: attribute \"property\" not allowed here; expected attribute \"content\", \"id\", \"name\", \"scheme\" or \"xml:lang\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand All @@ -223,7 +223,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'element \"body\" incomplete; expected element \"address\", \"blockquote\", \"del\", \"div\", \"dl\", \"h1\", \"h2\", \"h3\", \"h4\", \"h5\", \"h6\", \"hr\", \"ins\", \"noscript\", \"ns:svg\", \"ol\", \"p\", \"pre\", \"script\", \"table\" or \"ul\" (with xmlns:ns=\"http://www.w3.org/2000/svg\")'.",
"message" : "Error while parsing file: element \"body\" incomplete; expected element \"address\", \"blockquote\", \"del\", \"div\", \"dl\", \"h1\", \"h2\", \"h3\", \"h4\", \"h5\", \"h6\", \"hr\", \"ins\", \"noscript\", \"ns:svg\", \"ol\", \"p\", \"pre\", \"script\", \"table\" or \"ul\" (with xmlns:ns=\"http://www.w3.org/2000/svg\")",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/toc.xhtml",
Expand All @@ -235,7 +235,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'element \"meta\" missing required attributes \"content\" and \"name\"'.",
"message" : "Error while parsing file: element \"meta\" missing required attributes \"content\" and \"name\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand All @@ -247,7 +247,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'element \"nav\" not allowed anywhere; expected element \"address\", \"blockquote\", \"del\", \"div\", \"dl\", \"h1\", \"h2\", \"h3\", \"h4\", \"h5\", \"h6\", \"hr\", \"ins\", \"noscript\", \"ns:svg\", \"ol\", \"p\", \"pre\", \"script\", \"table\" or \"ul\" (with xmlns:ns=\"http://www.w3.org/2000/svg\")'.",
"message" : "Error while parsing file: element \"nav\" not allowed anywhere; expected element \"address\", \"blockquote\", \"del\", \"div\", \"dl\", \"h1\", \"h2\", \"h3\", \"h4\", \"h5\", \"h6\", \"hr\", \"ins\", \"noscript\", \"ns:svg\", \"ol\", \"p\", \"pre\", \"script\", \"table\" or \"ul\" (with xmlns:ns=\"http://www.w3.org/2000/svg\")",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/toc.xhtml",
Expand All @@ -264,7 +264,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'text not allowed here; expected the element end-tag'.",
"message" : "Error while parsing file: text not allowed here; expected the element end-tag",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@
<version>2.0.1</version>
<status>Not well-formed</status>
<messages>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file 'attribute "property" not allowed here; expected attribute "content", "id", "name", "scheme" or "xml:lang"'.], OPS/content.opf (7-39)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file 'element "meta" missing required attributes "content" and "name"'.], OPS/content.opf (7-39)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file 'text not allowed here; expected the element end-tag'.], OPS/content.opf (7-61)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file 'attribute "properties" not allowed here; expected attribute "fallback", "fallback-style", "href", "media-type", "required-modules" or "required-namespace"'.], OPS/content.opf (12-90)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file: attribute "property" not allowed here; expected attribute "content", "id", "name", "scheme" or "xml:lang"], OPS/content.opf (7-39)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file: element "meta" missing required attributes "content" and "name"], OPS/content.opf (7-39)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file: text not allowed here; expected the element end-tag], OPS/content.opf (7-61)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file: attribute "properties" not allowed here; expected attribute "fallback", "fallback-style", "href", "media-type", "required-modules" or "required-namespace"], OPS/content.opf (12-90)</message>
<message severity="error" subMessage="HTM-004">HTM-004, ERROR, [Irregular DOCTYPE: found '', expected '&lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"&gt;'.], OPS/toc.xhtml</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file 'element "nav" not allowed anywhere; expected element "address", "blockquote", "del", "div", "dl", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "ins", "noscript", "ns:svg", "ol", "p", "pre", "script", "table" or "ul" (with xmlns:ns="http://www.w3.org/2000/svg")'.], OPS/toc.xhtml (9-22)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file 'element "nav" not allowed anywhere; expected element "address", "blockquote", "del", "div", "dl", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "ins", "noscript", "ns:svg", "ol", "p", "pre", "script", "table" or "ul" (with xmlns:ns="http://www.w3.org/2000/svg")'.], OPS/toc.xhtml (12-10)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file 'element "body" incomplete; expected element "address", "blockquote", "del", "div", "dl", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "ins", "noscript", "ns:svg", "ol", "p", "pre", "script", "table" or "ul" (with xmlns:ns="http://www.w3.org/2000/svg")'.], OPS/toc.xhtml (14-8)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file: element "nav" not allowed anywhere; expected element "address", "blockquote", "del", "div", "dl", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "ins", "noscript", "ns:svg", "ol", "p", "pre", "script", "table" or "ul" (with xmlns:ns="http://www.w3.org/2000/svg")], OPS/toc.xhtml (9-22)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file: element "nav" not allowed anywhere; expected element "address", "blockquote", "del", "div", "dl", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "ins", "noscript", "ns:svg", "ol", "p", "pre", "script", "table" or "ul" (with xmlns:ns="http://www.w3.org/2000/svg")], OPS/toc.xhtml (12-10)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file: element "body" incomplete; expected element "address", "blockquote", "del", "div", "dl", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "ins", "noscript", "ns:svg", "ol", "p", "pre", "script", "table" or "ul" (with xmlns:ns="http://www.w3.org/2000/svg")], OPS/toc.xhtml (14-8)</message>
<message severity="info" subMessage="HTM-010">HTM-010, HINT, [Namespace uri 'http://www.daisy.org/z3986/2005/ncx/' was found.], OPS/toc.ncx (2-68)</message>
</messages>
<mimeType>application/epub+zip</mimeType>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'attribute \"fallback-style\" not allowed here; expected attribute \"media-overlay\", \"media-type\" or \"properties\"'.",
"message" : "Error while parsing file: attribute \"fallback-style\" not allowed here; expected attribute \"media-overlay\", \"media-type\" or \"properties\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'manifest items referenced from the handler attribute of a bindings mediaType element must be of the 'application/xhtml+xml' type (given type was '')'.",
"message" : "Error while parsing file: manifest items referenced from the handler attribute of a bindings mediaType element must be of the 'application/xhtml+xml' type (given type was '')",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'Exactly one manifest item must declare the 'nav' property (number of 'nav' items: 0).'.",
"message" : "Error while parsing file: Exactly one manifest item must declare the 'nav' property (number of 'nav' items: 0).",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'element \"spine\" missing required attribute \"toc\"'.",
"message" : "Error while parsing file: element \"spine\" missing required attribute \"toc\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'element \"package\" incomplete; missing required element \"spine\"'.",
"message" : "Error while parsing file: element \"package\" incomplete; missing required element \"spine\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'element \"package\" incomplete; missing required element \"spine\"'.",
"message" : "Error while parsing file: element \"package\" incomplete; missing required element \"spine\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<status>Not well-formed</status>
<messages>
<message severity="error" subMessage="OPF-019">OPF-019, FATAL, [Spine tag was not found in the OPF file.], OPS/content.opf</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file 'element "package" incomplete; missing required element "spine"'.], OPS/content.opf (13-11)</message>
<message severity="error" subMessage="RSC-005">RSC-005, ERROR, [Error while parsing file: element "package" incomplete; missing required element "spine"], OPS/content.opf (13-11)</message>
<message severity="error" subMessage="RSC-011">RSC-011, ERROR, [Found a reference to a resource that is not a spine item.], OPS/toc.xhtml (11-36)</message>
<message severity="info" subMessage="ACC-007">ACC-007, HINT, [Content Documents do not use 'epub:type' attributes for semantic inflection.], OPS/page01.xhtml</message>
<message severity="info" subMessage="ACC-008">ACC-008, HINT, [Navigation Document has no 'landmarks nav' element.], Missing_Spine_epub3.epub</message>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'element \"metadata\" incomplete; missing required elements \"dc:identifier\", \"dc:language\" and \"dc:title\"'.",
"message" : "Error while parsing file: element \"metadata\" incomplete; missing required elements \"dc:identifier\", \"dc:language\" and \"dc:title\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'element \"manifest\" not allowed yet; missing required element \"metadata\"'.",
"message" : "Error while parsing file: element \"manifest\" not allowed yet; missing required element \"metadata\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand All @@ -235,7 +235,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'package element unique-identifier attribute does not resolve to a dc:identifier element (given reference was 'BOGUS')'.",
"message" : "Error while parsing file: package element unique-identifier attribute does not resolve to a dc:identifier element (given reference was 'BOGUS')",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'element \"package\" missing required attribute \"unique-identifier\"'.",
"message" : "Error while parsing file: element \"package\" missing required attribute \"unique-identifier\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/content.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'attribute \"version\" not allowed here; expected attribute \"id\"'.",
"message" : "Error while parsing file: attribute \"version\" not allowed here; expected attribute \"id\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "oebps12.opf",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@
}, {
"ID" : "RSC-005",
"severity" : "ERROR",
"message" : "Error while parsing file 'element \"meta\" missing required attribute \"content\"'.",
"message" : "Error while parsing file: element \"meta\" missing required attribute \"content\"",
"additionalLocations" : 0,
"locations" : [ {
"path" : "OPS/page004.xhtml",
Expand Down
Loading

0 comments on commit 5ef4497

Please sign in to comment.