7.2. Editing the Documentation (using XMLMind)

7.2. Editing the Documentation (using XMLMind)
Prev	Chapter 7. Writing DocBook Documentation	Next

7.2.1. XMLMind XML Editor

The documentation are written in XML using the DocBook dialect. As such you can edit the text with any text editor. However, you may find it easier to use an editor; the one I use is from XMLMind. The personal edition is free for use on open source projects.

7.2.2. Images

Images should be saved as .png files, under the images subdirectory (relative the directory holding xxx-guide.xml).

Images should be embedded into the documentation using a screenshot/mediaobject/imageobject/imagedata tag. In XMLMind, use Edit>Insert and select screenshot:

The outer imagedata tag should have an appropriate scale attribute; a value of 50 (note: not 50%) works reasonably well:

7.2.3. Tables

In XMLMind, use Edit > Insert, then select one of table, table(head_column), table(head_row), table(head_row_column):

This will create a 2x2 table body with a header row and/or column if requested. Then use DocBook > Column > Insert or DocBook > Row > Insert to adjust the number of columns and rows as required.