<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kappname "&ktimetracker;">
  <!ENTITY package "kdepim">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
  <!ENTITY % addindex "IGNORE">
]>

<book id="ktimetracker" lang="&language;">

<bookinfo id="ktimetrackerinfo">
<title>The &ktimetracker; Handbook</title>

<authorgroup>
<author>
<firstname>Jonathan</firstname>
<surname>Singer</surname>
<affiliation>
<address>&Jonathan.Singer.mail;</address>
</affiliation>
</author>

<author>
<firstname>Mark</firstname>
<surname>Bucciarelli</surname>
<affiliation>
<address><email>mark@hubcapconsulting.com</email></address>
</affiliation>
</author>

<author>
<firstname>Sirtaj</firstname>
<othername>Singh</othername>
<surname>Kang</surname>
<affiliation><address>&Sirtaj.Singh.Kang.mail;</address></affiliation>
</author>

<othercredit role="reviewer">
<firstname>Lauri</firstname>
<surname>Watts</surname>
<contrib>Reviewer</contrib>
<affiliation><address>&Lauri.Watts.mail;</address></affiliation>
</othercredit>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
<year>2000-2004</year>
<holder>&Jonathan.Singer;</holder>
</copyright>

<copyright>
<year>2004-2005</year>
<holder>Mark Bucciarelli</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>2013-05-26</date>
<releaseinfo>4.11 pre (&kde; 4.11)</releaseinfo>

<abstract><para>&ktimetracker; tracks time spent on various tasks.</para></abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>ktimetracker</keyword>
<keyword>kdeutils</keyword>
<keyword>time</keyword>
<keyword>tracker</keyword>
<keyword>project</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>&ktimetracker; tracks time spent on various tasks.  It is useful for tracking
	billable hours and can report the hours logged by task and day.</para>

<para>This time history can be exported to a comma-delimited text file for
	import into other billing and/or project management tools.</para>

<para>&ktimetracker; detects when your keyboard and mouse are idle and can associate
	different tasks with different desktops, two tools that can help keep the
	timer running on the correct task.</para>

<para>&ktimetracker; was originally written by &Sirtaj.Singh.Kang;.
Its home page is <ulink
url="http://userbase.kde.org/KTimeTracker">http://userbase.kde.org/KTimeTracker</ulink>.</para>

</chapter>


<chapter id="using-ktimetracker">
<title>Using &ktimetracker;</title>

<sect1 id="starting">
<title>Starting &ktimetracker;</title>

<para>Type <command>ktimetracker</command> at a command prompt or select
<guimenuitem>Personal Time Tracker</guimenuitem> from the <menuchoice>
<guimenu>Applications</guimenu><guisubmenu>Utilities</guisubmenu> 
</menuchoice> group in the <guimenu>KDE start
menu</guimenu>. The standard &Qt; and &kde; command options are
available, and can be listed by entering
<userinput><command>ktimetracker</command> <option>--help</option></userinput>
at the command line.</para>

<para>&ktimetracker; provides an additional command option that allows you to enter
the name of the iCalendar file that is used to store your labor history.
You enter a remote iCalendar file by using http or ftp as part of the file
name; for example, http://www.mysite.com/mydata/mylabor.ics.</para>

</sect1>

<sect1 id="general-use">
<title>Tasks</title>

<informalexample>
<para><emphasis>Problem:</emphasis> You are a freelance software consultant with
many clients.  Some clients have multiple projects.  During the course of a
day, you switch back and forth between different projects.  You need to track
your time to generate monthly invoices.</para>
<para><emphasis>Solution:</emphasis> Create one top-level task for each client
and a subtask for each client project.  For projects that require more
detailed tracking, create a list of project subtasks.  Track time by
double-clicking on the task you are currently working on.</para>
</informalexample>

<para>&ktimetracker; provides great flexibility in tracking your time, allowing
unlimited tasks and task depth.  Time may be logged to any task, and more than
one task can be active at any given time.</para>
<para>&ktimetracker; allows you to edit your task's history and to put a comment 
for every event that you have stopped.</para>
<para>
To create a top-level task, select
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>
</shortcut>
<guimenu>Task</guimenu>
<guimenuitem>New Task...</guimenuitem>
</menuchoice>. 

To create a subtask, highlight the parent task and select

