[kde-doc-english] [kdepim/KDE/4.12] doc/akonadi_folderarchive_agent: Documentation: Updated Akonadi Folder Archive Agent documentation.

[Burkhard Lück]

Git commit cc4fd8d6dcd385ce516b6de935e739aa21b74d2e by Burkhard Lück, on behalf of Scarlett Clark.
Committed on 22/11/2013 at 15:34.
Pushed by lueck into branch 'KDE/4.12'.

Documentation: Updated Akonadi Folder Archive Agent documentation.

REVIEW:114001
(cherry picked from commit 829945fece4c7933dc54f1ed62149ec08d4e1ed0)
backport to 4.12.1

A  +-    --    doc/akonadi_folderarchive_agent/folderarchiveagent.png
M  +44   -11   doc/akonadi_folderarchive_agent/index.docbook

http://commits.kde.org/kdepim/cc4fd8d6dcd385ce516b6de935e739aa21b74d2e

diff --git a/doc/akonadi_folderarchive_agent/folderarchiveagent.png b/doc/akonadi_folderarchive_agent/folderarchiveagent.png
new file mode 100644
index 0000000..9da23b1
Binary files /dev/null and b/doc/akonadi_folderarchive_agent/folderarchiveagent.png differ
diff --git a/doc/akonadi_folderarchive_agent/index.docbook b/doc/akonadi_folderarchive_agent/index.docbook
index 41f4ca3..3a6b575 100644
--- a/doc/akonadi_folderarchive_agent/index.docbook
+++ b/doc/akonadi_folderarchive_agent/index.docbook
@@ -3,11 +3,12 @@
 "dtd/kdex.dtd" [
   <!-- Define an entity for your application if it is not part of KDE
        CVS -->
-  <!ENTITY kapplication "<application>folderarchiveagent</application>">
+  <!ENTITY kapplication "<application>Folder Archive Agent</application>">
   <!ENTITY kappname "&kapplication;">
   <!ENTITY package "kdepim">
   <!ENTITY % addindex "IGNORE">
-  <!ENTITY % English "INCLUDE"> 
+  <!ENTITY % English "INCLUDE">
+  <!ENTITY imap "<acronym>IMAP</acronym>">
 ]>
 
 <book id="folderarchiveagent" lang="&language;">
@@ -24,6 +25,13 @@
 </personname>
 <email>montel at kde.org</email>
 </author>
+<author>
+<firstname>Scarlett</firstname>
+<surname>Clark</surname>
+<affiliation><address>
+&Scarlett.Clark.mail;
+</address></affiliation>
+</author>
 <!-- TRANS:ROLES_OF_TRANSLATORS -->
 </authorgroup>
 
@@ -39,7 +47,7 @@
 
 <abstract>
 <para>
-&kapplication; is an akonadi agent which allows to store emails in an archive folder.
+&kapplication; is an akonadi agent which allows to store individual emails in an archive folder.
 </para>
 </abstract>
 
@@ -53,22 +61,47 @@
 <chapter id="introduction">
 <title>Introduction</title>
 
-<para>&kapplication; allows to store emails in an archive folder.</para>
+<para>&kapplication; can be enabled on a per account basis to allow you to archive individual emails through
+the right click menu.</para>
 </chapter>
 
 <chapter id="using-kapp">
 <title>Using &kapplication;</title>
-<para>using</para>
+<para>
+<screenshot>
+<screeninfo>Screenshot of &kapplication;</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="folderarchiveagent.png" format="PNG" />
+    </imageobject>
+  </mediaobject>
+</screenshot>
+</para>
 
-<!-- kmail-using archive-folder -->
-<para>Use <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Folder Archive Agent...</guimenuitem></menuchoice>
+<sect1 id="folderarchiveagent-basic-usage">
+<title>&kapplication; Basic Usage</title>
+<para>&kapplication; is used to archive single emails to a specified folder. For instance, you need to archive all of
+those pesky bill receipts in one place. &kapplication; can easily accommodate those needs. Start by
+using <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Folder Archive Agent...</guimenuitem></menuchoice>
 in &kmail;'s reader window to open a dialog to set up the folder archive agent.
 </para>
 
-<para>This dialog allows you to enable/disable the folder archive agent. It is enabled by default, to disable uncheck the <guilabel>Enable</guilabel>
-checkbox. You can change the location of your Archive folder by clicking the folder icon next to
-<guilabel>Archive folder:</guilabel> and selecting the folder you wish to use.</para>
-
+<para>This dialog will have a tab for each of your configured accounts including Local Folders and you will need to configure all accounts that you wish to
+use this feature with. The first option allows you to enable/disable the folder archive agent. It is disabled by default, to enable check the <guilabel>Enable</guilabel>
+checkbox. You can set the location of your Archive folder by clicking the folder icon next to
+<guilabel>Archive folder:</guilabel> and selecting the folder you wish to use. For example, you could create
+a folder called bill receipts by clicking the <guibutton>New Subfolder...</guibutton> and typing bill receipts in
+the dialog. You may choose a folder location anywhere, ⪚.. a folder in your Local Folders or on your &imap; server.
+You have several choices on how the emails will be archived:
+<itemizedlist id="archivefolder-options">
+  <listitem><para><guilabel>Unique Folder</guilabel> Uses the selected folder sorted by date.</para></listitem>
+  <listitem><para><guilabel>Folder by months</guilabel>Creates new folders inside the selected folder by months.</para></listitem>
+  <listitem><para><guilabel>Folder by years</guilabel>Create new folders inside the selected folder by years.</para></listitem>
+</itemizedlist>
+Now when you receive a bill receipt, right click the email and select <guimenuitem>Archive</guimenuitem> from the menu. The email will be archived
+into your configured archive folder for easy viewing later on.
+</para>
+</sect1>
 </chapter>
 
 <chapter id="credits">