Tom Browder

tom.browder@gmail.com

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 ./kmymoney2/html/home.html and ./kmymoney2/html/whats_new.html which are used on &kappname;'s internal home page when running the application. 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: http://l10n.kde.org/ http://l10n.kde.org/docs/markup/index.html http://l10n.kde.org/docs/tools.php http://people.fruitsalad.org/phil/kde 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 ./developer-doc/phb/kmymoney-entities.docbook meinproc (used to produce HTML from docbook; part of KDE base) dblatex (used to produce PDF from docbook; add-on from KDE doc team; see resources) ??check?? (used to check docbook formatting, etc.; part of KDE base) ??check?? (used to check consistency of word and phrase usage; add-on from KDE doc team; see resources) (command)