empathy r2647 - in trunk/help/C: . figures

[miloc svn gnome org]

Author: miloc
Date: Mon Mar  9 12:22:40 2009
New Revision: 2647
URL: http://svn.gnome.org/viewvc/empathy?rev=2647&view=rev

Log:

Added a new section on the documentation (Advanced Options)
Removed one image as it was not used anymore


Removed:
   trunk/help/C/figures/empathy-new-account.png
Modified:
   trunk/help/C/empathy.xml

Modified: trunk/help/C/empathy.xml
==============================================================================
--- trunk/help/C/empathy.xml	(original)
+++ trunk/help/C/empathy.xml	Mon Mar  9 12:22:40 2009
@@ -626,7 +626,7 @@
 	  <listitem>
 	    <para>
 	      Select the account you wish to edit in the box on the
-	      left and double-click on it's name.
+	      left and double-click on its name.
 	    </para>
 	  </listitem>
 	  <listitem>
@@ -746,7 +746,7 @@
 	  <para>
 	    An <emphasis>alias</emphasis> is an alternative way you
 	    can identify yourself. You can use your real
-	    name or your nickname.
+	    name or a nickname.
 	  </para>
 	</note>
       </para>
@@ -755,8 +755,408 @@
     <sect2 id="empathy-advanced-options">
       <title>Advanced Options</title> 
       <para>
-	TODO
+	Based on the service you are using, it is possible to
+	configure more advanced options to modify the normal behavior of
+	&app;.
       </para>
