GNOME.org
 

[gnome-dictionary/wip/help-pages: 19/25] Review save-definition help page

commit ba0a603ef763d78a9dac248268e49a01022aab20
Author: Ekaterina Gerasimova <kittykat3756 gmail com>
Date:   Fri Mar 29 15:54:03 2013 +0000

    Review save-definition help page

 help/C/dictionary-select.page                      |   50 +++++++++++++
 help/C/{shortcuts.page => keyboard-shortcuts.page} |   74 +++++++++----------
 help/C/prob-error-while-retrieving-definition.page |   33 +++++++--
 help/C/save-definition.page                        |   47 ++++++++++++
 help/C/save-defintion.page                         |   43 -----------
 help/C/sources-add-local.page                      |   23 ------
 ...dd-remote.page => sources-add-remote.page.stub} |    6 ++
 help/C/sources-default.page                        |   26 +++++++-
 ...ources-delete.page => sources-delete.page.stub} |    2 +
 .../{sources-edit.page => sources-edit.page.stub}  |    0
 help/C/sources-guide.page                          |   11 ++--
 help/C/sources-select.page                         |   18 +++++-
 help/C/{strategies.page => strategies.page.stub}   |    0
 help/C/text-operations.page                        |    2 +-
 help/Makefile.am                                   |    5 +-
 15 files changed, 217 insertions(+), 123 deletions(-)
---
diff --git a/help/C/dictionary-select.page b/help/C/dictionary-select.page
new file mode 100644
index 0000000..1ff4e3e
--- /dev/null
+++ b/help/C/dictionary-select.page
@@ -0,0 +1,50 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="task"
+      id="dictionary-select">
+
+  <info>
+    <revision version="0.1" date="2013-03-30" status="review"/>
+    <link type="guide" xref="index#features"/>
+    <link type="seealso" xref="sources-default"/>
+    <!--link type="guide" xref=""/-->
+
+    <credit type="author copyright">
+      <name>Sindhu S</name>
+      <email>sindhus live in</email>
+      <years>2013</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+  </info>
+
+  <title>Select a dictionary</title>
+
+  <p>A single dictionary source may have many dictionaries related to various
+  subjects and languages. You can search terms from any of these
+  dictionaries.</p>
+
+  <steps>
+    <title>To select a dictionary:</title>
+    <item>
+      <p>Select <guiseq><gui style="menu">View</gui><gui style="menuitem">Available 
Databases</gui></guiseq>. The sidebar will pop up listing the
+      available dictionaries for your default set dictionary source.</p>
+    </item>
+    <item>
+      <p>Select and click the desired dictionary.</p>
+    </item>
+    <item>
+      <p><link xref="definition">Look up</link> the definition for the desired
+      term.</p>
+    </item>
+  </steps>
+
+  <note style="important">
+    <p>Unless you select another dictionary or open a new instance of
+    <app>Dictionary</app> or restart <app>Dictionary</app>, throughout the
+    current session of <app>Dictionary</app>, terms you search
+    will be looked up from the selected dictionary. By default in a new
+    instance, a term will searched from the first dictionary from the
+    <gui>Available Dictionaries</gui> list.</p>
+  </note>
+</page>
\ No newline at end of file
diff --git a/help/C/shortcuts.page b/help/C/keyboard-shortcuts.page
similarity index 63%
rename from help/C/shortcuts.page
rename to help/C/keyboard-shortcuts.page
index ac8cf35..4745ce4 100644
--- a/help/C/shortcuts.page
+++ b/help/C/keyboard-shortcuts.page
@@ -1,42 +1,45 @@
 <page xmlns="http://projectmallard.org/1.0/";
       xmlns:ui="http://projectmallard.org/experimental/ui/";
       type="task"
-      id="shortcuts">
+      id="keyboard-shortcuts">
 
   <info>
-    <revision version="0.1" date="2013-03-28" status="review"/>
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="candidate"/>
     <link type="guide" xref="index#features"/>
-    <!--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>Use keyboard shortcuts</desc>
+    <desc>You can use keyboard shortcuts to navigate around <app>Dictionary</app> more efficiently.</desc>
 
   </info>
 
-  <title>Keyboard Shortcuts</title>
+  <title>Keyboard shortcuts</title>
 
-  <p>Keyboard shortcuts are a combination of keys that allow you to do routine
-  tasks such as selecting and copying text quickly. The following shortcuts
-  are available:</p>
+  <p>Keyboard shortcuts are combinations of keys that you can use instead of
+  navigating through the menu. The following shortcuts are available:</p>
 
   <table rules="rows" frame="top bottom" ui:expanded="yes">
