"text" versus "begin-reading" in Guide
| Project: | EPUB Maintenance |
| Component: | Open Packaging Format (OPF) |
| Category: | feature request |
| Priority: | normal |
| Assigned: | BDuga |
| Status: | dismissed |
Jump to:
The Guide section of the OPF spec defines a value of "text" for the type attribute to specify the beginning of the "real" content of the work. However in practice I often see a value of "begin-reading" used for this purpose. We should consider adding this as an alternate value.
Publications that use "begin-reading" instead of "text" are non-conforming documents (and have been for some time). Retroactively modifying the spec in this way would render all current, compliant Reading Systems non-compliant. Relevant portions of the spec are found in section 2.6, "Guide", specifically:
"The values for the type attributes must be selected from the list defined below when applicable. Other types may be used when none of the predefined types are applicable; their names must begin with the string other.."
Note that the type "begin-reading" is not listed, nor does it begin with "other.". Even if the type was "other.begin-reading", it would still be illegal since there is a predefined type that is applicable.
I propose we leave the spec as it stands, but modify epubcheck to validate the values of "type" to make sure it is either drawn from the legal list or starts with "other.".
- Login to post comments

Comments
#1
#2
Publications that use "begin-reading" instead of "text" are non-conforming documents (and have been for some time). I am hesitant to retroactively modify the spec to grandfather in illegal publications, especially when the spec already identifies a legal way to perform the same action. Relevant portions of the spec are found in section 2.6, "Guide", specifically:
"The values for the type attributes must be selected from the list defined below when applicable. Other types may be used when none of the predefined types are applicable; their names must begin with the string other.."
Note that the type "begin-reading" is not listed, nor does it begin with "other.". Even if the type was "other.begin-reading", it would still be illegal since there is a predefined type that is applicable.
I propose we leave the spec as it stands, but modify epubcheck to validate the values of "type" to make sure it is either drawn from the legal list or starts with "other.".
#3
This has had a proposed resolution for a while, but was still set to "open". I have changed the status and am beginning the 1 week review period now. Barring further comments, this issue will be dismissed in 1 week.
#4
No comments in 5 weeks. Moving to "dismissed".