Add new ktimer handbook in support of bug report 1867.

6 files changed, 125 insertions, 15 deletions

diff --git a/doc/ktimer/first.png b/doc/ktimer/first.png
new file mode 100644
index 0000000..6fba62e
--- /dev/null
+++ b/doc/ktimer/first.png
diff --git a/doc/ktimer/index.docbook b/doc/ktimer/index.docbook
index bd96f68..5e10747 100644
--- a/doc/ktimer/index.docbook
+++ b/doc/ktimer/index.docbook
@@ -2,6 +2,8 @@
 <!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   <!ENTITY kappname "&ktimer;">
   <!ENTITY package "tdeutils">
+  <!ENTITY Stefan.Schimanski "<personname><firstname>Stefan</firstname><surname>Schimanski</surname></personname>">
+  <!ENTITY A.L.Spehr "<personname><firstname>A. L.</firstname><surname>Spehr</surname></personname>">
   <!ENTITY % English "INCLUDE">
   <!ENTITY % addindex "IGNORE">
 ]>
@@ -10,9 +12,9 @@
 <title>The &ktimer; Handbook</title>
 
 <articleinfo>
-<title>The &ktimer; Handbook</title>
 
 <authorgroup>
+<author><firstname>A. L.</firstname><surname>Spehr</surname></author>
 <author>&tde-authors;</author>
 <!-- TRANS:ROLES_OF_TRANSLATORS -->
 </authorgroup>
@@ -21,6 +23,10 @@
 <date>Reviewed: &tde-release-date;</date>
 
 <copyright>
+<year>2010</year>
+<holder>A. L. Spehr</holder>
+</copyright>
+<copyright>
 <year>&tde-copyright-date;</year>
 <holder>&tde-team;</holder>
 </copyright>
@@ -36,29 +42,132 @@
 <keywordset>
 <keyword>TDE</keyword>
 <keyword>tdeutils</keyword>
-<keyword>kcharselect</keyword>
+<keyword>ktimer</keyword>
 </keywordset>
 
 </articleinfo>
 
-<sect1 id="apologies">
-<title>We Apologize</title>
-<para>No documentation has yet been written for &ktimer;.</para>
+<sect1 id="introduction">
+<title>Introduction</title>
+<para>&ktimer; allows you to enter several tasks and to set a timer for each of them.
+When the timer reaches zero, the task is executed. The timers for each task can be started,
+stopped, changed, or looped.</para> 
+
+</sect1>
+
+<sect1 id="using-ktimer">
+<title>Using &ktimer;</title>
+
+<screenshot>
+<screeninfo>Here's a screenshot of &ktimer; when you start it for the first
+time</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="main.png" format="PNG"/>
+    </imageobject>
+      <textobject>
+      <phrase>&ktimer; main window</phrase>
+    </textobject>
+  </mediaobject>
+</screenshot>
+
+<para>To start, first add a task by selecting <guibutton>New</guibutton>. Then type the
+command you wish to execute into the <guilabel>Command line:</guilabel> box. You can then
+adjust the settings, or start the timer countdown. When the time is up, the command
+will be run.</para>
+
+<screenshot>
+<screeninfo>Here's a screenshot of &ktimer; after you have told it to run &konqueror;.</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="first.png" format="PNG"/>
+    </imageobject>
+      <textobject>
+      <phrase>add a task</phrase>
+    </textobject>
+  </mediaobject>
+</screenshot>
+
+<para>Let's use &konqueror; as an example. By default, &konqueror; will start in 100 seconds
+after the timer countdown is started.</para>
+
+<screenshot>
+<screeninfo>Here it is counting down: in 56 seconds &konqueror; will be run.</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="running.png" format="PNG"/>
+    </imageobject>
+      <textobject>
+      <phrase>56 seconds to go</phrase>
+    </textobject>
+  </mediaobject>
+</screenshot>
+
+<para>Now let's start the task. Here it has been running for a bit and is partway through the
+countdown. In 56 seconds, &konqueror; will be started.</para>
+
+<para>See that sliding bar? You can use it to quickly increase or decrease the amount of time
+on a task.</para>
+
+<screenshot>
+<screeninfo>Let's add a second task.</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="two_at_once.png" format="PNG"/>
+    </imageobject>
+      <textobject>
+      <phrase>start another &konqueror;, you can never have too many!</phrase>
+    </textobject>
+  </mediaobject>
+</screenshot>
+
+<para>Now two &konqueror;s are scheduled to be run. The top one will be run in 20 seconds,
+and the bottom one is currently stopped. You can add more commands. While you can never have
+too many &konqueror;s, you probably want to use other executables. Your own shell script, perhaps.</para>
+
+</sect1>
+
+<sect1 id="settings">
+<title>Settings</title>
+<para>
+
+<variablelist>
+  <varlistentry>
+    <term><guibutton>New</guibutton></term>
+    <listitem><para><action>Adds a new task.</action></para></listitem>
+    </varlistentry>
+
+    <varlistentry>
+    <term><guibutton>Remove</guibutton></term>
+    <listitem><para><action>Removes the current task.</action></para></listitem>
+    </varlistentry>
+ 
+    <varlistentry>
+    <term><guibutton>Help</guibutton></term>
+    <listitem><para><action>Opens the Handbook.</action></para></listitem>
+    </varlistentry>
+</variablelist>
 
-<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde;
-web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php">
-&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/">
-&tde; bug tracker</ulink>.</para>
+</para>
+
+</sect1>
+
+<sect1 id="credits">
+<title>Credits and License</title>
+
+<para>
+&ktimer;
+</para>
 
-<para>If you are interested in helping, please consider writing the help file.
-Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para>
+<!--List all the copyright holders here-->
+<para>Program Copyright 2001 &Stefan.Schimanski;</para>
 
-<para>Thank you for helping and thank you for your patience.</para>
+<para>Documentation Copyright 2008 &A.L.Spehr;</para>
 
-&underFDL;
-&underGPL;
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+&underFDL;               <!-- FDL: do not remove -->
+&underGPL;           <!-- GPL License -->
 
 </sect1>
 
-&documentation.index; 
 </article>
diff --git a/doc/ktimer/main.png b/doc/ktimer/main.png
new file mode 100644
index 0000000..ace0f79
--- /dev/null
+++ b/doc/ktimer/main.png
diff --git a/doc/ktimer/running.png b/doc/ktimer/running.png
new file mode 100644
index 0000000..d8ddc67
--- /dev/null
+++ b/doc/ktimer/running.png
diff --git a/doc/ktimer/two_at_once.png b/doc/ktimer/two_at_once.png
new file mode 100644
index 0000000..b622404
--- /dev/null
+++ b/doc/ktimer/two_at_once.png
diff --git a/ktimer/ktimer.desktop b/ktimer/ktimer.desktop
index 8137098..a7cc1fe 100644
--- a/ktimer/ktimer.desktop
+++ b/ktimer/ktimer.desktop
@@ -61,3 +61,4 @@ Name[zh_TW]=TDE 計時器
 X-TDE-StartupNotify=true
 X-DCOP-ServiceType=Multi
 Categories=Qt;TDE;Utility;
+DocPath=ktimer/index.html