Text of httpd.apache.org › docs-project › docsformat.html as Styx crawled it on Nov 18, 2026. The page may have changed since. Only its words are kept, without pictures or layout.

Open the live page

Documentation Format and Build - The Apache HTTP Server Project

Essentials ¶ Download! About License FAQ Security Reports Source Repositories ¶ General Information Trunk 2.4 Documentation ¶ Version 2.4 Trunk (dev) Wiki Get Involved ¶ Mailing Lists Bug Reports Developer Info User Support Subprojects ¶ Docs Test Flood Modules mod_fcgid Related Projects ¶ Apache Traffic Server Apache Traffic Control Tomcat APR mod_perl Miscellaneous ¶ Contributors Thanks! Sponsorship Privacy Documentation Format and Build ¶ This page describes the XML format used for the Apache HTTP Server documentation and how to transform it into HTML for review.

Format Overview ¶ The documentation is written in a custom XML format with its own DTD. The DTD is in the style directory of the manual. For markup conventions, element usage, prose style rules, and typographic guidelines, see the Documentation Style Guide . Viewing Your Changes ¶ Modern browsers can render the XML files directly by applying the referenced XSLT stylesheet. Simply open the .xml file in your browser to see a reasonable approximation of the final output.

This lets you check your work without any build setup. This is going away, however: Chrome removes XSLT in version 158 (November 17, 2026), and Firefox and Safari have announced plans to remove it as well. See the Chrome for Developers article and the feature tracking entry . This affects browser preview only; the documentation build still uses XSLT and is unaffected. For the authoritative rendering, use the Ant build system described below.

Building the Documentation ¶ The official build uses Xalan + Xerces (Java) via Apache Ant. This ensures consistent HTML output across all contributors. Prerequisites ¶ Java 8 or later (JRE or JDK) An SVN checkout of the docs (see SVN workflow ) Build Steps ¶ From your checkout: cd docs/manual svn co https://svn.apache.org/repos/asf/httpd/docs-build/trunk build cd build ./build.sh all The all target builds documentation for all available languages.

To build only English: ./build.sh To build a specific language (e.g., French): ./build.sh fr Available Build Targets ¶ To see all available targets: ./build.sh -projecthelp Validating Your Changes ¶ The validate-xhtml target uses the W3C Nu HTML Checker. If you don't already have it, download vnu.jar into the build/ directory: curl -L -o vnu.jar https://github.com/validator/validator/releases/download/latest/vnu.jar See https://github.com/validator/validator for details.

Before submitting a patch, validate your XML and the generated HTML: ./build.sh validate-xml ./build.sh validate-xhtml These checks will catch malformed XML, broken cross-references, and invalid HTML output. Please run them before sending patches — it saves everyone time. Special Files ¶ When adding a new module, the build process generates entries in mod/allmodules.xml and creates accompanying metafiles. This step requires a working Perl installation.

If you don't have Perl available, just note this in your patch submission and someone on the team will handle it. See Also ¶ Style Guide — markup conventions and prose style SVN Workflow — checking out and submitting patches Tools for Contributors — editors and validation tools Copyright © 1997-2026 The Apache Software Foundation. Apache HTTP Server, Apache, the Apache logo and the Apache HTTP Server logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.