DocBook 5.0 validation nits #3
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adjusting the attribute on <figure/> so that it says floatstyle="none" allows the document to be validated (jing, against docbook.rng)
Adding a few <para/> elements so that the document will validate (<listitem/> cannot contain bare CDATA)
the DocBook 4.x standard used format="linespecific" to number lines; the DocBook 5.0 standard uses linenumbering="numbered" to mean the same thing
A <sect2/> cannot be a direct child of a chapter; however, a <section/> can. This also obviates the need to keep track of whether something is a <sect1/>, <sect2/> or <sect3/>. And, <section/>s can be nested.
I do not know what is intended, and it is not in the DocBook 4.x nor DocBook 5.x references; commenting it out allows validation.
adding a symlink to the book.xml named RTCQuickstartGuide.xml; TLDP convention is to have the document stem name be the same as an enclosing directory (if there are multiple files)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Greetings Daniel,
I'm working with The Linux Documentation Project to improve automation and collection management. We now have automated publishing and hope to make some progress on some of the indexing and metadata managament questions.
Several months ago, you posted a request about your guide and whether it would be welcome in the TLDP collection. As part of my response to you (several weeks ago), I noted that I had made some minor DocBook 5.0 validation improvements.
This pull request includes all of these validation fixes that I found while examining your RTCQuickstartGuide document (as well as an ancillary symlink called RTCQuickstartGuide.xml pointing to book.xml).
Best regards,
-Martin