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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "KMyMoney">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
<!ENTITY version "1.2">
<!ENTITY app "<command>KMyMoney</command>">
<!ENTITY cvs "<command>CVS</command>">
<!ENTITY ac "<command>autoconf</command>">
<!ENTITY am "<command>automake</command>">
<!ENTITY GPG "<command>GPG</command>">
<!ENTITY cvs-host "kmymoney2.cvs.sourceforge.net">
<!ENTITY cvs-anonuser "anonymous">
<!ENTITY cvs-user "<emphasis>username</emphasis>">
<!ENTITY cvs-dir "/cvsroot/kmymoney2">
<!ENTITY cvs-module "kmymoney2">
<!ENTITY config-management SYSTEM "cfg-mgmt.docbook">
<!ENTITY release-management SYSTEM "rel-mgmt.docbook">
<!ENTITY coding-standards SYSTEM "coding.docbook">
<!ENTITY creating-dialogs SYSTEM "dialogs.docbook">
<!ENTITY translation-hints SYSTEM "translation.docbook">
<!ENTITY error-management SYSTEM "error-mgmt.docbook">
<!ENTITY cvs-examples SYSTEM "cvs-examples.docbook">
<!ENTITY src-examples SYSTEM "src-examples.docbook">
<!ENTITY unit-test SYSTEM "unit-test.docbook">
<!ENTITY test-examples SYSTEM "test-examples.docbook">
<!ENTITY rpm-example SYSTEM "rpm-example.docbook">
<!ENTITY documentation SYSTEM "documentation.docbook">
<!ENTITY submissions SYSTEM "submissions.docbook">
<!ENTITY settings SYSTEM "settings.docbook">
<!ENTITY licence SYSTEM "licence.docbook">
<!ENTITY fdl-licence SYSTEM "fdl-licence">
]>
<book lang="&language;">
<bookinfo>
<title>&kappname; Project Handbook</title>
<subtitle>Version &version;</subtitle>
<authorgroup>
<author>
<honorific>Dipl.Ing</honorific>
<firstname>Thomas</firstname>
<surname>Baumgart</surname>
<affiliation>
<address><email>[email protected]</email></address>
</affiliation>
</author>
<author>
<firstname>Michael</firstname>
<surname>Edwardes</surname>
<affiliation>
<address><email>[email protected]</email></address>
</affiliation>
</author>
</authorgroup>
<date>18.09.2005</date>
<copyright>
<year>2001</year>
<year>2002</year>
<year>2005</year>
<year>2008</year>
<holder>Thomas Baumgart</holder>
<holder>Michael Edwardes</holder>
<holder>Alvaro Soliverez</holder>
</copyright>
<legalnotice>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation; with
no Invariant Sections, with no Front-Cover texts, and with no Back-Cover
Texts. A copy of the license is included in the appendix entitled
<link linkend="licence">"GNU Free Documentation License"</link>.
</para>
</legalnotice>
<abstract>
<para>
As for any software development project, certain rules regulate the
development process of &app;. These rules cover things like coding
standards, configuration management and error reporting, just to name a few.
The focus of this document is on configuration management and coding
standards. More
information about the &app; project can be found on the
<ulink url="http://kmymoney2.sourceforge.net/">project's hompage</ulink>.
</para>
<para>
If you have any comments to raise about this document please send an email
to <email>[email protected]</email>,
the project's developer mailing list and we will try to rectify it.
Please note that the most up-to-date version of this document can be
found in the source tree and is online on the
<ulink url="http://kmymoney2.sourceforge.net/">project's homepage</ulink>.
A <ulink url="http://kmymoney2.sourceforge.net/phb/kmymoney-phb.pdf">PDF
version</ulink> is also available for download.
</para>
<para>
A prerequisite for this document is a basic understanding on the work with
&cvs;. Even though this document covers some of the more special topics of
&cvs; in more detail it is not intended as an introduction to &cvs; in general.
</para>
</abstract>
</bookinfo>
<!--
<dedication>
<para>
The dedication will show up here!
<para>
</dedication>
-->
<preface id="versionhistory">
<title>History of this document</title>
<para>
This chapter contains a list of releases of this document. Each entry in this
list contains a date, an author and a short description and possibly a
release number.
<variablelist>
<varlistentry>
<term>2001-11, Thomas Baumgart, Rev 0.1</term>
<listitem>
<itemizedlist>
<listitem><para>
Initial work on the project handbook goes back into November 2001.
Unfortunately, the only history information is available in &cvs;.
</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term>2005-09-18, Thomas Baumgart, Rev 1.0</term>
<listitem>
<itemizedlist>
<listitem><para>Added chapter about <link linkend="translation">translation</link>
provided by J. Rundholz.</para></listitem>
<listitem><para>Added this version history</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term>2006-09-11, Thomas Baumgart, Rev 1.1</term>
<listitem>
<itemizedlist>
<listitem><para>Added chapter about <link linkend="documentation">documentation</link>
provided by Tom Browder.</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term>2008-01-31, Alvaro Soliverez, Rev 1.2</term>
<listitem>
<itemizedlist>
<listitem><para>Added chapter about <link linkend="submissions">submissions</link></para></listitem>
<listitem><para>Added chapter about <link linkend="settings">settings</link></para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</para>
</preface>
&config-management;
&release-management;
&coding-standards;
&creating-dialogs;
&settings;
&unit-test;
&documentation;
&submissions;
&translation-hints;
&error-management;
&cvs-examples;
&src-examples;
&test-examples;
&rpm-example;
&licence;
</book>
|
