GNOME.org
 

[gnome-dictionary/wip/help-pages: 19/21] Review sources pages

commit 416da580a79b68b58195f0292c42d3c89b1f23d0
Author: Ekaterina Gerasimova <kittykat3756 gmail com>
Date:   Sat Mar 30 17:13:18 2013 +0000

    Review sources pages
    
    Move sources-guide.page index page to sources.page to be consistent with
    gnome-user-docs naming. Update links to it.
    
    Define "dictionary source" in sources.page. Bug 358960.
    
    Change page title to use sentence capitalisation.

 help/C/similar-words.page                   |    2 +-
 help/C/sources-default.page                 |   30 ++++++++--------
 help/C/sources-delete.page                  |   33 +++++++++---------
 help/C/sources-edit.page                    |   49 ++++++++++++++------------
 help/C/sources-select.page                  |   22 ++++++-----
 help/C/{sources-guide.page => sources.page} |   21 +++++++----
 6 files changed, 84 insertions(+), 73 deletions(-)
---
diff --git a/help/C/similar-words.page b/help/C/similar-words.page
index 648d4e0..abb3972 100644
--- a/help/C/similar-words.page
+++ b/help/C/similar-words.page
@@ -5,7 +5,7 @@
   <info>
     <revision pkgversion="3.6" version="0.1" date="2013-03-28" status="candidate"/>
     <link type="guide" xref="index#features"/>
-    <link type="seealso" xref="sources-guide"/>
+    <link type="seealso" xref="sources"/>
 
     <credit type="author copyright">
       <name>Sindhu S</name>
diff --git a/help/C/sources-default.page b/help/C/sources-default.page
index 49852fc..b2d7e03 100644
--- a/help/C/sources-default.page
+++ b/help/C/sources-default.page
@@ -3,15 +3,19 @@
       id="sources-default">
 
   <info>
-    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="review"/>
-    <link type="guide" xref="sources-guide#guide"/>
-    <!--link type="guide" xref=""/-->
+    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="candidate"/>
+    <link type="guide" xref="sources#guide"/>
 
     <credit type="author copyright">
       <name>Sindhu S</name>
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="copyright editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+      <years>2013</years>
+    </credit>
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
@@ -19,28 +23,24 @@
 
   <title>Set a default dictionary source</title>
 
-  <p>The default dictionary source in <app>Dictionary</app> is to set to
-  <sys href="http://dict.org";>dict.org</sys>. <app>Dictionary</app> can look
-  up definitions from dictionary sources of your choice. This is useful if you
-  often look up terms in a dictionary source other than the default.</p>
+  <p>When you first use <app>Dictionary</app>, it should have some
+  pre-installed dictionaries that you can use. You can change the default
+  <link xref="sources">dictionary source</link> to one that you would
+  prefer to use instead.</p>
 
   <steps>
-    <title>To set a defualt dictionary source:</title>
+    <title>Change the default dictionary source:</title>
     <item>
       <p>Select <guiseq><gui><app>Dictionary</app></gui>
       <gui style="menu">Preferences</gui>
       <gui style="tab">Source</gui></guiseq>.</p>
     </item>
     <item>
-      <p>From the list below <gui style="radiobutton">Select a dictionary
-      source for looking up words:</gui>, select the desired dictionary source
-      to be set as the default.</p>
+      <p>Select the dictionary source that you want to set as the default.</p>
     </item>
     <item>
-      <p>Click <gui style="button">Close</gui> to close the
-      <gui><app>Dictionary</app> Preferences</gui> dialog and return to
-      <app>Dictionary</app>.</p>
+      <p>Your change will be saved automatically.</p>
     </item>
   </steps>
 
-</page>
\ No newline at end of file
+</page>
diff --git a/help/C/sources-delete.page b/help/C/sources-delete.page
index 542b67d..b35f4bf 100644
--- a/help/C/sources-delete.page
+++ b/help/C/sources-delete.page
@@ -3,47 +3,48 @@
       id="sources-delete">
 
   <info>
-    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="review"/>
-    <link type="guide" xref="sources-guide#guide"/>
+    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="candidate"/>
+    <link type="guide" xref="sources#guide"/>
     <link type="seealso" xref="prob-retrieving-definition"/>