-    <title><app>Dictionary</app> window shortcuts:</title>
+    <title>Navigate around <app>Dictionary</app></title>
     <thead>
       <tr>
-        <td><p>To Do This</p></td>
-        <td><p>Press This</p></td>
+        <td><p>Action</p></td>
+        <td><p>Shortcut</p></td>
       </tr>
     </thead>
     <tbody>
       <tr>
-        <td><p>Preview</p></td>
+        <td><p>Print preview</p></td>
         <td><p><keyseq><key>Shift</key><key>Ctrl</key><key>P</key></keyseq></p></td>
       </tr>
       <tr>
@@ -59,60 +62,52 @@
   </table>
 
   <table rules="rows" frame="top bottom" ui:expanded="yes">
-    <title>Text operation shortcuts:</title>
+    <title>Search shortcuts</title>
     <thead>
       <tr>
-        <td><p>To Do This</p></td>
-        <td><p>Press This</p></td>
+        <td><p>Action</p></td>
+        <td><p>Shortcut</p></td>
       </tr>
     </thead>
     <tbody>
       <tr>
-        <td><p>Open Find bar</p></td>
-        <td><p><key>/</key></p></td>
+        <td><p>Search within a definition</p></td>
+        <td><p><key>/</key> or <keyseq><key>Ctrl</key><key>F</key></keyseq></p></td>
       </tr>
       <tr>
-        <td><p>Find Next</p></td>
+        <td><p>Find next</p></td>
         <td><p><keyseq><key>Ctrl</key><key>G</key></keyseq></p></td>
       </tr>
       <tr>
-        <td><p>Find Previous</p></td>
+        <td><p>Find previous</p></td>
         <td><p><keyseq><key>Shift</key><key>Ctrl</key><key>G</key></keyseq></p></td>
       </tr>
-      <tr>
-        <td><p>Select all text</p></td>
-        <td><p><keyseq><key>Ctrl</key><key>A</key></keyseq></p></td>
-      </tr>
-      <tr>
-        <td><p>Copy text</p></td>
-        <td><p><keyseq><key>Ctrl</key><key>C</key></keyseq></p></td>
-      </tr>
     </tbody>
   </table>
 
   <table rules="rows" frame="top bottom" ui:expanded="yes">
-    <title>Search and navigate results shortcuts:</title>
+    <title>Navigate within a definition</title>
     <thead>
       <tr>
-        <td><p>To Do This</p></td>
-        <td><p>Press This</p></td>
+        <td><p>Action</p></td>
+        <td><p>Shortcut</p></td>
       </tr>
     </thead>
     <tbody>
       <tr>
-        <td><p>Previous Definition</p></td>
+        <td><p>Previous definition</p></td>
         <td><p><keyseq><key>Ctrl</key><key>Page Up</key></keyseq></p></td>
       </tr>
       <tr>
-        <td><p>Next Definition</p></td>
+        <td><p>Next definition</p></td>
         <td><p><keyseq><key>Ctrl</key><key>Page Down</key></keyseq></p></td>
       </tr>
       <tr>
-        <td><p>First Definition</p></td>
+        <td><p>First definition</p></td>
         <td><p><keyseq><key>Ctrl</key><key>Home</key></keyseq></p></td>
       </tr>
       <tr>
-        <td><p>Last Definition</p></td>
+        <td><p>Last definition</p></td>
         <td><p><keyseq><key>Ctrl</key><key>End</key></keyseq></p></td>
       </tr>
     </tbody>
@@ -122,8 +117,8 @@
     <title><app>Dictionary</app> definitions shortcuts:</title>
     <thead>
       <tr>
-        <td><p>To Do This</p></td>
-        <td><p>Press This</p></td>
+        <td><p>Action</p></td>
+        <td><p>Shortcut</p></td>
       </tr>
     </thead>
     <tbody>
@@ -132,17 +127,18 @@
         <td><p><keyseq><key>Ctrl</key><key>T</key></keyseq></p></td>
       </tr>
       <tr>
-        <td><p>Dictionary Sources</p></td>
+        <td><p>Dictionary sources</p></td>
         <td><p><keyseq><key>Ctrl</key><key>D</key></keyseq></p></td>
       </tr>
       <tr>
-        <td><p>Available Databases</p></td>
+        <td><p>Available databases</p></td>
         <td><p><keyseq><key>Ctrl</key><key>B</key></keyseq></p></td>
       </tr>
       <tr>
-        <td><p>Available Strategies</p></td>
+        <td><p>Available strategies</p></td>
         <td><p><keyseq><key>Ctrl</key><key>R</key></keyseq></p></td>
       </tr>
     </tbody>
   </table>
+
 </page>
diff --git a/help/C/prob-error-while-retrieving-definition.page 
b/help/C/prob-error-while-retrieving-definition.page
index b8563a6..cdcbfee 100644
--- a/help/C/prob-error-while-retrieving-definition.page
+++ b/help/C/prob-error-while-retrieving-definition.page
@@ -1,9 +1,9 @@
 <page xmlns="http://projectmallard.org/1.0/";
       type="task"
-      id="error-while-retrieving-definition">
+      id="prob-error-while-retrieving-definition">
 
   <info>
-    <revision version="0.1" date="2013-03-28" status="review"/>
+    <revision pkgversion="3.6" date="2013-03-30" status="review"/>
     <link type="guide" xref="index#troubleshooting"/>
     <link type="seealso" xref="definitions"/>
     <!--link type="guide" xref=""/-->
@@ -16,11 +16,32 @@
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
-    <desc>What do I do?</desc>
+    <desc><sys>Error while retreiving definitions</sys>.</desc>
 
   </info>
 
-  <title>"Error while retreiving definition" message</title>
+  <title>Can't Find Definitions</title>
 
-  <p></p>
-</page>
+  <p>If you receive the error message:
+  <sys>Error while retreiving definition</sys> when looking up a definition
+  from any of the <link xref="sources-select">selected dictionaries</link>,
+  the following is most likely to have happened:</p>
+
+  <list>
+    <item>
+      <p>One or more of the selected <app>DICT</app> servers that are used to
+      look up definitions could be offline. You can try
+      <link xref="definition">looking up</link> the definition after
+      sometime.</p>
+    </item>
+    <item>
+      <p>You may not be connected to the Internet. For <app>Dictionary</app>
+      to look up terms, your computer must be connected to the Internet with
+      servers that are able to find <sys href="http://dict.org";>dict.org</sys>.
+      You can consult <app>GNOME</app> help to
+      <link xref="help:gnome-help/net">set up an internet
+      connection</link>.</p>
+    </item>
+  </list>
+
+</page>
\ No newline at end of file
diff --git a/help/C/save-definition.page b/help/C/save-definition.page
new file mode 100644
index 0000000..a39cdc1
--- /dev/null
+++ b/help/C/save-definition.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="task"
+      id="save-text">
+
+  <info>
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="candidate"/>
+    <link type="guide" xref="index#features"/>
+
+    <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>Save a copy of a definition to a text file.</desc>
+
+  </info>
+
+  <title>Save a definition</title>
+
+  <p>You can save a definition to a text file. This may be useful if you want
+  to use it outside of <app>Dictionary</app>.</p>
+
+  <steps>
+    <title>To save a definition:</title>
+    <item>
+      <p>Select <guiseq><gui style="menu">File</gui>
+      <gui style="menuitem">Save a Copy…</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>Chose where you want to save the definition to and a name for the
+      file. You may want to add a <file>.txt</file> file extention to the end
+      of the file name.</p>
+    </item>
+    <item>
+      <p>Press <gui style="button">Save</gui> to save the definition.</p>
+    </item>
+  </steps>
+
+</page>
diff --git a/help/C/source-add-remote.page b/help/C/sources-add-remote.page.stub
similarity index 87%
rename from help/C/source-add-remote.page
rename to help/C/sources-add-remote.page.stub
index d5f2c89..16122f3 100644
--- a/help/C/source-add-remote.page
+++ b/help/C/sources-add-remote.page.stub
@@ -19,5 +19,11 @@
 
   <title>Add remote dictionary sources</title>
 
+  <p></p>
 
+  <steps>
+    <item>
+      <p></p>
+    </item>
+  </steps>
 </page>
\ No newline at end of file
diff --git a/help/C/sources-default.page b/help/C/sources-default.page
index e3450a4..c848502 100644
--- a/help/C/sources-default.page
+++ b/help/C/sources-default.page
@@ -3,7 +3,7 @@
       id="sources-default">
 
   <info>
-    <revision version="0.1" date="2013-03-06" status="draft"/>
+    <revision version="0.1" date="2013-03-30" status="review"/>
     <link type="guide" xref="sources-guide#guide"/>
     <!--link type="guide" xref=""/-->
 
