docbook: Thread: ANNOUNCE: docbook-lint: a tool for checking DocBook source files


[<<] [<] Page 1 of 1 [>] [>>]
Subject: ANNOUNCE: docbook-lint: a tool for checking DocBook source files
From: David Malcolm ####@####.####
Date: 10 Nov 2006 21:27:01 -0000
Message-Id: <1163194018.14778.48.camel@cassandra.boston.redhat.com>

[apologies for broad cross-posting]

I wanted to do a bit of checking of DocBook XML files beyond just DTD
validation, and couldn't find a tool to so this (is there one?), so I've
hacked one together (GPL license, python implementation)

In the spirit of "release early, release often", the code is in public
Subversion here:
https://testing.108.redhat.com/source/browse/testing/trunk/incubator/docbooklint/?rev=259

and the mailing list for the project is:
####@####.####
(see https://testing.108.redhat.com/servlets/ProjectMailingListList for
archives and subscription info)

So far all it does is verify that text inside a <computeroutput> element
has been properly line-wrapped [1], but the framework is hopefully clean
enough to be expanded to cover other checks people might want to
implement that aren't so easy to do with DTDs, for instance:
- enforcing naming policies for node ids
- spell-checking
etc - any other ideas?  Patches welcome.

Hopefully this will be of use to various projects with DocBook
toolchains.

Dave Malcolm

[1] I ran into some problems where line-endings of screen dumps in my
DocBook files got garbled, and verbatim monospace rendering was looking
terrible: the tool detects this now.


[<<] [<] Page 1 of 1 [>] [>>]


  ©The Linux Documentation Project, 2014. Listserver maintained by dr Serge Victor on ibiblio.org servers. See current spam statz.