<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Alt;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>Task</guimenu>
<guimenuitem>New Subtask...</guimenuitem>
</menuchoice>.
</para>

<para>When &ktimetracker; exits, the task list is saved to a file on your disk. 
When it next opens, it reloads the task list from the same file.</para>

<para>&ktimetracker; can import and export tasks to minimize your work. 
See <link linkend="interfaces">Other Systems</link>.</para>

</sect1>

<sect1 id="timers"><title>Timers</title>

<informalexample>
<para><emphasis>Problem:</emphasis> To remain solvent, you must bill an
average of five hours a day.  To stay on track, you watch your daily and
weekly totals.</para>
<para><emphasis>Solution:</emphasis> Reset the session timer at the
beginning of each work day and reset all timers at the beginning of each
week.</para> </informalexample>

<para>&ktimetracker; makes tracking time simple.  To start logging time against a
task, double-click on the task.  To stop logging time, double-click
the task again.  Active tasks display a small clock in the <guilabel>Session
Time</guilabel> column.</para>
	
<para>Another visual clue of logging activity is the &ktimetracker; system tray icon.
When a task is active, the second hand in the icon moves.  If you rest the
mouse pointer over this icon, the name of the active task will display in a
tooltip.  If more than one task is active, the task names in the tooltip are 
separated by commas.</para>

<para>&ktimetracker; maintains two timers for each task: one for the session time
and one for the total time.  In the default configuration, &ktimetracker; displays
two columns for each timer, resulting in a total of four columns for each task:</para>

<variablelist>
<varlistentry> <term><guilabel>Session Time</guilabel></term>
<listitem><para>The time spent on the task since the session
began.</para></listitem> </varlistentry> 

<varlistentry> <term><guilabel>Time</guilabel></term> <listitem><para>The time
spent on the task since all times were reset.</para></listitem>
</varlistentry> 

<varlistentry> <term><guilabel>Total Session Time</guilabel></term>
<listitem><para>The time spent on the task and all its subtasks since the
session began.</para></listitem> </varlistentry> 

<varlistentry> <term><guilabel>Total Time</guilabel></term>
<listitem><para>The time spent on the task and all its subtasks since all
times were reset.</para></listitem> </varlistentry> 
</variablelist>

<para>To start a new session, select
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Start New Session</guimenuitem>
</menuchoice>
</para>

<para>To reset all times, select
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Reset All Times</guimenuitem>
</menuchoice>
</para>

<sect2><title>Desktop Tracking</title>

<informalexample>
<para><emphasis>Problem:</emphasis> You have two main projects that you
switch between each day.  To help organize your work, you keep your project
1 files on Desktop 1 and your project 2 files on Desktop
2.</para>

<para><emphasis>Solution:</emphasis> Associate project 1 task with Desktop 1
and the project 2 task with Desktop 2.  When you switch from Desktop 2 to
Desktop 1 active, &ktimetracker; automatically stops the project 2 task and starts
the project 1 task.</para>
</informalexample>

<para>To associate a task with a one or more desktops, select
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>E</keycap></keycombo>
</shortcut>
<guimenu>Task</guimenu>
<guimenuitem>Edit...</guimenuitem>
</menuchoice>.

Turn on <guilabel>Auto Tracking</guilabel> and select the desktop or desktops
to associate with this task.  When any of the selected desktops becomes active,
after a short delay &ktimetracker; will be automatically start logging time against
that task.</para>

</sect2>

<sect2><title>Idle Detection</title>

<informalexample> <para><emphasis>Problem:</emphasis> You leave work early on
Friday to run an errand and forget to stop the timer.  When you return on
Monday, the timer is still running.</para>
<para><emphasis>Solution:</emphasis> Turn on idle detection on the <guilabel>Behavior</guilabel> page 
of the settings dialog.</para>
</informalexample>

<para>&ktimetracker; can be configured to detect when the mouse and keyboard become
 idle.  If the mouse and keyboard are idle for longer than the specified
 number of minutes, &ktimetracker; displays the following dialog:</para>

<screenshot>
 <screeninfo>&ktimetracker; Idle Detection</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="idle-detect.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&ktimetracker; Idle Detection Dialog</phrase>
          </textobject>
        </mediaobject>
</screenshot>

<variablelist>
<varlistentry> <term><guibutton>Continue timing</guibutton></term>
<listitem><para>Apply the idle time to all active timers and keep them
running.</para><para>You were working on the task(s) while your computer
was idle and still are.</para></listitem></varlistentry>

