Warning, /utilities/kteatime/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003  <!ENTITY % addindex "IGNORE">
0004  <!ENTITY % English "INCLUDE">
0005 ]>
0006 
0007 <book id="kteatime" lang="&language;">
0008 <bookinfo>
0009 <title>The &kteatime; Handbook</title>
0010 <authorgroup>
0011 <author>
0012 &Michael.Korman; &Michael.Korman.mail;
0013 </author>
0014 
0015 <othercredit role="developer">
0016 &Matthias.Hoelzer-Kluepfel; &Matthias.Hoelzer-Kluepfel.mail;
0017 <!-- <contrib>Developer</contrib> -->
0018 </othercredit>
0019 
0020 <othercredit role="reviewer">
0021 &Lauri.Watts; &Lauri.Watts.mail;
0022 <!-- <contrib>Reviewer</contrib> -->
0023 </othercredit>
0024 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0025 </authorgroup>
0026 
0027 <copyright>
0028 <year>2000</year>
0029 <holder>&Michael.Korman;</holder>
0030 </copyright>
0031 
0032 <legalnotice>&FDLNotice;</legalnotice>
0033 
0034 <date>2016-07-06</date>
0035 <releaseinfo>1.3.0 (Applications 16.04)</releaseinfo>
0036 
0037 <abstract>
0038 <para>This Handbook describes &kteatime;, the &kde; Tea Cooker.</para>
0039 </abstract>
0040 <keywordset>
0041 <keyword>KDE</keyword>
0042 <keyword>kdetoys</keyword>
0043 <keyword>kteatime</keyword>
0044 <keyword>tea</keyword>
0045 <keyword>cooker</keyword>
0046 <keyword>timer</keyword>
0047 </keywordset>
0048 </bookinfo>
0049 
0050 <chapter id="introduction">
0051 <title>Introduction</title>
0052 
0053 <sect1 id="whats-kteatime">
0054 <title>What's &kteatime;?</title>
0055 
0056 <para>&kteatime; is a handy timer for steeping tea. No longer will you have to guess at how long it takes for your tea to be ready. Simply select the type of tea you have, and it will alert you when the tea is ready to drink.</para>
0057 </sect1>
0058 
0059 </chapter>
0060 
0061 <chapter id="how-to-use">
0062 <title>How to Use &kteatime;</title>
0063 
0064 <para>When you start up &kteatime;, it will automatically dock itself in your panel. To access the menu, right click on the docked icon. This will present a list of options which are covered in more detail in the next chapter.</para>
0065 
0066 <sect1 id="timing-your-tea">
0067 <title>Timing Your Tea</title>
0068 
0069 <para>Upon starting, the panel icon will be that of an tea mug. If you click with the &RMB; on the mug and select your tea, an animated clock  visualizing the remaining time is displayed on the icon. After the specified time, the tea will be finished, and a suitable message box will be shown. At this point, you can close the message box by clicking on it. This resets also the timer and the clock on the mug disappears again.</para>
0070 
0071 <note><para>The timer should only be reset by those who really enjoy tea.</para></note>
0072 
0073 </sect1>
0074 </chapter>
0075 
0076 <chapter id="menu-options">
0077 <title>Menu Options</title>
0078 
0079 <para>The following section describes the menu options that are available in &kteatime;.</para>
0080 
0081 <sect1 id="select-your-tea">
0082 <title>Select Your Tea</title>
0083 
0084 <para>Clicking on the icon with the &RMB; will bring up a menu. At the top of the menu there are four menu items. Here, you can select what kind of tea you are preparing to drink. There are: <guimenuitem>Black Tea</guimenuitem>, <guimenuitem>Earl Grey</guimenuitem>, <guimenuitem>Fruit Tea</guimenuitem>, and <guimenuitem>Green Tea</guimenuitem>. These teas are preconfigured with a default time. Many people have complained that the times are not correct. Please be aware that the amount of time it takes to steep a cup of tea is based on personal preference. The times chosen are approximations. If you read on, you will learn how to change or delete these predefined times and to set your own time. A quick-and-easy way to set a custom time is to choose <guimenuitem>Custom...</guimenuitem> from the menu.</para>
0085 
0086 <para>Clicking <guimenuitem>Configure Notifications...</guimenuitem> brings up the &kde; Notification Settings for &kteatime;.</para>
0087 
0088 </sect1>
0089 
0090 <sect1 id="start">
0091 <title>Start the Tea Timer</title>
0092 
0093 <para>To start the tea timer select a tea from the context menu. As confirmation that you have indeed started 
0094 the timer, a clock visualizing the remaining time is displayed in the panel icon.</para></sect1>
0095 
0096 <sect1 id="configure">
0097 <title>Configure</title>
0098 
0099 <para>This menu item opens up the configuration dialog box. A screenshot is shown below:</para>
0100 
0101 <screenshot>
0102 <screeninfo>The &kteatime; configuration dialog box.</screeninfo>
0103 <mediaobject>
0104 <imageobject><imagedata fileref="config.png" format="PNG"/></imageobject>
0105 <textobject><phrase>The &kteatime; configuration dialog
0106 box.</phrase></textobject>
0107 </mediaobject>
0108 </screenshot>
0109 
0110 <para>As shown in the picture, you may add new entries for other tea or change names, times and the order of existing entries. This is useful if you are brewing a cup of tea that is not on the list or if you do not agree with the predefined times. To edit one entry, mark it in the <guilabel>Tea List</guilabel> on the left and change the values in the <guilabel>Tea Properties</guilabel> on the right.</para>
0111 
0112 <para>The box below is the <guilabel>Action</guilabel> field. Here you can define an action that will be executed when the time is up.  If <guilabel>Popup</guilabel> is selected, a message box will appear alerting you to the fact that your tea is ready. 
0113 </para>
0114 
0115 <para>If you enable the check box labeled <guilabel>Visualize progress in icon tray</guilabel>, the progress will be shown as a little animated clock inside the icon.</para>
0116 
0117 </sect1>
0118 </chapter>
0119 
0120 <chapter id="credits">
0121 <title>Credits</title>
0122 
0123 <para>&kteatime; Copyright &copy; 1998-1999 by
0124 &Matthias.Hoelzer-Kluepfel; &Matthias.Hoelzer-Kluepfel.mail;
0125 </para>
0126 
0127 <para>Documentation by &Michael.Korman; &Michael.Korman.mail;</para>
0128 
0129 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0130 &underFDL;               <!-- FDL: do not remove -->
0131 &underGPL;               <!-- GPL License -->
0132 
0133 </chapter>
0134 
0135 &documentation.index;
0136 
0137 </book>
0138 
0139 <!--
0140 Local Variables:
0141 mode: sgml
0142 sgml-minimize-attributes:nil
0143 sgml-general-insert-case:lower
0144 sgml-indent-step:0
0145 sgml-indent-data:nil
0146 End:
0147 
0148 // vim:ts=2:sw=2:tw=78:noet
0149 -->
0150 
0151