Git commit 25507c62c99db8face3439f19b3867006ce934b5 by Burkhard L?ck. Committed on 21/09/2013 at 19:59. Pushed by lueck into branch 'KDE/4.11'.
Dokumentation update for Archiv Mail Agent (cherry picked from commit 288479f620116b9b317fffa7efd97b1ab3aa8ab6) backport to 4.11.3 A +- -- doc/akonadi_archivemail_agent/add-archive-mail.png A +- -- doc/akonadi_archivemail_agent/configure-archive-mail-agent.png M +84 -46 doc/akonadi_archivemail_agent/index.docbook http://commits.kde.org/kdepim/25507c62c99db8face3439f19b3867006ce934b5 diff --git a/doc/akonadi_archivemail_agent/add-archive-mail.png b/doc/akonadi_archivemail_agent/add-archive-mail.png new file mode 100644 index 0000000..638166b Binary files /dev/null and b/doc/akonadi_archivemail_agent/add-archive-mail.png differ diff --git a/doc/akonadi_archivemail_agent/configure-archive-mail-agent.png b/doc/akonadi_archivemail_agent/configure-archive-mail-agent.png new file mode 100644 index 0000000..04f8d79 Binary files /dev/null and b/doc/akonadi_archivemail_agent/configure-archive-mail-agent.png differ diff --git a/doc/akonadi_archivemail_agent/index.docbook b/doc/akonadi_archivemail_agent/index.docbook index 177d4ba..f9c3da8 100644 --- a/doc/akonadi_archivemail_agent/index.docbook +++ b/doc/akonadi_archivemail_agent/index.docbook @@ -1,20 +1,16 @@ <?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>archivemailagent</application>"> - <!ENTITY kappname "&kapplication;"> - <!ENTITY package "kdepim"> + <!ENTITY i18n-archivemailagent "<application>Archive Mail Agent</application>"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"> ]> -<book id="archivemailagent" lang="&language;"> +<article id="archivemailagent" lang="&language;"> -<bookinfo id="archivemailagentinfo"> +<articleinfo id="archivemailagentinfo"> -<title>The &kapplication; Handbook</title> +<title>The &i18n-archivemailagent; Handbook</title> <authorgroup> <author> @@ -34,42 +30,95 @@ <legalnotice>&FDLNotice;</legalnotice> -<date>2013-04-23</date> -<releaseinfo>1.0</releaseinfo> +<date>2013-08-30</date> +<releaseinfo>&kde; 4.11</releaseinfo> +</articleinfo> + +<sect1 id="introduction"> +<title>Introduction</title> -<abstract> <para> -&kapplication; is a akonadi agent which allow to archive mails automatically. +&i18n-archivemailagent; is an Akonadi agent which allows to archive mail folders automatically. </para> -</abstract> -<keywordset> -<keyword>KDE</keyword> -<keyword>KMail</keyword> -<keyword>Archive</keyword> -</keywordset> - -</bookinfo> -<chapter id="introduction"> -<title>Introduction</title> +<sect2 id="using-kapp"> +<title>Using &i18n-archivemailagent;</title> -<para>&kapplication; allows to archive mails automatically.</para> -<para>With this application we can define which folder we will archive and when do it.</para> -<para>We can specify if we want archive subfolder too</para> +<!-- keep in sync with kmail/menus.docbook reader-tools-configure-automatic-archiving"--> +<para>Use <menuchoice><guimenu>Tools</guimenu><guimenuitem>Configure Automatic Archiving...</guimenuitem> +</menuchoice><action> in &kmail;'s reader window to open a dialog to set up automatic archiving of mail folders.</action> +</para> -</chapter> +<!-- keep in sync with kmail/using.docbook auto-archive --> +<para>This is a powerful tool that can be used to assist in backing up your email. To use this, click +the <guibutton>Add...</guibutton> button, and the <guilabel>Add Archive Mail</guilabel> dialog will pop up.</para> + +<screenshot> +<screeninfo>Add Archive Mail dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="add-archive-mail.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Add Archive Mail dialog</phrase> + </textobject> + <caption> + <para>Add Archive Mail dialog</para> + </caption> + </mediaobject> +</screenshot> + +<itemizedlist> +<listitem><para>First select the folder you would like to archive.</para></listitem> +<listitem><para>Select the format you would like to save it in. ⪚ <literal role="extension">.tar.bz2</literal> + in the drop down list. The archive filename will consist of the prefix <userinput>Archive_</userinput>, +the path of the selected folder in &kmail;'s folder list, the date in format <userinput>year-month-day</userinput> +and the selected file extension ⪚ <filename>Archive_Local Folder_inbox_2013-09-03.tar.bz2</filename>. +</para></listitem> +<listitem><para>By default <guilabel>Archive all subfolders</guilabel> is enabled. +Uncheck this if you only want the parent folder archived.</para></listitem> +<listitem><para>You can type in the location you would like to save your archive, or click +the <guibutton>Open File Dialog</guibutton> button to select the folder.</para></listitem> +<listitem><para>Select how often you wish to backup through the dropdown menus next to +<guilabel>Backup each:</guilabel>.</para></listitem> +<listitem><para>If you are limited on drive space you will want to set a limit on +<guilabel>Maximum number of archive:</guilabel></para></listitem> +</itemizedlist> +<para>If you have added or modified an archive job it will be executed automatically after closing the dialog. +</para> -<chapter id="using-kapp"> -<title>Using &kapplication;</title> -<para>using</para> +<para>If you have already added mail archive jobs the <guilabel>Configure Archive Mail +Agent</guilabel> dialog will list and allow to modify them. +</para> +<screenshot> +<screeninfo>Configure Archive Mail Agent</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="configure-archive-mail-agent.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Configure Archive Mail Agent</phrase> + </textobject> + <caption> + <para>Configure Archive Mail Agent</para> + </caption> + </mediaobject> +</screenshot> +<para>You can use the checkbox at the left of each entry in the list to enable or disable +archiving of this job. +</para> +<para>Using the context menu launched with a &RMB; click on an archive job you can open the +folder containing the archives or start the archive job immediately. This will overwrite an existing +archive created earlier at the same day without notification. +</para> -</chapter> +</sect2> -<chapter id="credits"> +<sect2 id="credits"> <title>Credits and License</title> -<para>&kapplication;</para> +<para>&i18n-archivemailagent;</para> <para> Program copyright 2013 Laurent Montel montel at kde.org </para> @@ -81,22 +130,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:
