Introduction
DocbookCS scans DocBook 5 XML sources, reports style and convention violations, and can fix them automatically, helping keep large documentation trees consistent across many contributors. By default it checks only the current Git diff, making it fast for pull-request workflows; full files, directories, or piped diffs can be checked too.
Built for the PHP manual
DocbookCS was built for the PHP manual and works well with any large, multi-contributor DocBook project.
Quick install
- Git
git clone https://github.com/php/docbook-cs.git
cd docbook-cs
Why?
In projects like the PHP manual, DocBook sources accumulate style drift over
time: inconsistent attribute ordering, misuse of <simpara>, exception names
that don't match conventions. DocbookCS catches these automatically in CI.