14 files changed, 332 insertions, 0 deletions
diff --git a/doc/kpercentage/Makefile.am b/doc/kpercentage/Makefile.am
new file mode 100644
index 00000000..085981d9
--- /dev/null
+++ b/doc/kpercentage/Makefile.am
@@ -0,0 +1,4 @@
+
+KDE_LANG = en
+KDE_DOCS = AUTO
+
diff --git a/doc/kpercentage/answer.png b/doc/kpercentage/answer.png
new file mode 100644
index 00000000..f7c94352
--- /dev/null
+++ b/doc/kpercentage/answer.png
diff --git a/doc/kpercentage/commands.docbook b/doc/kpercentage/commands.docbook
new file mode 100644
index 00000000..b5997824
--- /dev/null
+++ b/doc/kpercentage/commands.docbook
@@ -0,0 +1,53 @@
+<chapter id="commands">
+<title>Command Reference</title>
+
+<sect1 id="kpercentage-mainwindow">
+<title>The main &kpercentage; window</title>
+
+<para>In the main window you can only enter one of the three input
+boxes. Here you have to type in your guess.  Press
+<keycap>Enter</keycap> or click the <guibutton>Apply</guibutton>
+Button, to see if you are right.  </para>
+
+<screenshot>
+<screeninfo>Here's a screenshot of the &kpercentage; main window</screeninfo>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="main.png" format="PNG"/>
+	  </imageobject>
+	  <textobject>
+	    <phrase>Here's a screenshot of the &kpercentage; main window</phrase>
+	  </textobject>
+	</mediaobject>
+</screenshot>
+
+<para>On the bottom, two progress bars display your effort. The upper bar shows the ratio 
+	of totally attempted exercises. The lower bar compares the
+	right with the wrong answers. Do you notice that this is a
+	percentage task too? Mistyped inputs (letters, spaces, and so on) have no influence here.
+	</para>
+
+<para> At any time you can leave this window with the
+<guibutton>Cancel</guibutton> button.  You will be carried back to the
+welcome window.  There you can select another type of task or exit
+&kpercentage;.</para>
+
+<para> If you press the <guibutton>Apply</guibutton> button you are
+told whether your input was right or wrong... </para>
+
+<screenshot>
+<screeninfo>Information about correct input</screeninfo>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="answer.png" format="PNG"/>
+	  </imageobject>
+	  <textobject>
+	    <phrase>Information about correct input</phrase>
+	  </textobject>
+	</mediaobject>
+</screenshot>
+
+<para>The funny smiley jumping up and down for every right task you made!</para>
+</sect1>
+</chapter>
+
diff --git a/doc/kpercentage/credits.docbook b/doc/kpercentage/credits.docbook
new file mode 100644
index 00000000..1473caf4
--- /dev/null
+++ b/doc/kpercentage/credits.docbook
@@ -0,0 +1,35 @@
+<chapter id="credits">
+<title>Credits and License</title>
+
+<para>
+&kpercentage;
+</para>
+<para>
+Program copyright 2001 Matthias Messmer <email>[email protected]</email>
+</para>
+<para>
+Contributors:
+<itemizedlist>
+<listitem><para><acronym>CVS</acronym>, coding and discussion partner: Robert Gogolok
+ <email>[email protected]</email> and
+  Carsten Niehaus <email>[email protected]</email></para>
+</listitem>
+<listitem><para>Cleaning and bugfixing the code: Primoz Anzur <email>[email protected]</email></para></listitem>
+<listitem><para>Pixmaps: Elhay Achiam
+ <email>[email protected]</email></para>
+</listitem>
+<listitem><para>Spelling and <quote>good</quote> English: Jonathan Drews
+ <email>[email protected]</email></para>
+</listitem>
+</itemizedlist>
+</para>
+
+<para>
+Documentation copyright 2001 by Matthias Messmer <email>[email protected]</email>
+</para>
+
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+&underFDL;
+&underGPL;
+
+</chapter>
diff --git a/doc/kpercentage/devel.docbook b/doc/kpercentage/devel.docbook
new file mode 100644
index 00000000..a2f4932f
--- /dev/null
+++ b/doc/kpercentage/devel.docbook
@@ -0,0 +1,9 @@
+<chapter id="developers">
+<title>Developer's Guide to &kpercentage;</title>
+
+<para>If you want to contribute &kpercentage;, feel free to send me a
+mail <email>[email protected]</email>.</para>
+
+
+</chapter>
+
diff --git a/doc/kpercentage/edu-logo.png b/doc/kpercentage/edu-logo.png
new file mode 100644
index 00000000..d1234fd8
--- /dev/null
+++ b/doc/kpercentage/edu-logo.png
diff --git a/doc/kpercentage/faq.docbook b/doc/kpercentage/faq.docbook
new file mode 100644
index 00000000..f4b3f820
--- /dev/null
+++ b/doc/kpercentage/faq.docbook
@@ -0,0 +1,20 @@
+<chapter id="faq">
+<title>Questions and Answers</title>
+
+&reporting.bugs;
+&updating.documentation;
+
+<qandaset id="faqlist">
+<qandaentry>
+<question>
+<para>I got no help by pressing the <guibutton>Help</guibutton> Button in
+&kpercentage;?</para>
+</question> 
+<answer> 
+<para>If you got &kpercentage; from <acronym>CVS</acronym>, you must
+install the documentation  separately.</para>
+</answer>
+</qandaentry>
+</qandaset>
+</chapter>
+
diff --git a/doc/kpercentage/help.png b/doc/kpercentage/help.png
new file mode 100644
index 00000000..ff7cbf7b
--- /dev/null
+++ b/doc/kpercentage/help.png
diff --git a/doc/kpercentage/index.docbook b/doc/kpercentage/index.docbook
new file mode 100644
index 00000000..8315047c
--- /dev/null
+++ b/doc/kpercentage/index.docbook
@@ -0,0 +1,102 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"  "dtd/kdex.dtd" [
+  <!ENTITY package "kdeedu">
+  <!ENTITY introduction SYSTEM "introduction.docbook">
+  <!ENTITY using SYSTEM "using.docbook">
+  <!ENTITY commands SYSTEM "commands.docbook">
+  <!ENTITY devel SYSTEM "devel.docbook">
+  <!ENTITY faq SYSTEM "faq.docbook">
+  <!ENTITY credits SYSTEM "credits.docbook">
+  <!ENTITY install SYSTEM "install.docbook">
+  <!ENTITY % addindex "IGNORE">
+  <!ENTITY % English "INCLUDE"><!-- change language only here -->
+]>
+
+<!-- The language must NOT be changed here. -->
+
+<book lang="&language;">
+
+<bookinfo>
+<title>The &kpercentage; Handbook</title>
+
+<authorgroup>
+<author>
+<firstname>Matthias</firstname>
+<surname>Messmer</surname>
+<affiliation>
+<address><email>&Matthias.Messmer.mail;</email></address>
+</affiliation>
+</author>
+<author>
+<firstname>Carsten</firstname>
+<surname>Niehaus</surname>
+<affiliation>
+<address><email>[email protected]</email></address>
+</affiliation>
+</author>
+<author>
+<firstname>Robert</firstname>
+<surname>Gogolok</surname>
+<affiliation>
+<address><email>&Robert.Gogolok.mail;</email></address>
+</affiliation>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<copyright>
+<year>2001</year>
+<year>2002</year>
+<holder>&Matthias.Messmer;</holder>
+</copyright>
+
+<legalnotice>&FDLNotice;</legalnotice>
+
+<date>2002-10-08</date>
+<releaseinfo>1.2</releaseinfo>
+
+<abstract>
+<para>
+&kpercentage; is a small math application that will help pupils
+to improve their skills in calculating percentages.
+
+
+    <inlinemediaobject>
+        <imageobject>
+            <imagedata fileref="edu-logo.png" format="PNG"/>
+        </imageobject>
+    </inlinemediaobject>
+    &kpercentage; is part of the &kde;-EDU Project:
+    <ulink url="http://edu.kde.org/">http://edu.kde.org/</ulink></para>
+
+</abstract>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>KPercentage</keyword>
+<keyword>EDU</keyword>
+<keyword>edutainment</keyword>
+<keyword>percentages</keyword>
+</keywordset>
+
+</bookinfo>
+
+&introduction;
+&using;
+&commands;
+&devel;
+&faq;
+&credits;
+&install;
+
+&documentation.index;
+</book>
+<!--
+Local Variables:
+mode: sgml
+sgml-minimize-attributes:nil
+sgml-general-insert-case:lower
+sgml-indent-step:0
+sgml-indent-data:nil
+End:
+-->
diff --git a/doc/kpercentage/install.docbook b/doc/kpercentage/install.docbook
new file mode 100644
index 00000000..7b87e4e2
--- /dev/null
+++ b/doc/kpercentage/install.docbook
@@ -0,0 +1,21 @@
+<appendix id="installation">
+<title>Installation</title>
+
+<para>
+    <inlinemediaobject>
+        <imageobject>
+            <imagedata fileref="edu-logo.png" format="PNG"/>
+        </imageobject>
+    </inlinemediaobject>
+    &kpercentage; is part of the KDE-EDU Project:
+    <ulink url="http://edu.kde.org/">http://edu.kde.org/</ulink>
+</para>
+
+<para>Information about &kpercentage; can be found on <ulink
+url="http://edu.kde.org/kpercentage">The &kpercentage; home
+page</ulink>.</para>
+
+&install.intro.documentation;
+&install.compile.documentation;
+
+</appendix>
diff --git a/doc/kpercentage/introduction.docbook b/doc/kpercentage/introduction.docbook
new file mode 100644
index 00000000..d8285c7c
--- /dev/null
+++ b/doc/kpercentage/introduction.docbook
@@ -0,0 +1,13 @@
+<chapter id="introduction">
+<title>Introduction</title>
+
+<para>
+&kpercentage; is a small math application that will help pupils
+to improve their skills in calculating percentages.</para>
+
+<para>There is a special training section for the three basic
+tasks. Finally the pupil can select a random mode, in which all three
+tasks are mixed randomly.</para>
+
+</chapter>
+
diff --git a/doc/kpercentage/main.png b/doc/kpercentage/main.png
new file mode 100644
index 00000000..fbf526f4
--- /dev/null
+++ b/doc/kpercentage/main.png
diff --git a/doc/kpercentage/using.docbook b/doc/kpercentage/using.docbook
new file mode 100644
index 00000000..3d61a023
--- /dev/null
+++ b/doc/kpercentage/using.docbook
@@ -0,0 +1,75 @@
+<chapter id="using-kpercentage">
+<title>Using &kpercentage;</title>
+
+<para> The welcome window lets you choose the type of exercise by
+clicking on one of the buttons.  The buttons are labeled with the
+value to be deduced in the exercises.</para>
+
+<screenshot>
+	<screeninfo>Here's a screenshot of the &kpercentage; welcome window</screeninfo>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="welcome.png" format="PNG"/>
+	  </imageobject>
+	  <textobject>
+	    <phrase>Here's a screenshot of the &kpercentage; welcome window</phrase>
+	  </textobject>
+	</mediaobject>
+</screenshot>
+
+<sect1 id="kpercentage-features">
+<title>More &kpercentage; features</title>
+
+<para>On the left hand the number of exercises can be selected. One
+can choose from 1 to 10 tasks.</para>
+
+<para>On the right hand you can change the level of difficulty:</para>
+
+<variablelist>
+<varlistentry>
+<term>Easy</term>
+<listitem>
+<para>Only percentages with easy to calculate values are given.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Medium</term>
+<listitem>
+<para>Harder percentages are included, even some with values greater
+than 100%</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Crazy</term>
+<listitem>
+<para>Any percentage up to 200% may occur.  All values are whole
+numbered however, so be honest, calculate them in your head!</para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+<para>There are some help functions integrated. As usual some tool tips arise when the mouse is over 
+	a control element like a button or an edit line. If you click
+on the <guibutton>Help</guibutton> button, a little menu pops up with
+further opportunities:</para>
+
+<screenshot>
+	<screeninfo>The Help popup menu.</screeninfo>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="help.png" format="PNG"/>
+	  </imageobject>
+	  <textobject>
+		  <phrase>The Help popup menu.</phrase>
+	  </textobject>
+	</mediaobject>
+</screenshot>
+
+&help.menu.documentation;
+
+</sect1>
+
+</chapter>
+
diff --git a/doc/kpercentage/welcome.png b/doc/kpercentage/welcome.png
new file mode 100644
index 00000000..57c5ead4
--- /dev/null
+++ b/doc/kpercentage/welcome.png