runtime/doc/kcontrol/emoticons/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
   3 "dtd/kdex.dtd" [
   4   <!ENTITY % addindex "IGNORE">
   5   <!ENTITY % English "INCLUDE">
   6 ]>
   7 <article>
   8 <articleinfo>
   9 <authorgroup>
  10 <author>&Anne-Marie.Mahfouf;</author>
  11 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  12 </authorgroup>
  13
  14 <date>2008-09-12</date>
  15 <releaseinfo>&kde; 4.1.2</releaseinfo>
  16
  17 <keywordset>
  18 <keyword>KDE</keyword>
  19 <keyword>System Settings</keyword>
  20 <keyword>emoticons</keyword>
  21 <keyword>KCMEmoticons</keyword>
  22 </keywordset>
  23 </articleinfo>
  24
  25 <sect1 id="kcm_emoticons">
  26 <title><guilabel>Emoticons Themes Manager</guilabel></title>
  27 <sect2 id="icons-intro">
  28 <title>Introduction</title>
  29
  30 <para>
  31 <screenshot>
  32 <screeninfo>Screenshot of the Emoticons Theme Manager</screeninfo>
  33   <mediaobject>
  34     <imageobject>
  35       <imagedata fileref="emoticons.png" format="PNG"/>
  36     </imageobject>
  37      <textobject>
  38       <phrase>The Emoticons Theme Manager</phrase>
  39     </textobject>
  40   </mediaobject>
  41 </screenshot>
  42 </para>
  43
  44 <para>Emoticons can be used in several &kde; applications: &kopete;, &konversation;, &kmail;... This module offers you to easily manage your emoticons sets. You can:</para>
  45
  46 <itemizedlist>
  47 <listitem><para>add emoticons themes</para></listitem>
  48 <listitem><para>remove emoticons themes</para></listitem>
  49 <listitem><para>install an existing theme</para></listitem>
  50 <listitem><para>add, remove or edit emoticons within a theme</para></listitem>
  51 </itemizedlist>
  52
  53 <important><para>Please note that you will set emoticons themes per application.</para></important>
  54
  55 <para>
  56 The module is separated in two parts: on the left you can manage your themes and on the right you can manage emoticons within themes.
  57 </para>
  58
  59 <para>
  60 An emoticon consists in two parts: an icon (typically a <filename>.png</filename>, <filename>.mng</filename> or <filename>.gif</filename> picture) and a text describing the emoticon. The text can be some ASCII symbols like <userinput>]:-></userinput> or the emoticon short description enclosed within <userinput>*</userinput> like <userinput>*FRIEND*</userinput>. The user types the symbol or the text and the emoticon icon replaces it.
  61 </para>
  62
  63 <para>
  64 The emoticons themes will be saved locally in your home in <filename class="directory">$KDEHOME/share/emoticons</filename>.
  65 </para>
  66
  67 </sect2>
  68
  69 <sect2 id="themes">
  70 <title>Emoticons Themes</title>
  71
  72 <para>
  73 This section allows you to manage emoticons themes.
  74 </para>
  75
  76 <variablelist>
  77 <varlistentry><term><guilabel>Require spaces around emoticons</guilabel></term>
  78 <listitem>
  79 <para>
  80 When this option is checked, you need to separate the emoticon with a white space before and after it so it is changed to an icon. If you type "Hello:-)" then this string will stay as it is while if you type "Hello :-)" you will get "Hello" followed by the :-) emoticon.
  81 </para>
  82 <para>
  83 When this option is not checked (default), each emoticon string will be replaced by its icon.
  84 </para>
  85 </listitem>
  86 </varlistentry>
  87
  88 <varlistentry><term><guilabel>New Theme...</guilabel></term>
  89 <listitem>
  90 <para>
  91 You can create your own new theme from scratch. Clicking on this button brings a dialog asking for the name of the new theme. You can then use the <guibutton>Add...</guibutton> button on the right to create new emoticons and their associated text.
  92 </para>
  93 </listitem>
  94 </varlistentry>
  95 <varlistentry><term><guilabel>Get New Themes...</guilabel></term>
  96 <listitem>
  97 <para>
  98 You need to be connected to the Internet to use this action. A dialog displays a list of emoticons themes from <ulink url="http://www.kde-look.org">http://www.kde-look.org</ulink> and you can install one by clicking the <guibutton>Install</guibutton> button on the right side of the theme description in the list.
  99 </para>
 100 </listitem>
 101 </varlistentry>
 102 <varlistentry><term><guilabel>Install Theme File...</guilabel></term>
 103 <listitem>
 104 <para>
 105 This action allows you to install a theme you downloaded yourself. A theme file is an archive file, usually a <filename>.tar.gz</filename> or a <filename>.zip</filename> file or any other archive files. A dialog asks you for the location of this local archive file and after you entered or dragged the URL and clicked <guibutton>OK</guibutton>, the theme is installed and will appear in the themes list.
 106 </para>
 107 </listitem>
 108 </varlistentry>
 109 <varlistentry><term><guilabel>Remove Theme</guilabel></term>
 110 <listitem>
 111 <para>
 112 This action will remove the theme from your disk. Select the theme you want to remove in the list. Click the <guibutton>Remove Theme</guibutton> button. A dialog appears to ask you confirmation.
 113 </para>
 114 </listitem>
 115 </varlistentry>
 116 </variablelist>
 117
 118 </sect2>
 119
 120 <sect2 id="emoticons">
 121 <title>Emoticons Management</title>
 122
 123 <para>
 124 This section allows you to manage emoticons within the selected theme. The list on the right displays all emoticons of the selected theme. You can add, edit or remove any emoticon. Select a theme in the list on the left and then select the action you want to perform.
 125 </para>
 126
 127 <variablelist>
 128 <varlistentry><term><guilabel>Add...</guilabel></term>
 129 <listitem>
 130 <para>
 131 This button allows you to add an emoticon to the selected theme. The dialog asks you to choose an icon for your emoticon and to enter the corresponding ASCII symbol or text attached to it. After that, clicking <guibutton>OK</guibutton> will add your new emoticon in the emoticon list, you will see the icon and the corresponding text displayed. If you want to modify either the icon or the text, you can use the <guibutton>Edit...</guibutton> button described below.
 132 </para>
 133 </listitem>
 134 </varlistentry>
 135
 136 <varlistentry><term><guilabel>Edit...</guilabel></term>
 137 <listitem>
 138 <para>
 139 The <guibutton>Edit...</guibutton> button allows you to change either the icon or the text of the selected emoticon. You need to click the <guibutton>OK</guibutton> button to validate this action.
 140 </para>
 141 </listitem>
 142 </varlistentry>
 143 <varlistentry><term><guilabel>Remove</guilabel></term>
 144 <listitem>
 145 <para>
 146 This will remove the selected emoticon from the selected theme. You need to click the <guibutton>Yes</guibutton> button to validate this action.
 147 </para>
 148 </listitem>
 149 </varlistentry>
 150 </variablelist>
 151 </sect2>
 152
 153 </sect1>
 154 </article>
 155
 156 <!--
 157 Local Variables:
 158 mode: xml
 159 sgml-minimize-attributes:nil
 160 sgml-general-insert-case:lower
 161 sgml-indent-step:0
 162 sgml-indent-data:nil
 163 End:
 164
 165 vim:tabstop=2:shiftwidth=2:expandtab
 166 kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
 167 -->