Git commit c2b255b88eedb4b80622a7c3b6d29c2fc0095d46 by David Jarvie. Committed on 13/05/2020 at 23:25. Pushed by djarvie into branch 'master'.
Update documentation M +21 -18 doc/index.docbook https://commits.kde.org/kalarm/c2b255b88eedb4b80622a7c3b6d29c2fc0095d46 diff --git a/doc/index.docbook b/doc/index.docbook index 8c2187c7..8653f509 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -31,7 +31,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>2010</year><year>2011</year><year>2012</year><year>2013</year><year>2016</year><year>2018</year><year>2019</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><year>2011</year><year>2012</year><year>2013</year><year>2016</year><year>2018</year><year>2019</year><year>2020</year> <holder>&David.Jarvie;</holder> </copyright> @@ -39,8 +39,8 @@ <!-- Don't change format of date and version of the documentation --> -<date>2019-10-20</date> -<releaseinfo>2.12.8 (Applications 19.08.3)</releaseinfo> +<date>2020-05-14</date> +<releaseinfo>3.0.0 (Applications 20.08)</releaseinfo> <abstract> <para>&kalarm; is a personal alarm message, command and email scheduler by &kde;.</para> @@ -910,7 +910,7 @@ retriggered.</para></warning> <varlistentry> <term><menuchoice><guimenuitem>Import...</guimenuitem></menuchoice></term> <listitem> -<para>Import alarms from an external calendar file into the selected +<para>Import alarms from external calendar files into the selected calendar. This is described in <link linkend="import">Importing Alarms from External Calendars</link>. This option is not available for disabled or read-only @@ -975,7 +975,7 @@ been used on this calendar.</para> <para>You can import alarms from other calendar files into &kalarm;. The import function scans the selected calendar -file for events containing alarms, and copies them (with new unique +files for events containing alarms, and copies them (with new unique IDs) into &kalarm;'s calendar. Events without alarms, and calendar entries other than events, are ignored. There are two ways to import alarms:</para> @@ -985,7 +985,7 @@ alarms:</para> <para>Use <menuchoice><guimenu>File</guimenu> <guimenuitem>Import Alarms...</guimenuitem></menuchoice> to import alarms of all types (active alarms, archived alarms and alarm -templates) from the calendar.</para> +templates) from the calendar files.</para> <para>If you have configured <link linkend="calendars">alarm calendars</link>, alarms of each type @@ -3254,7 +3254,8 @@ including displaying the <entry><option>--edit <replaceable>eventID</replaceable></option></entry> <entry>Display the Alarm Edit dialog to edit the alarm with the specified event ID. The event ID is the unique ID of the event, optionally - prefixed by the ID of the resource containing the event, in the format + prefixed by the configuration name or numeric ID of the resource containing + the event, in the format <replaceable>[resourceID:]eventUID</replaceable>.</entry> </row> <row> @@ -3286,8 +3287,7 @@ including displaying the <entry><option>--list</option></entry> <entry>Output a list of scheduled alarms to <filename>stdout</filename>. The list shows brief details of each pending alarm: its resource - identifier (if using Akonadi), UID, next scheduled time and message - text or file.</entry> + identifier, UID, next scheduled time and message text or file.</entry> </row> <row> <entry><option>--tray</option></entry> @@ -3358,7 +3358,8 @@ void cancelEvent(const QString& <replaceable>eventID</replaceable>) <term><parameter>eventID</parameter></term> <listitem> <para>Specifies the unique ID of the event to be canceled, optionally -prefixed by the ID of the resource containing the event, in the format +prefixed by the configuration name or numeric ID of the resource containing +the event, in the format <replaceable>[resourceID:]eventUID</replaceable>.</para> </listitem> </varlistentry> @@ -3396,7 +3397,8 @@ void triggerEvent(const QString& <replaceable>eventID</replaceable>) <term><parameter>eventID</parameter></term> <listitem> <para>Specifies the unique ID of the event to be triggered, optionally -prefixed by the ID of the resource containing the event, in the format +prefixed by the configuration name or numeric ID of the resource containing +the event, in the format <replaceable>[resourceID:]eventUID</replaceable>.</para> </listitem> </varlistentry> @@ -4522,7 +4524,8 @@ bool edit(const QString& <replaceable>eventID</replaceable>) <term><parameter>eventID</parameter></term> <listitem> <para>Specifies the unique ID of the event to be edited, optionally -prefixed by the ID of the resource containing the event, in the format +prefixed by the configuration name or numeric ID of the resource containing +the event, in the format <replaceable>[resourceID:]eventUID</replaceable>.</para> </listitem> </varlistentry> @@ -4633,8 +4636,8 @@ QString list() <para><function>list()</function> is a &DBus; call to return a string containing a summary of scheduled alarms. The list shows brief details -of each pending alarm: its resource identifier (if using Akonadi), UID, -next scheduled time and message text or file.</para> +of each pending alarm: its resource identifier, UID, next scheduled time +and message text or file.</para> </refsect1> </refentry> @@ -4777,8 +4780,8 @@ Internet Calendaring and Scheduling Core Object Specification (iCalendar)</ulink>. This is the standard format used by all kdepim applications. &kalarm; uses certain non-standard properties, in conformance with RFC2445. These are documented in the -<filename>DESIGN.html</filename> file which is distributed with -&kalarm;.</para> +<filename>kalarmcal/DESIGN.html</filename> file which is distributed +with &kalarm;.</para> </answer> </qandaentry> @@ -4832,11 +4835,11 @@ detailed instructions are contained in the &kalarm; </para> <para> -Program copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 &David.Jarvie; &David.Jarvie.mail; +Program copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 &David.Jarvie; &David.Jarvie.mail; </para> <para> -Documentation copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 &David.Jarvie; &David.Jarvie.mail; +Documentation copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2016, 2018, 2019, 2020 &David.Jarvie; &David.Jarvie.mail; </para> <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
