Git commit 509e5c71fe6c04f3cd7a64c06f59741bbe71f5e1 by Burkhard Lück. Committed on 16/04/2016 at 18:52. Pushed by lueck into branch 'master'.
Update sieveeditor docbook Replace the stub in sieveeditor docbook with info + screenshots from Laurents blog REVIEW:127660 A +- -- doc/sieveeditor/first-start.png M +108 -30 doc/sieveeditor/index.docbook A +- -- doc/sieveeditor/script-edit.png A +- -- doc/sieveeditor/script-help.png A +- -- doc/sieveeditor/script-tools.png http://commits.kde.org/kdepim/509e5c71fe6c04f3cd7a64c06f59741bbe71f5e1 diff --git a/doc/sieveeditor/first-start.png b/doc/sieveeditor/first-start.png new file mode 100644 index 0000000..d20adad Binary files /dev/null and b/doc/sieveeditor/first-start.png differ diff --git a/doc/sieveeditor/index.docbook b/doc/sieveeditor/index.docbook index 691ea9e..3b5fe96 100644 --- a/doc/sieveeditor/index.docbook +++ b/doc/sieveeditor/index.docbook @@ -3,9 +3,8 @@ "dtd/kdedbx45.dtd" [ <!-- Define an entity for your application if it is not part of KDE CVS --> - <!ENTITY kapplication "<application>sieveeditor</application>"> - <!ENTITY kappname "&kapplication;"> - <!ENTITY package "kdepim"> + <!ENTITY i18n-kapplication "<application>Sieve Editor</application>"> + <!ENTITY kappname "&i18n-kapplication;"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"> ]> @@ -14,7 +13,7 @@ <bookinfo id="sieveeditorinfo"> -<title>The &kapplication; Handbook</title> +<title>The &i18n-kapplication; Handbook</title> <authorgroup> <author> @@ -34,12 +33,12 @@ <legalnotice>&FDLNotice;</legalnotice> -<date>2013-12-19</date> -<releaseinfo>1.0 (KDE 4.13)</releaseinfo> +<date>2016-04-14</date> +<releaseinfo>Applications 16.04</releaseinfo> <abstract> <para> -&kapplication; is an sieve script editor. +&i18n-kapplication; is an editor for Sieve scripts used for email filtering on a mail server. </para> </abstract> @@ -47,17 +46,109 @@ <keyword>KDE</keyword> <keyword>Sieve</keyword> </keywordset> - </bookinfo> + +<!-- info + screenshots from http://www.aegiap.eu/kdeblog/2014/01/new-in-kdepim-4-13-sieveeditor/ --> + <chapter id="introduction"> <title>Introduction</title> +<para>&i18n-kapplication; is an editor for +<ulink url="https://en.wikipedia.org/wiki/Sieve_(mail_filtering_language)">Sieve</ulink> +scripts used for email filtering on a mail server.</para> + +<sect1 id="using-kapp"> +<title>Using &i18n-kapplication;</title> + +<para>&i18n-kapplication; provides a &GUI; to perform these tasks:</para> + +<itemizedlist> +<listitem><para>Manage your Sieve servers</para></listitem> +<listitem><para>Upload, import and deactivate scripts, refresh the list with scripts</para></listitem> +<listitem><para>Create and edit Sieve scripts</para></listitem> +<listitem><para>Import and share scripts</para></listitem> +<listitem><para>Check the script syntax, autogenerate and debug scripts</para></listitem> +</itemizedlist> + +<para>&i18n-kapplication; can be used independent from Akonadi or &kmail;, +you only need a mail server with support for Sieve scripts.</para> + +<para>In a &plasma-desktop; the passwords are stored in &kwallet5;</para> + +<sect2 id="first-start"> +<title>First Start</title> +<para>At the first start of &i18n-kapplication; the server configuration dialog is displayed.</para> +<screenshot> +<screeninfo>Server Configuration</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="first-start.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Server Configuration</phrase> + </textobject> + </mediaobject> +</screenshot> +<para>In this dialog you can add, modify and remove your mails servers.</para> +<para>Later you can use <menuchoice><guimenu>File</guimenu><guimenuitem>Add Server Server</guimenuitem></menuchoice> +or the configuration dialog for these tasks.</para> +<para>On the next start &i18n-kapplication; automatically fetches all available scripts from the servers.</para> +</sect2> + +<sect2 id="script-edit"> +<title>Script Editing</title> +<para>The editor supports autocompletion and syntax highlighting.</para> +<screenshot> +<screeninfo>Script Editing</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="script-edit.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Script Editing</phrase> + </textobject> + </mediaobject> +</screenshot> +<para>For detailed information about the editor please read the <ulink url="help:kartpart">KatePart documentation</ulink>.</para> + +</sect2> + +<sect2 id="script-tools"> +<title>Script Tools</title> + +<para>The actions in the <guimenu>Tools</guimenu> menu enable you to check the syntax of your scripts, autogenerate and debug scripts.</para> + +<screenshot> +<screeninfo>Autogenerate scripts</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="script-tools.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Autogenerate scripts</phrase> + </textobject> + </mediaobject> +</screenshot> +</sect2> + +<sect2 id="script-help"> +<title>Help Support</title> + +<para>You can use the integrated help support and click with the &RMB; on a keyword of the Sieve language. +Then the correspondig section of the documentation is downloaded from the Internet and displayed in the <guilabel>Help</guilabel> tab.</para> +<screenshot> +<screeninfo>Help Support</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="script-help.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Help Support</phrase> + </textobject> + </mediaobject> +</screenshot> +</sect2> -<para>&kapplication; is a sieve script editor.</para> -</chapter> - -<chapter id="using-kapp"> -<title>Using &kapplication;</title> -<para>using</para> +</sect1> </chapter> @@ -65,12 +156,12 @@ <title>Credits and License</title> -<para>&kapplication;</para> +<para>&i18n-kapplication;</para> <para> -Program copyright 2013 Laurent Montel mon...@kde.org +Program copyright 2013 &Laurent.Montel; &Laurent.Montel.mail; </para> <para> -Documentation Copyright © 2013 Laurent Montel mon...@kde.org +Documentation Copyright © &Laurent.Montel; &Laurent.Montel.mail; </para> <!-- TRANS:CREDIT_FOR_TRANSLATORS --> @@ -79,19 +170,6 @@ Documentation Copyright © 2013 Laurent Montel mon...@kde.org &underGPL; <!-- GPL License --> </chapter> -<appendix id="installation"> -<title>Installation</title> - - -<sect1 id="compilation"> -<title>Compilation and Installation</title> - -&install.compile.documentation; - -</sect1> - -</appendix> - &documentation.index; </book> diff --git a/doc/sieveeditor/script-edit.png b/doc/sieveeditor/script-edit.png new file mode 100644 index 0000000..c7adbfe Binary files /dev/null and b/doc/sieveeditor/script-edit.png differ diff --git a/doc/sieveeditor/script-help.png b/doc/sieveeditor/script-help.png new file mode 100644 index 0000000..23daf1e Binary files /dev/null and b/doc/sieveeditor/script-help.png differ diff --git a/doc/sieveeditor/script-tools.png b/doc/sieveeditor/script-tools.png new file mode 100644 index 0000000..bbce284 Binary files /dev/null and b/doc/sieveeditor/script-tools.png differ _______________________________________________ kde-doc-english mailing list kde-doc-english@kde.org https://mail.kde.org/mailman/listinfo/kde-doc-english