diff options
| -rw-r--r-- | help/C/add-contact.page | 32 | ||||
| -rw-r--r-- | help/C/change-status.page | 28 | ||||
| -rw-r--r-- | help/C/disable-account.page | 62 | ||||
| -rw-r--r-- | help/C/figures/offline.png | bin | 0 -> 405 bytes | |||
| -rw-r--r-- | help/C/index.page | 22 | ||||
| -rw-r--r-- | help/C/prev-conv.page | 159 | ||||
| -rw-r--r-- | help/C/remove-account.page | 62 | ||||
| -rw-r--r-- | help/C/status-icons.page | 128 | ||||
| -rw-r--r-- | help/Makefile.am | 6 |
9 files changed, 211 insertions, 288 deletions
diff --git a/help/C/add-contact.page b/help/C/add-contact.page index 14d49a57a..11e11f619 100644 --- a/help/C/add-contact.page +++ b/help/C/add-contact.page @@ -1,13 +1,16 @@ <page xmlns="http://projectmallard.org/1.0/" - type="topic" - id="add-contact"> + xmlns:e="http://projectmallard.org/experimental/" + type="topic" style="task" + id="add-contact"> <info> <link type="guide" xref="index#accounts"/> <link type="seealso" xref="offline-contacts"/> <desc>Add someone to the contact list.</desc> <revision pkgversion="2.28" version="0.1" date="2009-06-15" status="draft"/> - <revision pkgversion="2.28" version="0.2" date="2009-08-10" status="review"/> + <revision pkgversion="2.28" version="0.2" date="2009-08-10" status="review"> + <e:review by="shaunm@gnome.org" date="2009-08-31" status="done"/> + </revision> <credit type="author"> <name>Phil Bull</name> <email>philbull@gmail.com</email> @@ -23,27 +26,20 @@ <steps> <item> - <p> - Choose <guiseq><gui>Chat</gui><gui>Add Contact</gui></guiseq>. - </p> + <p>Choose <guiseq><gui>Chat</gui><gui>Add Contact</gui></guiseq>.</p> </item> <item> - <p> - From the <gui>Account</gui> drop-down list, select the type of - service the person you want to add to your contacts is using. - </p> + <p>From the <gui>Account</gui> drop-down list, select the account you wish + to use to connect to your contact. Your contact will need to be using the + same service as the account you select.</p> </item> <item> - <p> - In the <gui>Identifier</gui> text box, type the email address - or the username of the person you want to add to your - contacts list. - </p> + <p>In the <gui>Identifier</gui> field, enter your contact’s login ID, username, + screen name, or other appropriate identifier for the service type.</p> </item> <item> - <p> - In the <gui>Alias</gui> text box, type their name. - </p> + <p>In the <gui>Alias</gui> field, type your contact’s name as you would like + it to appear in your contact list.</p> </item> <item> <p> diff --git a/help/C/change-status.page b/help/C/change-status.page index a2e687ffc..2b344246f 100644 --- a/help/C/change-status.page +++ b/help/C/change-status.page @@ -1,15 +1,18 @@ <page xmlns="http://projectmallard.org/1.0/" - type="topic" - id="change-status"> + xmlns:e="http://projectmallard.org/experimental/" + type="topic" style="task" + id="change-status"> <info> <link type="guide" xref="index#accounts"/> <link type="seealso" xref="status-icons"/> <desc> - Change your status, if you are going away from your computer for example. + Change your status to advertise your availability to 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-08-10" status="review"/> + <revision pkgversion="2.28" version="0.2" date="2009-08-10" status="review"> + <e:review by="shaunm@gnome.org" date="2009-09-01" status="done"/> + </revision> <credit type="author"> <name>Phil Bull</name> <email>philbull@gmail.com</email> @@ -23,6 +26,9 @@ <title>Change your status</title> + <p>You can set your status to indicate your availability to your contacts. + <app>Empathy</app> allows you to select from a list of defined statuses.</p> + <steps> <item> <p> @@ -36,16 +42,14 @@ </item> </steps> - <p> - For example, if you are busy and do not want to - be disturbed, select <gui>Busy</gui>. - </p> + <p>See <link xref="status-icons"/> for a list of the built-in statuses + and what they mean. You can also <link xref="set-custom-message">add + custom status messages</link> to provide more information about your + availability to your contacts.</p> <note> - <p> - If you do not use your computer for a while, or if the screen saver is turned on, - the status will be automatically set to <gui>Away</gui>. - </p> + <p>If you do not use your computer for a while, or if the screensaver is on, + the status will be automatically set to Away.</p> </note> </page> diff --git a/help/C/disable-account.page b/help/C/disable-account.page index f24c0f48f..6fbae8590 100644 --- a/help/C/disable-account.page +++ b/help/C/disable-account.page @@ -1,21 +1,26 @@ <page xmlns="http://projectmallard.org/1.0/" - type="topic" - id="disable-account"> + xmlns:e="http://projectmallard.org/experimental/" + type="topic" style="task" + id="disable-account"> <info> <link type="guide" xref="index#accounts"/> <link type="seealso" xref="remove-account"/> - <desc> - Prevent an account from logging-in automatically when you start - <app>Empathy</app>. - </desc> + <desc>Prevent <app>Empathy</app> from automatically logging in to an account.</desc> <revision pkgversion="2.28" version="0.1" date="2009-06-14" status="draft"/> <revision pkgversion="2.28" version="0.2" date="2009-08-10" status="review"/> <revision pkgversion="2.28" version="0.3" date="2009-08-27" status="review"/> + <revision pkgversion="2.28" version="0.4" date="2009-08-31" status="review"> + <e:review by="shaunm@gnome.org" date="2009-08-31" status="done"/> + </revision> <credit type="author"> <name>Milo Casagrande</name> <email>milo@ubuntu.com</email> </credit> + <credit type="author"> + <name>Shaun McCance</name> + <email>shaunm@gnome.org</email> + </credit> <copyright> <year>2009</year> <name>GNOME Documentation Project</name> @@ -25,48 +30,33 @@ <title>Disable an account</title> - <p> - Disabling an account means to deactivate it, temporarily or - permanently. All the conversations you had will be kept in your computer. - </p> - <p> - After disabling an account, it is possible to enable it again. - </p> + <p>You can disable an account to prevent <app>Empathy</app> from logging in to + it without removing the account entirely. You may wish to disable and re-enable + an account if you only want to be logged in to the account at certain times, + but you still want to use <app>Empathy</app> for other accounts.</p> <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> + <p>From the <gui>Contact List</gui> window, choose <guiseq><gui>Edit</gui> + <gui>Accounts</gui></guiseq>, or press <key>F4</key>.</p> </item> <item> - <p> - Select the account you wish to disable from the box on the - left of the dialog. - </p> + <p>Select the account you wish to disable from the accounts list on the left + side of the window.</p> </item> <item> - <p> - Deselect the <gui style="checkbox">Enabled</gui> check-box. - </p> + <p>Deselect <gui style="checkbox">Enabled</gui> on the right side of the + window. This option is after your primary account details, but before + any advanced settings.</p> </item> <item> <p> - Click on <gui style="button">Apply</gui>. + Click <gui style="button">Apply</gui>. </p> </item> </steps> + <p>To re-enable the account, simply select <gui style="checkbox">Enabled</gui> + and click <gui>Apply</gui>.</p> + </page> diff --git a/help/C/figures/offline.png b/help/C/figures/offline.png Binary files differnew file mode 100644 index 000000000..637be12cb --- /dev/null +++ b/help/C/figures/offline.png diff --git a/help/C/index.page b/help/C/index.page index a57596560..ff8a477c5 100644 --- a/help/C/index.page +++ b/help/C/index.page @@ -1,11 +1,13 @@ <page xmlns="http://projectmallard.org/1.0/" + xmlns:e="http://projectmallard.org/experimental/" type="guide" - style="2column" id="index"> <info> <revision pkgversion="2.28" version="0.1" date="2009-06-14" status="incomplete"/> - <revision pkgversion="2.28" version="0.1" date="2009-08-14" status="review"/> + <revision pkgversion="2.28" version="0.1" date="2009-08-14" status="review"> + <e:review by="shaunm@gnome.org" date="2009-08-31" status="done"/> + </revision> <credit type="author"> <name>Milo Casagrande</name> <email>milo@ubuntu.com</email> @@ -19,24 +21,24 @@ <title>Empathy Instant Messenger</title> - <section id="audio-video" style="2column"> - <title>Audio and video conversations</title> + <section id="text-conv" style="2column"> + <title>Text Conversations</title> </section> - <section id="text-conv" style="2column"> - <title>Text conversations</title> + <section id="audio-video" style="2column"> + <title>Audio and Video Conversations</title> </section> <section id="accounts" style="2column"> - <title>Manage accounts</title> + <title>Account Management</title> </section> <section id="advanced" style="2column"> - <title>Advanced actions</title> + <title>Advanced Actions</title> </section> - <section id="problems" style="2column"> - <title>Fix common problems</title> + <section id="problems"> + <title>Common Problems</title> </section> </page> diff --git a/help/C/prev-conv.page b/help/C/prev-conv.page index b521ada59..11c73c785 100644 --- a/help/C/prev-conv.page +++ b/help/C/prev-conv.page @@ -1,6 +1,7 @@ <page xmlns="http://projectmallard.org/1.0/" - type="topic" - id="prev-conv"> + xmlns:e="http://projectmallard.org/experimental/" + type="topic" style="tasks" + id="prev-conv"> <info> <link type="guide" xref="index#text-conv"/> @@ -8,11 +9,17 @@ Search your previous conversations. </desc> <revision pkgversion="2.28" version="0.1" date="2009-08-17" status="stub"/> - <revision pkgversion="2.28" version="0.2" date="2009-08-19" status="review"/> + <revision pkgversion="2.28" version="0.2" date="2009-08-31" status="review"> + <e:review by="shaunm@gnome.org" date="2009-08-31" status="done"/> + </revision> <credit type="author"> <name>Milo Casagrande</name> <email>milo@ubuntu.com</email> </credit> + <credit type="author"> + <name>Shaun McCance</name> + <email>shaunm@gnome.org</email> + </credit> <copyright> <year>2009</year> <name>GNOME Documentation Project</name> @@ -20,134 +27,98 @@ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> </info> - <title>Previous conversations</title> + <title>View previous conversations</title> + + <comment> + <cite date="2009-08-31">Shaun McCance</cite> + <p>Highlighting text is quirky: + <link href="http://bugzilla.gnome.org/show_bug.cgi?id=593733">#593733</link>. + If there's an actual highlighting going on, independent of the selection + (like in yellow or something), we can use the term "highlight". Otherwise + we need to use the term "select". Watch that bug.</p> + </comment> <p> <app>Empathy</app> automatically saves all your text conversations you have - with your contacts, and lets you perform two different kinds of search: a - normal text search, or a per-conversation search. - </p> - <p> - The normal search is a <em>full text</em> search: it will search the exact text in - all your previous conversations. - </p> - <p> - The per-conversation search permits you to limit the text search to a particular - contact and conversation, and permits you to look at all the previous - conversations you had with your contacts. + with your contacts. You can <link xref="#search">search through all of your + previous conversations</link> or <link xref="#browse">browse previous + conversations</link> by contact and date. </p> <note> <p> - You do not need to be connected to the Internet to search your previous + You do not need to be connected to the Internet to view and search your previous conversations. </p> </note> + <section id="search" style="task"> + <title>Search previous conversations</title> + + <p>You can perform a full-text search through all of your previous conversations.</p> + <steps> <item> - <p> - To start searching your previous conversations, from the <gui>Contact List</gui> - window, perform one of the following: - </p> - <list> - <item> - <p> - Press <key>F3</key>. - </p> - </item> - <item> - <p> - Choose <guiseq><gui>View</gui><gui>Previous Conversations</gui></guiseq>. - </p> - </item> - </list> + <p>From the <gui>Contact List</gui> window, choose <guiseq><gui>View</gui> + <gui>Previous Conversations</gui></guiseq>. Alternatively, press <key>F3</key>.</p> </item> <item> - <p> - Based on the kind of search you want to perform, see - <link xref="prev-conv#normal-search"/> or <link xref="prev-conv#contact-search"/> - for more information. - </p> + <p>Select the <gui>Search</gui> tab.</p> </item> - </steps> - - <section id="normal-search"> - <title>Normal search</title> - <steps> <item> - <p> - Select the <gui>Search</gui> tab. - </p> + <p>In the <gui>For</gui> field, type the text you want to search for. + Click <gui>Find</gui> or press <key>Enter</key>.</p> </item> <item> - <p> - In the <gui>For</gui> text box, type the text you want to search, and click on - <gui>Find</gui>. - </p> + <p>Any conversations that matched your search terms will be shown in the list below + the search field. By default, conversations are ordered by date.</p> </item> <item> - <p> - If there are results, they will be shown in the first pane, ordered by date. - </p> - </item> - <item> - <p> - Click on the result to see the exact text you were searching for on the - bottom pane. - </p> - <p> - The search results will be highlighted. - </p> + <p>Click on a conversation to view it. <app>Empathy</app> will select the text + in the conversation that matched your search terms.</p> </item> </steps> </section> - <section id="contact-search"> - <title>Conversation search</title> + <section id="browse" style="task"> + <title>Browse previous conversations</title> + + <p>You can browse your previous conversations with your contacts or in + chat rooms by date.</p> + <steps> <item> - <p> - Select the <gui>Conversations</gui> tab. - </p> + <p>From the <gui>Contact List</gui> window, choose <guiseq><gui>View</gui> + <gui>Previous Conversations</gui></guiseq>. Alternatively, press <key>F3</key>.</p> </item> <item> - <p> - From the drop-down list at the top of the window, select your account. - </p> + <p>Select the <gui>Conversations</gui> tab.</p> </item> <item> - <p> - From the left top pane, select the contact you want to look the previous - conversations of. The previous conversations will be shown on the right pane. - </p> - <p> - By default, the last conversation you had will be shown. - </p> - <note> - <p> - Based on your account selected and the service of that account, it will - be possible to select contacts, IRC rooms or group conversations. - </p> - </note> + <p>Select an account from the drop-down list in the top left. A list of + contacts and chat room for that account will be shown below.</p> </item> <item> - <p> - From the left bottom pane, you can browse your conversations by date. Based - on the contact selected, the date in which you had a conversation will - be highlighted in bold text. - </p> + <p>Select a contact or chat room to view your previous conversations from. + By default the most recent conversation will be shown.</p> </item> <item> - <p> - To perform a text search, type the text you want to search in the text box - at the top of the window. - </p> - <p> - The search results will be highlighted. - </p> + <p>You can browse your conversations by date. Days on which you had a conversation + with the selected contact will be shown in bold text. Click a date to select it. + Click the arrows next to the month and year to browse earlier dates.</p> </item> </steps> + + <p>You can search for text in the displayed conversation by typing into the + search field at the top. The matching text will be highlighted.</p> + + <note style="tip"> + <p>You can quickly view the previous conversations with one of your contacts + from the <gui>Contact List</gui> window. Simply right click the contact and + select <gui>View Previous Conversations</gui>. The <gui>Previous + Conversations</gui> window will open with that contact already selected.</p> + </note> + </section> </page> diff --git a/help/C/remove-account.page b/help/C/remove-account.page index dda83517c..fa53607db 100644 --- a/help/C/remove-account.page +++ b/help/C/remove-account.page @@ -1,13 +1,16 @@ <page xmlns="http://projectmallard.org/1.0/" - type="topic" - id="remove-account"> + xmlns:e="http://projectmallard.org/experimental/" + type="topic" style="task" + id="remove-account"> <info> <link type="guide" xref="index#accounts"/> <desc>Completely remove an account from <app>Empathy</app>.</desc> <revision pkgversion="2.28" version="0.1" date="2009-06-14" status="draft"/> <revision pkgversion="2.28" version="0.2" date="2009-08-10" status="review"/> - <revision pkgversion="2.28" version="0.3" date="2009-08-27" status="review"/> + <revision pkgversion="2.28" version="0.3" date="2009-08-27" status="review"> + <e:review by="shaunm@gnome.org" date="2009-08-31" status="done"/> + </revision> <credit type="author"> <name>Milo Casagrande</name> <email>milo@ubuntu.com</email> @@ -21,51 +24,32 @@ <title>Remove an account</title> - <p> - Removing an account means to delete it from your computer with all - the conversations you had with other people. - </p> - <p> - After removing an account you will not be able to recover it or to recover - the conversations you had. - </p> - + <p>You can completely remove an account from <app>Empathy</app> if you no + longer wish to use the account. If you wish to use the account in + <app>Empathy</app> again in the future, you will have to add your account + details again.</p> + <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> + <p>From the <gui>Contact List</gui> window, choose <guiseq><gui>Edit</gui> + <gui>Accounts</gui></guiseq>, or press <key>F4</key>.</p> </item> <item> - <p> - Select the account you wish to remove from the box on the - left of the dialog. - </p> + <p>Select the account you wish to remove from the accounts list on the + left side of the window.</p> </item> <item> - <p> - Click on the trash icon to remove the account. - </p> + <p>Click on the trash icon next to the account name to remove the account.</p> </item> <item> - <p> - A dialog will be shown asking for confirmation. Click on - the <gui>Remove</gui> button to permanently remove the - account. - </p> + <p>A dialog will be shown asking for confirmation. Click the <gui>Remove</gui> + button to permanently remove the account.</p> </item> </steps> + <note> + <p>Even after removing an account, <app>Empathy</app> does not delete + your conversation history for that account.</p> + </note> + </page> diff --git a/help/C/status-icons.page b/help/C/status-icons.page index 35c91e543..115d36eb4 100644 --- a/help/C/status-icons.page +++ b/help/C/status-icons.page @@ -1,18 +1,23 @@ <page xmlns="http://projectmallard.org/1.0/" - type="topic" - id="status-icons"> + xmlns:e="http://projectmallard.org/experimental/" + type="topic" style="concept" + id="status-icons"> <info> - <desc> - Understanding the various status icons. - </desc> + <desc>Understanding the various statuses and status icons.</desc> <revision pkgversion="2.28" version="0.1" date="2009-07-18" status="stub"/> <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"/> + <revision pkgversion="2.28" version="0.2" date="2009-08-14" status="review"> + <e:review by="shaunm@gnome.org" date="2009-09-01" status="done"/> + </revision> <credit type="author"> <name>Milo Casagrande</name> <email>milo@ubuntu.com</email> </credit> + <credit type="author"> + <name>Shaun McCance</name> + <email>shaunm@gnome.org</email> + </credit> <copyright> <year>2009</year> <name>GNOME Documentation Project</name> @@ -20,78 +25,45 @@ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" /> </info> - <title>Status icons</title> + <title>Status Types and Icons</title> - <table frame="all" rules="cols" shade="rows"> - <thead> - <tr> - <td> - <p> - Icon - </p> - </td> - <td> - <p> - Description - </p> - </td> - </tr> - </thead> - <tbody> - <tr> - <td> - <p> - <media type="image" mime="image/png" src="figures/available.png"> - Available icon - </media> - </p> - </td> - <td> - <p> - This is the default icon for the <em>Available</em> status. - </p> - <p> - Use this icon when you are availble to have conversations with other - people. - </p> - </td> - </tr> - <tr> - <td> - <p> - <media type="image" mime="image/png" src="figures/busy.png"> - Busy icon - </media> - </p> - </td> - <td> - <p> - This is the default icon for the <em>Busy</em> status. - </p> - <p> - Use this icon when you do not want to be disturbed. - </p> - </td> - </tr> - <tr> - <td> - <p> - <media type="image" mime="image/png" src="figures/away.png"> - Away icon - </media> - </p> - </td> - <td> - <p> - This is the default icon for the <em>Away</em> status. - </p> - <p> - Use this icon when you are going away from the computer. This icon - is used also when you leave the computer and the screensaver turns on. - </p> - </td> - </tr> - </tbody> - </table> + <terms> + <item> + <title><media type="image" mime="image/png" src="figures/available.png">Available icon</media> + <gui>Available</gui></title> + <p>Use the <em>Available</em> status when you are at your computer and able + to chat with your contacts. You can set a custom message for this status.</p> + </item> + <item> + <title><media type="image" mime="image/png" src="figures/busy.png">Busy icon</media> + <gui>Busy</gui></title> + <p>Use the <em>Busy</em> status to let your contacts know that you don’t want + to chat right now. They can still contact you, for instance if they have something + urgent they need to discuss. By default, <app>Empathy</app> will not use notification + bubbles and sounds when you are busy. You can set a custom message for this status.</p> + </item> + <item> + <title><media type="image" mime="image/png" src="figures/away.png">Away icon</media> + <gui>Away</gui></title> + <p>Use the <em>Away</em> status when you are going away from your computer. + <app>Empathy</app> automatically sets your status to Away if you do not use + your computer for a while, or if your screensaver is on. By default, + <app>Empathy</app> will not use notification bubbles and sounds when you are + away. You can set a custom message for this status.</p> + </item> + <item> + <title><media type="image" mime="image/png" src="figures/offline.png">Offline icon</media> + <gui>Hidden</gui></title> + <p>When you set your status to <em>Hidden</em>, you will appear as offline + to your contacts. You will still be connected to your accounts, and you + still see your contacts’ statuses and start conversations with them.</p> + </item> + <item> + <title><media type="image" mime="image/png" src="figures/offline.png">Offline icon</media> + <gui>Offline</gui></title> + <p>Setting your status to <em>Offline</em> disconnects you from all of + your accounts.</p> + </item> + </terms> </page> diff --git a/help/Makefile.am b/help/Makefile.am index b0bf927f2..32299a84f 100644 --- a/help/Makefile.am +++ b/help/Makefile.am @@ -8,7 +8,11 @@ DOC_FIGURES = \ figures/away.png \ figures/busy.png \ figures/camera-web.png \ - figures/empathy-main-window.png + figures/empathy-main-window.png \ + figures/gtk-add.png \ + figures/gtk-edit.png \ + figures/gtk-remove.png \ + figures/offline.png DOC_PAGES = \ account-irc.page \ |
