[gnome-dictionary/mallard-help] Review help pages

From: Ekaterina Gerasimova <egerasimov src gnome org>
To: commits-list gnome org
Cc:
Subject: [gnome-dictionary/mallard-help] Review help pages
Date: Sat, 30 Mar 2013 16:13:47 +0000 (UTC)
commit d0cd5e96e485d0edb082f7f6a44d20980c5343dc
Author: Ekaterina Gerasimova <kittykat3756 gmail com>
Date:   Sat Mar 30 14:51:36 2013 +0000

    Review help pages
    
    Fix link in legal.xml
    
    Review index.page and introduction.page: mark as final.
    
    Shorten prob-error-while-retrieving-definition to
    prob-retrieving-definition because it was repeating itself and it is
    best to keep page names short. Update links to match the new page ID.
    
    Similar Words shows other dictionaries in the source, not other sources.
    Update the page so that it is more precise.

 help/C/index.page                                  |    4 +-
 help/C/introduction.page                           |    5 +-
 help/C/legal.xml                                   |    4 +-
 help/C/prob-error-while-retrieving-definition.page |   47 -------------------
 help/C/prob-retrieving-definition.page             |   49 ++++++++++++++++++++
 help/C/similar-words.page                          |   36 ++++++--------
 help/C/sources-delete.page                         |    4 +-
 7 files changed, 73 insertions(+), 76 deletions(-)
---
diff --git a/help/C/index.page b/help/C/index.page
index 891210f..fbe284a 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -3,7 +3,7 @@
       id="index">
 
   <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="final"/>
     <title type="link">Dictionary</title>
     <title type="text">Dictionary</title>
 
@@ -15,7 +15,7 @@
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
-    <desc>Look up words using dictionary sources.</desc>
+    <desc>Look up word definitions in <app>Dictionary</app>.</desc>
   </info>
 
   <title>
diff --git a/help/C/introduction.page b/help/C/introduction.page
index 201ec6a..70a7d3b 100644
--- a/help/C/introduction.page
+++ b/help/C/introduction.page
@@ -3,7 +3,7 @@
       id="introduction">
 
   <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="final"/>
     <link type="guide" xref="index"/>
 
     <credit type="author copyright">
@@ -27,7 +27,7 @@
 
   <p><app>Dictionary</app> is an application for looking up term definitions.
   It searches for definitions using an online <app>DICT</app> server. The
-  default DICT server is at
+  default <app>DICT</app> server is at
   <sys href="http://dict.org";>http://dict.org</sys>.</p>
 
   <p>Start using <app>Dictionary</app> by
@@ -39,4 +39,5 @@
       <p>Screenshot showing the <app>Dictionary</app> main window.</p>
     </media>
   </figure>
+
 </page>
diff --git a/help/C/legal.xml b/help/C/legal.xml
index ef697e5..e8a7696 100644
--- a/help/C/legal.xml
+++ b/help/C/legal.xml
@@ -1,4 +1,4 @@
 <license xmlns="http://projectmallard.org/1.0/";>
 
