[orca] Continued work on bug 631123 - Orca documentation needs to be updated, converted to Mallard, augment
- From: Joanmarie Diggs <joanied src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [orca] Continued work on bug 631123 - Orca documentation needs to be updated, converted to Mallard, augment
- Date: Sun, 19 Dec 2010 06:02:42 +0000 (UTC)
commit e1f47847cdbe53d1b359cf8ca8ec79d54c8e455c
Author: Joanmarie Diggs <joanmarie diggs gmail com>
Date: Sun Dec 19 00:59:52 2010 -0500
Continued work on bug 631123 - Orca documentation needs to be updated, converted to Mallard, augmented, and moved to the Orca module
* Screenshots/figures for speech, braille, and magnifier
preferences
* More use of headings for easier navigation
* Addressed AlanC's issue regarding no definitions stated
for the various punctuation levels
.../figures/preferences_abbreviated_role_names.png | Bin 0 -> 2308 bytes
help/C/figures/preferences_advanced_button.png | Bin 0 -> 1860 bytes
help/C/figures/preferences_border.png | Bin 0 -> 5473 bytes
help/C/figures/preferences_braille_contracted.png | Bin 0 -> 6500 bytes
help/C/figures/preferences_braille_indicators.png | Bin 0 -> 12066 bytes
help/C/figures/preferences_braille_verbosity.png | Bin 0 -> 3881 bytes
.../preferences_break_speech_into_chunks.png | Bin 0 -> 3015 bytes
help/C/figures/preferences_color.png | Bin 0 -> 5246 bytes
help/C/figures/preferences_cross-hair.png | Bin 0 -> 7274 bytes
help/C/figures/preferences_cursor.png | Bin 0 -> 8510 bytes
help/C/figures/preferences_disable_eol_symbol.png | Bin 0 -> 2321 bytes
.../figures/preferences_enable_braille_monitor.png | Bin 0 -> 1932 bytes
.../figures/preferences_enable_braille_support.png | Bin 0 -> 2136 bytes
help/C/figures/preferences_enable_magnifier.png | Bin 0 -> 1924 bytes
help/C/figures/preferences_enable_speech.png | Bin 0 -> 1850 bytes
help/C/figures/preferences_magnifier_advanced.png | Bin 26397 -> 25380 bytes
.../preferences_only_speak_displayed_text.png | Bin 0 -> 2442 bytes
.../C/figures/preferences_progress_bar_updates.png | Bin 0 -> 8883 bytes
help/C/figures/preferences_punctuation_level.png | Bin 0 -> 4402 bytes
help/C/figures/preferences_rate_pitch_volume.png | Bin 0 -> 5605 bytes
help/C/figures/preferences_say_all_by.png | Bin 0 -> 2887 bytes
...references_speak_multicase_strings_as_words.png | Bin 0 -> 3096 bytes
help/C/figures/preferences_speech_verbosity.png | Bin 0 -> 3837 bytes
.../C/figures/preferences_system_voice_options.png | Bin 0 -> 6278 bytes
help/C/figures/preferences_table_rows.png | Bin 0 -> 4101 bytes
.../figures/preferences_tracking_and_alignment.png | Bin 0 -> 15814 bytes
help/C/figures/preferences_tts_options.png | Bin 0 -> 15565 bytes
help/C/figures/preferences_zoomer.png | Bin 0 -> 15094 bytes
help/C/preferences_braille.page | 61 +++-
help/C/preferences_magnifier.page | 386 ++++++++++++--------
help/C/preferences_speech.page | 354 +++++++++----------
help/Makefile.am | 27 ++
32 files changed, 476 insertions(+), 352 deletions(-)
---
diff --git a/help/C/figures/preferences_abbreviated_role_names.png b/help/C/figures/preferences_abbreviated_role_names.png
new file mode 100644
index 0000000..e6c94cf
Binary files /dev/null and b/help/C/figures/preferences_abbreviated_role_names.png differ
diff --git a/help/C/figures/preferences_advanced_button.png b/help/C/figures/preferences_advanced_button.png
new file mode 100644
index 0000000..4da534d
Binary files /dev/null and b/help/C/figures/preferences_advanced_button.png differ
diff --git a/help/C/figures/preferences_border.png b/help/C/figures/preferences_border.png
new file mode 100644
index 0000000..a1e881c
Binary files /dev/null and b/help/C/figures/preferences_border.png differ
diff --git a/help/C/figures/preferences_braille_contracted.png b/help/C/figures/preferences_braille_contracted.png
new file mode 100644
index 0000000..b9429bb
Binary files /dev/null and b/help/C/figures/preferences_braille_contracted.png differ
diff --git a/help/C/figures/preferences_braille_indicators.png b/help/C/figures/preferences_braille_indicators.png
new file mode 100644
index 0000000..de218a5
Binary files /dev/null and b/help/C/figures/preferences_braille_indicators.png differ
diff --git a/help/C/figures/preferences_braille_verbosity.png b/help/C/figures/preferences_braille_verbosity.png
new file mode 100644
index 0000000..9066e5a
Binary files /dev/null and b/help/C/figures/preferences_braille_verbosity.png differ
diff --git a/help/C/figures/preferences_break_speech_into_chunks.png b/help/C/figures/preferences_break_speech_into_chunks.png
new file mode 100644
index 0000000..cbbb84a
Binary files /dev/null and b/help/C/figures/preferences_break_speech_into_chunks.png differ
diff --git a/help/C/figures/preferences_color.png b/help/C/figures/preferences_color.png
new file mode 100644
index 0000000..2eb714e
Binary files /dev/null and b/help/C/figures/preferences_color.png differ
diff --git a/help/C/figures/preferences_cross-hair.png b/help/C/figures/preferences_cross-hair.png
new file mode 100644
index 0000000..7130ded
Binary files /dev/null and b/help/C/figures/preferences_cross-hair.png differ
diff --git a/help/C/figures/preferences_cursor.png b/help/C/figures/preferences_cursor.png
new file mode 100644
index 0000000..138d45b
Binary files /dev/null and b/help/C/figures/preferences_cursor.png differ
diff --git a/help/C/figures/preferences_disable_eol_symbol.png b/help/C/figures/preferences_disable_eol_symbol.png
new file mode 100644
index 0000000..e01c45c
Binary files /dev/null and b/help/C/figures/preferences_disable_eol_symbol.png differ
diff --git a/help/C/figures/preferences_enable_braille_monitor.png b/help/C/figures/preferences_enable_braille_monitor.png
new file mode 100644
index 0000000..ca1ccce
Binary files /dev/null and b/help/C/figures/preferences_enable_braille_monitor.png differ
diff --git a/help/C/figures/preferences_enable_braille_support.png b/help/C/figures/preferences_enable_braille_support.png
new file mode 100644
index 0000000..8c2d99b
Binary files /dev/null and b/help/C/figures/preferences_enable_braille_support.png differ
diff --git a/help/C/figures/preferences_enable_magnifier.png b/help/C/figures/preferences_enable_magnifier.png
new file mode 100644
index 0000000..8038170
Binary files /dev/null and b/help/C/figures/preferences_enable_magnifier.png differ
diff --git a/help/C/figures/preferences_enable_speech.png b/help/C/figures/preferences_enable_speech.png
new file mode 100644
index 0000000..5c3ca2a
Binary files /dev/null and b/help/C/figures/preferences_enable_speech.png differ
diff --git a/help/C/figures/preferences_magnifier_advanced.png b/help/C/figures/preferences_magnifier_advanced.png
index fe2c341..7e257ed 100644
Binary files a/help/C/figures/preferences_magnifier_advanced.png and b/help/C/figures/preferences_magnifier_advanced.png differ
diff --git a/help/C/figures/preferences_only_speak_displayed_text.png b/help/C/figures/preferences_only_speak_displayed_text.png
new file mode 100644
index 0000000..ba07ac6
Binary files /dev/null and b/help/C/figures/preferences_only_speak_displayed_text.png differ
diff --git a/help/C/figures/preferences_progress_bar_updates.png b/help/C/figures/preferences_progress_bar_updates.png
new file mode 100644
index 0000000..308acf1
Binary files /dev/null and b/help/C/figures/preferences_progress_bar_updates.png differ
diff --git a/help/C/figures/preferences_punctuation_level.png b/help/C/figures/preferences_punctuation_level.png
new file mode 100644
index 0000000..7ae16be
Binary files /dev/null and b/help/C/figures/preferences_punctuation_level.png differ
diff --git a/help/C/figures/preferences_rate_pitch_volume.png b/help/C/figures/preferences_rate_pitch_volume.png
new file mode 100644
index 0000000..dc009c1
Binary files /dev/null and b/help/C/figures/preferences_rate_pitch_volume.png differ
diff --git a/help/C/figures/preferences_say_all_by.png b/help/C/figures/preferences_say_all_by.png
new file mode 100644
index 0000000..9e951d7
Binary files /dev/null and b/help/C/figures/preferences_say_all_by.png differ
diff --git a/help/C/figures/preferences_speak_multicase_strings_as_words.png b/help/C/figures/preferences_speak_multicase_strings_as_words.png
new file mode 100644
index 0000000..2c79bb9
Binary files /dev/null and b/help/C/figures/preferences_speak_multicase_strings_as_words.png differ
diff --git a/help/C/figures/preferences_speech_verbosity.png b/help/C/figures/preferences_speech_verbosity.png
new file mode 100644
index 0000000..ec5c651
Binary files /dev/null and b/help/C/figures/preferences_speech_verbosity.png differ
diff --git a/help/C/figures/preferences_system_voice_options.png b/help/C/figures/preferences_system_voice_options.png
new file mode 100644
index 0000000..73862e0
Binary files /dev/null and b/help/C/figures/preferences_system_voice_options.png differ
diff --git a/help/C/figures/preferences_table_rows.png b/help/C/figures/preferences_table_rows.png
new file mode 100644
index 0000000..3bfabca
Binary files /dev/null and b/help/C/figures/preferences_table_rows.png differ
diff --git a/help/C/figures/preferences_tracking_and_alignment.png b/help/C/figures/preferences_tracking_and_alignment.png
new file mode 100644
index 0000000..b0ba7d4
Binary files /dev/null and b/help/C/figures/preferences_tracking_and_alignment.png differ
diff --git a/help/C/figures/preferences_tts_options.png b/help/C/figures/preferences_tts_options.png
new file mode 100644
index 0000000..4d177b2
Binary files /dev/null and b/help/C/figures/preferences_tts_options.png differ
diff --git a/help/C/figures/preferences_zoomer.png b/help/C/figures/preferences_zoomer.png
new file mode 100644
index 0000000..8f7ec5e
Binary files /dev/null and b/help/C/figures/preferences_zoomer.png differ
diff --git a/help/C/preferences_braille.page b/help/C/preferences_braille.page
index f2dacd7..e5873bc 100644
--- a/help/C/preferences_braille.page
+++ b/help/C/preferences_braille.page
@@ -18,39 +18,57 @@
<title>Braille Preferences</title>
<section id="braillesupport">
<title>Enable Braille Support</title>
+ <media type="image" mime="image/png" src="figures/preferences_enable_braille_support.png"/>
+ <p>
+ This check box toggles whether or not <app>Orca</app> will make
+ use of a braille display. If BrlTTY is not running, <app>Orca</app>
+ will recover gracefully and will not communicate with the braille
+ display.
+ </p>
+ <p>
+ Default value: not checked
+ </p>
+ <note style="tip">
<p>
- This check box toggles whether or not <app>Orca</app> will make
- use of a braille display. If BrlTTY is not running, <app>Orca</app>
- will recover gracefully and will not communicate with the braille
- display.
+ If you configure BrlTTY later on, you need to restart <app>Orca</app>
+ in order to use braille.
</p>
- <note style="tip">
- <p>
- If you configure BrlTTY later on, you need to restart <app>Orca</app>
- in order to use braille.
- </p>
- </note>
+ </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>
- <p>TODO: Get rid of the wiki reference; put basic docs here.</p>
+ <media type="image" mime="image/png" src="figures/preferences_braille_contracted.png"/>
+ <p>
+ Orca supports contracted braille via the liblouis project. Because many
+ distros include liblouis, you will likely automatically have access to
+ contracted braille support in <app>Orca</app>.
+ </p>
<p>
- Orca supports contracted braille via the liblouis project.
- Refer to the <app>Orca</app> Wiki, where you can find additional
- information about setting up liblouis with <app>Orca</app>.
+ To enable contracted braille on a system where liblouis has been installed,
+ be sure that the <gui>Enable Contraced Braille</gui> checkbox is checked.
+ Then choose your desired translation table from the <gui>Contraction
+ Table</gui> combo box.
+ </p>
+ <p>
+ Default value: not checked
</p>
</section>
<section id="rolenames">
<title>Abbreviated Role Names</title>
+ <media type="image" mime="image/png" src="figures/preferences_abbreviated_role_names.png"/>
<p>
This check box determines the manner in which role names are
displayed and can be used to help conserve real estate on the
@@ -58,25 +76,37 @@
"slider" would be displayed if abbreviated role names is not
checked; if it were checked, "sldr" would be displayed instead.
</p>
+ <p>
+ Default value: not checked
+ </p>
</section>
<section id="eolindicator">
<title>Disable end of line symbol</title>
+ <media type="image" mime="image/png" src="figures/preferences_disable_eol_symbol.png"/>
<p>
Checking this checkbox tells <app>Orca</app> to not present the
"$l" string at the end of a line of text.
</p>
+ <p>
+ Default value: not checked
+ </p>
</section>
<section id="verbosity">
<title>Verbosity</title>
+ <media type="image" mime="image/png" src="figures/preferences_braille_verbosity.png"/>
<p>
This radio button group determines the amount of information that
will be brailled in certain situations. For example, if it is set
to verbose, keyboard shortcut and role name information is displayed.
This information is not displayed in brief mode.
</p>
+ <p>
+ Default value: <gui>Verbose</gui>
+ </p>
</section>
<section id="selectionandhyperlink">
<title>Selection and Hyperlink Indicators</title>
+ <media type="image" mime="image/png" src="figures/preferences_braille_indicators.png"/>
<p>
The <gui>Selection Indicator</gui> and <gui>Hyperlink Indicator</gui>
radio button groups allow you to configure <app>Orca</app>'s behavior
@@ -86,6 +116,9 @@
can change the indicator to only be Dot 7, only be Dot 8, or not
be present at all.
</p>
+ <p>
+ Default value: <gui>Dots 7 and 8</gui>
+ </p>
<note style="tip">
<title>Text Attribute Indicators</title>
<p>
diff --git a/help/C/preferences_magnifier.page b/help/C/preferences_magnifier.page
index 5f0b9b0..fe09df3 100644
--- a/help/C/preferences_magnifier.page
+++ b/help/C/preferences_magnifier.page
@@ -18,65 +18,68 @@
<title>Magnifier Preferences</title>
<section id="enable_magnifier">
<title>Enable Magnifier</title>
- <p>
- The <gui>Enable magnifier</gui> check box enables and disables
- <app>Orca</app>'s magnification support. When it is unchecked,
- the other widgets on this page become unavailable.
- </p>
+ <media type="image" mime="image/png" src="figures/preferences_enable_magnifier.png"/>
+ <p>
+ The <gui>Enable magnifier</gui> check box enables and disables
+ <app>Orca</app>'s magnification support. When it is unchecked,
+ the other widgets on this page become unavailable.
+ </p>
+ <p>
+ Default value: not checked
+ </p>
</section>
<section id="zoomer">
<title>Zoomer</title>
+ <media type="image" mime="image/png" src="figures/preferences_zoomer.png"/>
<p>
The <gui>Zoomer</gui> options allow you to customize the magnifier's
- position, size, and level.
+ level, position, and size, as well as to hide the system pointer.
</p>
- <list>
- <item>
- <p>
- <gui>Scale factor</gui> can be used to set the magnification
- level from 1.0x to 16.0x (fractional values are supported).
- </p>
- </item>
- <item>
- <p>
- <gui>Position</gui> can be used to specify the placement of the
- magnifier on your screen. The available positions are:
- </p>
- <list>
- <item><p><gui>Full Screen</gui> (default)</p></item>
- <item><p><gui>Left Half</gui></p></item>
- <item><p><gui>Right Half</gui></p></item>
- <item><p><gui>Top Half</gui></p></item>
- <item><p><gui>Bottom Half</gui></p></item>
- <item><p><gui>Custom</gui></p></item>
- </list>
- </item>
- <item>
- <p>
- Choosing <gui>Custom</gui> causes four spin buttons to become
- available:
- </p>
- <list>
- <item><p><gui>Top</gui></p></item>
- <item><p><gui>Left</gui></p></item>
- <item><p><gui>Right</gui></p></item>
- <item><p><gui>Bottom</gui></p></item>
- </list>
- <p>
- These spin buttons allow you to define the location of each edge
- of the zoom window. Units are in pixels.
- </p>
- </item>
- <item>
- <p>
- The <gui>Hide System Pointer</gui> checkbox will hide the unmagnified
- pointer, leaving just the magnified one visible.
- </p>
- </item>
- </list>
+ <section>
+ <title>Scale factor</title>
+ <p>
+ <gui>Scale factor</gui> can be used to set the magnification
+ level from 1.0x to 16.0x (fractional values are supported).
+ </p>
+ </section>
+ <section>
+ <title>Position</title>
+ <p>
+ <gui>Position</gui> can be used to specify the placement of the
+ magnifier on your screen. The available positions are: <gui>Full
+ Screen</gui>, <gui>Left Half</gui>, <gui>Right Half</gui>, <gui>Top
+ Half</gui>, <gui>Bottom Half</gui>, and <gui>Custom</gui>.
+ </p>
+ <p>
+ Default value: <gui>Full Screen</gui>
+ </p>
+ </section>
+ <section>
+ <title>Specifying the Bounds of a "Custom" Zoomer</title>
+ <p>
+ Choosing a <gui>Position</gui> of <gui>Custom</gui> causes four spin
+ buttons to become available: <gui>Top</gui>, <gui>Left</gui>, <gui>Right
+ </gui>, and <gui>Bottom</gui>.
+ </p>
+ <p>
+ These spin buttons allow you to define the location of each edge of the
+ zoom window. Units are in pixels.
+ </p>
+ </section>
+ <section>
+ <title>Hide system pointer</title>
+ <p>
+ The <gui>Hide system pointer</gui> checkbox will hide the unmagnified
+ pointer, leaving just the magnified one visible.
+ </p>
+ <p>
+ Default value: unchecked
+ </p>
+ </section>
</section>
<section id="tracking_and_alignment">
<title>Tracking and Alignment</title>
+ <media type="image" mime="image/png" src="figures/preferences_tracking_and_alignment.png"/>
<p>These options control the tracking of the mouse cursor.</p>
<section id="mouse_pointer">
<title>Mouse Pointer</title>
@@ -88,7 +91,7 @@
<item>
<p>
<gui>Centered</gui>: Keeps the mouse pointer at the center
- of the screen whenever possible. This is the default.
+ of the screen whenever possible.
</p>
</item>
<item>
@@ -114,6 +117,12 @@
</item>
</list>
<p>
+ Default value: <gui>Centered</gui>
+ </p>
+ </section>
+ <section>
+ <title>Pointer follows zoomer</title>
+ <p>
The <gui>Pointer follows zoomer</gui> checkbox allows you to
customize what should occur if the mouse pointer is not on the
screen when you initially move the mouse. With this option
@@ -122,7 +131,10 @@
so that you can continue to see what you were working on. If
your preferred mouse tracking mode is centered, the pointer
will be moved to the center; otherwise it will be moved to the
- item with focus. This option is enabled by default.
+ item with focus.
+ </p>
+ <p>
+ Default value: checked
</p>
</section>
<section id="control_and_menu_item">
@@ -140,8 +152,7 @@
<p>
<gui>Push</gui>: When navigating via keyboard, move the
zoomer window the least amount necessary to display the
- focused dialog box control or menu item. This is the
- default.
+ focused dialog box control or menu item.
</p>
</item>
<item>
@@ -153,10 +164,18 @@
</item>
</list>
<p>
+ Default value: <gui>Push</gui>
+ </p>
+ </section>
+ <section>
+ <title>Pointer follows focus</title>
+ <p>
<gui>Pointer follows focus</gui>: If this option is enabled,
the mouse pointer will follow you as you arrow through menu
- items and move among controls in dialog boxes. This option
- is disabled by default.
+ items and move among controls in dialog boxes.
+ </p>
+ <p>
+ Default value: not checked
</p>
</section>
<section id="text_cursor">
@@ -172,8 +191,7 @@
<item>
<p>
<gui>Push</gui>: As the text cursor moves, move the zoomer
- window the least amount necessary to display it. This is
- the default.
+ window the least amount necessary to display it.
</p>
</item>
<item>
@@ -184,43 +202,67 @@
</item>
</list>
<p>
- The <gui>Edge margin</gui> is how close the caret should be
- allowed to get to the edge of the screen before it's time to
- "push" the zoomer window. The margin can range from 0 to 50%,
- with 50% being the equivalent of choosing centering. The default
- value is 0. This option is only available if "Push" is your text
- cursor tracking mode.
+ Default value: <gui>Push</gui>
+ </p>
+ </section>
+ <section>
+ <title>Edge margin</title>
+ <p>
+ The <gui>Edge margin</gui> is how close the caret should be allowed to
+ get to the edge of the screen before it's time to "push" the zoomer
+ window. The margin can range from 0 to 50%, with 50% being the
+ equivalent of choosing centering.
+ </p>
+ <note style="tip">
+ <p>
+ This option is only available if "Push" is your text cursor tracking
+ mode.
+ </p>
+ </note>
+ <p>
+ Default value: 0
</p>
</section>
</section>
<section id="color">
<title>Color</title>
+ <media type="image" mime="image/png" src="figures/preferences_color.png"/>
<p>
The <gui>Color</gui> options allow you to do some rough color
adjustments of the magnified region.
</p>
- <list>
- <item>
- <p>
- <gui>Invert colors</gui>: Creates a reverse or negative-image
- effect.
- </p>
- </item>
- <item>
- <p>
- <gui>Brightness</gui>: Ranges from -1 to 1 (-1 is black/no
- brightness; 1 is white/total brightness; 0 is "normal"/unchanged).
- </p>
- </item>
- <item>
- <p>
- <gui>Contrast</gui>: Ranges from -1 to 1 (-1 is grey/no contrast;
- 1 is maximum contrast; 0 is "normal"/unchanged).
- </p>
- </item>
- </list>
+ <section>
+ <title>Invert colors</title>
+ <p>
+ <gui>Invert colors</gui>: Creates a reverse or negative-image effect.
+ </p>
+ <p>
+ Default value: not checked
+ </p>
+ </section>
+ <section>
+ <title>Brightness</title>
+ <p>
+ <gui>Brightness</gui>: Ranges from -1 to 1 (-1 is black/no
+ brightness; 1 is white/total brightness; 0 is "normal"/unchanged).
+ </p>
+ <p>
+ Default value: 0.00
+ </p>
+ </section>
+ <section>
+ <title>Contrast</title>
+ <p>
+ <gui>Contrast</gui>: Ranges from -1 to 1 (-1 is grey/no contrast;
+ 1 is maximum contrast; 0 is "normal"/unchanged).
+ </p>
+ <p>
+ Default value: 0.00
+ </p>
+ </section>
</section>
<section id="border">
+ <media type="image" mime="image/png" src="figures/preferences_border.png"/>
<title>Border</title>
<p>
The <gui>Border</gui> options can be used to customize the border
@@ -228,96 +270,136 @@
As such, these options are not available when <gui>Full Screen</gui>
is selected.
</p>
- <list>
- <item>
- <p>
- <gui>Enable border</gui>: This option determines if a window
- border is visible for the magnifier.
- </p>
- </item>
- <item>
- <p>
- <gui>Border size</gui>: This value determines the size of the
- border in pixels.
- </p>
- </item>
- </list>
+ <section>
+ <title>Enable border</title>
+ <p>
+ <gui>Enable border</gui>: This option determines if a window
+ border is visible for the magnifier.
+ </p>
+ <p>
+ Default value: not checked
+ </p>
+ </section>
+ <section>
+ <title>Border size</title>
+ <p>
+ This value determines the size of the border in pixels.
+ </p>
+ <p>
+ Default value: 1
+ </p>
+ </section>
+ <section>
+ <title>Border color</title>
+ <p>
+ This value determines the color of the border.
+ </p>
+ <p>
+ Default value: black
+ </p>
+ </section>
</section>
<section id="cursor">
<title>Cursor</title>
+ <media type="image" mime="image/png" src="figures/preferences_cursor.png"/>
<p>
These controls can be used to customize the size and color of the
magnifier's cursor.
</p>
- <list>
- <item>
- <p>
- <gui>Enable cursor</gui>: If this check box is enabled then a
- cursor is visible and the size and color options become available.
- </p>
- </item>
- <item>
- <p>
- <gui>Custom size</gui>: Enable this check box if you would like
- to make the mouse pointer larger than it normally is. The cursor
- size can be changed from the default value of 32 pixels.
- </p>
- </item>
- <item>
- <p>
- <gui>Custom color</gui>: If the cursor is enabled, a custom color
- can also be applied.
- </p>
- </item>
- </list>
+ <section>
+ <title>Enable cursor</title>
+ <p>
+ If this checkbox is checked then a cursor is visible and the size and
+ color options become available.
+ </p>
+ <p>
+ Default value: checked
+ </p>
+ </section>
+ <section>
+ <title>Custom size</title>
+ <p>
+ Check this checkbox if you would like to make the mouse pointer larger
+ than it normally is.
+ </p>
+ <p>
+ Default value: not checked
+ </p>
+ </section>
+ <section>
+ <title>Cursor size</title>
+ <p>
+ This value determines the size of the border in pixels.
+ </p>
+ <p>
+ Default value: 32
+ </p>
+ </section>
+ <section>
+ <title>Cursor color</title>
+ <p>
+ This value determines the color of the cursor.
+ </p>
+ <p>
+ Default value: black
+ </p>
+ </section>
</section>
<section id="crosshair">
<title>Cross-hair</title>
+ <media type="image" mime="image/png" src="figures/preferences_cross-hair.png"/>
<p>
This set of controls can be used to customize the magnifier's optional
area-targeting cursor.
</p>
- <list>
- <item>
- <p>
- <gui>Enable cross-hair</gui>: If checked, you can additionally
- configure the clipping behavior, size and color of the cross-hair.
- </p>
- </item>
- <item>
- <p>
- <gui>Enable cross-hair clip</gui>: If enabled, the cross-hair
- will be "clipped" (removed) in the area immediately surrounding
- the mouse pointer.
- </p>
- </item>
- <item>
- <p>
- <gui>Cross-hair size</gui>: This control sets the thickness
- of the cross-hair in pixels.
- </p>
- </item>
- <item>
- <p>
- <gui>Cross-hair color</gui>: This control allows a custom color
- to be used for the cross-hair.
- </p>
- </item>
- </list>
+ <section>
+ <title>Enable cross-hair</title>
+ <p>
+ If this checkbox is checked then the cross-hair is visible and the size
+ and color options become available.
+ </p>
+ <p>
+ Default value: checked
+ </p>
+ </section>
+ <section>
+ <title>Enable cross-hair clip</title>
+ <p>
+ If checked, the cross-hair will be "clipped" (removed) in the area
+ immediately surrounding the mouse pointer.
+ </p>
+ <p>
+ Default value: not checked
+ </p>
+ </section>
+ <section>
+ <title>Cross-hair size</title>
+ <p>
+ This control sets the thickness of the cross-hair in pixels.
+ </p>
+ <p>
+ Default value: 16
+ </p>
+ </section>
+ <section>
+ <title>Cross-hair color</title>
+ <p>
+ This value determines the color of the cross-hair.
+ </p>
+ <p>
+ Default value: black
+ </p>
+ </section>
</section>
<section id="advanced">
<title>Advanced</title>
+ <media type="image" mime="image/png" src="figures/preferences_advanced_button.png"/>
<p>
If you press the <gui>Advanced</gui> button located near the bottom
of the Magnifier page, you can further customize <app>Orca</app>'s
magnification support.
</p>
- <figure>
- <title>
- The <app>Orca</app> <gui>Advanced Settings</gui> Dialog for Magnification
- </title>
- <media type="image" mime="image/png" src="figures/preferences_magnifier_advanced.png"/>
- </figure>
+ <media type="image" mime="image/png" src="figures/preferences_magnifier_advanced.png"/>
<list>
<item><p><gui>Smoothing</gui>: Bilinear or none.</p></item>
<item>
diff --git a/help/C/preferences_speech.page b/help/C/preferences_speech.page
index 1354c57..ad22ede 100644
--- a/help/C/preferences_speech.page
+++ b/help/C/preferences_speech.page
@@ -17,13 +17,8 @@
</info>
<title>Speech Preferences</title>
<section id="enable_speech">
- <info>
- <desc>
- Preferences dialog box option to enable and disable <app>Orca</app>'s
- speech output.
- </desc>
- </info>
<title>Enable speech</title>
+ <media type="image" mime="image/png" src="figures/preferences_enable_speech.png"/>
<p>
The <gui>Enable speech</gui> check box controls whether or not
<app>Orca</app> will make use of a speech synthesizer.
@@ -32,85 +27,110 @@
</p>
</section>
<section id="tts_options">
- <info>
- <desc>
- Preferences dialog box options to configure the text-to-speech
- settings to be used by <app>Orca</app>.
- </desc>
- </info>
<title>Text-To-Speech Options</title>
- <list>
- <item>
- <p>
- The <gui>Speech system</gui> combo box allows you to select your
- preferred speech system from those you have installed. Examples
- include Speech Dispatcher and GNOME Speech.
- </p>
- </item>
- <item>
- <p>
- The <gui>Speech synthesizer</gui> combo box allows you to select
- the speech synthesizer to be used with your chosen Speech system.
- </p>
- </item>
- <item>
- <p>
- The <gui>Voice settings</gui> combo box makes it possible for
- you to use different voices so that you can better distinguish
- uppercase and linked text from other text, and on-screen text
- from text added by <app>Orca</app>.
- </p>
- <note style="tip">
- <title>Configuring Multiple Voices</title>
- <p>
- For each voice you wish to configure, first select the
- voice in the <gui>Voice settings</gui> combo box. Then
- configure the person, rate, pitch, and volume to be used
- for that voice.
- </p>
- </note>
- </item>
- <item>
- <p>
- The <gui>Person</gui> combo box allows you to choose which
- "person" or "speaker" should be used with the selected voice.
- For instance, you might wish to have David speak by default,
- but have hyperlinks spoken by Alice. Note that what you find
- in the <gui>Person</gui> combo box will depend on which speech
- synthesizers you have installed.
- </p>
- </item>
- <item>
+ <media type="image" mime="image/png" src="figures/preferences_tts_options.png"/>
+ <section>
+ <title>Speech system</title>
+ <p>
+ This combo box allows you to select your preferred speech system from
+ those you have installed. Examples include Speech Dispatcher and GNOME
+ Speech.
+ </p>
+ </section>
+ <section>
+ <title>Speech synthesizer</title>
+ <p>
+ This combo box allows you to select the speech synthesizer to be used
+ with your chosen Speech system.
+ </p>
+ </section>
+ <section>
+ <title>Voice settings</title>
+ <p>
+ This combo box makes it possible for you to use different voices so that
+ you can better distinguish uppercase and linked text from other text,
+ and on-screen text from text added by <app>Orca</app>.
+ </p>
+ <note style="tip">
+ <title>Configuring Multiple Voices</title>
<p>
- The <gui>Rate</gui>, <gui>Pitch</gui>, and <gui>Volume</gui>
- left-right sliders allow you to further customize the sound
- of the person you have just selected.
+ For each voice you wish to configure, first select the
+ voice in the <gui>Voice settings</gui> combo box. Then
+ configure the person, rate, pitch, and volume to be used
+ for that voice.
</p>
- </item>
- </list>
+ </note>
+ </section>
+ <section>
+ <title>Person</title>
+ <p>
+ This combo box allows you to choose which "person" or "speaker" should
+ be used with the selected voice. For instance, you might wish to have
+ David speak by default, but have hyperlinks spoken by Alice. Note that
+ what you find in the <gui>Person</gui> combo box will depend on which
+ speech synthesizers you have installed.
+ </p>
+ </section>
+ <section>
+ <title>Rate, Pitch, and Volume</title>
+ <media type="image" mime="image/png" src="figures/preferences_rate_pitch_volume.png"/>
+ <p>
+ These three left-right sliders allow you to further customize the sound
+ of the person you have just selected.
+ </p>
+ </section>
</section>
<section id="punctuation_level">
- <info>
- <desc>
- Preferences dialog box option to set the level of verbalized
- punctuation.
- </desc>
- </info>
<title>Punctuation Level</title>
+ <media type="image" mime="image/png" src="figures/preferences_punctuation_level.png"/>
<p>
The <gui>Punctuation Level</gui> radio button group is used to
adjust the amount of punctuation spoken by the synthesizer. The
- available levels are None, Some, Most and All.
+ available levels are <gui>None</gui>, <gui>Some</gui>, <gui>Most</gui>,
+ and <gui>All</gui>.
+ </p>
+ <section>
+ <title>None</title>
+ <p>
+ Choosing a punctuation level of <gui>None</gui> would, as you expect,
+ cause no punctuation to be spoken. Note, however, that special symbols
+ such as subscripted and superscripted numbers, unicode fractions, and
+ bullets are still spoken at this level, even though some might consider
+ these types of symbols punctuation.
+ </p>
+ </section>
+ <section>
+ <title>Some</title>
+ <p>
+ Choosing a punctuation level of <gui>Some</gui> causes all of the
+ previously-mentioned symbols to be spoken. In addition, <app>Orca</app>
+ will speak known mathematical symbols, currency symbols, and "^", "@",
+ "/", "&", "#".
+ </p>
+ </section>
+ <section>
+ <title>Most</title>
+ <p>
+ Choosing a punctuation level of <gui>Most</gui> causes all of the
+ previous-mentioned symbols to be spoken. In addition, <app>Orca</app>
+ will speak all other known punctuation symbols <em>other than</em> "!",
+ "'", ",", ".", "?".
+ </p>
+ </section>
+ <section>
+ <title>All</title>
+ <p>
+ Choosing a punctuation level of <gui>All</gui>, as expected, causes
+ <app>Orca</app> to speak all known punctuation symbols.
+ </p>
+ </section>
+ <p>
+ Default value: <gui>Most</gui>
</p>
</section>
<section id="verbosity">
- <info>
- <desc>
- Preferences dialog box option to control the amount of information
- which will be spoken in various situations.
- </desc>
- </info>
<title>Verbosity</title>
+ <media type="image" mime="image/png" src="figures/preferences_speech_verbosity.png"/>
<p>
The <gui>Verbosity</gui> setting determines the amount of information
that will be spoken in various situations. For example, if it is set
@@ -118,15 +138,13 @@
will announce that the word is misspelled. When the level is set to brief,
this announcement will not be made.
</p>
+ <p>
+ Default value: <gui>Verbose</gui>
+ </p>
</section>
<section id="table_rows">
- <info>
- <desc>
- Preferences dialog box option to configure what gets spoken when
- navigating amongst rows in a table.
- </desc>
- </info>
<title>Table Rows</title>
+ <media type="image" mime="image/png" src="figures/preferences_table_rows.png"/>
<p>
The <gui>Table Rows</gui> radio button group determines what gets
spoken when navigating amongst rows in a table. The available
@@ -140,45 +158,62 @@
the full row may not be desired. In that case, <gui>speak cell</gui>
should instead be chosen.
</p>
+ <p>
+ Default value: <gui>Speak row</gui>
+ </p>
</section>
<section id="progress_bar_updates">
- <info>
- <desc>
- Preferences dialog box options to control which progress bar updates
- get spoken.
- </desc>
- </info>
<title>Progress Bar Updates</title>
- <p>
- If the <gui>Enabled</gui> checkbox is checked <app>Orca</app> will
- periodically announce the status of progress bars. How often the
- announcement is made is determined by the value chosen in the
- <gui>Frequency (secs)</gui> spin button.
- </p>
- <p>
- The <gui>Restrict to</gui> combo box allows you to control which
- progress bars should be spoken, assuming the speaking of progress
- bar updates has been enabled. The choices are <gui>All</gui>,
- <gui>Application</gui>, and <gui>Window</gui>. Choosing <gui>All</gui>
- will result in <app>Orca</app> speaking updates for all progress bars,
- regardless of where the progress bars are located. Choosing
- <gui>Application</gui> will result in <app>Orca</app> speaking updates
- from progress bars in the active application, even if they are not in
- the active window. Choosing <gui>Window</gui> will result in
- <app>Orca</app> only speaking updates for progress bars in the active
- window. The default value is <gui>Application</gui>.
- </p>
+ <media type="image" mime="image/png" src="figures/preferences_progress_bar_updates.png"/>
+ <section>
+ <title>Enabled</title>
+ <p>
+ If the <gui>Enabled</gui> checkbox is checked <app>Orca</app> will
+ periodically present the status of progress bars.
+ </p>
+ <p>
+ Default value: checked
+ </p>
+ </section>
+ <section>
+ <title>Frequency (secs)</title>
+ <p>
+ This spin button determines how often the announcement is made.
+ </p>
+ <p>
+ Default value: 10
+ </p>
+ </section>
+ <section>
+ <title>Restrict to</title>
+ <p>
+ This combo box allows you to control which progress bars should be
+ presented, assuming the presentation of progress bar updates has been
+ enabled. The choices are <gui>All</gui>, <gui>Application</gui>, and
+ <gui>Window</gui>.
+ </p>
+ <p>
+ Choosing <gui>All</gui> will result in <app>Orca</app> presenting
+ updates for all progress bars, regardless of where the progress bars
+ are located.
+ </p>
+ <p>
+ Choosing <gui>Application</gui> will result in <app>Orca</app>
+ presenting updates from progress bars in the active application, even
+ if they are not in the active window.
+ </p>
+ <p>
+ Choosing <gui>Window</gui> will result in <app>Orca</app> only
+ presenting updates for progress bars in the active window.
+ </p>
+ <p>
+ Default value: <gui>Application</gui>
+ </p>
+ </section>
</section>
<section id="only_speak_displayed_text">
- <info>
- <desc>
- Preferences dialog box option to cause <app>Orca</app> to only
- speak actual text displayed on screen. This option is intended
- primarily for low vision users and users with a visual learning
- disability.
- </desc>
- </info>
<title>Only speak displayed text</title>
+ <media type="image" mime="image/png" src="figures/preferences_only_speak_displayed_text.png"/>
<p>
Checking this checkbox causes <app>Orca</app> to only speak actual
text displayed on screen. This option is intended primarily for low
@@ -186,13 +221,8 @@
</p>
</section>
<section id="multicase_strings">
- <info>
- <desc>
- Preferences dialog box option to cause <app>Orca</app> to present
- multicase strings as if they were separate words.
- </desc>
- </info>
<title>Speak multicase strings as words</title>
+ <media type="image" mime="image/png" src="figures/preferences_speak_multicase_strings_as_words.png"/>
<p>
In some texts, and especially when working with code, one often comes
across a "word" consisting of several words with alternating case, such
@@ -204,12 +234,7 @@
</p>
</section>
<section id="pauses">
- <info>
- <desc>
- Preferences dialog box option to cause <app>Orca</app> to add pauses
- to the items being spoken.
- </desc>
- </info>
+ <media type="image" mime="image/png" src="figures/preferences_break_speech_into_chunks.png"/>
<title>Break speech into chunks between pauses</title>
<p>
Depending on the enabled speech settings, <app>Orca</app> may have quite
@@ -221,12 +246,7 @@
</p>
</section>
<section id="say_all_by">
- <info>
- <desc>
- Preferences dialog box option controlling <app>Orca</app>'s Say All
- style. The options are by sentence and by line.
- </desc>
- </info>
+ <media type="image" mime="image/png" src="figures/preferences_say_all_by.png"/>
<title>Say All By</title>
<p>
The <gui>Say All By</gui> combo box allows you to specify whether
@@ -236,33 +256,21 @@
</section>
<section id="system_voice_items">
<title>System Information</title>
- <info>
- <desc>
- Preferences dialog box options for controlling the presentation
- of a variety of supplemental, "system" information about the item
- with focus.
- </desc>
- </info>
+ <media type="image" mime="image/png" src="figures/preferences_system_voice_options.png"/>
+ <p>
+ The following items control the presentation of a variety of
+ supplemental, "system" information about the item with focus.
+ Because the associated text does not appear on screen, this
+ information is presented in <app>Orca</app>'s System voice.
+ </p>
+ <note style="note">
+ <title>Configuration of System Information</title>
<p>
- The following items control the presentation of a variety of
- supplemental, "system" information about the item with focus.
- Because the associated text does not appear on screen, this
- information is presented in <app>Orca</app>'s System voice.
+ The follow items will not be available for configuration if
+ the <gui>Only speak displayed text</gui> checkbox is checked.
</p>
- <note style="note">
- <title>Configuration of System Information</title>
- <p>
- The follow items will not be available for configuration if
- the <gui>Only speak displayed text</gui> checkbox is checked.
- </p>
</note>
<section id="speak_blank_lines">
- <info>
- <desc>
- Preferences dialog box option for controlling whether or not
- blank lines are announced by <app>Orca</app>.
- </desc>
- </info>
<title>Speak blank lines</title>
<p>
If the <gui>Speak blank lines</gui> checkbox is checked,
@@ -272,12 +280,6 @@
</p>
</section>
<section id="indentation_and_justification">
- <info>
- <desc>
- Preferences dialog box option for enabling/disabling the speaking
- of indentation and justification whilst navigating within text.
- </desc>
- </info>
<title>Speak indentation and justification</title>
<p>
When working with code or editing other documents it is often
@@ -287,28 +289,15 @@
</p>
</section>
<section id="mnemonics">
- <info>
- <desc>
- Preferences dialog box option for enabling/disabling the speaking
- of mnemonics and keyboard shortcuts associated with the focused
- item.
- </desc>
- </info>
- <title>Speak object mnemonics</title>
- <p>
- If the <gui>Speak object mnemonics</gui> checkbox is checked,
- <app>Orca</app> will announce the mnemonic associated with the
- object with focus (such as <keyseq><key>Alt</key><key>O</key>
- </keyseq> for an <gui>OK</gui> button).
- </p>
- </section>
+ <title>Speak object mnemonics</title>
+ <p>
+ If the <gui>Speak object mnemonics</gui> checkbox is checked,
+ <app>Orca</app> will announce the mnemonic associated with the
+ object with focus (such as <keyseq><key>Alt</key><key>O</key>
+ </keyseq> for an <gui>OK</gui> button).
+ </p>
+ </section>
<section id="child_position">
- <info>
- <desc>
- Preferences dialog box option for enabling/disabling the speaking
- of the position of the current item in a menu, list, or tree.
- </desc>
- </info>
<title>Speak child position</title>
<p>
Checking the <gui>Speak child position</gui> checkbox will cause
@@ -317,13 +306,6 @@
</p>
</section>
<section id="speak_tutorial_messages">
- <info>
- <desc>
- Preferences dialog box option for controlling whether or not
- <app>Orca</app> provides tutorial information, such as how to
- interact with the currently-focused object.
- </desc>
- </info>
<title>Speak tutorial messages</title>
<p>
If the <gui>Speak tutorial messages</gui> checkbox is checked, as
diff --git a/help/Makefile.am b/help/Makefile.am
index c28fc43..fd41be0 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -6,29 +6,56 @@ DOC_FIGURES = \
figures/orca_find.png \
figures/orca-logo.png \
figures/perferences_table_navigation.png \
+ figures/preferences_abbreviated_role_names.png \
+ figures/preferences_advanced_button.png \
+ figures/preferences_border.png \
+ figures/preferences_braille_contracted.png \
+ figures/preferences_braille_indicators.png \
+ figures/preferences_braille_verbosity.png \
+ figures/preferences_break_speech_into_chunks.png \
figures/preferences_character_echo.png \
figures/preferences_chat.png \
+ figures/preferences_color.png \
+ figures/preferences_cross-hair.png \
+ figures/preferences_cursor.png \
figures/preferences_date_and_time.png \
+ figures/preferences_disable_eol_symbol.png \
figures/preferences_disable_gksu_keyboard_grab.png \
+ figures/preferences_enable_braille_monitor.png \
+ figures/preferences_enable_braille_support.png \
+ figures/preferences_enable_magnifier.png \
+ figures/preferences_enable_speech.png \
figures/preferences_gecko_find_options.png \
figures/preferences_gecko_page_navigation.png \
figures/preferences_key_bindings_table.png \
figures/preferences_keyboard_layout.png \
figures/preferences_key_echo.png \
figures/preferences_magnifier_advanced.png \
+ figures/preferences_only_speak_displayed_text.png \
figures/preferences_Orca_modifier_keys.png \
figures/preferences_present_tooltips.png \
figures/preferences_profiles.png \
+ figures/preferences_progress_bar_updates.png \
figures/preferences_pronunciation.png \
+ figures/preferences_punctuation_level.png \
figures/preferences_quit_Orca_without_confirmation.png \
+ figures/preferences_rate_pitch_volume.png \
+ figures/preferences_say_all_by.png \
figures/preferences_show_Orca_main_window.png \
+ figures/preferences_speak_multicase_strings_as_words.png \
figures/preferences_speak_object_under_mouse.png \
+ figures/preferences_speech_verbosity.png \
figures/preferences_start_Orca_when_you_login.png \
+ figures/preferences_system_voice_options.png \
figures/preferences_table_navigation.png \
+ figures/preferences_table_rows.png \
figures/preferences_text_attributes_braille.png \
figures/preferences_text_attributes_rearranging.png \
figures/preferences_text_attributes_table.png \
+ figures/preferences_tracking_and_alignment.png \
+ figures/preferences_tts_options.png \
figures/preferences_word_and_sentence_echo.png \
+ figures/preferences_zoomer.png \
figures/profiles_conflict.png \
figures/profiles_load.png \
figures/profiles_save_as.png
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
