blob: f2ee6f29060a3213c121e156683409475f19a967 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
<chapter id="documentation">
<chapterinfo>
<authorgroup>
<author>
<firstname>Tom</firstname>
<surname>Browder</surname>
<affiliation>
<address><email>tom.browder@gmail.com</email></address>
</affiliation>
</author>
</authorgroup>
</chapterinfo>
<title>Documentation</title>
<para>
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
<filename>./kmymoney2/html/home.html</filename>
and
<filename>./kmymoney2/html/whats_new.html</filename>
which are used on &kappname;'s internal home page when running the application.
</note>
</para>
<!-- =============================================== -->
<sect1 id="documentation-general">
<title>General</title>
<para>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:
</para>
<orderedlist>
<listitem><ulink url="http://l10n.kde.org/">http://l10n.kde.org/</ulink></listitem>
<listitem><ulink url="http://l10n.kde.org/docs/markup/index.html">http://l10n.kde.org/docs/markup/index.html</ulink></listitem>
<listitem><ulink url="http://l10n.kde.org/docs/tools.php">http://l10n.kde.org/docs/tools.php</ulink></listitem>
<listitem><ulink url="http://people.fruitsalad.org/phil/kde">http://people.fruitsalad.org/phil/kde</ulink></listitem>
<listitem><ulink url="http://people.fruitsalad.org/phil/kde/pdf-stuff/pdf-instructions.html">http://people.fruitsalad.org/phil/kde/pdf-stuff/pdf-instructions.html</ulink></listitem>
</orderedlist>
<para>XML entities should be used for commonly used terms and phrases. There is a &kappname; list at
<orderedlist>
<listitem>./developer-doc/phb/kmymoney-entities.docbook</listitem>
</orderedlist>
</para>
</sect1>
<!-- =============================================== -->
<sect1 id="documentation-entities">
<title>Style Guide</title>
</sect1>
<!-- =============================================== -->
<sect1 id="documentation-tools">
<title>Tools</title>
<orderedlist>
<listitem>meinproc (used to produce HTML from docbook; part of KDE base)</listitem>
<listitem>dblatex (used to produce PDF from docbook; add-on from KDE doc team; see resources)</listitem>
<listitem>??check?? (used to check docbook formatting, etc.; part of KDE base)</listitem>
<listitem>??check?? (used to check consistency of word and phrase usage; add-on from KDE doc team; see resources)</listitem>
</orderedlist>
</sect1>
<!-- =============================================== -->
<sect1 id="documentation-style-guide">
<title>Style Guide</title>
</sect1>
<!-- =============================================== -->
<sect1 id="documentation-making-docs">
<title>Producing Final Documents</title>
<sect2 id="documentation-making-html">
<title>HTML</title>
<example>
<title>Using include stoppers</title>
<screen>
(command)
</screen>
</example>
</sect2>
<sect2 id="documentation-making-pdf">
<title>PDF</title>
</sect2>
<sect2 id="documentation-making-man">
<title>Man Pages (UNIX only)</title>
</sect2>
</sect1>
</chapter>
|