@@ -19,4 +19,28 @@
 
   <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>
+
+  <steps>
+    <title>To set a defualt 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>
+    </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>
+    </item>
+  </steps>
+
 </page>
\ No newline at end of file
diff --git a/help/C/sources-delete.page b/help/C/sources-delete.page.stub
similarity index 96%
rename from help/C/sources-delete.page
rename to help/C/sources-delete.page.stub
index 6e58398..39f7869 100644
--- a/help/C/sources-delete.page
+++ b/help/C/sources-delete.page.stub
@@ -19,5 +19,7 @@
 
   <title>Remove dictionary sources</title>
 
+  <p></p>
+
 
 </page>
\ No newline at end of file
diff --git a/help/C/sources-edit.page b/help/C/sources-edit.page.stub
similarity index 100%
rename from help/C/sources-edit.page
rename to help/C/sources-edit.page.stub
diff --git a/help/C/sources-guide.page b/help/C/sources-guide.page
index 9d93049..d82893b 100644
--- a/help/C/sources-guide.page
+++ b/help/C/sources-guide.page
@@ -3,7 +3,7 @@
       id="sources-guide">
 
   <info>
-    <revision version="0.1" date="2013-03-28" status="review"/>
+    <revision version="0.1" date="2013-03-30" status="review"/>
     <link type="guide" xref="index#preferences"/>
     <link type="seealso" xref="definition"/>
 
@@ -21,11 +21,10 @@
 
   <title><app>Dictionary</app> sources</title>
 
-  <p><gui><app>Dictionary</app> sources</gui> are collections of terms and
-  their meanings. Each dictionary source contains terms particular to a
-  language or subject. Individually, each dictionary source is called a
-  <em>Dictionary</em>. You can install various dictionaries (both online and
-  offline) related to your interest.</p>
+  <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>
 
   <section id="guide" style="2column">
     <title>Manage your dictionary sources</title>
diff --git a/help/C/sources-select.page b/help/C/sources-select.page
index 80d34f1..2189592 100644
--- a/help/C/sources-select.page
+++ b/help/C/sources-select.page
@@ -3,9 +3,10 @@
       id="sources-select">
 
   <info>
-    <revision version="0.1" date="2013-03-28" status="review"/>
+    <revision version="0.1" date="2013-03-30" status="review"/>
     <link type="guide" xref="sources-guide#guide"/>
     <link type="seealso" xref="sources-default"/>
+    <link type="seealso" xref="dictionary-select"/>
     <!--link type="guide" xref=""/-->
 
     <credit type="author copyright">
@@ -20,5 +21,20 @@
 
   <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>
+
+  <steps>
+    <title>To 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>
+    </item>
+  </steps>
 
 </page>
\ No newline at end of file
diff --git a/help/C/strategies.page b/help/C/strategies.page.stub
similarity index 100%
rename from help/C/strategies.page
rename to help/C/strategies.page.stub
diff --git a/help/C/text-operations.page b/help/C/text-operations.page
index 9d79b9a..e6ca599 100644
--- a/help/C/text-operations.page
+++ b/help/C/text-operations.page
@@ -5,7 +5,7 @@
   <info>
     <revision version="0.1" date="2013-03-28" status="review"/>
     <link type="guide" xref="index#features"/>
-    <link type="seealso" xref="shortcuts"/>
+    <link type="seealso" xref="keyboard-shortcuts"/>
     <!--link type="guide" xref=""/-->
 
     <credit type="author copyright">
diff --git a/help/Makefile.am b/help/Makefile.am
index 37a618f..4bd6ceb 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -4,9 +4,11 @@ HELP_ID = gnome-dictionary
 
 HELP_FILES = \
           definition.page \
+          dictionary-select.page \
           find.page \
           index.page \
           introduction.page \
+          keyboard-shortcuts.page \
           legal.xml \
           print-font.page \
           print.page \
@@ -14,8 +16,6 @@ HELP_FILES = \
           save-definition.page \
           save-text.page \
           similar-words.page \
-          sources-guide.page \
-          shortcuts.page \
           source-add-remote.page \
           source-add-local.page \
           sources-default.page \
@@ -23,7 +23,6 @@ HELP_FILES = \
           sources-edit.page \
           sources-guide.page \
           sources-select.page \
-          strategies.page \
           text-operations.page
 HELP_MEDIA = \
        figures/gnome-dictionary-icon.png       \
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]