Chapter 29. Write documentation

Table of Contents

29.1. User, administrator and developer documentation with Docbook
29.1.1. Documentation layout
29.1.2. Getting started
Organization of source files
Create new chapter/file
Controlling chunking
The id attribute
Help text for the BASE web client
Build the documentation
29.1.3. Docbook tags to use
Text elements
Code elements
Gui elements
Images and figures
Examples and program listing
Admonitions
Lists
Link elements
29.2. Create UML diagrams with MagicDraw
29.2.1. Organisation
29.2.2. Classes
Data layer classes
Core layer classes
29.2.3. Diagrams
Create a new diagram
Visual appearance and style
Save diagram as image
29.3. Javadoc
29.3.1. Writing Javadoc