GNOME.org
 

[orca] Docs rewrite in progress: Added structural navigation; made miscellaneous tweaks

commit 0303b7a5ca94c4ee6d25d32144622b7bdb7dcbbf
Author: Joanmarie Diggs <joanmarie diggs gmail com>
Date:   Thu Dec 16 22:44:46 2010 -0500

    Docs rewrite in progress: Added structural navigation; made miscellaneous tweaks

 help/C/commands_structural_navigation.page        |    3 +-
 help/C/howto_documents.page                       |    2 +-
 help/C/{howto_web_forms.page => howto_forms.page} |    8 +-
 help/C/howto_profiles.page                        |   15 ++--
 help/C/howto_reading_web.page                     |   95 --------------------
 help/C/howto_structural_navigation.page           |   96 +++++++++++++++++++++
 help/C/howto_tables.page                          |    6 +-
 help/C/howto_text_attributes.page                 |   11 ++-
 help/Makefile.am                                  |    4 +-
 9 files changed, 123 insertions(+), 117 deletions(-)
---
diff --git a/help/C/commands_structural_navigation.page b/help/C/commands_structural_navigation.page
index 874d0ae..7277f57 100644
--- a/help/C/commands_structural_navigation.page
+++ b/help/C/commands_structural_navigation.page
@@ -2,8 +2,7 @@
   <info>
     <link type="next" xref="commands_table" />
     <link type="guide" xref="commands#reading_documents" />
-    <link type="seealso" xref="howto_reading_web"  />
-    <link type="seealso" xref="howto_web_forms"  />
+    <link type="seealso" xref="howto_forms"  />
     <title type="sort">2. Structural Navigation</title>
     <title type="link">Structural Navigation</title>
     <desc>
diff --git a/help/C/howto_documents.page b/help/C/howto_documents.page
index 3997595..e104324 100644
--- a/help/C/howto_documents.page
+++ b/help/C/howto_documents.page
@@ -4,7 +4,7 @@
     <link type="next" xref="howto_text_attributes" />
     <title type="sort">1. Documents</title>
     <desc>
-      Reading textual information
+      Reading content
     </desc>
     <credit type="author">
       <name>Joanmarie Diggs</name>
diff --git a/help/C/howto_web_forms.page b/help/C/howto_forms.page
similarity index 72%
rename from help/C/howto_web_forms.page
rename to help/C/howto_forms.page
index d49ec6a..e94c0a9 100644
--- a/help/C/howto_web_forms.page
+++ b/help/C/howto_forms.page
@@ -1,10 +1,10 @@
-<page xmlns="http://projectmallard.org/1.0/"; type="topic" id="howto_web_forms">
+<page xmlns="http://projectmallard.org/1.0/"; type="topic" id="howto_forms">
   <info>
     <link type="guide" xref="index#reading"/>
-    <link type="next" xref="howto_tables" />
-    <title type="sort">4. Form Controls</title>
+     <link type="next" xref="howto_live_regions" />
+    <title type="sort">5. Form Controls</title>
     <desc>
-      Interacting with embedded widgets
+      Accessing widgets embedded in documents
     </desc>
     <credit type="author">
       <name>Joanmarie Diggs</name>
diff --git a/help/C/howto_profiles.page b/help/C/howto_profiles.page
index 2536369..7f7be55 100644
--- a/help/C/howto_profiles.page
+++ b/help/C/howto_profiles.page
@@ -23,8 +23,8 @@
     <steps>
       <item>
         <p>
-          Get into the <link xref="preferences"><link xref="preferences">Orca
-          Preferences</link></link> dialog box.
+          Get into the <link xref="preferences">Orca
+          Preferences</link> dialog box.
         </p>
       </item>
       <item>
@@ -55,8 +55,8 @@
     <steps>
       <item>
         <p>
-          Get into the <link xref="preferences"><link xref="preferences">Orca
-          Preferences</link></link> dialog box.
+          Get into the <link xref="preferences">Orca Preferences</link> dialog
+          box.
         </p>
       </item>
       <item>
@@ -84,7 +84,8 @@
     <steps>
       <item>
         <p>
-          Follow the steps described above to load the profile you wish to change.
+          Follow the steps described above to load the profile you wish to
+          change.
         </p>
       </item>
       <item>
@@ -111,8 +112,8 @@
     <steps>
       <item>
         <p>
-          Get into the <link xref="preferences"><link xref="preferences">Orca
-          Preferences</link></link> dialog box.
+          Get into the <link xref="preferences">Orca
+          Preferences</link> dialog box.
         </p>
       </item>
       <item>
