[kde-doc-english] [kdepim] doc/akonadi_sendlater_agent: Update Dokumentation for Send Later Agent
Burkhard Lück
lueck at hube-lueck.de
Thu Sep 5 19:15:31 UTC 2013
Git commit 1a95cc6a2cb45b1823d6501af115d72714dfa495 by Burkhard Lück.
Committed on 05/09/2013 at 19:15.
Pushed by lueck into branch 'master'.
Update Dokumentation for Send Later Agent
REVIEW:112426
M +78 -50 doc/akonadi_sendlater_agent/index.docbook
A +- -- doc/akonadi_sendlater_agent/sendlateragent-configure.png
A +- -- doc/akonadi_sendlater_agent/sendlateragentdialog.png
http://commits.kde.org/kdepim/1a95cc6a2cb45b1823d6501af115d72714dfa495
diff --git a/doc/akonadi_sendlater_agent/index.docbook b/doc/akonadi_sendlater_agent/index.docbook
index 54673cc..6e595b8 100644
--- a/doc/akonadi_sendlater_agent/index.docbook
+++ b/doc/akonadi_sendlater_agent/index.docbook
@@ -1,21 +1,14 @@
<?xml version="1.0" ?>
-<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
"dtd/kdex.dtd" [
- <!-- Define an entity for your application if it is not part of KDE
- CVS -->
- <!ENTITY kapplication "<application>sendlateragent</application>">
- <!ENTITY kappname "&kapplication;">
- <!ENTITY package "kdepim">
+ <!ENTITY i18n-sendlateragent "<application>Send Later Agent</application>">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
-<book id="sendlateragent" lang="&language;">
-
-<bookinfo id="sendlateragentinfo">
-
-<title>The &kapplication; Handbook</title>
-
+<article id="sendlateragent" lang="&language;">
+<articleinfo>
+<title>The &i18n-sendlateragent; Handbook</title>
<authorgroup>
<author>
<personname>
@@ -32,41 +25,88 @@
<holder>Laurent Montel</holder>
</copyright>
-<legalnotice>&FDLNotice;</legalnotice>
+<date>2013-08-30</date>
+<releaseinfo>&kde; 4.11</releaseinfo>
-<date>2013-04-23</date>
-<releaseinfo>1.0</releaseinfo>
+</articleinfo>
+
+<sect1 id="introduction">
+<title>Introduction</title>
-<abstract>
<para>
-&kapplication; is a akonadi agent which allow to send mails later.
+&i18n-sendlateragent; is an akonadi agent which allows to send scheduled mails once or repeatedly.
</para>
-</abstract>
-<keywordset>
-<keyword>KDE</keyword>
-<keyword>KMail</keyword>
-<keyword>Archive</keyword>
-</keywordset>
-
-</bookinfo>
-<chapter id="introduction">
-<title>Introduction</title>
-
-<para>&kapplication; allows to send emails later.</para>
-</chapter>
+<sect2 id="using-kapp">
+<title>Using &i18n-sendlateragent;</title>
+
+<!-- keep in sync with kmail/using.docbook id=send-later-->
+<para>Use <menuchoice><guimenu>Message</guimenu><guimenuitem>Send Later</guimenuitem></menuchoice>
+in &kmail;'s composer window to open a dialog which allows you to schedule your emails to send
+at a specific date and time.</para>
+
+<screenshot>
+<screeninfo>&i18n-sendlateragent; Dialog</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="sendlateragentdialog.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>&i18n-sendlateragent; Dialog</phrase>
+ </textobject>
+ <caption>
+ <para>&i18n-sendlateragent; Dialog</para>
+ </caption>
+ </mediaobject>
+</screenshot>
+
+<para>You can configure it to repeat sending the message by checking <guilabel>Repeat every</guilabel>
+checkbox and selecting the desired intervals.</para>
+<para>
+This is useful if you need to send out reminders to someone on a consistent basis, ⪚ employees.</para>
+<para> You can put the message in your queued messages by selecting the <guibutton>Put in outbox</guibutton>
+button or select the <guibutton>Send Later</guibutton> button to schedule the message immediately.
+</para>
+<para>This agent works independent from &kmail; and does not need a running &kmail; instance or &kmail; beeing
+in online mode.</para>
+<para>If you have no network connection when a scheduled message should be sent, the agent will report an error
+and ask if you want to resend it later.</para>
+<para>At login to a &kde; session the agent checks the scheduled messages and sends all
+messages overdue since the last logout if necessary.
+</para>
-<chapter id="using-kapp">
-<title>Using &kapplication;</title>
-<para>using</para>
+<!--keep in sync with kmail/menus.docbook id=reader-tools-configure-send-later-agent -->
+<para>To change the options for later scheduled messages use <menuchoice><guimenu>Tools</guimenu>
+<guimenuitem>Configure Send Later Agent...</guimenuitem></menuchoice> in &kmail;.
+</para>
-</chapter>
+<screenshot>
+<screeninfo>Configure &i18n-sendlateragent;</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="sendlateragent-configure.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Configure &i18n-sendlateragent;</phrase>
+ </textobject>
+ <caption>
+ <para>Configure &i18n-sendlateragent;</para>
+ </caption>
+ </mediaobject>
+</screenshot>
+
+<para><action>This brings up a dialog that allows you to modify the schedule and remove emails
+that have been sent using the send later feature.</action>
+</para>
+<para>It is not possible to change the content (body, headers &etc;) of a scheduled message.
+</para>
+</sect2>
-<chapter id="credits">
+<sect2 id="credits">
<title>Credits and License</title>
-<para>&kapplication;</para>
+<para>&i18n-sendlateragent;</para>
<para>
Program copyright 2013 Laurent Montel montel at kde.org
</para>
@@ -78,23 +118,11 @@ Documentation Copyright © 2013 Laurent Montel montel at kde.org
&underFDL; <!-- FDL: do not remove -->
&underGPL; <!-- GPL License -->
-</chapter>
-
-<appendix id="installation">
-<title>Installation</title>
-
-<sect1 id="compilation">
-<title>Compilation and Installation</title>
-
-&install.compile.documentation;
+</sect2>
</sect1>
-</appendix>
-
-&documentation.index;
-</book>
-
+</article>
<!--
Local Variables:
mode: xml
diff --git a/doc/akonadi_sendlater_agent/sendlateragent-configure.png b/doc/akonadi_sendlater_agent/sendlateragent-configure.png
new file mode 100644
index 0000000..cd8499f
Binary files /dev/null and b/doc/akonadi_sendlater_agent/sendlateragent-configure.png differ
diff --git a/doc/akonadi_sendlater_agent/sendlateragentdialog.png b/doc/akonadi_sendlater_agent/sendlateragentdialog.png
new file mode 100644
index 0000000..cb35f1d
Binary files /dev/null and b/doc/akonadi_sendlater_agent/sendlateragentdialog.png differ
More information about the kde-doc-english
mailing list