Add page: "reference documentation of all the messages"

daisy / epubcheck-website

Website with end-user documentation about EPUBCheck

https://daisy.github.io/epubcheck-website/

MIT License

0 stars 0 forks source link

Add page: "reference documentation of all the messages" #9

Open marisademeglio opened 4 years ago

marisademeglio commented 4 years ago

Under "messages documentation" subsection.

Generated automatically from the parsing done in #5

gregoriopellegrino commented 4 years ago

JSON file with message:

code
message
severity
description
link to specs
afflicted version

To get messages: https://github.com/w3c/epubcheck/blob/master/src/main/resources/com/adobe/epubcheck/messages/MessageBundle.properties

To find severities: https://github.com/w3c/epubcheck/blob/master/src/main/java/com/adobe/epubcheck/messages/DefaultSeverities.java

For specifications: https://github.com/w3c/epubcheck/blob/master/src/test/resources/epub3/package-document.feature

marisademeglio commented 4 years ago

Is the JSON file you're talking about the format you'd like to receive once the messages are parsed?

I haven't gone ahead with a message parser yet as I believe a code refactor may still be pending (see #5). @rdeltour can tell us more.

rdeltour commented 4 years ago

@marisademeglio I had a call with Gregorio and we agreed he could start creating a JSON file that would hold all the message information (codes, messages, description, spec references). At first this will be duplicating the bits that are already in EPUBCheck’s source code, but ultimately this JSON file will become the master source when I refactor the messaging system.

gregoriopellegrino commented 4 years ago

I setup the job, for the moment I filtered out the messages that are "suggestion" or suppressed

gregoriopellegrino commented 4 years ago

My doubts/1:

ACC_008 it isn't a EPUB Accessibility Guidelines 1.0 requirement
ACC_013 it isn't a EPUB Accessibility Guidelines 1.0 neither a WCAG 2.0 requirement
ACC_014, ACC_015 reference inserted a bit by force, depends very much on the capabilities of the reading solution
ACC_014 and ACC_016 seem equivalent
ACC_015 and ACC_017 seem equivalent

gregoriopellegrino commented 4 years ago

My doubts/2:

The messages from the "CHK" section seem to be self explaining to me

gregoriopellegrino commented 4 years ago

My doubts/3:

CSS_005: can't find references and can't understand it

gregoriopellegrino commented 4 years ago

Only now I realized that the "usage" level messages are not printed by default and that maybe it doesn't make sense to describe them all :(

gregoriopellegrino commented 4 years ago

My doubts/4:

The messages from the "HTM" section seem to be self explaining to me
HTM_003: can't find references in specs
HTM_004: can't find references in specs
HTM_008: can't find references in specs
HTM_009: can't find references in specs
HTM_011: can't find references in specs
HTM_014: can't find references in specs
HTM_025: can't find references in specs
HTM_053: can't find references in specs

gregoriopellegrino commented 4 years ago

My doubts/5:

The message from the "INF" section seem to be self explaining to me
MED_001: not sure it is the right spec reference
MED_007: can't find references and can't really understand it

gregoriopellegrino commented 4 years ago

My doubts/6:

NAV_003: can't find references in specs
NAV_009: can't find references in specs
NAV_010: seem to be self explaining to me
NAV_011: seem to be self explaining to me

gregoriopellegrino commented 4 years ago

My doubts/7:

NCX_001: can't find references (http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1)