<varlistentry><term><guibutton>Revert timing</guibutton></term>
<listitem><para>Subtract the amount of idle time from all active timers and
stop them.</para><para>You were not working on the task(s) while your
computer was idle and you are still not.</para></listitem></varlistentry>
</variablelist>

</sect2>

</sect1>

<sect1 id="interfaces">
<title>Other Systems</title>
<sect2 id="korganizer"><title>&korganizer;</title>

<para>&ktimetracker;, like &korganizer; and Apple's iCal, uses the industry standard
<ulink url="http://www.faqs.org/rfcs/rfc2445.html">iCalendar</ulink>
format for its data.  &ktimetracker; can read and write the to-do lists created by
these two applications.</para>
<para>
You can even work synchronously on one file with &korganizer; and &ktimetracker;. 
If one program changes the file, the updates will be propagated to the other 
application automatically.
</para>

</sect2>

<sect2 id="planner"><title>Planner</title>

<para>As a typical usecase, you might want to plan a project with the project 
management tool Imendio Planner 
(from <ulink url="http://live.gnome.org/Planner">live.gnome.org/Planner</ulink>) 
and import its tasks to &ktimetracker; with <menuchoice><guimenu>File</guimenu>
<guisubmenu>Import</guisubmenu><guimenuitem>Import Tasks From Planner...</guimenuitem>
</menuchoice>, to have them in the industry standard <ulink
url="http://www.faqs.org/rfcs/rfc2445.html">iCalendar</ulink> 
format. Having done so, you are able to schedule the tasks in &korganizer;, and account your time 
to them in &ktimetracker;. That's one way to help ensure your project stays on time
and under budget.</para>

</sect2>

<sect2 id="dcop"><title>&DBus;</title>

<para>&DBus; is the mechanism &kde; programs use to communicate with each
other.  A &kde; program provides a list of functions that other programs (a Bash
script, for example) can use.</para>

<example><title>Bash script that echoes &ktimetracker;'s version</title>
<programlisting>
qdbus org.kde.ktimetracker /KTimeTracker version 2>/dev/null || echo "ktimetracker not running"
</programlisting>
</example>

<para>&ktimetracker;'s current &DBus; interface is currently used mainly for automated
	testing, so it is very limited.  For the full interface definition, see
	<link linkend="dcopappendix">&DBus; Interface Appendix</link>.</para>

<para>To see the full &DBus; interface of the &ktimetracker; version installed on your
	system, run the following Bash script:</para>

<example><title>List &ktimetracker;'s &DBus; interface to console</title>
<programlisting>
qdbus org.kde.ktimetracker /KTimeTracker 2>/dev/null || echo "ktimetracker not running"
</programlisting>
</example>
</sect2>

<sect2 id="csv-export"><title>Export Totals to CSV</title>

<para>&ktimetracker; can export both totals and history to a comma-delimited file
format.  To export totals, select
<menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Export</guisubmenu>
<guimenuitem>Export Times...</guimenuitem>
</menuchoice> and &ktimetracker; displays the following export dialog:</para>

<screenshot>
<screeninfo>&ktimetracker; CSV Export Dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="csvexport.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&ktimetracker; CSV Export Dialog</phrase>
</textobject>
</mediaobject>
</screenshot>

<para>Enter the filename that you would like to export the data to, and modify the
other dialog defaults if necessary.  Click
<guibutton>Export</guibutton> and &ktimetracker; exports the totals for all tasks to
the file you selected.</para>
<para>Use the <guibutton>Export to Clipboard</guibutton> button to export the times to the clipboard</para>
<para>Here is an example of the output format:</para>

<literallayout>
<computeroutput>
"kde",,,,,0.00,0.00,6.88,9.83
,"ktimetracker",,,,6.88,8.70,6.88,9.83
,,"3.2 feature plan",,,0.00,0.00,0.00,0.00
,,"bugs",,,0.00,1.13,0.00,1.13
,,"checkin changes - translation strings",,,0.00,0.00,0.00,0.00
,,"time card report",,,0.00,0.00,0.00,0.00
,"kopete",,,,0.00,0.00,0.00,0.00
,"promo",,,,0.00,0.00,0.00,0.00
,"web stuff",,,,0.00,0.00,0.00,0.00
</computeroutput>
</literallayout>

