GNOME.org
 

[gnome-dictionary/wip/help-pages: 5/30] Add basic content to help pages

commit f1f5a3e2a21fd6f5222a11032954884c48c560fb
Author: Sindhu S <sindhus live in>
Date:   Wed Mar 13 00:28:12 2013 +0530

    Add basic content to help pages
    
    Add Dictionary screenshot.
    Add help instructions to save-text.page.
    Rename save-text to save-definition.page
    Add better explanation for introduction.page.
    Add help instructions on using similar words.
    Reword help instructions in defintions.page.
    Reflow paragraphs.
    Update Makefile.am.

 help/C/definition.page              |   23 +++++++++++++++++-
 help/C/figures/gnome-dictionary.png |  Bin 0 -> 14635 bytes
 help/C/index.page                   |    4 +-
 help/C/introduction.page            |   17 +++++++++++++-
 help/C/print-font.page              |   32 +++++++++++++++++++++++++-
 help/C/print.page                   |   27 +++++++++++++++++++++-
 help/C/save-defintion.page          |   43 +++++++++++++++++++++++++++++++++++
 help/C/save-text.page               |   24 -------------------
 help/C/similar-words.page           |   36 ++++++++++++++++++++++++++--
 help/C/strategies.page              |    4 ++-
 help/C/text-operations.page         |   13 +++++++++-
 help/Makefile.am                    |    3 +-
 12 files changed, 189 insertions(+), 37 deletions(-)
---
diff --git a/help/C/definition.page b/help/C/definition.page
index 184bec9..bbc0ff8 100644
--- a/help/C/definition.page
+++ b/help/C/definition.page
@@ -3,10 +3,10 @@
       id="definition">
 
   <info>
-    <revision version="0.1" date="2013-03-06" status="draft"/>
+    <revision version="0.1" date="2013-03-23" status="review"/>
     <link type="guide" xref="index#features"/>
     <!--link type="guide" xref=""/-->
-
+    <link type="seealso" xref="sources"/>
     <credit type="author copyright">
       <name>Sindhu S</name>
       <email>sindhus live in</email>
@@ -21,4 +21,23 @@
 
   <title>Look up definitions</title>
 
+  <p>Meanings of words explain their origin, importance and their usage in
+  language. To look up a definition:</p>
+
+  <steps>
+    <item>
+      <p>In the text entry next to <gui style="button">Look up:</gui>, type the
+      desired term.</p>
+    </item>
+    <item>
+      <p>Press <gui style="button">Look up:</gui> or <key>Enter</key> to let
+      <app>Dictionary</app> search the definition from a
+      <link xref="sources-select">selected dictionary source</link>.</p>
+    </item>
+  </steps>
+
+  <note style="tip">
+    <p>You can press <keyseq><key>Ctrl</key><key>T</key></keyseq> and view
+    <link xref="similar-words">similar words</link> to your search term.</p>
+  </note>
 </page>
diff --git a/help/C/figures/gnome-dictionary.png b/help/C/figures/gnome-dictionary.png
new file mode 100644
index 0000000..4d84bd9
Binary files /dev/null and b/help/C/figures/gnome-dictionary.png differ
diff --git a/help/C/index.page b/help/C/index.page
index d779dae..2b7f9a6 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -3,7 +3,7 @@
       id="index">
 
   <info>
-    <revision version="0.1" date="2013-03-06" status="draft"/>
+    <revision version="0.1" date="2013-03-23" status="review"/>
     <title type="link">Dictionary</title>
     <title type="text">Dictionary</title>
 
@@ -25,7 +25,7 @@
   </title>
 
     <section id="features" style="1column">
-    <title>Main features</title>
+    <title>Features</title>
   </section>
 
  <section id="preferences" style="2column">
diff --git a/help/C/introduction.page b/help/C/introduction.page
index 8ee1c89..ca5f779 100644
--- a/help/C/introduction.page
+++ b/help/C/introduction.page
@@ -3,7 +3,7 @@
       id="introduction">
 
   <info>
-    <revision version="0.1" date="2013-03-06" status="draft"/>
+    <revision version="0.1" date="2013-03-23" status="review"/>
     <link type="guide" xref="index"/>
     <!--link type="guide" xref=""/-->
 
@@ -21,4 +21,19 @@
 
   <title>Introduction</title>
 
+  <p><app>Dictionary</app> is a program to search and view definitions of\
+  words, phrases for a language or subject of your choice.
+  <app>Dictionary</app> searches for definitions using a <app>DICT</app>
+  server located on the Internet. The default DICT server is at
+  <link href="http://dict.org";>http://dict.org</link>.</p>
+
+  <p>If you do not have access to an Internet connection, you can also install
+  offline <app>DICT</app> server.</p>
+
+  <figure>
+    <title>Dictionary</title>
+    <desc>Screenshot of <app>Dictionary</app></desc>
+    <media type="image" src="figures/gnome-dictionary.png" width="700">
+    </media>
+  </figure>
 </page>
diff --git a/help/C/print-font.page b/help/C/print-font.page
index 94c1e17..88cc8fb 100644
--- a/help/C/print-font.page
+++ b/help/C/print-font.page
@@ -3,7 +3,7 @@
       id="print-font">
 
   <info>
-    <revision version="0.1" date="2013-03-06" status="draft"/>
+    <revision version="0.1" date="2013-03-28" status="review"/>
     <link type="guide" xref="index#preferences"/>
     <!--link type="guide" xref=""/-->
 
@@ -21,4 +21,34 @@
 
   <title>Print font</title>
 
