[orca] Remove incorrect/obsolete information from Orca's help content
- From: Joanmarie Diggs <joanied src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [orca] Remove incorrect/obsolete information from Orca's help content
- Date: Mon, 30 Sep 2013 13:17:34 +0000 (UTC)
commit 024218f89df2b5af5b2551259f29271f572d10bd
Author: Joanmarie Diggs <jdiggs igalia com>
Date: Mon Sep 30 09:15:25 2013 -0400
Remove incorrect/obsolete information from Orca's help content
help/C/commands_controlling_orca.page | 34 +++++++++-------------
help/C/howto_learn_modes.page | 22 ++++++--------
help/C/howto_setting_up_orca.page | 50 ++++-----------------------------
help/C/howto_text_setup.page | 24 +--------------
help/C/howto_the_orca_modifier.page | 2 +-
help/C/introduction.page | 36 ++++++++++--------------
help/C/preferences_braille.page | 13 --------
7 files changed, 48 insertions(+), 133 deletions(-)
---
diff --git a/help/C/commands_controlling_orca.page b/help/C/commands_controlling_orca.page
index fb468d8..d2c3da2 100644
--- a/help/C/commands_controlling_orca.page
+++ b/help/C/commands_controlling_orca.page
@@ -20,26 +20,27 @@
<title>Commands for Controlling <app>Orca</app></title>
<p>
The following commands can be used to get into <app>Orca</app>'s
- Preferences dialogs, quit <app>Orca</app>, and bypass <app>Orca</app>
- commands to avoid shortcut conflicts within the application being accessed.
+ Preferences dialogs, toggle <app>Orca</app> on and off, and bypass
+ <app>Orca</app> commands to avoid shortcut conflicts within the
+ application being accessed.
</p>
<list>
<item>
<p>
- <link xref="preferences">Orca Preferences</link> dialog:
- <keyseq><key>Orca Modifier</key><key>Space</key></keyseq>.
+ Toggle <app>Orca</app> on and off in GNOME:
+ <keyseq><key>Super</key><key>Alt</key><key>S</key></keyseq>.
</p>
</item>
<item>
<p>
- Orca's Preferences dialog for the focused application:
- <keyseq><key>Ctrl</key><key>Orca Modifier</key><key>Space</key></keyseq>.
+ <link xref="preferences">Orca Preferences</link> dialog:
+ <keyseq><key>Orca Modifier</key><key>Space</key></keyseq>.
</p>
</item>
<item>
<p>
- Quit <app>Orca</app>:
- <keyseq><key>Orca Modifier</key><key>Q</key></keyseq>.
+ Orca's Preferences dialog for the focused application:
+ <keyseq><key>Ctrl</key><key>Orca Modifier</key><key>Space</key></keyseq>.
</p>
</item>
<item>
@@ -53,11 +54,10 @@
<section id="learning">
<title>Commands for Learning to Use <app>Orca</app></title>
<p>
- Orca has two modes for learning more about <app>Orca</app>'s commands:
- Learn Mode and List Shortcuts Mode. In Learn Mode, <app>Orca</app> will
- announce each keystroke you pressed along with any associated
- <app>Orca</app> command that keystroke is bound to. List Shortcuts Mode
- provides you with a list of all the <app>Orca</app> commands you can use.
+ In Learn Mode, <app>Orca</app> will announce each keystroke you pressed
+ along with any associated <app>Orca</app> command that keystroke is bound
+ to. In this mode, you can also get a list of shortcuts containing all the
+ <app>Orca</app> commands you can use.
</p>
<list>
<item>
@@ -68,13 +68,7 @@
</item>
<item>
<p>
- Enter list shortcuts mode:
- <keyseq><key>Orca Modifier</key><key>H</key></keyseq> (double-clicked)
- </p>
- </item>
- <item>
- <p>
- Exit either mode:
+ Exit learn mode:
<keyseq><key>Esc</key></keyseq>
</p>
</item>
diff --git a/help/C/howto_learn_modes.page b/help/C/howto_learn_modes.page
index eecaa21..1d98b75 100644
--- a/help/C/howto_learn_modes.page
+++ b/help/C/howto_learn_modes.page
@@ -2,7 +2,7 @@
<info>
<link type="guide" xref="index#getting_started" />
<link type="next" xref="howto_keyboard_layout" />
- <title type="sort">5. The "Learn" Modes</title>
+ <title type="sort">5. "Learn" Mode</title>
<desc>
Discovering <app>Orca</app>'s commands
</desc>
@@ -14,14 +14,12 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
- <title>The "Learn" Modes</title>
+ <title>"Learn" Mode</title>
<p>
- Orca has two modes for learning more about <app>Orca</app>'s commands:
- Learn Mode and List Shortcuts Mode. In Learn Mode, <app>Orca</app>
- will announce each keystroke you pressed along with any associated
- <app>Orca</app> command that keystroke is bound to. List Shortcuts
- Mode provides you with a list of all the <app>Orca</app> commands
- you can use.
+ In Learn Mode, <app>Orca</app> will announce each keystroke you pressed
+ along with any associated <app>Orca</app> command that keystroke is bound
+ to. In this mode, you can also get a list of shortcuts containing all the
+ <app>Orca</app> commands you can use.
</p>
<steps>
<title>Using Learn Mode</title>
@@ -42,11 +40,11 @@
</item>
</steps>
<steps>
- <title>Using List Shortcuts Mode</title>
+ <title>Getting a List of Shortcuts</title>
<item>
<p>
- Get into List Shortcuts Mode by pressing <keyseq><key>Orca Modifier</key>
- <key>H</key></keyseq> twice quickly.
+ Get into Learn Mode by pressing <keyseq><key>Orca Modifier</key>
+ <key>H</key></keyseq>.
</p>
</item>
<item>
@@ -64,7 +62,7 @@
</item>
<item>
<p>
- Press <key>Esc</key> to exit List Shortcuts Mode.
+ Press <key>Esc</key> to exit the list.
</p>
</item>
</steps>
diff --git a/help/C/howto_setting_up_orca.page b/help/C/howto_setting_up_orca.page
index 0593bba..40989f8 100644
--- a/help/C/howto_setting_up_orca.page
+++ b/help/C/howto_setting_up_orca.page
@@ -3,10 +3,10 @@
<link type="seealso" xref="preferences" />
<link type="guide" xref="index#getting_started" />
<link type="next" xref="howto_the_orca_modifier" />
- <title type="sort">3. Orca Configuration</title>
+ <title type="sort">4. Orca Configuration</title>
<title type="link">Configuration</title>
<desc>
- Setting up <app>Orca</app> initially and in the future
+ Setting up <app>Orca</app>
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
@@ -17,47 +17,17 @@
</license>
</info>
<title>Orca Configuration</title>
- <section id="initial_setup">
- <title>Initial Setup</title>
- <p>
- When you run <app>Orca</app> for the first time, it will automatically
- enter setup mode. Depending on your active session's configuration,
- one of two things will occur:
- </p>
- <list>
- <item>
- <p>
- If accessibility support has already been enabled for your
- session, you will be placed in the <app>Orca</app>
- <link xref="preferences">Preferences</link> dialog box where
- you can customize <app>Orca</app> completely and then use it
- immediately.
- </p>
- </item>
- <item>
- <p>
- If accessibility support has not already been enabled for your
- session, <app>Orca</app>'s <link xref="howto_text_setup">text-based
- setup</link> will be launched instead. The text-based setup allows
- you to configure the most fundamental settings and enable
- accessibility support for your session. You will need to log out
- and log back in for the new settings to take effect.
- </p>
- </item>
- </list>
- </section>
<section id="configuring_orca">
- <title>Configuring <app>Orca</app> in the Future</title>
<p>
- If you want to configure <app>Orca</app> in the future, you can do one
+ If you want to configure <app>Orca</app>, you can do one
of the following:
</p>
<list>
<item>
<p>
- Pass the <cmd>--setup</cmd> option to <app>Orca</app> the next
- time you run it to automatically be placed in the <link
- xref="preferences">Preferences</link> dialog box.
+ Get into the <link xref="preferences">Preferences</link> dialog
+ by pressing <keyseq><key>Orca Modifier</key><key>Space</key>
+ </keyseq> from within any accessible application.
</p>
</item>
<item>
@@ -67,14 +37,6 @@
setup</link>.
</p>
</item>
- <item>
- <p>
- Get into the <link xref="preferences">Preferences</link> dialog
- box by pressing the <gui>Preferences</gui> button in the <app>Orca</app>
- main window or by pressing <keyseq><key>Orca Modifier</key><key>Space</key>
- </keyseq> from within any accessible application.
- </p>
- </item>
</list>
</section>
</page>
diff --git a/help/C/howto_text_setup.page b/help/C/howto_text_setup.page
index b0264f6..117fa6b 100644
--- a/help/C/howto_text_setup.page
+++ b/help/C/howto_text_setup.page
@@ -165,29 +165,9 @@
recover gracefully and function even if it cannot find BrlTTY.
</p>
</item>
- <item>
- <p>Enable Braille Monitor</p>
- <p>
- Orca's Braille Monitor is an on-screen braille representation. This is
- mostly for sighted developers who need to verify BrlTTY output, but may
- also be useful in other situations, such as visually diagnosing or verifying
- braille output. Type <cmd>y</cmd> or <cmd>n</cmd> and press <key>Return</key>.
- </p>
- </item>
- <item>
- <p>Automatically start <app>Orca</app> when you log in</p>
- <p>
- Type <cmd>y</cmd> if you want <app>Orca</app> automatically launched for you
- or <cmd>n</cmd> if you do not, and press <key>Return</key>.
- </p>
- </item>
</steps>
<p>
- That's it. <app>Orca</app> is now ready for use. If accessibility was not
- yet enabled, <app>Orca</app> does so now and asks you to logout and back
- in for the services to start. Type <cmd>y</cmd> and press <key>Return</key>
- to restart your login session. If, on the other hand, accessibility was
- already enabled, you will simply be prompted to press <key>Return</key>
- after which <app>Orca</app> will be launched for you.
+ That's it. <app>Orca</app> is now ready for use and will be launched if
+ you are in a graphical desktop environment where accessibility is enabled.
</p>
</page>
diff --git a/help/C/howto_the_orca_modifier.page b/help/C/howto_the_orca_modifier.page
index 2c98e34..9d97e06 100644
--- a/help/C/howto_the_orca_modifier.page
+++ b/help/C/howto_the_orca_modifier.page
@@ -2,7 +2,7 @@
<info>
<link type="guide" xref="index#getting_started"/>
<link type="next" xref="howto_learn_modes" />
- <title type="sort">4. The Orca Modifier</title>
+ <title type="sort">3. The Orca Modifier</title>
<desc>
A key that works like <key>Shift</key>, <key>Ctrl</key>,
and <key>Alt</key>
diff --git a/help/C/introduction.page b/help/C/introduction.page
index 314245f..35a96c3 100644
--- a/help/C/introduction.page
+++ b/help/C/introduction.page
@@ -35,13 +35,6 @@
<list>
<item>
<p>
- Type <cmd>orca</cmd>, along with any optional parameters, in a
- terminal window or within the <gui>Run</gui> dialog and then press
- <key>Return</key>.
- </p>
- </item>
- <item>
- <p>
The method for configuring <app>Orca</app> to be launched
automatically as your preferred screen reader will depend upon
which desktop environment you use. For instance, in GNOME 3.x
@@ -49,25 +42,26 @@
panel on the <gui>Seeing</gui> page.
</p>
</item>
+ <item>
+ <p>
+ To toggle <app>Orca</app> on and off in GNOME, press
+ <keyseq><key>Super</key><key>Alt</key><key>S</key></keyseq>.
+ </p>
+ </item>
+ <item>
+ <p>
+ Type <cmd>orca</cmd>, along with any optional parameters, in a
+ terminal window or within the <gui>Run</gui> dialog and then press
+ <key>Return</key>.
+ </p>
+ </item>
</list>
</section>
- <section id="quitting">
- <title>Quitting <app>Orca</app></title>
- <p>To quit <app>Orca</app>:</p>
- <list>
- <item>
- <p>
- Press <keyseq><key>Orca Modifier</key><key>Q</key></keyseq>.
- This command works whether the <app>Orca</app> main window is
- enabled or not.
- </p>
- </item>
- </list>
- </section>
<section id="loadtime">
<title>Load-Time Options</title>
<p>
- The following options can be specified when launching <app>Orca</app>:
+ The following options can be specified when launching <app>Orca</app>
+ in a terminal window or within the <gui>Run</gui> dialog:
</p>
<list>
<item>
diff --git a/help/C/preferences_braille.page b/help/C/preferences_braille.page
index e5873bc..66e8010 100644
--- a/help/C/preferences_braille.page
+++ b/help/C/preferences_braille.page
@@ -35,19 +35,6 @@
</p>
</note>
</section>
- <section id="braillemonitor">
- <title>Enable Braille Monitor</title>
- <media type="image" mime="image/png" src="figures/preferences_enable_braille_monitor.png"/>
- <p>
- Orca's braille monitor provides an on-screen representation of what
- takes place on the braille display. This feature is mostly for
- demonstration purposes, but is also useful for <app>Orca</app>
- developers who do not have access to a braille display.
- </p>
- <p>
- Default value: not checked
- </p>
- </section>
<section id="contractedbraille">
<title>Enable Contracted Braille</title>
<media type="image" mime="image/png" src="figures/preferences_braille_contracted.png"/>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]