<para>Top-level tasks are output in the first column, sub-tasks in the second,
and so on.  The time data is output after the maximum task depth (five in
this example).  The first time column is <guilabel>Session Time</guilabel>,
the second is <guilabel>Time</guilabel>, the third is <guilabel>Total Session
Time</guilabel> and the fourth is the <guilabel>Total Time</guilabel>.
</para>


</sect2>

<sect2 id="csv-export-history"><title>Export History to CSV</title>

<para>To export task history, select
<menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Export</guisubmenu>
<guimenuitem>Export History...</guimenuitem>
</menuchoice> and &ktimetracker; displays the same export dialog as shown above.</para>

<para>Enter the filename that you would like to export the data to, and select a date
range that you want the task history to cover.  Modify the other dialog defaults if
necessary.  Click <guibutton>Export</guibutton> and &ktimetracker; exports the
task history to the chosen file.</para>
<para>Use the <guibutton>Export to Clipboard</guibutton> button to export the history to the clipboard.</para>

<para>Here is an example of the output format:</para>

<literallayout>
<computeroutput>
Task History
From Tuesday 06 July 2004 to Tuesday 13 July 2004
Printed on: 2004-07-13 18:10
2004-07-06,2004-07-07,2004-07-08,2004-07-09,2004-07-10,2004-07-11,2004-07-12,2004-07-13,
,,,,,,,,0.00,"kde"
,,1.77,3.23,1.73,,1.37,0.82,8.95,,"ktimetracker"
,,,,,,,,0.00,,,"3.2 feature plan"
,1.13,,,,,,,1.13,,,"bugs"
,,,,,,,,0.00,,,"checkin changes - translation strings"
,,,,,,,,0.00,,,"time card report"
,,,,,,,,0.00,,"kopete"
,,,,,,,,0.00,,"promo"
,,,,,,,,0.00,,"web stuff"
</computeroutput>
</literallayout>

<para>The first three lines identify when the report was generated and for which
date range.  The fourth row is a comma-delimited list of the dates in the
date range, in ISO 8601 format (YYYY-MM-DD).  All subsequent rows list the
time logged against each task.   The last numeric column is the row total
across all days.  The task name prints after the total column, and is indented
to indicate the task/sub-task relationship.  Top level task names appear
in the first column after the total.</para>

</sect2>
</sect1>

</chapter>

<chapter id="interface">
<title>The &ktimetracker; interface</title>

<para>The main &ktimetracker; window has the following components: menubar, toolbar, 
searchbar, task/time window and status bar.</para>

<para>The searchbar is a combined field. As long as you do not press &Enter;, it acts as a
filter. Then, only tasks that match your input are shown. As soon as you 
press &Enter;, your input is used as a name to create a new task.
</para>

<para>Choose <guilabel>Configuration for PDA</guilabel> in the <guilabel>Appearance</guilabel> 
page of the settings dialog if you have a touchscreen and your screen real estate is 
precious. It will disable the search bar and every click will pop up a 
context menu.</para>

<screenshot>
<screeninfo>&ktimetracker; Screen</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="ktimetracker.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&ktimetracker; Screen</phrase>
          </textobject>
        </mediaobject>
</screenshot>

<sect1 id="main-window">
<title>The Task/Time window</title>

<para>The various tasks are displayed in this window, along with the
time accumulated for each in the current session and in total. Tasks
being timed have a small clock icon next to the session time.</para>

<para>Subtasks can be created for each task. Clicking the plus sign and 
minus sign in front of the main task toggles the view of its associated
subtasks. The total time accrued for a task includes the times for its 
subtasks, as well as its own accumulated time.</para>

</sect1>

<sect1 id="tool-bar-status-bar">
<title>The Toolbar and Statusbar</title>
<para>The toolbar contains icons for the following commands:</para>

<note><para>All behave identically to the menu command.</para></note>

<itemizedlist>
<listitem><para><guiicon>New Task</guiicon></para></listitem>
<listitem><para><guiicon>New Subtask</guiicon></para></listitem>
<listitem><para><guiicon>Start</guiicon></para></listitem>
<listitem><para><guiicon>Stop</guiicon></para></listitem>
<listitem><para><guiicon>Delete</guiicon></para></listitem>
<listitem><para><guiicon>Edit</guiicon></para></listitem>
<listitem><para><guiicon>Open</guiicon></para></listitem>
<listitem><para><guiicon>Save</guiicon></para></listitem>
</itemizedlist>