+      <para>
+	To configure these options, when you are <link
+	linkend="empathy-create-account">adding a new
+	account</link>, click on the drop-down section
+	<guilabel>Advanced</guilabel>.
+      </para>
+
+      <sect3 id="empathy-xmpp-advanced">
+	<title>
+	  Jabber (or <acronym>XMPP</acronym>) and Google Talk
+	</title>
+	<para>
+	  <variablelist>
+	    <varlistentry>
+	      <term>
+		<guilabel>Encryption required (TLS/SSL)</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Select this option in order to use some sort of
+		  encryption during your conversations.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Ignore SSL certificate errors</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Select this option in order to ignore the errors
+		  that can be generated by some types of security
+		  certificates. Usually these certificates are called
+		  auto-signed.
+		</para>
+		<para>
+		  <note>
+		    <para>
+		      Select this option only if you are sure the
+		      certificate is secure and you can trust it.
+		    </para>
+		  </note>
+ 		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Resource</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this text box to set a name with which you can
+		  identify the running program based on where you are
+		  running it. With this option, and the
+		  <guilabel>Priority</guilabel> one, you can
+		  use your account simultaneously in two different
+		  devices. For example, if you set one device to
+		  <replaceable>desktop</replaceable> and of the other
+		  one to <replaceable>mobile</replaceable>, you can
+		  connect with both of them and based on the
+		  <guilabel>Priority</guilabel> value you will receive
+		  messages on one of the two devices or both.
+		</para>
+		<para>
+		  This can be useful if you have two devices, a main
+		  one and a portable one, and you move away from the
+		  main one bringing with you the other: you can still
+		  receive messages from your account with the portable
+		  device even if you do not disconnet from the main one.
+		</para>
+		<para>
+		  <note>
+		    <para>
+		      If you set the same value for this text box on
+		      both the devices, when you connect with one of
+		      them, the other one will be disconnected, even
+		      if you set a different value with the
+		      <guilabel>Priority</guilabel> spin box.
+		    </para>
+		  </note>
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Priority</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this spin box to indicate wich device, set in
+		  the <guilabel>Resource</guilabel> text box, will
+		  receive the new messages. The higher the number, the
+		  higher the priority: you will receive the new
+		  messages on the device with the highest number.
+		</para>
+		<para>
+		  You can set values in the range from
+		  <literal>-128</literal> to <literal>127</literal>.
+		</para>
+		<para>
+		  <note>
+		    <para>
+		      If you set the same value of this spin box in
+		      both the devices, you will receive messages on
+		      both of them.
+		    </para>
+		  </note>
+		</para>
+	      </listitem>
+	    </varlistentry>
+	  </variablelist>
+	</para>
+	<para>
+	  In the <guilabel>Override server settings</guilabel> section
+	  you can set options that take precedence over the default settings.
+	  <variablelist>
+	    <varlistentry>
+	      <term>
+		<guilabel>Server</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this text box to write the name of the
+		  server you want to use for this service.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Port</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this spin box to set the number of the port of
+		  the server to use.
+		</para>
+		<para>
+		  You can set values in the range from
+		  <literal>0</literal> to <literal>65,555</literal>.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Use old SSL</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Select this option to use the old version of the
+		  secure protocol for encrypting your connection.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	  </variablelist>
+	</para>
+      </sect3>
+
+      <sect3 id="empathy-yahoo-advanced">
+	<title>Yahoo</title>
+	<para>
+	  <variablelist>
+	    <varlistentry>
+	      <term>
+		<guilabel>Ignore conference and chatrooms
+		invitations</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Select this option to ignore the invitations that
+		  other people may send you.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Room List locale</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  The value of this text box identifies the language
+		  used to retrieve the room list when connecting to
+		  the Yahoo service.
+		</para>
+		<para>
+		  If you need to change this value, use the two letter
+		  code of your language.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Charset</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  The value of this text box identifies the set of the
+		  characters used by &app;.
+		</para>
+		<para>
+		  <note>
+		    <para>
+		      It is advise to leave this value to
+		      <literal>UTF-8</literal>. Change it only
+		      if that charset does not cover your language.
+		    </para>
+		  </note>
+		</para>
+	      </listitem>
+	    </varlistentry>		  
+	    <varlistentry>
+	      <term>
+		<guilabel>Server</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this text box to write the name of the
+		  server you want to use for this service.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Port</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this spin box to set the number of the port of
+		  the server to use.
+		</para>
+		<para>
+		  You can set values in the range from
+		  <literal>0</literal> to <literal>65,555</literal>.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Use Yahoo Japan</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Select this option only if you have a Yahoo! Japan
+		  account. With the Yahoo! Japan service you can only
+		  use a Yahoo! Japan account: if you have registered
+		  an account with the English version of the service,
+		  that account will not work. 
+		</para>
+	      </listitem>
+	    </varlistentry>
+	  </variablelist>
+	</para>
+      </sect3>
+
+      <sect3 id="empathy-msn-advanced">
+	<title><acronym>AIM</acronym>, GroupWise and <acronym>MSN</acronym></title>
+	<para>
+	  <variablelist>
+	    <varlistentry>
+	      <term>
+		<guilabel>Server</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this text box to write the name of the
+		  server you want to use for this service.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Port</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this spin box to set the number of the port of
+		  the server to use.
+		</para>
+		<para>
+		  You can set values in the range from
+		  <literal>0</literal> to <literal>65,555</literal>.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	  </variablelist>	    
+	</para>
+      </sect3>
+
+      <sect3 id="empathy-salut-advanced">
+	<title>Salut</title>
+	<para>
+	  <variablelist>
+	    <varlistentry>
+	      <term>
+		<guilabel>Published Name</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this text box to write the name that will be
+		  visible to the other users of the network. 
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Email</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this text box to write your email.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Jabber ID</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this text box to write your Jabber ID, if you
+		  have one.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	  </variablelist>
+	</para>
+      </sect3>
+
+      <sect3 id="empathy-icq-advanced">
+	<title>ICQ</title>
+	<para>
+	  <variablelist>
+	    <varlistentry>
+	      <term>
+		<guilabel>Charset</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  The value of this text box identifies the set of the
+		  characters used by &app;.
+		</para>
+		<para>
+		  <note>
+		    <para>
+		      It is advise to leave this value to
+		      <literal>UTF-8</literal>. Change it only
+		      if that charset does not cover your language.
+		    </para>
+		  </note>
+		</para>
+	      </listitem>
+	    </varlistentry>		  
+	    <varlistentry>
+	      <term>
+		<guilabel>Server</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this text box to write the name of the
+		  server you want to use for this service.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term>
+		<guilabel>Port</guilabel>
+	      </term>
+	      <listitem>
+		<para>
+		  Use this spin box to set the number of the port of
+		  the server to use.
+		</para>
+		<para>
+		  You can set values in the range from
+		  <literal>0</literal> to <literal>65,555</literal>.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	  </variablelist>
+	</para>
+      </sect3>
+
+      <sect3 id="empathy-gadugadu-advanced">
+	<title>Gadu Gadu</title>
+	<para>
+	  <variablelist>
+	    <varlistentry>
+	      <term><guilabel>Nick</guilabel></term>
+	      <listitem>
+		<para>
+		  Use this text box to write an alternative name to
+		  use with this service.
+		</para>
+	      </listitem>
+	    </varlistentry>
+	  </variablelist>
+	</para>
+      </sect3>
+
     </sect2>
     
   </sect1>