diff --git a/help/C/howto_structural_navigation.page b/help/C/howto_structural_navigation.page
new file mode 100644
index 0000000..97608ab
--- /dev/null
+++ b/help/C/howto_structural_navigation.page
@@ -0,0 +1,96 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="howto_structural_navigation">
+  <info>
+    <link type="guide" xref="index#reading"/>
+    <link type="next" xref="howto_tables" />
+    <title type="sort">3. Structural Navigation</title>
+    <desc>
+      Moving by heading and other elements
+    </desc>
+    <credit type="author">
+      <name>Joanmarie Diggs</name>
+      <email>joanied gnome org</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+  <title>Structural Navigation</title>
+  <p>
+    <app>Orca</app>'s Structural Navigation feature allows you to navigate
+    amongst elements in a document. The types of elements by which you can
+    navigate include:
+  </p>
+  <list>
+    <item><p>Headings and other text blocks</p></item>
+    <item><p>Form controls</p></item>
+    <item><p>Links</p></item>
+    <item><p>Lists and list items</p></item>
+    <item><p>Landmarks, separators, and anchors</p></item>
+    <item><p>Tables and table cells</p></item>
+  </list>
+  <p>
+    A full list of individual elements and their associated keybindings can
+    be found in <link xref="commands_structural_navigation">Structural
+    Navigation Commands</link>.
+  </p>
+  <section id="applications">
+      <title>Supported Applications</title>
+      <p>
+        Currently, Structural Navigation is fully implemented for web content,
+        including the help content you are reading now. <app>Orca</app>'s
+        Structural Navigation support for table cells has also been implemented
+        for <app>OpenOffice Writer</app> and <app>LibreOffice Writer</app>.
+      </p>
+      <p>
+        Implementing the remainder of the Structural Navigation objects to
+        these office suites requires changes to be made by their respective
+        developers. Implementing any Structural Navigation features within
+        <app>Evince</app> will require a similar effort on the part of its
+        developers.
+      </p>
+  </section>
+  <section id="settings">
+    <title>Available Settings</title>
+    <p>
+      In addition to the aforementioned commands, <app>Orca</app> has a number of
+      <link xref="preferences_structural_navigation">configurable options</link>
+      available specifically for applications in which there is structural
+      navigation support. To access these options:
+    </p>
+    <steps>
+      <item>
+        <p>
+          Give focus to an application for which <app>Orca</app> has
+          Structural Navigation support.
+        </p>
+      </item>
+      <item>
+        <p>
+          Get into the <link xref="preferences">Orca Preferences</link>
+          dialog box for the current application by pressing:
+          <keyseq>
+            <key>Ctrl</key><key>Orca Modifier</key><key>Space</key>
+          </keyseq>
+        </p>
+      </item>
+      <item>
+        <p>
+          Navigate to the last page of the dialog box which should be
+          named according to the name of your current application.
+        </p>
+      </item>
+      <item>
+        <p>
+         Examine and change the settings as you see fit.
+        </p>
+      </item>
+      <item>
+        <p>
+          Press the <gui>OK</gui> button.
+        </p>
+      </item>
+    </steps>
+  </section>
+</page>
diff --git a/help/C/howto_tables.page b/help/C/howto_tables.page
index 5541414..d563e04 100644
--- a/help/C/howto_tables.page
+++ b/help/C/howto_tables.page
@@ -1,10 +1,10 @@
 <page xmlns="http://projectmallard.org/1.0/"; type="topic" id="howto_tables">
   <info>
     <link type="guide" xref="index#reading"/>
-    <link type="next" xref="howto_live_regions" />
-    <title type="sort">5. Tables</title>
+    <link type="next" xref="howto_forms" />
+    <title type="sort">4. Tables</title>
     <desc>
-      Accessing document tables efficiently
+      Navigating and setting dynamic headers
     </desc>
     <credit type="author">
       <name>Joanmarie Diggs</name>
diff --git a/help/C/howto_text_attributes.page b/help/C/howto_text_attributes.page
index f1ff511..7b133f3 100644
--- a/help/C/howto_text_attributes.page
+++ b/help/C/howto_text_attributes.page
@@ -1,10 +1,10 @@
 <page xmlns="http://projectmallard.org/1.0/"; type="topic" id="howto_text_attributes">
   <info>
     <link type="guide" xref="index#reading"/>
-    <link type="next" xref="howto_reading_web" />
-    <title type="sort">2. Obtaining Text Attribute Information</title>
+    <link type="next" xref="howto_structural_navigation" />
+    <title type="sort">2. Text Attributes</title>
     <desc>
-      Obtaining formatting details
+      Examining text formatting
     </desc>
     <credit type="author">
       <name>Joanmarie Diggs</name>
@@ -15,6 +15,11 @@
     </license>
   </info>
   <title>Text Attributes</title>
+  <p>
+    The term "text attributes" refers to all of the font, style, alignment,
+    and other formatting associated with a given character or series of
+    characters.
+  </p>
   <section>
     <title>Obtaining Formatting Information</title>
     <p>
diff --git a/help/Makefile.am b/help/Makefile.am
index 9c1dc3f..7d5cb29 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -25,6 +25,7 @@ DOC_PAGES = \
 	howto_bookmarks.page \
 	howto_documents.page \
 	howto_flat_review.page \
+	howto_forms.page \
 	howto_key_bindings.page \
 	howto_keyboard_layout.page \
 	howto_learn_modes.page \
@@ -33,14 +34,13 @@ DOC_PAGES = \
 	howto_notifications.page \
 	howto_orca_find.page \
 	howto_profiles.page \
-	howto_reading_web.page \
 	howto_setting_up_orca.page \
+	howto_structural_navigation.page \
 	howto_tables.page \
 	howto_text_attributes.page \
 	howto_text_setup.page \
 	howto_the_orca_modifier.page \
 	howto_toggling_caps_lock.page \
-	howto_web_forms.page \
 	howto_whereami.page \
 	index.page \
 	introduction.page \
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]