GNOME.org
 

[empathy] [help] Adding information about the Accounts window and IRC

commit d058ec42f339ff9ca62c729496030e6efa7edc19
Author: Shaun McCance <shaunm gnome org>
Date:   Fri Aug 28 12:24:42 2009 -0500

    [help] Adding information about the Accounts window and IRC

 help/C/account-irc.page       |  145 +++++++++++++++++++++++++++++++++++++++++
 help/C/account-jabber.page    |   62 +++++++++++++++++
 help/C/accounts-window.page   |   38 +++++++++++
 help/C/figures/gtk-add.png    |  Bin 0 -> 400 bytes
 help/C/figures/gtk-edit.png   |  Bin 0 -> 744 bytes
 help/C/figures/gtk-remove.png |  Bin 0 -> 215 bytes
 help/C/prob-conn-name.page    |    6 +-
 help/Makefile.am              |    3 +
 8 files changed, 252 insertions(+), 2 deletions(-)
---
diff --git a/help/C/account-irc.page b/help/C/account-irc.page
new file mode 100644
index 0000000..a77d3a0
--- /dev/null
+++ b/help/C/account-irc.page
@@ -0,0 +1,145 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="screen"
+      id="account-irc">
+
+  <info>
+    <revision pkgversion="2.28" version="0.1" date="2009-08-26" status="stub"/>
+    <credit type="author">
+      <name>Shaun McCance</name>
+      <email>shaunm gnome org</email>
+    </credit>
+    <copyright>
+      <year>2009</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>IRC Account Details</title>
+
+  <p>IRC accounts require different information than many other types of
+  accounts.  To create an IRC account, you must specify at least an IRC
+  network and a nickname.  This page details the information you can
+  provide for an IRC account.</p>
+
+  <note style="info package">
+    <p>You must have the <sys>telepathy-idle</sys> package installed
+    in order to use IRC in <app>Empathy</app>.</p>
+  </note>
+
+  <terms>
+    <item>
+      <title><gui>Network</gui></title>
+      <p>IRC is an open system that allows people to run separate IRC
+      networks.  Each network is distinct and has its own users and
+      chat rooms.  <app>Empathy</app> lists the most popular networks
+      in the <gui>Network</gui> drop-down list.  You can add additional
+      networks.  See <link xref="#networks"/> below.</p>
+    </item>
+    <item>
+      <title><gui>Nickname</gui></title>
+      <p>Your nickname is your unique name on the IRC network. Only one
+      person on a network may use a given nickname.  If you get an error
+      message that says <link xref="prob-conn-name" role="error-msg"/>
+      you will need to change your nickname.</p>
+    </item>
+    <item>
+      <title><gui>Password</gui></title>
+      <p>Some servers, particularly those on private networks, require
+      a password to connect.  If you are authorized to use the network,
+      the network administrators should provide you with a password.</p>
+      <note>
+        <title>NickServ Passwords</title>
+        <p>On some networks, nicknames can be registered using a service
+        known as NickServ.  <app>Empathy</app> does not directly support
+        nickname passwords.  On some networks, including the popular
+        FreeNode network, server passwords are automatically forwarded
+        to NickServ, allowing you to set this field to identify yourself
+        with NickServ.  See <link xref="irc-nick-password"/> for more
+        details.</p>
+      </note>
+    </item>
+    <item>
+      <title><gui>Real name</gui></title>
+      <p>You can provide your real name in addition to your nickname.  Other
+      users will be able to see this when they view your information.</p>
+    </item>
+    <item>
+      <title><gui>Quit message</gui></title>
+      <p>When you go offline, a quit message is sent to all the chat rooms
+      youâ??re in and to all the users youâ??re having a private conversation
+      with.  Use this field to provide a custom quit message.</p>
+    </item>
+  </terms>
+
+<!--
+telepathy-idle note
+-->
+
+  <section id="networks">
+    <info>
+      <title type="link">IRC Networks</title>
+    </info>
+
+    <title>Networks</title>
+
+    <p><app>Empathy</app> includes a list of popular IRC networks.  If you
+    wish to another IRC network, you can add it to the list.  You can also
+    modify networks and remove them from the list.</p>
+
+    <list>
+      <item><p>To add a network to the list, click <media type="image"
+      mime="image/png" src="figures/gtk-add.png" width="16"
+      height="16">Add</media>.</p></item>
+      <item><p>To modify a network in the list, select the network and click
+      <media type="image" mime="image/png" src="figures/gtk-edit.png" width="16"
+             height="16">Edit</media>.</p></item>
+      <item><p>To remove a network from the list, select the network and
+      click <media type="image" mime="image/png" src="figures/gtk-remove.png"
+      width="16" height="16">Remove</media>.</p></item>
+    </list>
+
+    <p>When adding or modifying a network, you can enter the following
+    information:</p>
+
+    <terms>
+      <item>
+        <title><gui>Network</gui></title>
+        <p>This is the name of the network as you want it to appear in
+        the list of networks.</p>
+      </item>
+      <item>
+        <title><gui>Charset</gui></title>
+        <p>This specifies the character encoding that is typically used on
+        this network.  A character encoding is a specific way of recording
+        characters internally in a computer.  There are many character
+        encodings, and you need to use the same character encoding as other
+        users to see their messages correctly.</p>
+        <!--
+            Translators: Recommend character encodings that are common
+            for your language.
+        -->
+        <p>By default, <app>Empathy</app> uses UTF-8, a modern character
+        encoding that can handle text from most of the world's languages.
+        Another common encoding for English and some other Western languages
+        is ISO-8859-1.</p>
+      </item>
+      <item>
+        <title><gui>Servers</gui></title>
+        <p>An IRC network may have many servers you can connect to.  When
+        you are connected to a server on a particular network, you can
+        communicate with all users on all other servers on that network.
+        You can add and remove servers for this network using the
+        <gui>Add</gui> and <gui>Remove</gui> buttons.</p>
+        <p>When a server is selected, click the field under <gui>Server</gui>
+        or <gui>Port</gui> to edit it.  Alternatively, use the left and right
+        arrow keys to focus the field, and press the space bar to begin
+        editing.</p>
+        <p>Select the check box in the <gui>SSL</gui> column to encrypt
+        all communication with a server.  Note that this does not prevent
+        other users on the network from seeing what you write on public
+        chat rooms.</p>
+      </item>
+    </terms>
+  </section>
+</page>
diff --git a/help/C/account-jabber.page b/help/C/account-jabber.page
new file mode 100644
index 0000000..b6ba60a
--- /dev/null
+++ b/help/C/account-jabber.page
@@ -0,0 +1,62 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="screen"
+      id="account-jabber">
+
+  <info>
+    <revision pkgversion="2.28" version="0.1" date="2009-08-27" status="review"/>
+    <credit type="author">
+      <name>Shaun McCance</name>
+      <email>shaunm gnome org</email>
+    </credit>
+    <copyright>
+      <year>2009</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Jabber Account Details</title>
+
+  <p>Most Jabber accounts will require only a login ID and a password
+  to connect.  For some accounts or on certain types of networks, you
+  may need to enter additional information in the <gui>Advanced</gui>
+  section.  Normally, you will not need to use the advanced options
+  below.  For general instructions on adding an account, see
+  <link xref="add-account"/>.</p>
+
+  <terms>
+    <item>
+      <title><gui>Encryption required (TLS/SSL)</gui></title>
+      <title><gui>Ignore SSL certificate errors</gui></title>
+      <p>Whenever possible, communication between <app>Empathy</app> and
+      the Jabber server is encrypted.  If encrypted communication is not
+      possible, messages may be sent unencrypted.  Select <gui>Encryption
+      required</gui> to prevent <app>Empathy</app> from communicating with
+      the Jabber server when encryption is not possible.</p>
+      <p>Some Jabber servers may encrypt data using invalid certificates,
+      or using certificates from unknown authorities.  If you trust the
+      server you are connecting to, you can select <gui>Ignore SSL
+      certificate errors</gui> to allow encrypted communication with
+      invalid certificates.</p>
+    </item>
+    <item>
+      <title><gui>Resource</gui></title>
+      <title><gui>Priority</gui></title>
+      <p>If you have multiple applications (for instance, on separate computers)
+      connected to your account at the same time, you can set a resource to
+      uniquely identify each one.  By default, <app>Empathy</app> will use
+      <input>Telepathy</input> as the resource.</p>
+      <p>You can set the priority to specify which application should receive
+      incoming messages from your contacts.  New messages will be sent to the
+      application with the highest priority.</p>
+    </item>
+    <item>
+      <title><gui>Override server settings</gui></title>
+      <p><app>Empathy</app> will use default settings to connect to the
+      Jabber server based on your login ID.  For some Jabber servers, you
+      will need to enter custom server settings manually.  These settings
+      should be provided for you by your Jabber provider.</p>
+    </item>
+  </terms>
+
+</page>
diff --git a/help/C/accounts-window.page b/help/C/accounts-window.page
new file mode 100644
index 0000000..14e7056
--- /dev/null
+++ b/help/C/accounts-window.page
@@ -0,0 +1,38 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="accounts-window">
+
+  <info>
+    <link type="topic" xref="add-account"/>
+    <link type="topic" xref="disable-account"/>
+    <link type="topic" xref="remove-account"/>
+    <desc>Add, modify, and delete accounts.</desc>
+    <revision pkgversion="2.28" version="0.1" date="2009-08-26" status="incomplete"/>
+    <credit type="author">
+      <name>Shaun McCance</name>
+      <email>shaunm gnome org</email>
+    </credit>
+    <copyright>
+      <year>2009</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Accounts Window</title>
+
+  <p>The <gui>Accounts</gui> window allows you to add, modify, and delete
+  accounts.</p>
+
+  <section id="details">
+    <info>
+      <link type="topic" xref="account-jabber"/>
+      <link type="topic" xref="account-irc"/>
+    </info>
+    <title>Account Details</title>
+    <p>For most types of accounts, you can simply enter a login ID and
+    a password.  Certain accounts or account types, however, may require
+    additional information.</p>
+  </section>
+
+</page>
diff --git a/help/C/figures/gtk-add.png b/help/C/figures/gtk-add.png
new file mode 100644
index 0000000..c541e6e
Binary files /dev/null and b/help/C/figures/gtk-add.png differ
diff --git a/help/C/figures/gtk-edit.png b/help/C/figures/gtk-edit.png
new file mode 100644
index 0000000..5200e14
Binary files /dev/null and b/help/C/figures/gtk-edit.png differ
diff --git a/help/C/figures/gtk-remove.png b/help/C/figures/gtk-remove.png
new file mode 100644
index 0000000..6b8361e
Binary files /dev/null and b/help/C/figures/gtk-remove.png differ
diff --git a/help/C/prob-conn-name.page b/help/C/prob-conn-name.page
index 3e4edd4..593c60d 100644
--- a/help/C/prob-conn-name.page
+++ b/help/C/prob-conn-name.page
@@ -5,8 +5,10 @@
   <info>
     <link type="guide" xref="prob-conn"/>
     <link type="guide" xref="irc-manage#problems"/>
+    <link type="seealso" xref="account-irc"/>
+    <title type="link" role="error-msg">â??Name in useâ??</title>
     <desc>
-      An error message which says "<gui>Name in use</gui>" appears in the main window.
+      An error message which says â??<gui>Name in use</gui>â?? appears in the main window.
     </desc>
     <revision pkgversion="2.28" version="0.1" date="2009-07-26" status="draft"/>
     <revision pkgversion="2.28" version="0.2" date="2009-08-14" status="review"/>
@@ -21,7 +23,7 @@
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
   </info>
 
-  <title>I get a message that says "Name in use"</title>
+  <title>I get a message that says â??Name in useâ??</title>
 
   <p>
     This kind of error happens when you try to connect to your IRC account and
diff --git a/help/Makefile.am b/help/Makefile.am
index 95b218a..ff79d05 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -11,6 +11,9 @@ DOC_FIGURES = \
 	figures/empathy-main-window.png
 
 DOC_PAGES = \
+	account-irc.page \
+	account-jabber.page \
+	accounts-window.page \
 	add-account.page \
 	add-contact.page \
 	audio-call.page \
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]