[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdepim/doc/kalarm
From:       David Jarvie <djarvie () kde ! org>
Date:       2010-09-30 21:00:12
Message-ID: 20100930210012.65F51AC891 () svn ! kde ! org
[Download RAW message or body]

SVN commit 1181378 by djarvie:

Update for latest application changes


 M  +30 -3     index.docbook  


--- trunk/KDE/kdepim/doc/kalarm/index.docbook #1181377:1181378
@@ -33,7 +33,7 @@
 </authorgroup>
 
 <copyright>
-<year>2001</year><year>2002</year><year>2003</year><year>2004</year><year>2005</year><year>2006</year><year>2007</year><year>2008</year><year>2009</year>
 +<year>2001</year><year>2002</year><year>2003</year><year>2004</year><year>2005</year \
><year>2006</year><year>2007</year><year>2008</year><year>2009</year><year>2010</year>
> 
 <holder>&David.Jarvie;</holder>
 </copyright>
 
@@ -41,8 +41,8 @@
 
 <!-- Don't change format of date and version of the documentation -->
 
-<date>2009-11-28</date>
-<releaseinfo>2.04.00</releaseinfo>
+<date>2010-09-30</date>
+<releaseinfo>2.06.00</releaseinfo>
 
 <abstract>
 <para>&kalarm; is a personal alarm message, command and email scheduler for \
&kde;.</para> @@ -1134,6 +1134,10 @@
 your last display choice whenever the Alarm Edit dialog is
 redisplayed.</para>
 
+<para>You can configure the default values of many of the settings in
+the Alarm Edit dialog using the
+<link linkend="preferences-edit">Configuration dialog's Edit tab</link>.</para>
+
 <screenshot>
 <screeninfo>Screenshot of the simplified Alarm Edit dialog</screeninfo>
 <mediaobject>
@@ -1313,6 +1317,21 @@
 is still visible; in other words, when the previous occurrence of the
 alarm has not yet been acknowledged.</para></listitem>
 </itemizedlist>
+
+<para>The pre-alarm action can be used to control whether to display
+the alarm message:</para>
+
+<itemizedlist>
+<listitem><para>Check <guilabel>Cancel alarm on error</guilabel> to
+cancel the alarm if the pre-alarm command returns an error status.
+This will prevent the alarm message from being displayed, and any
+post-alarm action from being executed.</para></listitem>
+
+<listitem><para>Normally, if the pre-alarm command returns an error,
+an error message is displayed and an error indication is shown in the
+alarm list. These error notifications can be prevented by checking
+<guilabel>Do not notify errors</guilabel>.</para></listitem>
+</itemizedlist>
 </listitem>
 
 <listitem>
@@ -1348,6 +1367,14 @@
 <note><para>This alarm type is not available if &kde; is running in
 kiosk mode.</para></note>
 
+<para>When the command is executed, the environment variable
+<envar>KALARM_UID</envar> contains the event UID for the alarm. Note
+that when the command is executed from the Alarm Edit dialog's
+<guibutton>Try</guibutton> button, <envar>KALARM_UID</envar> will be
+blank if it is a new alarm, or if the alarm has been modified in the
+dialog, because the alarm only acquires a UID when it is saved in the
+alarm calendar.</para>
+
 <para>The controls available for command alarms are:</para>
 
 <itemizedlist>


[prev in list] [next in list] [prev in thread] [next in thread]