Table of Contents

30.1. User, administrator and developer documentation with Docbook

30.1.1. Documentation layout

30.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

30.1.3. Docbook tags to use

Text elements

Code elements

Gui elements

Images and figures

Examples and program listing

Admonitions

Lists

Link elements

30.2. Create UML diagrams with MagicDraw

30.2.1. Organisation

30.2.2. Classes

Data layer classes

Core layer classes

30.2.3. Diagrams

Create a new diagram

Visual appearance and style

Save diagram as image

30.3. Javadoc

30.3.1. Writing Javadoc