Home 

Chapter 7. Documentation

Tom Browder

Table of Contents

General
Style Guide
Tools
Style Guide
Producing Final Documents
HTML
PDF
Man Pages (UNIX only)

Code documentation is discussed in the section "coding." This section discusses developer and user documentation and generating html and pdf versions of same. Note that all non-source-code documentation, with two exceptions, must be written in docbook form.

Note

The two exceptions are ./kmymoney2/html/home.html and ./kmymoney2/html/whats_new.html which are used on KMyMoney's internal home page when running the application.

General

In general, all documentation for KMyMoney should follow guidelines for the KDE project. In addition to the KDE guidelines, there are KMyMoney guidelines (which take precedence if there are conflicts). See the following KDE resources:

XML entities should be used for commonly used terms and phrases. There is a KMyMoney list at

  1. ./developer-doc/phb/kmymoney-entities.docbook