+  <p>You can select custom font and size to print defintions. To select font
+  for printing defintions:</p>
+
+  <steps>
+    <item>
+      <p>Select <guiseq><gui style="menu">Dictionary</gui>
+      <gui style="menuitem">Preferences</gui>
+      <gui style="tab">Print</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>Click the button next to <gui>Font:</gui>.</p>
+    </item>
+    <item>
+      <p>Browse fonts from the list and click to select the desired font.
+      Alternatively you can search the font by name in the text input bar.</p>
+    </item>
+    <item>
+      <p>Drag the slider forward to increase the font size. Alternatively, you
+      can input the font size in the text box and use <gui>+</gui> to increase
+      or <gui>-</gui> to decrease the font size.</p>
+    </item>
+    <item>
+      <p>Click <gui style="button">Select</gui> to confirm choice of font and
+      size selection.</p>
+    </item>
+    <item>
+      <p>Click <gui style="button">Close</gui> to exit <gui>Preferences</gui>
+      dialog and return to <app>Dictionary</app>.</p>
+    </item>
+  </steps>
 </page>
diff --git a/help/C/print.page b/help/C/print.page
index 63159d3..22eaa2b 100644
--- a/help/C/print.page
+++ b/help/C/print.page
@@ -19,6 +19,31 @@
 
   </info>
 
-  <title>Print defintions</title>
+  <title>Preview and Printing defintions</title>
+
+  <section id="preview">
+    <title>Print preview definitions</title>
+
+    <p></p>
+  </section>
+
+  <section id="print">
+    <title>Print defintions</title>
+
+    <p>You can print definitions to your local or remote printer. To print defintions you have looked up:</p>
+
+    <steps>
+      <item>
+        <p>Select <guiseq><gui style="menu">File</gui><gui style="menuitem">Print</gui></guiseq>.</p>
+      </item>
+      <item>
+        <p><!--Change print page layout, size etc --></p>
+      </item>
+      <item>
+        <p>Click <gui style="button">Print</gui> to send the selected definition to your printer.</p>
+      </item>
+    </steps>
+
+  </section>
 
 </page>
diff --git a/help/C/save-defintion.page b/help/C/save-defintion.page
new file mode 100644
index 0000000..4451226
--- /dev/null
+++ b/help/C/save-defintion.page
@@ -0,0 +1,43 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="task"
+      id="save-text">
+
+  <info>
+    <revision version="0.1" date="2013-03-28" status="review"/>
+    <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>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <desc>Save definitions on file.</desc>
+
+  </info>
+
+  <title>Save definitions</title>
+
+  <p><app>Dictionary</app> allows you to save definitions for future reference
+  onto a text file.</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>Input the desired filename along with the file extension,
+      <code>.txt</code> in the <gui>Save a Copy…</gui> dialog. You can also
+      browse and select the desired directory for the file to be saved
+      onto.</p>
+    </item>
+    <item>
+      <p>Click <gui style="button">Save</gui> to save the definition to file.</p>
+    </item>
+  </steps>
+</page>
diff --git a/help/C/similar-words.page b/help/C/similar-words.page
index 90a133a..a2c127e 100644
--- a/help/C/similar-words.page
+++ b/help/C/similar-words.page
@@ -3,8 +3,9 @@
       id="similar-words">
 
   <info>
-    <revision version="0.1" date="2013-03-06" status="draft"/>
+    <revision version="0.1" date="2013-03-28" status="review"/>
     <link type="guide" xref="index#features"/>
+    <link type="seealso" xref="sources-guide"/>
     <!--link type="guide" xref=""/-->
 
     <credit type="author copyright">
@@ -15,10 +16,39 @@
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
-    <desc>Search similar words.</desc>
+    <desc>Search dictionaries for similar words.</desc>
 
   </info>
 
-  <title>Find related words</title>
+  <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>
+
+  <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>
+    </item>
+    <item>
+      <p>To close the <gui>Similar Words</gui> sidebar click the <gui>x</gui>
+      button.</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/strategies.page b/help/C/strategies.page
index 7d2b0f4..0547497 100644
--- a/help/C/strategies.page
+++ b/help/C/strategies.page
@@ -19,6 +19,8 @@
 
   </info>
 
-  <title>Available strategies</title>
+  <title><app>Search</app> strategies</title>
+
+  <p></p>
 
 </page>
diff --git a/help/C/text-operations.page b/help/C/text-operations.page
index 35b59f8..72f1184 100644
--- a/help/C/text-operations.page
+++ b/help/C/text-operations.page
@@ -15,10 +15,21 @@
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
-    <desc>Operations on text <app>Dictionary</app>.</desc>
+    <desc>Copy defintions as text.</desc>
 
   </info>
 
   <title>Text operations</title>
 
+  <p>You can copy definitions from <app>Dictionary</app> to pasted as text into other applications of 
choice. To copy a definition:</p>
+
+    <steps>
+      <item>
+        <p>Drag and select desired text portions in <app>Dictionary</app>.</p>
+      </item>
+      <item>
+        <p>Select <guiseq><gui style="menu">Edit</gui><gui style="menuitem">Copy</gui></guiseq>.</p>
+      </item>
+    </steps>
+
 </page>
diff --git a/help/Makefile.am b/help/Makefile.am
index dbc3851..492a4e8 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -17,5 +17,6 @@ HELP_FILES = \
           text-operations.page \
 HELP_MEDIA = \
        figures/gnome-dictionary-icon.png       \
+       figures/gnome-dictionary.png
+HELP_LINGUAS = ca cs da de el en_GB es eu fi fr gl id it oc ru sl sv uk zh_CN
 
-HELP_LINGUAS = ca cs da de el en_GB es eu fi fr gl id it oc pt_BR ru sl sv uk zh_CN
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]