<para>The statusbar reports the name of the file where the data was saved.</para>
</sect1>

</chapter>

<chapter id="credits">

<title>Credits and License</title>

<para>
&ktimetracker;
</para>

<para> Program copyright: </para>

<itemizedlist>

<listitem><para>1997-2000 &Sirtaj.Singh.Kang;
&Sirtaj.Singh.Kang.mail;.</para>  </listitem> 

<listitem><para>2001-2002 Tomas Pospisek
<email>tpo_deb@sourcepole.ch</email></para></listitem>

<listitem><para>2003-2004 Mark
Bucciarelli <email>mark@hubcapconsulting.com</email></para></listitem>

</itemizedlist>

<para>Contributors (in alphabetical order)</para>
<itemizedlist>
<listitem><para>Allen Winter <email>winter@kde.org</email></para></listitem>
<listitem><para>&David.Faure; &David.Faure.mail;</para></listitem>
<listitem><para>&Espen.Sand; <email>espen@kde.org</email></para></listitem>
<listitem><para>Gioele Barabucci <email>gioele@gioelebarabucci.com</email></para></listitem>
<listitem><para>Jan Schaumann <email>jschauma@netmeister.org</email></para></listitem>
<listitem><para>&Jesper.Pedersen; <email>blackie@ifad.dk</email></para></listitem>
<listitem><para>Kalle Dalheimer &Matthias.Kalle.Dalheimer.mail;</para></listitem>
<listitem><para>Klar&auml;lvdalens Datakonsult AB</para></listitem>
<listitem><para>Mark Bucciarelli <email>mark@hubcapconsulting.com</email></para></listitem>
<listitem><para>Thorsten St&auml;rk <email>dev@staerk.de</email></para></listitem>
<listitem><para>Tomas Pospisek <email>tpo_deb@sourcepole.ch</email></para></listitem>
<listitem><para>Willi Richert <email>w.richert@cox.net</email></para></listitem>
</itemizedlist>

<para>&ktimetracker; was inspired by Harald Tveit Alvestrand's very useful
utility called <application>titrax</application>, the only failing of
which is that it is based on the Xt toolkit.</para>

<para>Documentation copyright 2000-2004 &Jonathan.Singer; &Jonathan.Singer.mail; and 
&Sirtaj.Singh.Kang; &Sirtaj.Singh.Kang.mail;.</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;

</chapter>

<glossary id="glossary">
<title>Glossary</title>

<glossdiv>
<title>A</title> 
<glossentry id="gloss-active-task">
<glossterm>active task</glossterm>
<glossdef><para>A task which has a timer running.</para></glossdef>
</glossentry>
</glossdiv>

<glossdiv> 
<title>D</title> 
<glossentry id="gloss-dcop">
<glossterm>&DBus;</glossterm>
<glossdef><para>The interprocess communication protocol used in &kde;.  Short
for Desktop Bus.</para></glossdef>
</glossentry>

<glossentry id="gloss-desktop">
<glossterm>desktop</glossterm>
<glossdef><para>&GNU;/&Linux;, FreeBSD and other systems that run X-Windows have
multiple desktops.  You can typically have four different desktops installed by
default.  Each desktop can display its own set of programs and files.  When
&kde; first starts up, the desktop you see is Desktop 1.  If you press
<keycombo action="simul">&Ctrl;<keycap>F2</keycap></keycombo>, you will see
Desktop 2.  Pressing <keycombo
action="simul">&Ctrl;<keycap>F1</keycap></keycombo> will bring back Desktop
1.  </para></glossdef> </glossentry>
</glossdiv>

<glossdiv> 
<title>H</title> 
<glossentry id="gloss-history">
<glossterm>history</glossterm>
<glossdef><para>If &ktimetracker; is configured to log history, it will record every
start/stop timer event. This history is not cleared when times are reset
and remains on file until the task is deleted.</para></glossdef>
</glossentry>
</glossdiv>

<glossdiv> 
<title>S</title> 
<glossentry id="gloss-session"> <glossterm>session</glossterm>
<glossdef><para>A user-defined starting point for the session timers.  A new
session begins when you select <menuchoice> <guimenu>File</guimenu>
<guimenuitem>Start New Session</guimenuitem> </menuchoice>.
Session data is not saved when you create a new session.
</para></glossdef> </glossentry>

