summaryrefslogtreecommitdiffstats
path: root/kapptemplate/kapp/index.docbook
diff options
context:
space:
mode:
Diffstat (limited to 'kapptemplate/kapp/index.docbook')
-rw-r--r--kapptemplate/kapp/index.docbook106
1 files changed, 106 insertions, 0 deletions
diff --git a/kapptemplate/kapp/index.docbook b/kapptemplate/kapp/index.docbook
new file mode 100644
index 00000000..5f8071ff
--- /dev/null
+++ b/kapptemplate/kapp/index.docbook
@@ -0,0 +1,106 @@
+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.1.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>
+<!--
+Local Variables:
+mode: sgml
+sgml-omittag: nil
+sgml-shorttag: t
+sgml-general-insert-case: lower
+End:
+-->
+