The DocBook Framework renders the pages of the PDF output by default in US Letter format (8.5 x 11 inches). This allows printing the resulting PDF in both Letter and A4 format.
If you want to reformat the PDF documentation in A4, you can use
paper.type property when invoking ant or by
setting it permanently in the
Figure 3.4. Rendering documentation in A4 format
ant -Dpaper.type=A4 will render the documentation in A4.
While the docbook files are located in their respective
subdirectories below src/docbook, your image files should be put into
When writing documentation, images are referenced as
images/<your image file name here> because
this is where they will end up when rendering your
If your DocBook writing tool does not allow you to specify
image locations, it might not be able to locate the images from
Create a new subdirectory inside
This is where your new DocBook document will reside.
In your documentation ant build file, you must then add a
reference to render your new document. To add a DocBook document
called NewGuide.xml which has been located in the
guide subdirectory, see the following
Figure 3.5. Adding a new DocBook document
When you add a new document to the framework, you should make sure that it references DocBook DTD files which can be resolved locally. Included are the DTD files for DocBook 4.4, so your document declaration should be
Figure 3.6. Recommended DTD for DocBook documents.
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
If you use a different doctype definition, the DocBook Framework will still render your documents, but it will have to connect to the Internet to retrieve the definition files every time you run the build process.