3. Using the Framework

3.1 How to set up your documentation files

Writing documentation is not just writing text. Often, an author wants to add images, customize the layout of the pages or use specific style information to format documentation in e.g. HTML format. All the required files must be found by the DocBook Framework for creating output files.

Figure 3.1. Recommended layout for a documentation project

<root>
  |
  +---- build.xml 1
  +---- project.properties 2
  |
  +-- src
       |
       +-- docbook 3
       |
       +-- styles
       |     |
       |     +-- pdf 4
       |     |
       |     +-- html 5
       |
       +-- css
       |    |
       |    +-- html 6
       |
       +-- images 7
1

ant build file

2

custom settings for your build

3

Docbook sources

4

Custom styles for PDF

5

Custom styles for HTML

6

CSS files for HTML

7

Image files for PDF/HTML


It is possible to customize this file layout further to adjust it to existing documentation. If you start a new documentation project, then we recommend that you start with this layout until you are familiar on how the DocBook Framework behaves.