diff options
author | Milo Casagrande <milo@ubuntu.com> | 2009-08-15 03:09:26 +0800 |
---|---|---|
committer | Milo Casagrande <milo@ubuntu.com> | 2009-08-15 03:09:26 +0800 |
commit | 7a91c985c8e9b96764e29948de83fb016da9beda (patch) | |
tree | aed87cec63e26c8ae309732642fa01a8c2fca25a /help | |
parent | 7b2b0bf17f28dffc39de8482989a72c401c6e263 (diff) | |
download | gsoc2013-empathy-7a91c985c8e9b96764e29948de83fb016da9beda.tar gsoc2013-empathy-7a91c985c8e9b96764e29948de83fb016da9beda.tar.gz gsoc2013-empathy-7a91c985c8e9b96764e29948de83fb016da9beda.tar.bz2 gsoc2013-empathy-7a91c985c8e9b96764e29948de83fb016da9beda.tar.lz gsoc2013-empathy-7a91c985c8e9b96764e29948de83fb016da9beda.tar.xz gsoc2013-empathy-7a91c985c8e9b96764e29948de83fb016da9beda.tar.zst gsoc2013-empathy-7a91c985c8e9b96764e29948de83fb016da9beda.zip |
[help]
irc-nick-password:
* wordings
* added a note
irc-start-conversation:
* added topic for starting a private IRC conversation
irc-send-file:
* added topic for sending files via IRC (it's not possible)
start-conversation:
* added topic describing the Ctrl+N way to start a conversation
prob-conn-neterror:
* reworked the page adding the IRC problem
prob-conn-name:
* reworked the page
prob-conn-acctdisabled:
* reworked the page
audio-video:
* added a note
* added table for supported services/protocols
Makefile.am:
* added new pages
Diffstat (limited to 'help')
-rw-r--r-- | help/C/audio-video.page | 70 | ||||
-rw-r--r-- | help/C/irc-join-room.page | 5 | ||||
-rw-r--r-- | help/C/irc-manage.page | 11 | ||||
-rw-r--r-- | help/C/irc-nick-password.page | 19 | ||||
-rw-r--r-- | help/C/irc-sending-file.page | 27 | ||||
-rw-r--r-- | help/C/irc-start-conversation.page | 62 | ||||
-rw-r--r-- | help/C/prob-conn-acctdisabled.page | 68 | ||||
-rw-r--r-- | help/C/prob-conn-auth.page | 52 | ||||
-rw-r--r-- | help/C/prob-conn-name.page | 45 | ||||
-rw-r--r-- | help/C/prob-conn-neterror.page | 83 | ||||
-rw-r--r-- | help/C/send-file.page | 16 | ||||
-rw-r--r-- | help/C/start-conversation.page | 71 | ||||
-rw-r--r-- | help/Makefile.am | 3 |
13 files changed, 403 insertions, 129 deletions
diff --git a/help/C/audio-video.page b/help/C/audio-video.page index cc118dd56..244ed2c4b 100644 --- a/help/C/audio-video.page +++ b/help/C/audio-video.page @@ -65,5 +65,75 @@ </tr> </tbody> </table> + + <note> + <p> + In order to have a video conversation, you need to have a web-cam that is + supported by your operating system, and a working microphone. + </p> + <p> + In order to have an audio conversation, you need to have a sound-card that is + supported by your operating system, and a working microphone. + </p> + </note> + + <section id="supported-services"> + + <title>Supported services</title> + + <table frame="all" rules="cols" shade="rows"> + <thead> + <tr> + <td> + Protocol / Service + </td> + <td> + Video conversations + </td> + <td> + Audio conversations + </td> + </tr> + </thead> + <tbody> + <tr> + <td>AIM</td> + <td>No</td> + <td>No</td> + </tr> + <tr> + <td>Google Talk</td> + <td>Yes</td> + <td>Yes</td> + </tr> + <tr> + <td>ICQ</td> + <td>No</td> + <td>No</td> + </tr> + <tr> + <td>Jabber</td> + <td>Yes</td> + <td>Yes</td> + </tr> + <tr> + <td>MSN</td> + <td>No</td> + <td>No</td> + </tr> + <tr> + <td>Salut</td> + <td>No</td> + <td>No</td> + </tr> + <tr> + <td>Yahoo!</td> + <td>No</td> + <td>No</td> + </tr> + </tbody> + </table> + + </section> </page> diff --git a/help/C/irc-join-room.page b/help/C/irc-join-room.page index 379399267..c196f2055 100644 --- a/help/C/irc-join-room.page +++ b/help/C/irc-join-room.page @@ -4,9 +4,9 @@ <info> <link type="guide" xref="irc-manage#manage"/> - <desc>Entering an IRC channel.</desc> + <desc>Join an IRC channel.</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"/> <credit type="author"> <name>Milo Casagrande</name> <email>milo@ubuntu.com</email> @@ -15,7 +15,6 @@ <year>2009</year> <name>GNOME Documentation Project</name> </copyright> - <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> </info> diff --git a/help/C/irc-manage.page b/help/C/irc-manage.page index bb285f248..081c7e2c3 100644 --- a/help/C/irc-manage.page +++ b/help/C/irc-manage.page @@ -4,9 +4,10 @@ <info> <link type="guide" xref="index#text-conv"/> - <desc>Manage IRC accounts with <app>Empathy</app>.</desc> - <revision pkgversion="2.28" version="3.0" date="2009-07-25" status="draft"/> - + <link type="seealso" xref="irc-account"/> + <desc>Hot to use IRC with <app>Empathy</app>.</desc> + <revision pkgversion="2.28" version="0.1" date="2009-07-25" status="draft"/> + <revision pkgversion="2.28" version="0.2" date="2009-08-14" status="review"/> <credit type="author"> <name>Milo Casagrande</name> <email>milo@ubuntu.com</email> @@ -15,7 +16,6 @@ <year>2009</year> <name>GNOME Documentation Project</name> </copyright> - <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> </info> @@ -31,11 +31,10 @@ </comment> <section id="manage" style="2column"> - <title>Manage IRC accounts</title> + <title>IRC rooms and conversations</title> </section> <section id="problems" style="2column"> - <!-- TODO: see prob-conn-neterror.page --> <title>Fix common problems</title> </section> diff --git a/help/C/irc-nick-password.page b/help/C/irc-nick-password.page index 1a73a2c4f..c0e9328a9 100644 --- a/help/C/irc-nick-password.page +++ b/help/C/irc-nick-password.page @@ -23,7 +23,7 @@ <title>Set the nickname password</title> <p> - Registering a nickname is useful to preserve your identity on IRC and you will be able + Registering a nickname is useful to preserve your identity on IRC, and to be able to use always the same nickname. In some cirtumstances, some IRC channels may be configured to accept only registered nickname. </p> @@ -31,8 +31,14 @@ <p> If you have registered your nickname with a password on a network that supports nickname registration, you can use that password with <app>Empathy</app> to identify yourself as - the owner of the nickname. + the owner of that nickname. </p> + + <note> + <p> + Not all the IRC servers support nickname registration. + </p> + </note> <steps> <item> @@ -74,14 +80,13 @@ Enable the account by selecting the <gui>Enabled</gui> check-box next to the name of the account. </p> + <p> + Once connected, you will receive a message from the nickname server that will + tell you of the established identification. + </p> </item> </steps> - <p> - Once you are connected, you will receive a message from the nickname server that will - tell you of the established identification. - </p> - <note> <p> At the moment it is not possible to register an IRC nickname with <app>Empathy</app>, it is diff --git a/help/C/irc-sending-file.page b/help/C/irc-sending-file.page new file mode 100644 index 000000000..804efa9fa --- /dev/null +++ b/help/C/irc-sending-file.page @@ -0,0 +1,27 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="irc-send-file"> + + <info> + <link type="guide" xref="irc-manage#manage"/> + <link type="seealso" xref="send-file"/> + <desc>Send a file from your computer to one of the IRC contacts.</desc> + <revision pkgversion="2.28" version="0.1" date="2009-08-14" status="review"/> + <credit type="author"> + <name>Milo Casagrande</name> + <email>milo@ubuntu.com</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>Send files</title> + + <p> + At the moment it is not possible to send files using IRC. + </p> + +</page> diff --git a/help/C/irc-start-conversation.page b/help/C/irc-start-conversation.page new file mode 100644 index 000000000..0f73bdad6 --- /dev/null +++ b/help/C/irc-start-conversation.page @@ -0,0 +1,62 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="irc-start-conversation"> + + <info> + <link type="guide" xref="irc-manage#manage"/> + <desc>Start a conversation witn an IRC contact.</desc> + <revision pkgversion="2.28" version="0.1" date="2009-08-14" status="review"/> + <credit type="author"> + <name>Milo Casagrande</name> + <email>milo@ubuntu.com</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>Start a conversation</title> + + <steps> + <item> + <p> + To start a private conversation with one of the IRC contacts that + are in a room, after you joined a room, from the IRC room contact list perform + one of the following: + </p> + <list> + <item> + <p> + Double-click the name of contact you want to have a conversation with. + </p> + </item> + <item> + <p> + Right-click on the name of the contact you want to have a conversation with, + and select <gui>Chat</gui>. + </p> + </item> + </list> + </item> + </steps> + + <list> + <item> + <p> + The IRC room contact list is not the same as <app>Empathy</app> <gui>Contact List</gui>, + and is relative only to the IRC room you joined. Different rooms can have different + contacts listed. + </p> + </item> + <item> + <p> + The IRC room contact list is usually on the right side of the IRC room window. If you + do not see it, choose + <guiseq><gui>Conversation</gui><gui>Show Contact List</gui></guiseq>. + </p> + </item> + </list> + +</page> diff --git a/help/C/prob-conn-acctdisabled.page b/help/C/prob-conn-acctdisabled.page index 71caf567e..1daf61406 100644 --- a/help/C/prob-conn-acctdisabled.page +++ b/help/C/prob-conn-acctdisabled.page @@ -8,11 +8,16 @@ The instant messaging account that you want to use is not enabled in the list of accounts. </desc> - <revision version="3.0" date="2009-06-17" status="draft"/> + <revision pkgversion="2.28" version="0.1" date="2009-06-17" status="draft"/> + <revision pkgversion="2.28" version="0.2" date="2009-08-14" status="review"/> <credit type="author"> <name>Phil Bull</name> <email>philbull@gmail.com</email> </credit> + <credit type="author"> + <name>Milo Casagrande</name> + <email>milo@ubuntu.com</email> + </credit> <copyright> <year>2009</year> <name>GNOME Documentation Project</name> @@ -20,32 +25,43 @@ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" /> </info> -<title>My account is not enabled</title> + <title>My account is not enabled</title> -<p> -If the instant messaging account that you want to use is not enabled in the -drop-down account list when you try to start a new conversation or join a -chat, your account details may not be correct. -</p> + <p> + If the instant messaging account that you want to use is not enabled in the + drop-down account list when you try to start a new conversation or join a + room, your account details may not be correct. + </p> -<list> -<item> - <p> - Click <guiseq><gui>Edit</gui><gui>Accounts</gui></guiseq> and make sure - that the <gui>Enabled</gui> checkbox is checked. - </p> -</item> -<item> - <p> - Make sure that your username and password are correct. - </p> -</item> -<item> - <p> - Expand the <gui>Advanced</gui> section of the <app>Accounts</app> - window and make sure that all of the server settings are correct. - </p> -</item> -</list> + <steps> + <item> + <p> + Make sure that you are connected to the Internet, or to a local area network. + </p> + </item> + <item> + <p> + Choose <guiseq><gui>Edit</gui><gui>Accounts</gui></guiseq> and select the account + that is not working. + </p> + </item> + <item> + <p> + Type your username and password again to make sure that they are correct. + </p> + </item> + <item> + <p> + Check in the <gui>Advanced</gui> section that all the details are correct. + You should be able to find these details from the website of the messaging service. + </p> + </item> + <item> + <p> + Check that the <gui>Enabled</gui> check-box next to the name of your account is selected. + If it is not, select the check-box to enalbe the account. + </p> + </item> + </steps> </page> diff --git a/help/C/prob-conn-auth.page b/help/C/prob-conn-auth.page index e49167299..3188b261b 100644 --- a/help/C/prob-conn-auth.page +++ b/help/C/prob-conn-auth.page @@ -6,23 +6,23 @@ <link type="guide" xref="prob-conn"/> <link type="seealso" xref="create-account"/> <desc> - An error message appears in the main window saying that - "<gui>Authentication failed</gui>". + An error message which says "<gui>Authentication failed</gui>" appears in the main window. </desc> - - <revision version="3.0" date="2009-06-17" status="draft"/> - <revision pkgversion="2.28" version="3.1" date="2009-07-23" status="draft"/> - + <revision pkgversion="2.28" version="0.1" date="2009-06-17" status="draft"/> + <revision pkgversion="2.28" version="0.2" date="2009-07-23" status="draft"/> + <revision pkgversion="2.28" version="0.3" date="2009-08-14" status="review"/> <credit type="author"> <name>Phil Bull</name> <email>philbull@gmail.com</email> </credit> - + <credit type="author"> + <name>Milo Casagrande</name> + <email>milo@ubuntu.com</email> + </credit> <copyright> <year>2009</year> <name>GNOME Documentation Project</name> </copyright> - <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" /> </info> @@ -37,26 +37,38 @@ </comment> <p> - If you try to connect and you get a message saying <gui>Authentication failed</gui>, - your instant messaging service is not allowing you to connect because it does not - recognize your username or password for some reason. + This kind of error happens when your instant messaging service is not allowing + you to connect because it does not recognize your username or password for some reason. </p> - <list> + <steps> + <item> + <p> + Make sure that you are connected to the Internet, or to a local area network. + </p> + </item> + <item> + <p> + Make sure that you have registered an account with the service you are trying + to connect to. If you do not have an account, most services will not allow + you to connect. + </p> + </item> + <item> + <p> + Click on the <gui>Edit Account</gui> button in the error message. + </p> + </item> <item> <p> - Make sure that you have registered for an account with the service you - are trying to connect to. If you do not have an account, most services - will not allow you to connect. + Type your username and password again to make sure that they are correct. </p> </item> <item> <p> - Click the <gui>Edit Account</gui> button in the error message. Type - your username and password again to make sure that they are correct. - Deselect the <gui>Enabled</gui> box next to the name of your account and - then select it to try to connect to the service again. + Deselect the <gui>Enabled</gui> check-box next to the name of your account, + and then select it again to try to reconnect to the service. </p> </item> - </list> + </steps> </page> diff --git a/help/C/prob-conn-name.page b/help/C/prob-conn-name.page index 98e17c36c..3e4edd40c 100644 --- a/help/C/prob-conn-name.page +++ b/help/C/prob-conn-name.page @@ -6,10 +6,10 @@ <link type="guide" xref="prob-conn"/> <link type="guide" xref="irc-manage#problems"/> <desc> - An error message appears in the main <app>Empathy</app> window which says - "Name in use". + 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"/> <credit type="author"> <name>Milo Casagrande</name> <email>milo@ubuntu.com</email> @@ -21,39 +21,42 @@ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" /> </info> - <!-- - TODO: work on this page. This error appears with the IRC account - when you set a nickname that is already in use on that network. We need - to write topics for changing your nickname and to set the password of your - nickname. - --> - <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 - you are using a nickname that is being used by someone else on that particular + you are using a nickname that is already being used by someone else on that particular network. </p> - <p> - To resolve this problem, click on the <gui>Edit Account</gui> button and - perform one of the following: - </p> - - <list> + <steps> <item> <p> - Change your nickname. + Click on the <gui>Edit Account</gui> button in the error message. </p> </item> <item> + <list> + <item> + <p> + In the <gui>Nickname</gui> text box, type a new nickname. + </p> + </item> + <item> + <p> + If you have registered that nickname within the network you are using, + set the password for that nickname. For more information, + see <link xref="irc-nick-password"/>. + </p> + </item> + </list> + </item> + <item> <p> - Set the password for that nickname, if you have registered that nickname - within the network you are using. For more information, - see <link xref="irc-nick-password"/>. + Deselect the <gui>Enabled</gui> check-box next to the name of your account, + and then select it again to try to reconnect to the service. </p> </item> - </list> + </steps> </page> diff --git a/help/C/prob-conn-neterror.page b/help/C/prob-conn-neterror.page index f15a4c86c..8001ed49b 100644 --- a/help/C/prob-conn-neterror.page +++ b/help/C/prob-conn-neterror.page @@ -6,14 +6,18 @@ <link type="guide" xref="prob-conn"/> <link type="guide" xref="irc-manage#problems" /> <desc> - An error message appears in the main <app>Empathy</app> window which says - "Network error". + An error message which says "<gui>Network error</gui>" appears in the main window. </desc> <revision pkgversion="2.28" version="0.1" date="2009-06-17" status="draft"/> + <revision pkgversion="2.28" version="0.2" date="2009-08-14" status="review"/> <credit type="author"> <name>Phil Bull</name> <email>philbull@gmail.com</email> </credit> + <credit type="author"> + <name>Milo Casagrande</name> + <email>milo@ubuntu.com</email> + </credit> <copyright> <year>2009</year> <name>GNOME Documentation Project</name> @@ -21,47 +25,50 @@ <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> + <title>I get a message that says "Network error"</title> -<p> -If you try to connect and an error message appears in the main Empathy -window which says "Network error", Empathy cannot communicate with -the instant messaging service for some reason. -</p> + <p> + This kind of error happens when <app>Empathy</app> cannot communicate + with the instant messaging service for some reason. + </p> + <p> + Also, this kind of error happens when you try to use an IRC account without + setting a nickname. + </p> -<list> -<item> - <p> - Check that you are connected to the Internet or network. - </p> -</item> -<item> - <steps> - <item> - <p> - Click the <gui>Edit Account</gui> button in the error message. - </p> - </item> + <steps> + <item> + <p> + Make sure that you are connected to the Internet, or to a local area network. + </p> + </item> + <item> + <p> + Click on the <gui>Edit Account</gui> button in the error message. + </p> + </item> + <item> + <list> <item> - <p> - Expand the <gui>Advanced</gui> section and make sure that the details - such as server address and port are correct. You should be able to find - these details from the website of the messaging service. - </p> + <p> + Check in the <gui>Advanced</gui> section that all the details are correct. + You should be able to find these details from the website of the messaging service. + </p> </item> <item> - <p> - Uncheck the <gui>Enabled</gui> box next to the name of your account and - then check it again to try to connect to the service again. - </p> + <p> + In the case of an IRC account, type your nickname in the <gui>Nickname</gui> + text box. + </p> </item> - </steps> -</item> -</list> + </list> + </item> + <item> + <p> + Deselect the <gui>Enabled</gui> check-box next to the name of your account, + and then select it again to try to reconnect to the service. + </p> + </item> + </steps> </page> diff --git a/help/C/send-file.page b/help/C/send-file.page index 7d7b2ab7d..bbe4302cf 100644 --- a/help/C/send-file.page +++ b/help/C/send-file.page @@ -7,7 +7,7 @@ <desc>Send a file from your computer to one of your contacts.</desc> <revision pkgversion="2.28" version="0.1" date="2009-06-14" status="draft"/> <revision pkgversion="2.28" version="0.2" date="2009-07-21" status="draft"/> - + <revision pkgversion="2.28" version="0.2" date="2009-08-14" status="review"/> <credit type="author"> <name>Phil Bull</name> <email>philbull@gmail.com</email> @@ -65,6 +65,13 @@ </p> </note> + <note> + <p> + In order to send a file to someone, you need to be connected to the Internet, or to + a local area network. + </p> + </note> + <p> If your contact accepts the file transfer, you can watch the progress of the transfer and see the estimated amount of time remaining before it is complete. @@ -80,11 +87,4 @@ list and will not delete them from your computer. </p> - <note> - <p> - In order to send a file to someone, you need to be connected to the Internet, or to - a local area network. - </p> - </note> - </page> diff --git a/help/C/start-conversation.page b/help/C/start-conversation.page new file mode 100644 index 000000000..d7123c4e4 --- /dev/null +++ b/help/C/start-conversation.page @@ -0,0 +1,71 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="start-conversation"> + + <info> + <link type="guide" xref="index#audio-video"/> + <link type="guide" xref="index#text-conv"/> + <link type="seealso" xref="add-contact"/> + <desc>General method to start a conversation.</desc> + <revision pkgversion="2.28" version="0.1" date="2009-08-14" status="review"/> + <credit type="author"> + <name>Milo Casagrande</name> + <email>milo@ubuntu.com</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>Start a conversation</title> + + <steps> + <item> + <p> + From the <gui>Contact List</gui> window, perform one of the following: + </p> + <list> + <item> + <p> + Choose <guiseq><gui>Chat</gui><gui>New conversation</gui></guiseq>. + </p> + </item> + <item> + <p> + Press <keyseq><key>Ctrl</key><key>N</key></keyseq>. + </p> + </item> + </list> + </item> + <item> + <p> + From the <gui>Account</gui> drop-down list, select the account you want to + use for the conversation. + </p> + <p> + This one is one of your accounts. + </p> + </item> + <item> + <p> + In the <gui>Contact ID</gui> text box, type the identifier of the contact you want to + have a conversation with. + </p> + <p> + You have to enter the identifier as it has been inserted when adding a new contact to + your contact list. If you are trying to start a conversation using one of your IRC + accounts or a SIP account, you have to enter the exact nickname or the + exact SIP address of the contact. + </p> + </item> + <item> + <p> + To start a text conversation, click on <gui>Chat</gui>; to start + an audio conversation, click on <gui>Call</gui>. + </p> + </item> + </steps> + +</page> diff --git a/help/Makefile.am b/help/Makefile.am index 2ba171df1..91747b93c 100644 --- a/help/Makefile.am +++ b/help/Makefile.am @@ -26,6 +26,8 @@ DOC_PAGES = \ irc-join-room.page \ irc-manage.page \ irc-nick-password.page \ + irc-sending-file.page \ + irc-start-conversation.page \ offline-contacts.page \ prob-conn-acctdisabled.page \ prob-conn-auth.page \ @@ -38,6 +40,7 @@ DOC_PAGES = \ send-message.page \ set-custom-status.page \ share-desktop.page \ + start-conversation.page \ status-icons.page \ video-call.page |