<glossentry id="gloss-system-time"> <glossterm><guilabel>Session
Time</guilabel></glossterm> <glossdef><para>The time spent on the task
since the session began.</para></glossdef> </glossentry> 

<glossentry id="gloss-system-tray"> <glossterm>system tray</glossterm>
<glossdef><para>The system tray is in the bar that (by default) appears at
the bottom of the screen.  In this system tray <inlinemediaobject>
<imageobject> <imagedata fileref="systray.png"
format="PNG"/></imageobject> </inlinemediaobject> the &ktimetracker; icon is on the far
right.</para></glossdef>
</glossentry>
</glossdiv>

<glossdiv> 
<title>T</title> 
<glossentry id="gloss-top-level-task">
<glossterm>top level task</glossterm>
<glossdef><para>A task with no parent tasks.</para></glossdef>
</glossentry>

<glossentry id="gloss-total-session-time"> <glossterm><guilabel>Total Session
Time</guilabel></glossterm> <glossdef><para>The time spent on the task and
all its subtasks since the session began.</para></glossdef> </glossentry>
<glossentry> <glossterm><guilabel>Time</guilabel></glossterm>
<glossdef><para>The time spent on the task since all times were
reset.</para></glossdef> </glossentry> 

<glossentry id="gloss-total-time"> <glossterm><guilabel>Total Time</guilabel></glossterm>
<glossdef><para>The time spent on the task and all its subtasks since all
times were reset.</para></glossdef> </glossentry> 
</glossdiv>

</glossary>

<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-ktimetracker">
<title>How to obtain &ktimetracker;</title>

&install.intro.documentation;
&install.compile.documentation;

</sect1>

</appendix>

<appendix id="dcopappendix"><title>&DBus; Interface</title>

<refentry id="dcop-version">
<refmeta>
<refentrytitle>version</refentrytitle>
</refmeta>
<refnamediv>
<refname>version</refname>
<refpurpose>Return &ktimetracker;'s version.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
QString version()
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><function>version()</function> is a &DBus; call that returns &ktimetracker;'s
version number; for example 4.3.1.  The version number is returned as a string
in the typical &GNU; format of major.minor.bugfix.</para>
</refsect1>
</refentry>

<refentry id="dcop-quit">
<refmeta>
<refentrytitle>quit</refentrytitle>
</refmeta>
<refnamediv>
<refname>quit</refname>
<refpurpose>Return &ktimetracker;'s quit.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
QString quit()
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><function>quit()</function> is a &DBus; call that provides a way that an
external program can gracefully shutdown &ktimetracker;.
</para>
</refsect1>
</refentry>
<!--
<refentry id="dcop-hastodo">
<refmeta>
<refentrytitle>hastodo</refentrytitle>
</refmeta>
<refnamediv>
<refname>hastodo</refname>
<refpurpose>Check if top-level to-do exists.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
QString hastodo(QString taskname)
</synopsis>
<refsect2>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>taskname</parameter></term>
<listitem>
	<para>The name of the to-do to look for.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><function>hastodo(QString taskname)</function> is a &DBus; call that
	looks for a of the given name.  If found, it returns the
	iCalendar UID that identifies that to-do.  If not found, it returns an empty
	string.
</para>
<para>The iCalendar file that &ktimetracker; currently has opened is the file that is
searched.  All to-do trees are searched, not just top-level to-do's.  If more
than one to-do has a matching name, the first one found is returned.</para>
</refsect1>
</refentry>
-->
<refentry id="dcop-addtodo">
<refmeta>
<refentrytitle>addTask</refentrytitle>
</refmeta>
<refnamediv>
<refname>addTask</refname>
<refpurpose>Add new task.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
QString addTask(QString taskname)
</synopsis>
<refsect2>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>taskname</parameter></term>
<listitem>
<para>The name of new task.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsynopsisdiv>

<refsect1>
<title>Description</title>
<para><function>addTask(QString taskname)</function> is a &DBus; call that
adds a new top-level to-do to the current storage.  The UID of the new task
is returned.
</para>
</refsect1>
</refentry>

</appendix>

&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:

// vim:ts=2:sw=2:tw=78:noet
-->
