blob: fabbbdaef0930df8353949f61e96b98d592f6e40 (
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
|
echo "Creating $LOCATION_ROOT/doc/$APP_NAME_LC/index.docbook...";
$MKDIR $LOCATION_ROOT/doc/$APP_NAME_LC
echo "It is better to use template.docbook instead of this - please replace it"
cat << EOF > $LOCATION_ROOT/doc/$APP_NAME_LC/index.docbook
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY $APP_NAME_LC "$APP_NAME">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
<!-- Important note: please use template.docbook instead of this file.
This is only the conversion of app.sgml into DocBook SGML.
template.docbook gives you more information on what you can and
should do. Thanks. -->
<book lang="&language;">
<bookinfo>
<title>The &$APP_NAME_LC; Handbook</title>
<authorgroup>
<author>
<firstname></firstname>
<surname>$AUTHOR</surname>
<affiliation><address><email>$EMAIL</email></address></affiliation>
</author>
</authorgroup>
<date>`date "+%Y-%m-%d"`</date>
<releaseinfo>$APP_VERSION</releaseinfo>
<abstract>
<para>SHORT DESCRIPTION GOES HERE</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>$APP_NAME_LC</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<sect1 id="features">
<title>Features</title>
<para></para>
</sect1>
</chapter>
<chapter id="installation">
<title>Installation</title>
<sect1 id="how-to-obtain-$APP_NAME_LC">
<title>How to obtain &$APP_NAME_LC;</title>
<para></para>
</sect1>
<sect1 id="requirements">
<title>Requirements</title>
<para></para>
</sect1>
<sect1 id="compilation-and-installation">
<title>Compilation and Installation</title>
<para>Compiling &$APP_NAME_LC; is very easy. The following should do
it: <screen>
<prompt>%</prompt> <userinput><command>./configure</command></userinput>
<prompt>%</prompt> <userinput><command>make</command></userinput>
<prompt>%</prompt> <userinput><command>make</command> install</userinput></screen>
</para>
<para>That should do it! Should you run into any problems,
please report them to the <ulink
url="mailto:$EMAIL">author</ulink></para>
</sect1>
</chapter>
<chapter id="using-$APP_NAME_LC">
<title>Using &$APP_NAME_LC;</title>
<para></para>
</chapter>
<chapter id="questionsanswersandtips">
<title>Questions, Answers, and Tips</title>
<qandaset id="faq">
<title>Frequently asked questions</title>
<qandaentry>
<question>
<para>Question 1</para>
</question>
<answer>
<para>The answer</para>
</answer>
</qandaentry>
</qandaset>
</chapter>
&documentation.index;
</book>
|
