[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 08:32:03 +0000 (UTC)
commit abce5bae4c89cf84a8f0eb4ca7e18f7a4efb8b9a
Author: Joanmarie Diggs <joanmarie diggs gmail com>
Date: Sun Dec 19 03:00:01 2010 -0500
Continued work on bug 631123 - Orca documentation needs to be updated, converted to Mallard, augmented, and moved to the Orca module
* Added a proper link (which loads in yelp) to the GNOME Desktop
Accessibility Guide. (Thanks Attila!!)
* Moved some text out of preferences.page into a new page:
preferences_introduction.page
help/C/index.page | 20 ++++++------
help/C/preferences.page | 33 +------------------
help/C/preferences_introduction.page | 59 ++++++++++++++++++++++++++++++++++
help/Makefile.am | 1 +
4 files changed, 71 insertions(+), 42 deletions(-)
---
diff --git a/help/C/index.page b/help/C/index.page
index 8858db6..b0c79ac 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -15,16 +15,13 @@
</media>
<app>Orca</app> Screen Reader
</title>
- <p>
- If you are a new user of the GNOME Desktop, you may wish to begin with the
- <link href="http://library.gnome.org/users/gnome-access-guide/stable/">
- GNOME Desktop Accessibility Guide</link> which will introduce you to all
- of the accessibility features in GNOME, including keyboard navigation and
- accessible login.
- </p>
- <section id="quick_reference" style="2column">
- <title>Quick Reference</title>
- </section>
+ <note style="important">
+ <title>Before You Begin</title>
+ <p>
+ Read the <link href="ghelp:gnome-access-guide">GNOME Desktop
+ Accessibility Guide</link>
+ </p>
+ </note>
<section id="getting_started" style="2column">
<title>Getting Started</title>
</section>
@@ -34,4 +31,7 @@
<section id="reviewing" style="2column">
<title>Reviewing and Interacting with Screen Contents</title>
</section>
+ <section id="quick_reference" style="2column">
+ <title>Quick Reference</title>
+ </section>
</page>
diff --git a/help/C/preferences.page b/help/C/preferences.page
index 479c016..dd65c9c 100644
--- a/help/C/preferences.page
+++ b/help/C/preferences.page
@@ -1,6 +1,6 @@
<page xmlns="http://projectmallard.org/1.0/" type="guide" id="preferences">
<info>
- <link type="next" xref="preferences_general" />
+ <link type="next" xref="preferences_introduction" />
<link type="guide" xref="index#quick_reference" />
<title type="link">Preferences</title>
<credit type="author">
@@ -14,39 +14,8 @@
<title><app>Orca</app>'s Preferences Dialogs</title>
<section id="orca" style="2column">
<title>Orca Preferences</title>
- <p>
- These preferences allow you to customize functionality in <app>Orca</app>
- that applies to all applications. As a result, with the exception of the
- General Preferences, you will find the following available in both the
- <app>Orca</app> Preferences dialog and <app>Orca</app>'s
- application-specific preferences dialogs.</p>
- <note style="tip">
- <title>Keyboard Shortcuts for Getting Into the Preferences Dialogs</title>
- <list>
- <item>
- <p>
- <keyseq><key>Orca Modifier</key><key>Space</key></keyseq>:
- <app>Orca</app>'s Preferences
- </p>
- </item>
- <item>
- <p>
- <keyseq><key>Ctrl</key><key>Orca Modifier</key><key>Space</key>
- </keyseq>: <app>Orca</app>'s Preferences for the current
- application
- </p>
- </item>
- </list>
- </note>
</section>
<section id="application" style="2column">
<title>Application-Unique Preferences</title>
- <p>
- These preferences allow you to customize <app>Orca</app> functionality
- that only applies in certain environments, such as on web pages or in
- chat applications. As a result, you will only find these options
- available in the application-specific preferences dialogs and only for
- those applications to which these options apply.
- </p>
</section>
</page>
diff --git a/help/C/preferences_introduction.page b/help/C/preferences_introduction.page
new file mode 100644
index 0000000..c449e85
--- /dev/null
+++ b/help/C/preferences_introduction.page
@@ -0,0 +1,59 @@
+<page xmlns="http://projectmallard.org/1.0/" type="topic" id="preferences_introduction">
+ <info>
+ <title type="sort">0. Introduction to <app>Orca</app>'s Preferences</title>
+ <title type="link">Introduction to <app>Orca</app>'s Preferences</title>
+ <link type="guide" xref="preferences" />
+ <link type="next" xref="preferences_general" />
+ <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>Introduction to <app>Orca</app>'s Preferences</title>
+ <section>
+ <title>Orca Preferences</title>
+ <p>
+ Orca preferences allow you to customize functionality in <app>Orca</app>
+ which applies to all applications. An example of an Orca preference is
+ key echo because key echo is something that applies to all applications.
+ </p>
+ <p>
+ Note that Orca preferences can be customized on an application-by-application
+ basis. For instance you can set the default key echo to words and then
+ set the key echo for Pidgin to be none. Having done so, <app>Orca</app>
+ would always echo each word that you typed, unless you were in Pidgin.
+ </p>
+ <note style="tip">
+ <title>Keyboard Shortcuts for Getting Into the Preferences Dialogs</title>
+ <list>
+ <item>
+ <p>
+ <keyseq><key>Orca Modifier</key><key>Space</key></keyseq>:
+ <app>Orca</app>'s Preferences
+ </p>
+ </item>
+ <item>
+ <p>
+ <keyseq><key>Ctrl</key><key>Orca Modifier</key><key>Space</key>
+ </keyseq>: <app>Orca</app>'s Preferences for the current
+ application
+ </p>
+ </item>
+ </list>
+ </note>
+ </section>
+ <section>
+ <title>Application-Unique Preferences</title>
+ <p>
+ In contrast to Orca preferences, there are appliation-unique preferences.
+ These preferences allow you to customize <app>Orca</app> functionality
+ that only applies in certain environments, such as on web pages or in
+ chat applications. As a result, you will only find these options
+ available in the application-specific preferences dialogs and only for
+ those applications to which these options apply.
+ </p>
+ </section>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index fd41be0..26268d1 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -104,6 +104,7 @@ DOC_PAGES = \
preferences_chat.page \
preferences_gecko.page \
preferences_general.page \
+ preferences_introduction.page \
preferences_key_bindings.page \
preferences_key_echo.page \
preferences_magnifier.page \
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]