-<p>This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a 
copy of this license, visit <link 
xref="http://creativecommons.org/licenses/by-sa/3.0/";>http://creativecommons.org/licenses/by-sa/3.0/</link> 
or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.</p>
-</license>
\ No newline at end of file
+<p>This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a 
copy of this license, visit <link 
href="http://creativecommons.org/licenses/by-sa/3.0/";>http://creativecommons.org/licenses/by-sa/3.0/</link> 
or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.</p>
+</license>
diff --git a/help/C/prob-retrieving-definition.page b/help/C/prob-retrieving-definition.page
new file mode 100644
index 0000000..44b3406
--- /dev/null
+++ b/help/C/prob-retrieving-definition.page
@@ -0,0 +1,49 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="task"
+      id="prob-retrieving-definition">
+
+  <info>
+    <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="candidate"/>
+    <link type="guide" xref="index#troubleshooting"/>
+    <link type="seealso" xref="definition"/>
+
+    <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"/>
+
+    <desc><sys>Error while retrieving definitions</sys>.</desc>
+
+  </info>
+
+  <title>Cannot find definitions</title>
+
+  <p>If you see the error message
+  <sys>Error while retrieving definition</sys> when looking up a definition
+  from any of the <link xref="sources-select">selected dictionaries</link>,
+  the problem is more likely one of the following:</p>
+
+  <list>
+    <item>
+      <p>One or more of the selected <app>DICT</app> servers that are used to
+      look up definitions may not be working. You can try waiting a while
+      before <link xref="definition">looking up</link> the definition
+      again.</p>
+    </item>
+    <item>
+      <p>You may not have a working Internet connection. For
+      <app>Dictionary</app> to look up terms, your computer
+      <link href="help:gnome-help/net">must be able to connect</link> to
+      <sys href="http://dict.org";>dict.org</sys>.</p>
+    </item>
+  </list>
+
+</page>
diff --git a/help/C/similar-words.page b/help/C/similar-words.page
index 31fb2b7..648d4e0 100644
--- a/help/C/similar-words.page
+++ b/help/C/similar-words.page
@@ -3,52 +3,46 @@
       id="similar-words">
 
   <info>
-    <revision pkgversion="3.6" version="0.1" date="2013-03-28" status="review"/>
+    <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="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"/>
 
-    <desc>Search dictionaries for similar words.</desc>
+    <desc>View related results in other dictionaries.</desc>
 
   </info>
 
   <title>Similar words</title>
 
-  <p><app>Dictionary</app> searches for terms similar to your
-  searched term from dictionary sources other than the default. To view similar
-  words:</p>
+  <p><app>Dictionary</app> will only display the definition from one your
+  dictionaries. To check if there are search results in other dictionaries:</p>
 
   <steps>
     <item>
       <p><link xref="definition">Look up</link> the desired term.</p>
-    <note style="tip">
-     <p>If the sidebar is not already visible, select
-     <guiseq><gui style="menu">View</gui>
-     <gui style="menuitem">Similar Words</gui></guiseq>.</p>
-    </note>
     </item>
     <item>
-      <p>The <gui>Similar Words</gui> sidebar will now show expressions same as
-      the searched term from other dictionary sources. To view the similar
-      word, double click on the desired entry. The definition will be
-      displayed in <app>Dictionary</app>.</p>
+      <p>If the sidebar is not already visible, select
+      <guiseq><gui style="menu">View</gui>
+      <gui style="menuitem">Similar Words</gui></guiseq>.</p>
     </item>
     <item>
-      <p>To close the <gui>Similar Words</gui> sidebar click the <gui>x</gui>
-      button.</p>
+      <p>The <gui>Similar Words</gui> sidebar will show search results from
+      other dictionaries in your selected dictionary source. To view the
+      similar word, double click on the entry.</p>
     </item>
   </steps>
 
-  <note style="tip">
-    <p>If you are experiencing delays when searching for similar words, press
-    the brush icon below the sidebar to refresh the search.</p>
-  </note>
 </page>
diff --git a/help/C/sources-delete.page b/help/C/sources-delete.page
index e445db0..542b67d 100644
--- a/help/C/sources-delete.page
+++ b/help/C/sources-delete.page
@@ -5,7 +5,7 @@
   <info>
     <revision pkgversion="3.6" version="0.1" date="2013-03-30" status="review"/>
     <link type="guide" xref="sources-guide#guide"/>
-    <link type="seealso" xref="prob-error-while-retrieving-definition"/>
+    <link type="seealso" xref="prob-retrieving-definition"/>
     <!--link type="guide" xref=""/-->
 
     <credit type="author copyright">
@@ -47,4 +47,4 @@
     </item>
   </steps>
 
-</page>
\ No newline at end of file
+</page>
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]