Add TODO comment on prob-conn-neterror.page * need to talk about IRC problem

Added new pages:
* irc-manage: guide page for all IRC topics
* irc-account: topic on how to set up an IRC account

Linked the prob-conn-neterror topic from the irc-manage page

Modified dialog instead of window for the account page

diff --git a/help/C/add-account.page b/help/C/add-account.page
index d985cf6d4301e305caa45a7e973cfe390e075abd..8a31cc12ca6b7267ce0ca2a133ec969927f4572b 100644 (file)
--- a/help/C/add-account.page
+++ b/help/C/add-account.page
@@ -83,7 +83,7 @@
       <p>
       To enable the new account, select the
            <gui>Enabled</gui> check-box next to
-           the name of the account in the box on the left of the window.
+           the name of the account in the box on the left of the dialog
       </p>
     </item>
   </steps>

diff --git a/help/C/irc-account.page b/help/C/irc-account.page
new file mode 100644 (file)
index 0000000..7a93506
--- /dev/null
+++ b/help/C/irc-account.page
@@ -0,0 +1,123 @@
+<page xmlns="http://projectmallard.org/1.0/"
+  type="topic"
+  id="irc-account">
+
+  <info>
+    <link type="guide" xref="irc-manage#manage"/>
+    <link type="seealso" xref="prob-conn-neterror"/>
+    <desc>Create a new IRC account.</desc>
+    <revision pkgversion="2.28" version="0.1" date="2009-07-25" status="draft"/>
+
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo@ubuntu.com</email>
+    </credit>
+    <copyright>
+      <year>2009</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+
+    <license>Creative Commons Share Alike 3.0</license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+  
+  <title>Create an IRC account</title>
+
+  <steps>
+    <item>
+      <p>
+             From the <gui>Contact List</gui> window, perform one of the following:
+      </p>
+      <list>
+        <item>
+               <p>
+                 Press <key>F4</key>
+               </p>
+             </item>
+             <item>
+               <p>
+                 Choose <guiseq><gui>Edit</gui><gui>Accounts</gui></guiseq>
+               </p>
+       </item>
+      </list>
+    </item>
+    <item>
+      <p>
+             If it is the first time you launch <app>Empathy</app>:
+      </p>
+      <list>
+             <item>
+               <p>
+                 From the <gui>Type</gui> drop-down list choose
+                 <gui>IRC</gui>, then click on the <gui>Create</gui> button.
+               </p>
+             </item>
+      </list>
+      <p>
+             Otherwise:
+      </p>
+      <steps>
+             <item>
+               <p>
+                 Click on the <gui>Add</gui> button.
+               </p>
+             </item>
+             <item>
+               <p>
+                 From the <gui>Type</gui> drop-down list choose
+                 <gui>IRC</gui>, then click on the <gui>Create</gui> button.
+               </p>
+             </item>
+            </steps>
+          </item>
+          <item>
+           <p>
+             From the <gui>Network</gui> drop-down list, select the name of the network 
+             you are creating the account for.
+           </p>
+          </item>
+          <item>
+          <!-- TODO: think of a simple way to talk about the nickname -->
+           <p>
+             In the <gui>Nickname</gui> text box, type the name... 
+           </p>
+          </item>
+          <item>
+           <p>
+             In the <gui>Password</gui> text box, type the password you used to register 
+             your nikcname. If you do not have one, leave this field blank.
+           </p>
+          </item>
+          <item>
+           <p>
+             In the <gui>Real name</gui> text box, type your real name. 
+           </p>
+           <note>
+             <p>
+               It is not necessary to insert also your real name.
+             </p>
+           </note>
+          </item>
+          <item>
+           <p>
+             In the <gui>Quit message</gui> text box, type the text message that will be 
+             sent when you close your session.
+           </p>
+          </item>
+          <item>
+           <p>
+             To enable the new account, select the <gui>Enabled</gui> check-box 
+             next to the name of the account in the box on the left of the dialog.
+      </p>
+    </item>
+        </steps>
+
+  <note>
+    <p>
+      If you want to use different networks at the same time, you need to create an 
+      account with each of the networks you want to use.
+    </p>
+  </note>
+
+</page>

diff --git a/help/C/irc-manage.page b/help/C/irc-manage.page
new file mode 100644 (file)
index 0000000..64d6911
--- /dev/null
+++ b/help/C/irc-manage.page
@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/"
+  type="guide"
+  id="irc-manage">
+
+  <info>
+    <link type="guide" xref="index#accounts"/>
+    <desc>Manage IRC accounts with <app>Empathy</app>.</desc>
+    <revision pkgversion="2.28" version="3.0" date="2009-07-25" status="draft"/>
+
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo@ubuntu.com</email>
+    </credit>
+    <copyright>
+      <year>2009</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+
+    <license>Creative Commons Share Alike 3.0</license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <comment>
+    <cite date="2009-07-25"><name>Milo Casagrande</name></cite>
+    <p>
+      Guide page for all the IRC related actions. Need to work on this page 
+      if the content starts to grow. In case we don't have a lot of contets for 
+      this page, rework the other.
+    </p>
+  </comment>
+
+  <title>Use IRC</title>
+
+  <section id="manage" style="2column">
+    <title>Manage IRC accounts</title>
+  </section>
+
+  <section id="problems" style="2column">
+    <!-- TODO: see prob-conn-neterror.page -->
+    <title>Fix common problems</title>
+  </section>
+
+  
+</page>

diff --git a/help/C/prob-conn-neterror.page b/help/C/prob-conn-neterror.page
index f7bb7281c8d6d0dceb686c90ee7458c44a0f5aa2..65a8d1e952f0b374dc6c1132cd9868bd344bd435 100644 (file)
--- a/help/C/prob-conn-neterror.page
+++ b/help/C/prob-conn-neterror.page
@@ -4,8 +4,9 @@
 
   <info>
     <link type="guide" xref="prob-conn"/>
+    <link type="guide" xref="irc-manage#problems" />
     <desc>
-        An error message appears in the main Empathy window which says 
+        An error message appears in the main <app>Empathy</app> window which says 
         <gui>Network error</gui>.
     </desc>
     <revision version="3.0" date="2009-06-17" status="draft"/>
@@ -21,6 +22,11 @@
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" />
   </info>
 
+<!--
+  TODO: rework this page in order to talk about the IRC problem: if you
+  don't set your nickname, this is the kind of error that will be shown.
+ -->
+
 <title>I get a message that says "Network error"</title>
 
 <p>