[publican-list] [Bug 442969] FEATURE REQUEST: docbook-lint

[bugzilla at redhat.com]

Please do not reply directly to this email. All additional
comments should be made in the comments box of this bug report.

Summary: FEATURE REQUEST: docbook-lint


https://bugzilla.redhat.com/show_bug.cgi?id=442969





------- Additional Comments From dmalcolm at redhat.com  2008-04-22 19:12 EST -------
As maintainer of docbook-lint, I'm interested in seeing a hook for this added to
publican.   It has various tests that I believe are useful for a document author
(and for QA purposes; I'm a QA engineer at Red Hat with a hobby interest in
DocBook):
- spellchecking, with heuristics about elements that ought to ignore
spellchecking e.g. <computeroutput>
- warn about common markup errors that are valid according to the DTD but tend
to generate poor PDFs/HTML upon going through the toolchain.

Other tests could be implemented e.g. are all images in a format that the
toolchain supports?  are all images in the correct location? etc.  Basically,
whenever the publican documenation mentions some caveat, we can code it up into
a test in docbook-lint and have the tools automatically warn, rather than
needing human inspection.

I imagine integrating it would be a case of adding new target(s) to the publican
common Makefile (along with packaging it), along with work on the docbook-lint
side to add new tests and handle any config necessary, so that a user gets a
good signal:noise ratio on their documents without needing extensive extra config.

Caveat: docbook-lint is immature (e.g. I only just added XInclude support).  So
I suspect the way to go about this is to get docbook-lint to the point where it
runs well on a freshly-created publican document, and then consider adding the
support to publican.

-- 
Configure bugmail: https://bugzilla.redhat.com/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.