Red Hat Bugzilla – Bug 442969
FEATURE REQUEST: docbook-lint
Last modified: 2010-11-23 23:19:23 EST
Description of problem:
The above looks like a set of interesting tools that looks like they can be
integrated into publican.
The internet has 4 billion interesting tools on it. Please specify exactly what
features this tool has that you think would be useful and why integrating them
in to publican is a good idea.
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
- 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.
This sounds pretty cool, let me know if you need any help with understanding
publican or when it's ready for some integration testing.
Changing version to '9' as part of upcoming Fedora 9 GA.
More information and reason for this action is here:
Reporter, could you please reply to the previous question? If you won't reply in
one month, I will have to close this bug as INSUFFICIENT_DATA. Thank you.
Need to investigate the features further will try to do this in the next 2
months (during f10). Moving to F10