[hamster-applet] initial version of the documentation

[Toms Baugis <tbaugis src gnome org>]

commit f21566718e09366357c80560ead393b140df33b4
Author: Toms Bauģis <toms baugis gmail com>
Date:   Thu Jan 21 04:10:40 2010 +0000

    initial version of the documentation

 doc/backup.page     |   22 ++++++++++++++++++++++
 doc/index.page      |    5 +++++
 doc/input.page      |   51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/merge.page      |   24 ++++++++++++++++++++++++
 doc/reports.page    |   26 ++++++++++++++++++++++++++
 doc/statistics.page |   19 +++++++++++++++++++
 6 files changed, 147 insertions(+), 0 deletions(-)
---
diff --git a/doc/backup.page b/doc/backup.page
new file mode 100644
index 0000000..87fe91c
--- /dev/null
+++ b/doc/backup.page
@@ -0,0 +1,22 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="backup">
+<info>
+  <link type="guide" xref="index"/>
+</info>
+<title>Backup</title>
+
+<p>
+    Activities are stored in an SQLite database, located
+    <file>~/.local/share/hamster-applet/hamster.db</file>.
+    The file can be backed up and restored on the go.
+    Application will reload the data automatically after a short while.
+</p>
+<note style="info">
+    <p>
+        For viewing contents of the database we can suggest using the
+        <link href="https://addons.mozilla.org/en-US/firefox/addon/5817";><app>SQLite Manager</app></link>
+        for Mozilla Firefox.
+    </p>
+</note>
+</page>
diff --git a/doc/index.page b/doc/index.page
new file mode 100644
index 0000000..abb8ace
--- /dev/null
+++ b/doc/index.page
@@ -0,0 +1,5 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="index">
+<title>Time Tracking Help</title>
+</page>
diff --git a/doc/input.page b/doc/input.page
new file mode 100644
index 0000000..78c7f7e
--- /dev/null
+++ b/doc/input.page
@@ -0,0 +1,51 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="input">
+<info>
+  <link type="guide" xref="index"/>
+</info>
+<title>Input</title>
+
+<p>
+    To start tracking, type in activity name in the input box and hit
+    <key>Enter</key> key.
+    There are few tricks however, that will allow you to specify more detail on
+    the fly:
+</p>
+
+<steps>
+    <item><p>Use @ symbol to add category</p></item>
+    <item><p>Everything after a comma "," will be stored in the description field</p></item>
+    <item><p>To specify time on the fly, enter it as first in the input box.</p></item>
+</steps>
+
+<p>
+    Few examples:
+</p>
+<example>
+    <code>12:30-12:45 watering flowers</code>
+    <p>Forgot to note the important act of watering flowers over the lunch.</p>
+</example>
+<example>
+    <code>tomatoes garden, digging holes</code>
+    <p>
+        Need more tomatoes in the garden. Digging holes is purely informational,
+        so added it as a description
+    </p>
+</example>
+<example>
+    <code>-7 existentialism, thinking about the vastness of the universe</code>
+    <p>
+        Corrected information by informing application that I've been
+        onto something else for last seven minutes. Relative times work
+        only without end times - that is - for the most recent activity.
+    </p>
+</example>
+
+<p>
+    On top of that you can add tags in the tag input field.
+    Tags are delimited by comma. Hitting <key>Tab</key> when the suggestion
+    box shows up, will complete input to the first matching tag.
+</p>
+
+</page>
diff --git a/doc/merge.page b/doc/merge.page
new file mode 100644
index 0000000..4861456
--- /dev/null
+++ b/doc/merge.page
@@ -0,0 +1,24 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="merge">
+<info>
+  <link type="guide" xref="index"/>
+</info>
+<title>Splitting activities</title>
+
+<p>
+    <app>Time Tracker</app> does it's best to avoid overlaps in the activities.
+    If you create an activity in the middle of an existing activity. The former
+    will be split into two. In other cases of overlapping - the previous entries
+    will be shrunk.
+</p>
+<note style="info">
+    <p>
+        Merging aspect can come handy when entering information for the whole day.
+        Start by entering the first activity and set end time to "ongoing".
+        For the next activity again set just the start time and mark it as
+        ongoing. Observe how the end time of the previous activity get's adjusted
+        to the start time of the new one. Repeat the process until happy!
+    </p>
+</note>
+</page>
diff --git a/doc/reports.page b/doc/reports.page
new file mode 100644
index 0000000..96d93fa
--- /dev/null
+++ b/doc/reports.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="reports">
+<info>
+  <link type="guide" xref="index"/>
+</info>
+<title>Generating reports and exporting data</title>
+
+<p>
+    Apart from the HTML format that is offered by default in the Save report
+    dialog, format drop-down allows to choose TSV (Tab Separated Values, good for
+    spreadsheets), XML and iCal formats.
+</p>
+<p>
+    For programmatic access, there is D-Bus API, that can be introspected
+    using tools like <link href="https://fedorahosted.org/d-feet/";>D-Feet</link>.
+</p>
+
+<note style="info">
+    <p>
+        The really fastest way to get the data "out" of the Time Tracker, is by generatic the
+        HTML report, while holding the <key>Ctrl</key> key down, select all the
+        needed cells, and then copy/pasting them in the target application.
+    </p>
+</note>
+</page>
diff --git a/doc/statistics.page b/doc/statistics.page
new file mode 100644
index 0000000..f824fe9
--- /dev/null
+++ b/doc/statistics.page
@@ -0,0 +1,19 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="statistics">
+<info>
+  <link type="guide" xref="index"/>
+</info>
+<title>Statistics</title>
+
+<p>
+    The results, that are accessible, via the
+    <gui style="button">Show Statistics</gui> link are experimental and
+    they are interpretation of the facts. Interpretation that should be compared
+    with your own observations. Patches are welcome.
+</p>
+<p>
+    However, the "Starts and Ends" should give you some idea about your active
+    time.
+</p>
+</page>