help/C/empathy.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY legal SYSTEM "legal.xml">
   5 <!ENTITY appversion "2.24">
   6 <!ENTITY manrevision "2.0">
   7 <!ENTITY date "April 2008">
   8 <!ENTITY app "<application>Empathy</application>">
   9 <!ENTITY appname "Empathy">
  10 ]>
  11 <?db.chunk.max_depth 2?>
  12 <article id="index" lang="en">
  13   <!-- please do not change the id; for translations, change lang to -->
  14   <!-- appropriate code -->
  15   <articleinfo>
  16     <title>&app; Manual V&manrevision;</title>
  17
  18     <copyright>
  19       <year>2008</year>
  20       <holder>Ubuntu Documentation Project</holder>
  21     </copyright>
  22     <!-- An address can be added to the publisher information.  If a role is
  23     not specified, the publisher/author is the same for all versions of the
  24     document.  -->
  25     <publisher>
  26       <publishername>Ubuntu Documentation Project</publishername>
  27     </publisher>
  28
  29     <!-- licence stuff -->
  30     &legal;
  31
  32     <authorgroup>
  33       <author role="maintainer">
  34         <firstname>Milo</firstname>
  35         <surname>Casagrande</surname>
  36         <affiliation>
  37           <orgname>Ubuntu Documentation Project</orgname>
  38           <address><email>milo_casagrande@yahoo.it</email></address>
  39         </affiliation>
  40       </author>
  41       <author>
  42         <firstname>Seth</firstname>
  43         <surname>Dudenhofer</surname>
  44         <affiliation>
  45           <orgname>Ubuntu Documentation Project</orgname>
  46           <address><email>sdudenhofer@gmail.com</email></address>
  47         </affiliation>
  48       </author>
  49     </authorgroup>
  50
  51 <!-- According to GNU FDL, revision history is mandatory if you are -->
  52 <!-- modifying/reusing someone else's document.  If not, you can omit it. -->
  53 <!-- Remember to remove the &manrevision; entity from the revision -->
  54 <!-- entries other than the current revision. -->
  55 <!-- The revision numbering system for GNOME manuals is as follows: -->
  56 <!-- * the revision number consists of two components -->
  57 <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
  58 <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
  59 <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
  60 <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
  61 <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
  62 <!-- to V3.0, and so on. -->
  63     <revhistory>
  64       <revision>
  65         <revnumber>Empathy Manual V&manrevision;</revnumber>
  66         <date>&date;</date>
  67         <revdescription>
  68           <para role="author">Milo Casagrande
  69             <email>milo_casagrande@yahoo.it</email>
  70           </para>
  71           <para role="author">Seth Dudenhofer
  72             <email>sdudenhofer@gmail.com</email>
  73           </para>
  74           <para role="publisher">Ubuntu Documentation Project</para>
  75         </revdescription>
  76       </revision>
  77     </revhistory>
  78
  79     <releaseinfo>
  80       This manual describes version &appversion; of &appname;.
  81     </releaseinfo>
  82     <legalnotice>
  83       <title>Feedback</title>
  84       <para>
  85         To report a bug or make a suggestion regarding the &app; application or
  86         this manual, follow the directions in the <ulink url="ghelp:gnome-feedback"
  87           type="help">GNOME Feedback Page</ulink>.
  88       </para>
  89     </legalnotice>
  90
  91     <abstract role="description">
  92       <para>
  93         &appname; is an application for instant messaging.
  94       </para>
  95     </abstract>
  96
  97   </articleinfo>
  98
  99   <indexterm zone="index">
 100     <primary>Empathy</primary>
 101   </indexterm>
 102   <indexterm zone="index">
 103     <primary>empathy</primary>
 104     <secondary>istant messaging</secondary>
 105   </indexterm>
 106
 107   <sect1 id="empathy-intro">
 108     <title>Introduction</title>
 109     <para>
 110       &app; is a multi-protocol instant messaging program for the
 111       GNOME Desktop that allows you to keep in touch with your friends
 112       over a network.
 113     </para>
 114     <para>
 115       It supports the following protocols:
 116       <itemizedlist>
 117         <listitem>
 118           <para>
 119             <acronym>AIM</acronym>
 120           </para>
 121         </listitem>
 122         <listitem>
 123           <para>
 124             Google Talk
 125           </para>
 126         </listitem>
 127         <listitem>
 128           <para>
 129             ICQ
 130           </para>
 131         </listitem>
 132         <listitem>
 133           <para>
 134             <acronym>IRC</acronym>
 135           </para>
 136         </listitem>
 137         <listitem>
 138           <para>
 139             Jabber
 140           </para>
 141         </listitem>
 142         <listitem>
 143           <para>
 144             <acronym>MSN</acronym>
 145           </para>
 146         </listitem>
 147         <listitem>
 148           <para>
 149             Salut
 150           </para>
 151         </listitem>
 152         <listitem>
 153           <para>
 154             Yahoo
 155           </para>
 156         </listitem>
 157       </itemizedlist>
 158     </para>
 159   </sect1>
 160
 161   <sect1 id="empathy-getting-started">
 162     <title>Getting Started</title>
 163
 164     <sect2 id="empathy-starting">
 165       <title>Starting &appname;</title>
 166       <para>You can start &app; in the following ways:
 167       </para>
 168       <variablelist>
 169         <varlistentry>
 170           <term><guimenu>Applications</guimenu> menu</term>
 171           <listitem>
 172             <para>Choose
 173               <menuchoice>
 174                 <guisubmenu>Internet</guisubmenu>
 175                 <guimenuitem>Empathy Instant Messenger</guimenuitem>
 176               </menuchoice>.
 177             </para>
 178           </listitem>
 179         </varlistentry>
 180         <varlistentry>
 181           <term>Command line</term>
 182           <listitem>
 183             <para>Type <command>empathy</command> and then press
 184               <keycap>Enter</keycap>.
 185             </para>
 186           </listitem>
 187         </varlistentry>
 188       </variablelist>
 189     </sect2>
 190
 191     <sect2 id="emphaty-when-start">
 192       <title>When You Start &appname;</title>
 193       <para>
 194         When you start &app; the following window is shown.
 195         <!-- Figure 1 -->
 196         <figure id="empathy-mainwindow">
 197           <title>&app; Main Window</title>
 198           <screenshot>
 199             <mediaobject>
 200               <imageobject>
 201                 <imagedata fileref="figures/empathy-main-window.png" format="PNG"/>
 202               </imageobject>
 203               <textobject>
 204                 <phrase>
 205                   Shows &app; main window. Contains the titlebar, the
 206                   menubar, contact list, status icon and status arrow
 207                   button list.
 208                 </phrase>
 209               </textobject>
 210             </mediaobject>
 211           </screenshot>
 212         </figure>
 213         <!-- End of Figure -->
 214       </para>
 215       <para>
 216         <xref linkend="empathy-TBL-1"/> describes the components of
 217         &app;'s main window.
 218         <table frame="topbot" id="empathy-TBL-1">
 219           <title>&app; Main Components</title>
 220           <tgroup cols="2" colsep="0" rowsep="0">
 221             <colspec colname="colspec0" colwidth="29.39*"/>
 222             <colspec colname="colspec1" colwidth="70.61*"/>
 223             <thead>
 224               <row rowsep="1">
 225                 <entry valign="top">
 226                   <para>Component</para>
 227                 </entry>
 228                 <entry valign="top">
 229                   <para>Description</para>
 230                 </entry>
 231               </row>
 232             </thead>
 233             <tbody>
 234               <row>
 235                 <entry valign="top">
 236                   <para>Menubar</para>
 237                 </entry>
 238                 <entry valign="top">
 239                   <para>
 240                     Contains menus used to perform actions in &app;.
 241                   </para>
 242                 </entry>
 243               </row>
 244               <row>
 245                 <entry valign="top">
 246                   <para>Status Drop-Down List</para>
 247                 </entry>
 248                 <entry valign="top">
 249                   <para>
 250                     Allows to update the user's status.
 251                   </para>
 252                 </entry>
 253               </row>
 254               <row>
 255                 <entry valign="top">
 256                   <para>Account Button</para>
 257                 </entry>
 258                 <entry valign="top">
 259                   <para>
 260                     Opens the <guilabel>Accounts</guilabel> dialog.
 261                   </para>
 262                 </entry>
 263               </row>
 264               <row>
 265                 <entry valign="top">
 266                   <para>Contact List</para>
 267                 </entry>
 268                 <entry valign="top">
 269                   <para>
 270                     Shows all the available contacts and their
 271                     associated status.
 272                   </para>
 273                 </entry>
 274               </row>
 275             </tbody>
 276           </tgroup>
 277         </table>
 278       </para>
 279     </sect2>
 280
 281     <sect2 id="empathy-when-start-new">
 282       <title>When You Start &appname; for the First Time</title>
 283       <para>
 284         When you start &app; for the first time and you don't have
 285         configured any account yet, the following dialog is shown.
 286         <!-- Figure 2 -->
 287         <figure id="empathy-newaccount">
 288           <title>&app; Account Window</title>
 289           <screenshot>
 290             <mediaobject>
 291               <imageobject>
 292                 <imagedata fileref="figures/empathy-new-account.png" format="PNG"/>
 293               </imageobject>
 294               <textobject>
 295                 <phrase>
 296                   Shows &app; account creation dialog.
 297                 </phrase>
 298               </textobject>
 299             </mediaobject>
 300           </screenshot>
 301         </figure>
 302         <!-- End of Figure -->
 303       </para>
 304       <para>
 305         From here, you can configure and create your accounts. See
 306         <xref linkend="empathy-create-account" /> for more information.
 307       </para>
 308     </sect2>
 309
 310   </sect1>
 311
 312   <sect1 id="empathy-create-account">
 313     <title>Creating an Account</title>
 314     <para>
 315     </para>
 316   </sect1>
 317
 318
 319 </article>