documentation
Tom
Browder

    tom.browder@gmail.com

# Documentation

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.

The two exceptions are `./kmymoney/html/home.html` and `./kmymoney/html/whats_new.html` which are used on &kappname;'s internal home page when running the application.

## General

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

1. http://l10n.kde.org/

2. http://l10n.kde.org/docs/markup/index.html

3. http://l10n.kde.org/docs/tools.php

4. http://people.fruitsalad.org/phil/kde

5. http://people.fruitsalad.org/phil/kde/pdf-stuff/pdf-instructions.html

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

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

## Style Guide

## Tools

1. meinproc (used to produce HTML from docbook; part of KDE base)

2. dblatex (used to produce PDF from docbook; add-on from KDE doc team; see resources)

3. ??check?? (used to check docbook formatting, etc.; part of KDE base)

4. ??check?? (used to check consistency of word and phrase usage; add-on from KDE doc team; see resources)

## Style Guide

## Producing Final Documents

### HTML

#### Using include stoppers

      (command)

### PDF

### Man Pages (UNIX only)