GNOME.org
 

[orca] Doc rewrite in progress: More Structural Navigation content, added table navigation content

commit d85589e47ade6f845072ca2cc9f0c65997e9d4ad
Author: Joanmarie Diggs <joanmarie diggs gmail com>
Date:   Fri Dec 17 16:17:57 2010 -0500

    Doc rewrite in progress: More Structural Navigation content, added table navigation content

 help/C/howto_structural_navigation.page |   31 +++++++-
 help/C/howto_tables.page                |  130 ++++++++++++++++++++++++++++++-
 help/C/howto_whereami.page              |    2 +-
 help/C/preferences_speech.page          |    2 +-
 4 files changed, 159 insertions(+), 6 deletions(-)
---
diff --git a/help/C/howto_structural_navigation.page b/help/C/howto_structural_navigation.page
index 97608ab..5cab2da 100644
--- a/help/C/howto_structural_navigation.page
+++ b/help/C/howto_structural_navigation.page
@@ -42,14 +42,41 @@
         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>
+      <note style="tip">
+        <title>Don't Forget To Toggle Structural Navigation On!</title>
+        <p>
+          Depending on where you are, it may be necessary for you to explicitly
+          toggle Structural Navigation on before you can use it.
+        </p>
+      </note>
+      <section id="toggling_required">
+        <title>When Toggling Structural Navigation On Is Required</title>
+        <p>
+          In web pages, explicitly toggling Structural Navigation on is
+          generally unnecessary because your interaction with the document
+          largely consists of reading its content. Thus there is no question
+          as to whether the 'H' you just pressed was meant to be a writing
+          command or a navigation command.
+        </p>
+        <p>
+          On the other hand, in editable documents such as those found in
+          <app>OpenOffice</app> and <app>LibreOffice</app>, it is far more
+          difficult for <app>Orca</app> to accurately predict what you expect
+          to have happen as a result of pressing 'H'. Therefore, before you
+          can use any Structural Navigation command in an editable document,
+          you must first toggle Structural Navigation on by pressing
+          <keyseq><key>Orca Modifier</key><key>Z</key></keyseq>.
+          When you are finished navigating and ready to resume writing, press
+          <keyseq><key>Orca Modifier</key><key>Z</key></keyseq> again to toggle
+          Structural Navigation off.
+        </p>
+      </section>
   </section>
   <section id="settings">
     <title>Available Settings</title>
diff --git a/help/C/howto_tables.page b/help/C/howto_tables.page
index d563e04..479aa01 100644
--- a/help/C/howto_tables.page
+++ b/help/C/howto_tables.page
@@ -14,8 +14,134 @@
       <p>Creative Commons Share Alike 3.0</p>
     </license>
   </info>
-  <title>Tables (WRITE ME)</title>
+  <title>Tables</title>
   <p>
-    Write me
+    <app>Orca</app> provides several features specifically designed to improve
+    access to tables found in web pages and other documents: configurable cell
+    versus row reading, <link xref="howto_structural_navigation">Structural
+    Navigation</link> and Dynamic Headers.
   </p>