-    <!--link type="guide" xref=""/-->
 
     <credit type="author copyright">
       <name>Sindhu S</name>
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="copyrighti editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3767 gmail com</email>
+      <years>2013</years>
+    </credit>
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
   </info>
 
-  <title>Delete Dictionary Sources</title>
+  <title>Delete a dictionary source</title>
 
-  <p>When some <link xref="sources-add-remote">dictionary sources</link>
-  stop working for you or if you do not require a particular dictionary
-  source, you may choose to delete such dictionary sources.</p>
+  <p>If you no longer need a specific
+  <link xref="sources">dictionary source</link> or if one stops
+  working for you, you may want to delete it.</p>
 
   <steps>
-    <title>To delete a dictionary source:</title>
+    <title>Delete a dictionary source:</title>
     <item>
       <p>Select <guiseq><gui style="menu"><app>Dictionary</app></gui>
       <gui style="menuitem">Preferences</gui>
       <gui style="tab">Source</gui></guiseq>.</p>
     </item>
     <item>
-      <p>Select the desired dictionary source.</p>
+      <p>Select the dictionary source that you want to delete.</p>
     </item>
     <item>
-      <p>Click <gui style="button">Remove</gui>.</p>
-      <note style="warning">
-        <p>A dictionary source once deleted cannot be restored.</p>
-      </note>
+      <p>Press <gui style="button">Remove</gui>.</p>
     </item>
     <item>
-      <p>To close the <gui>Dictionary Preferences</gui> dialog and return to
-      <app>Dictionary</app>, click
-      <gui style="button">Close</gui>.</p>
+      <p>A dialog will pop up asking you to confirm that you wish to
+      permanently delete the selected source. Once you confirm, the source will
+      be deleted.</p>
     </item>
   </steps>
 
diff --git a/help/C/sources-edit.page b/help/C/sources-edit.page
index 07765bb..3685598 100644
--- a/help/C/sources-edit.page
+++ b/help/C/sources-edit.page
@@ -3,15 +3,19 @@
       id="sources-edit">
 
   <info>
-    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="review"/>
-    <link type="guide" xref="sources-guide#guide"/>
-    <!--link type="guide" xref=""/-->
+    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="candidate"/>
+    <link type="guide" xref="sources#guide"/>
 
     <credit type="author copyright">
       <name>Sindhu S</name>
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="copyright editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+      <years>2013</years>
+    </credit>
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
@@ -19,47 +23,46 @@
 
   <title>Edit a dictionary source</title>
 
-  <p>You can customize a dictionary source to update details such as it's
-  description, remote address and so on.</p>
+  <p>You can customize a <link xref="sources">dictionary source</link> to
+  update details such as its description, remote address and so on.</p>
 
   <steps>
     <title>To edit a dictionary source:</title>
     <item>
-      <p>Select <guiseq><gui style="menu">Dictionary</gui><gui style="menuitem">Preferences</gui><gui 
style="tab">Source</gui></guiseq>.</p>
+      <p>Select <guiseq><gui style="menu">Dictionary</gui>
+      <gui style="menuitem">Preferences</gui>
+      <gui style="tab">Source</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>Double click on the dictionary source which you want to edit.</p>
     </item>
     <item>
       <p>You can edit the following fields:</p>
       <list>
         <item>
-          <p><gui style="input">Description:</gui> adds a short note about the
-          dictionary source.</p>
+          <p><gui>Description</gui> is the name of the source as it will be
+          displayed to you.</p>
         </item>
         <item>
-          <p><gui style="menu">Transport:</gui> indicates the type of 
-          server.</p>
+          <p><gui>Transport</gui> is the type of server.</p>
         </item>
         <item>
-          <p><gui style="input">Hostname:</gui> indicates the remote address
-          where the dictionary source is located.</p>
+          <p><gui>Hostname</gui> is the location of the dictionary source.</p>
         </item>
         <item>
-          <p><gui style="input">Port:</gui> indicates the remote port for the
-          associated <gui style="input">Hostname</gui>.</p>
+          <!-- TODO: explain that the user should not need to set it, maybe
+          explain when one may want to set it. -->
+          <p><gui>Port</gui>.</p>
         </item>
       </list>
     </item>
     <item>
