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
  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       <author>
  50         <firstname>Jesse N.</firstname>
  51         <surname>Richardson</surname>
  52         <affiliation>
  53           <orgname>Ubuntu Documentation Project</orgname>
  54           <address><email>richardson183@bellsouth.net</email></address>
  55         </affiliation>
  56       </author>
  57     </authorgroup>
  58
  59 <!-- According to GNU FDL, revision history is mandatory if you are -->
  60 <!-- modifying/reusing someone else's document.  If not, you can omit it. -->
  61 <!-- Remember to remove the &manrevision; entity from the revision -->
  62 <!-- entries other than the current revision. -->
  63 <!-- The revision numbering system for GNOME manuals is as follows: -->
  64 <!-- * the revision number consists of two components -->
  65 <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
  66 <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
  67 <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
  68 <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
  69 <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
  70 <!-- to V3.0, and so on. -->
  71     <revhistory>
  72       <revision>
  73         <revnumber>Empathy Manual V&manrevision;</revnumber>
  74         <date>&date;</date>
  75         <revdescription>
  76           <para role="author">Milo Casagrande
  77             <email>milo_casagrande@yahoo.it</email>
  78           </para>
  79           <para role="author">Seth Dudenhofer
  80             <email>sdudenhofer@gmail.com</email>
  81           </para>
  82           <para role="author">Jesse N. Richardson
  83             <email>richardson183@bellsouth.net</email>
  84           </para>
  85           <para role="publisher">Ubuntu Documentation Project</para>
  86         </revdescription>
  87       </revision>
  88     </revhistory>
  89
  90     <releaseinfo>
  91       This manual describes version &appversion; of &appname;.
  92     </releaseinfo>
  93     <legalnotice>
  94       <title>Feedback</title>
  95       <para>
  96         To report a bug or make a suggestion regarding the &app; application or
  97         this manual, follow the directions in the <ulink url="ghelp:gnome-feedback"
  98           type="help">GNOME Feedback Page</ulink>.
  99       </para>
 100     </legalnotice>
 101
 102     <abstract role="description">
 103       <para>
 104         &appname; is an application for instant messaging.
 105       </para>
 106     </abstract>
 107
 108   </articleinfo>
 109
 110   <indexterm zone="index">
 111     <primary>Empathy</primary>
 112   </indexterm>
 113   <indexterm zone="index">
 114     <primary>empathy</primary>
 115     <secondary>istant messaging</secondary>
 116   </indexterm>
 117
 118   <sect1 id="empathy-intro">
 119     <title>Introduction</title>
 120     <para>
 121       &app; is a multi-protocol instant messaging program for the
 122       GNOME Desktop that allows you to keep in touch with your friends
 123       over a network.
 124     </para>
 125     <para>
 126       It supports the following protocols:
 127       <itemizedlist>
 128         <listitem>
 129           <para>
 130             <acronym>AIM</acronym>
 131           </para>
 132         </listitem>
 133         <listitem>
 134           <para>
 135             Google Talk
 136           </para>
 137         </listitem>
 138         <listitem>
 139           <para>
 140             ICQ
 141           </para>
 142         </listitem>
 143         <listitem>
 144           <para>
 145             <acronym>IRC</acronym>
 146           </para>
 147         </listitem>
 148         <listitem>
 149           <para>
 150             Jabber
 151           </para>
 152         </listitem>
 153         <listitem>
 154           <para>
 155             <acronym>MSN</acronym>
 156           </para>
 157         </listitem>
 158         <listitem>
 159           <para>
 160             Salut
 161           </para>
 162         </listitem>
 163         <listitem>
 164           <para>
 165             Yahoo
 166           </para>
 167         </listitem>
 168       </itemizedlist>
 169     </para>
 170   </sect1>
 171
 172   <sect1 id="empathy-getting-started">
 173     <title>Getting Started</title>
 174
 175     <sect2 id="empathy-starting">
 176       <title>To Start &appname;</title>
 177       <para>You can start &app; in the following ways:
 178       </para>
 179       <variablelist>
 180         <varlistentry>
 181           <term><guimenu>Applications</guimenu> menu</term>
 182           <listitem>
 183             <para>Choose
 184               <menuchoice>
 185                 <guisubmenu>Internet</guisubmenu>
 186                 <guimenuitem>Empathy Instant Messenger</guimenuitem>
 187               </menuchoice>.
 188             </para>
 189           </listitem>
 190         </varlistentry>
 191         <varlistentry>
 192           <term>Command line</term>
 193           <listitem>
 194             <para>Type <command>empathy</command> and then press
 195               <keycap>Return</keycap>.
 196             </para>
 197           </listitem>
 198         </varlistentry>
 199       </variablelist>
 200     </sect2>
 201
 202     <sect2 id="emphaty-when-start">
 203       <title>When you start &appname;</title>
 204       <para>
 205         When you start &app; the following window is displayed.
 206         <!-- Figure -->
 207         <!--
 208         Commented out, need to find a solution on how to
 209         structure this section.
 210         <figure id="empathy-mainwindow">
 211           <title>&app; Main Window</title>
 212           <screenshot>
 213             <mediaobject>
 214               <imageobject>
 215                 <imagedata fileref="figures/empathy-main-window.png" format="PNG"/>
 216               </imageobject>
 217               <textobject>
 218                 <phrase>
 219                   Shows &app; main window. Contains the titlebar, the
 220                   menubar, contact list, status icon and status arrow
 221                   button list.
 222                 </phrase>
 223               </textobject>
 224             </mediaobject>
 225           </screenshot>
 226         </figure>
 227         -->
 228         <!-- End of Figure -->
 229       </para>
 230       <para>
 231         <xref linkend="empathy-TBL-1"/> describes the components of a browser window.
 232         <table frame="topbot" id="empathy-TBL-1">
 233           <title>&app; Main Components</title>
 234           <tgroup cols="2" colsep="0" rowsep="0">
 235             <colspec colname="colspec0" colwidth="29.39*"/>
 236             <colspec colname="colspec1" colwidth="70.61*"/>
 237             <thead>
 238               <row rowsep="1">
 239                 <entry valign="top">
 240                   <para>Component</para>
 241                 </entry>
 242                 <entry valign="top">
 243                   <para>Description</para>
 244                 </entry>
 245               </row>
 246             </thead>
 247             <tbody>
 248               <row>
 249                 <entry valign="top">
 250                   <para>Menubar</para>
 251                 </entry>
 252                 <entry valign="top">
 253                   <para>
 254                     Contains menus used to perform actions in &app;.
 255                   </para>
 256                 </entry>
 257               </row>
 258               <row>
 259                 <entry valign="top">
 260                   <para>Status Drop-Down List</para>
 261                 </entry>
 262                 <entry valign="top">
 263                   <para>
 264                     Allows to update the user's status.
 265                   </para>
 266                 </entry>
 267               </row>
 268               <row>
 269                 <entry valign="top">
 270                   <para>Account Button</para>
 271                 </entry>
 272                 <entry valign="top">
 273                   <para>
 274                     Opens the <guilabel>Accounts</guilabel> dialog.
 275                   </para>
 276                 </entry>
 277               </row>
 278               <row>
 279                 <entry valign="top">
 280                   <para>Contact List</para>
 281                 </entry>
 282                 <entry valign="top">
 283                   <para>
 284                     Shows all the available contacts and their
 285                     associated status.
 286                   </para>
 287                 </entry>
 288               </row>
 289             </tbody>
 290           </tgroup>
 291         </table>
 292       </para>
 293     </sect2>
 294
 295   </sect1>
 296
 297 </article>