+  <section id="cell_row">
+    <title>Cell Versus Row Reading</title>
+    <p>
+      Consider the process of examining the list of messages in your Inbox.
+      In order to have Orca announce the sender, subject, date, and presence
+      of attachments you would need <app>Orca</app> to speak the row. On the
+      other hand, when navigating amongst rows in a spreadsheet, hearing the
+      full row may not be desired if for no other reason than the sheer number
+      of cells in each row. Thus in that case, you would want <app>Orca</app>
+      to only speak the cell with focus. Similar situations occur in document
+      tables.
+    </p>
+    <p>
+      <app>Orca</app> allows you to customize whether only the cell should be
+      read, or if the full row should be. You can set this preference Orca wide
+      as well as on an application-by-application basis. How to do each is
+      described in the guide on <link xref="preferences"><app>Orca</app>'s
+      preferences dialogs</link>. The setting can be found in the <gui>Table
+      Rows</gui> radio button group on the <link xref="preferences_speech">
+      <gui>Speech</gui> page</link>.
+    </p>
+    <p>
+      In addition, there is an <app>Orca</app> command which allows you to
+      toggle this setting on the fly: <keyseq><key>Orca Modifier</key>
+      <key>F11</key></keyseq>.
+    </p>
+  </section>
+  <section id="structural_navigation">
+    <title>Structural Navigation</title>
+    <p>
+      <app>Orca</app>'s <link xref="commands_structural_navigation#tables">table
+      Structural Navigation commands</link> make it possible for you to quickly
+      locate tables, jump immediately to a table's first or last cell, and
+      move to the next cell in any direction.
+    </p>
+    <p>
+      As you navigate amongst and within tables using Structural Navigation,
+      <app>Orca</app> will announce additional details to help you understand
+      your position, such as the dimensions of the table you just entered and
+      the fact that you have reached the edge of the table in the direction you
+      are moving.
+    </p>
+    <p>
+      In addition, <app>Orca</app> provides configurable
+      <link xref="preferences_structural_navigation">presentation options</link>
+      which work in conjunction with Structural Navigation and allow you to
+      control whether or not cell coordinates are presented, multiple cell spans
+      are indicated, and cell headers are announced.
+    </p>
+    <note style="tip">
+      <title>Don't Forget To Toggle Structural Navigation On!</title>
+      <p>
+        Depending on where you are, it may be necessary for you to explicitly
+        toggle Structural Navigation on before you can use it. To learn more, read
+        <link type="seealso" xref="howto_structural_navigation#toggling_required">
+        when toggling Structural Navigation on is required.</link>
+      </p>
+    </note>
+  </section>
+  <section id="dynamic_headers">
+    <title>Dynamic Headers</title>
+    <p>
+      Many of the tables you will encounter while reading have cells which serve
+      as the header for a row or a column. Whether or not the creator of that
+      table correctly marked those cells as headers is hard to say. In many
+      cases, the text was simply formatted to be larger and/or bold. And even if
+      the table is correctly marked up, that is no guarantee that the application
+      or toolkit exposes that text as header information to assistive technologies.
+      <app>Orca</app>'s Dynamic Header support makes it possible to overcome these
+      challenges.
+    </p>
+    <p>
+      To set column headers:
+    </p>
+    <steps>
+      <item>
+        <p>
+          Move to the row which contains all of the column headers.
+        </p>
+      </item>
+      <item>
+        <p>
+          Press <keyseq><key>Orca Modifier</key><key>R</key></keyseq> to tell
+          <app>Orca</app> that the current row is the one with the headers.
+        </p>
+      </item>
+    </steps>
+    <p>
+      To set row headers:
+    </p>
+    <steps>
+      <item>
+        <p>
+          Move to the column which contains all of the row headers.
+        </p>
+      </item>
+      <item>
+        <p>
+          Press <keyseq><key>Orca Modifier</key><key>C</key></keyseq> to tell
+          <app>Orca</app> that the current column is the one with the headers.
+        </p>
+      </item>
+    </steps>
+    <p>
+      Having set either the column headers or the row headers, you should find
+      that as you navigate amongst the cells, <app>Orca</app> will present each
+      header that has changed. Or to put it another way, <app>Orca</app> will
+      not present the column header over and over again as you move up or down
+      within the current column. Likewise, it will not present the row header
+      over and over again as you move left or right within the current row.
+      However, if you change rows and there are row headers, the header
+      associated with the new row will be presented. And if you change columns
+      and there are column headers, the header associated with the new column
+      will be presented.
+    </p>
+    <p>
+      To clear headers, simply double-click the command you used to set them.
+      Thus double-clicking <keyseq><key>Orca Modifier</key><key>R</key></keyseq>
+      tells <app>Orca</app> there are no row headers. Double-clicking 
+      <keyseq><key>Orca Modifier</key><key>C</key></keyseq> tells <app>Orca</app>
+      there are no column headers.
+    </p>
+  </section>
 </page>
diff --git a/help/C/howto_whereami.page b/help/C/howto_whereami.page
index b2a270c..ef145e6 100644
--- a/help/C/howto_whereami.page
+++ b/help/C/howto_whereami.page
@@ -4,7 +4,7 @@
     <link type="next" xref="howto_flat_review" />
     <title type="sort">1. WhereAmI</title>
     <desc>
-      Identifying and learning about your location
+      Learning about your location
     </desc>
     <credit type="author">
       <name>Joanmarie Diggs</name>
diff --git a/help/C/preferences_speech.page b/help/C/preferences_speech.page
index f6aed8f..d25d6bd 100644
--- a/help/C/preferences_speech.page
+++ b/help/C/preferences_speech.page
@@ -132,7 +132,7 @@
       options are <gui>speak row</gui> and <gui>speak cell</gui>.
     </p>
     <p>
-      Consider the process of examinging the list of messages in your Inbox.
+      Consider the process of examining the list of messages in your Inbox.
       In order to have <app>Orca</app> announce the sender, subject, date,
       and presence of attachments you would need <gui>speak row</gui>. On
       the other hand, when navigating amongst rows in a spreadsheet, hearing
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]