-      <p>To view available dictionaries under the dictionary source, select
-      <guiseq><gui style="menu"><app>Dictionary</app></gui>
-      <gui style="menuitem">Preferences</gui>
-      <gui style="tab">Dictionaries</gui></guiseq>. Optionally, you may use
-      the arrow icon to refresh the list and the brush icon to clear the
-      list.</p>
+      <p>View the dictionaries that are available in the dictionary source by
+      selecting the <gui style="tab">Dictionaries</gui> tab.</p>
     </item>
     <item>
-      <p>To close the <gui>Dictionary Source</gui> dialog and return to
-      <app>Dictionary</app>, click <gui style="button">Close</gui>.</p>
+      <p>Press <gui style="button">Close</gui> to save the settings.</p>
     </item>
   </steps>
 
-</page>
\ No newline at end of file
+</page>
diff --git a/help/C/sources-select.page b/help/C/sources-select.page
index 2111fa3..08749ec 100644
--- a/help/C/sources-select.page
+++ b/help/C/sources-select.page
@@ -3,17 +3,21 @@
       id="sources-select">
 
   <info>
-    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="review"/>
-    <link type="guide" xref="sources-guide#guide"/>
+    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="candidate"/>
+    <link type="guide" xref="sources#guide"/>
     <link type="seealso" xref="sources-default"/>
     <link type="seealso" xref="dictionary-select"/>
-    <!--link type="guide" xref=""/-->
 
     <credit type="author copyright">
       <name>Sindhu S</name>
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="copyright editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+      <years>2013</years>
+    </credit>
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
@@ -21,20 +25,18 @@
 
   <title>Select a dictionary source</title>
 
-  <p><app>Dictionary</app> allows you to change the
-  <link xref="sources-default">default dictionary source</link>
-  without affecting the <link xref="index#preferences">
-  <gui>Preferences</gui></link>.</p>
+  <p>You to change the <link xref="sources">dictionary source</link>
+  that you are currently using without changing your default preferences.</p>
 
   <steps>
-    <title>To temporarily change the dictionary source:</title>
+    <title>Temporarily change the dictionary source:</title>
     <item>
       <p>Select <guiseq><gui style="menu">View</gui>
       <gui style="menuitem">Dictionary Sources</gui></guiseq>.</p>
     </item>
     <item>
-      <p>Select and click on the desired dictionary source.</p>
+      <p>Double click on the dictionary source that you want to use.</p>
     </item>
   </steps>
 
-</page>
\ No newline at end of file
+</page>
diff --git a/help/C/sources-guide.page b/help/C/sources.page
similarity index 51%
rename from help/C/sources-guide.page
rename to help/C/sources.page
index eb6e451..fb62e8b 100644
--- a/help/C/sources-guide.page
+++ b/help/C/sources.page
@@ -1,9 +1,9 @@
 <page xmlns="http://projectmallard.org/1.0/";
       type="guide"
-      id="sources-guide">
+      id="sources">
 
   <info>
-    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="review"/>
+    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="candidate"/>
     <link type="guide" xref="index#preferences"/>
     <link type="seealso" xref="definition"/>
 
@@ -12,19 +12,24 @@
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="copyright editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+      <years>2013</years>
+    </credit>
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
-    <desc>Manage various <app>Dictionary</app> sources.</desc>
+    <desc>Manage various dictionary sources.</desc>
 
   </info>
 
-  <title><app>Dictionary</app> sources</title>
+  <title>Dictionary sources</title>
 
-  <p>Dictionaries are collections of terms and their meanings. A 
-  <gui><app>Dictionary</app> source</gui> is an online or offline resource
-  containing many dictionaries. Each dictionary contains terms particular to a
-  language or subject.</p>
+  <p><app>Dictionary</app> uses <em>dictionary sources</em> to look up words
+  that you search for. Dictionary sources are collections of one or more
+  dictionary databases which are usually online, but can be installed on your
+  machine as well.</p>
 
   <section id="guide" style="2column">
     <title>Manage your dictionary sources</title>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]