Warning, /pim/pim-sieve-editor/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
0003 "dtd/kdedbx45.dtd" [
0004   <!-- Define an entity for your application if it is not part of KDE
0005        CVS -->
0006   <!ENTITY i18n-kapplication "<application>Sieve Editor</application>">
0007   <!ENTITY kappname "&i18n-kapplication;">
0008   <!ENTITY % addindex "IGNORE">
0009   <!ENTITY % English "INCLUDE"> 
0010 ]>
0011 
0012 <book id="sieveeditor" lang="&language;">
0013 
0014 <bookinfo id="sieveeditorinfo">
0015 
0016 <title>The &i18n-kapplication; Handbook</title>
0017 
0018 <authorgroup>
0019 <author>
0020 <personname>
0021 <firstname>Laurent</firstname>
0022 <surname>Montel</surname>
0023 </personname>
0024 <email>montel@kde.org</email>
0025 </author>
0026 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0027 </authorgroup>
0028 
0029 <copyright>
0030 <year>2013</year>
0031 <holder>Laurent Montel</holder>
0032 </copyright>
0033 
0034 <legalnotice>&FDLNotice;</legalnotice>
0035 
0036 <date>2016-04-14</date>
0037 <releaseinfo>Applications 16.04</releaseinfo>
0038 
0039 <abstract>
0040 <para>
0041 &i18n-kapplication; is an editor for Sieve scripts used for email filtering on a mail server.
0042 </para>
0043 </abstract>
0044 
0045 <keywordset>
0046 <keyword>KDE</keyword>
0047 <keyword>Sieve</keyword>
0048 </keywordset>
0049 </bookinfo>
0050 
0051 <chapter id="introduction">
0052 <title>Introduction</title>
0053 <para>&i18n-kapplication; is an editor for
0054 <ulink url="https://en.wikipedia.org/wiki/Sieve_(mail_filtering_language)">Sieve</ulink>
0055 scripts used for email filtering on a mail server.</para>
0056 
0057 <sect1 id="using-kapp">
0058 <title>Using &i18n-kapplication;</title>
0059 
0060 <para>&i18n-kapplication; provides a &GUI; to perform these tasks:</para>
0061 
0062 <itemizedlist>
0063 <listitem><para>Manage your Sieve servers</para></listitem>
0064 <listitem><para>Upload, import and deactivate scripts, refresh the list with scripts</para></listitem>
0065 <listitem><para>Create and edit Sieve scripts</para></listitem>
0066 <listitem><para>Import and share scripts</para></listitem>
0067 <listitem><para>Check the script syntax, autogenerate and debug scripts</para></listitem>
0068 </itemizedlist>
0069 
0070 <para>&i18n-kapplication; can be used independent from Akonadi or &kmail;,
0071 you only need a mail server with support for Sieve scripts.</para>
0072 
0073 <para>In a &plasma-desktop; the passwords are stored in &kwallet5;</para>
0074 
0075 <sect2 id="first-start">
0076 <title>First Start</title>
0077 <para>At the first start of &i18n-kapplication; the server configuration dialog is displayed.</para>
0078 <screenshot>
0079 <screeninfo>Server Configuration</screeninfo>
0080         <mediaobject>
0081           <imageobject>
0082             <imagedata fileref="first-start.png" format="PNG"/>
0083           </imageobject>
0084           <textobject>
0085             <phrase>Server Configuration</phrase>
0086           </textobject>
0087         </mediaobject>
0088 </screenshot>
0089 <para>In this dialog you can add, modify and remove your mails servers.</para>
0090 <para>Later you can use <menuchoice><guimenu>File</guimenu><guimenuitem>Add Server</guimenuitem></menuchoice>
0091 or the configuration dialog for these tasks.</para>
0092 <para>On the next start &i18n-kapplication; automatically fetches all available scripts from the servers.</para>
0093 </sect2>
0094 
0095 <sect2 id="script-edit">
0096 <title>Script Editing</title>
0097 <para>The editor supports autocompletion and syntax highlighting.</para>
0098 <screenshot>
0099 <screeninfo>Script Editing</screeninfo>
0100         <mediaobject>
0101           <imageobject>
0102             <imagedata fileref="script-edit.png" format="PNG"/>
0103           </imageobject>
0104           <textobject>
0105             <phrase>Script Editing</phrase>
0106           </textobject>
0107         </mediaobject>
0108 </screenshot>
0109 
0110 </sect2>
0111 
0112 <sect2 id="script-tools">
0113 <title>Script Tools</title>
0114 
0115 <para>The actions in the <guimenu>Tools</guimenu> menu enable you to check the syntax of your scripts, autogenerate and debug scripts.</para>
0116 
0117 <screenshot>
0118 <screeninfo>Autogenerate scripts</screeninfo>
0119         <mediaobject>
0120           <imageobject>
0121             <imagedata fileref="script-tools.png" format="PNG"/>
0122           </imageobject>
0123           <textobject>
0124             <phrase>Autogenerate scripts</phrase>
0125           </textobject>
0126         </mediaobject>
0127 </screenshot>
0128 </sect2>
0129 
0130 <sect2 id="script-help">
0131 <title>Integrated Help</title>
0132 
0133 <para>You can use the integrated help support and click with the &RMB; on a keyword of the Sieve language.
0134 Then the corresponding section of the documentation is downloaded from the Internet and displayed in the <guilabel>Help</guilabel> tab.</para>
0135 <screenshot>
0136 <screeninfo>Integrated Help</screeninfo>
0137         <mediaobject>
0138           <imageobject>
0139             <imagedata fileref="script-help.png" format="PNG"/>
0140           </imageobject>
0141           <textobject>
0142             <phrase>Integrated Help</phrase>
0143           </textobject>
0144         </mediaobject>
0145 </screenshot>
0146 </sect2>
0147 
0148 </sect1>
0149 
0150 </chapter>
0151 
0152 <chapter id="credits">
0153 
0154 <title>Credits and License</title>
0155 
0156 <para>&i18n-kapplication;</para>
0157 <para>
0158 Program copyright 2013-2017 &Laurent.Montel; &Laurent.Montel.mail;
0159 </para>
0160 <para>
0161 Documentation Copyright &copy; &Laurent.Montel; &Laurent.Montel.mail;
0162 </para>
0163 
0164 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0165 
0166 &underFDL;               <!-- FDL: do not remove -->
0167 &underGPL;               <!-- GPL License -->
0168 </chapter>
0169 
0170 &documentation.index;
0171 </book>
0172 
0173 <!--
0174 Local Variables:
0175 mode: xml
0176 sgml-minimize-attributes:nil
0177 sgml-general-insert-case:lower
0178 sgml-indent-step:0
0179 sgml-indent-data:nil
0180 End:
0181 
0182 vim:tabstop=2:shiftwidth=2:expandtab
0183 kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
0184 -->