[orca/gnome-3-12] Add documentation for Orca's spell-check support
- From: Joanmarie Diggs <joanied src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [orca/gnome-3-12] Add documentation for Orca's spell-check support
- Date: Sun, 6 Apr 2014 00:10:32 +0000 (UTC)
commit ecaaba53ff4916e595c5ecf4f14d34f8d0f80468
Author: Joanmarie Diggs <jdiggs igalia com>
Date: Sat Apr 5 20:09:08 2014 -0400
Add documentation for Orca's spell-check support
help/C/howto_whereami.page | 9 +++++
help/C/preferences_chat.page | 1 +
help/C/preferences_spellcheck.page | 65 ++++++++++++++++++++++++++++++++++++
help/Makefile.am | 1 +
4 files changed, 76 insertions(+), 0 deletions(-)
---
diff --git a/help/C/howto_whereami.page b/help/C/howto_whereami.page
index ef145e6..c3bdcc9 100644
--- a/help/C/howto_whereami.page
+++ b/help/C/howto_whereami.page
@@ -91,6 +91,15 @@
headers will be included.
</p>
</item>
+ <item>
+ <p>
+ If you are in the spell checker of an application where <app>Orca</app>
+ provides enhanced support, a basic Where Am I will repeat the error
+ respecting your <link xref="preferences_spellcheck">spell check
+ preferences</link>. A detailed Where Am I will cause <app>Orca</app> to
+ present the full details of the error.
+ </p>
+ </item>
</list>
<p>
And so on. Again, the goal of <app>Orca</app>'s Where Am I is to provide
diff --git a/help/C/preferences_chat.page b/help/C/preferences_chat.page
index 97b04ee..918f6b0 100644
--- a/help/C/preferences_chat.page
+++ b/help/C/preferences_chat.page
@@ -1,6 +1,7 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="preferences_chat">
<info>
<link type="guide" xref="preferences#application" />
+ <link type="next" xref="preferences_spellcheck" />
<title type="sort">3. Chat</title>
<title type="link">Chat</title>
<desc>
diff --git a/help/C/preferences_spellcheck.page b/help/C/preferences_spellcheck.page
new file mode 100644
index 0000000..395e82d
--- /dev/null
+++ b/help/C/preferences_spellcheck.page
@@ -0,0 +1,65 @@
+<page xmlns="http://projectmallard.org/1.0/" type="topic" id="preferences_spellcheck">
+ <info>
+ <link type="guide" xref="preferences#application" />
+ <title type="sort">4. Spell Check</title>
+ <title type="link">Spell Check</title>
+ <desc>
+ Configuring <app>Orca's</app> support for Spell Check
+ </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>Spell Check Preferences</title>
+ <p>
+ <app>Orca</app> tries to provide a consistent user experience when interacting
+ with application spell checkers. For applications where this enhanced support
+ has been provided, you will find several options which you can adjust to get
+ the verbosity level that works best for you.
+ </p>
+ <note style="tip">
+ <title>You can have both brief and verbose spell check information</title>
+ <p>
+ If you normally want very little verbosity when using a spell checker,
+ but occasionally need detailed information about a given error, you can
+ disable these options. When you need additional details, just use
+ <app>Orca</app>'s detailed <link xref="howto_whereami">Where Am I</link>
+ command to have <app>Orca</app> present the current error as if all of these
+ options were enabled.
+ </p>
+ </note>
+ <section>
+ <title>Spell error</title>
+ <p>
+ If this checkbox is checked, <app>Orca</app> will spell out the misspelled
+ word after speaking it.
+ </p>
+ <p>
+ Default value: checked
+ </p>
+ </section>
+ <section>
+ <title>Spell suggestion</title>
+ <p>
+ If this checkbox is checked, <app>Orca</app> will spell out the suggested
+ correction after speaking it.
+ </p>
+ <p>
+ Default value: checked
+ </p>
+ </section>
+ <section>
+ <title>Present context of error</title>
+ <p>
+ If this checkbox is checked, <app>Orca</app> will speak the sentence or
+ line from the document in which the error is found.
+ </p>
+ <p>
+ Default value: checked
+ </p>
+ </section>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 3190cab..a4b2af2 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -54,6 +54,7 @@ HELP_FILES = \
preferences.page \
preferences_pronunciation.page \
preferences_speech.page \
+ preferences_spellcheck.page \
preferences_table_navigation.page \
preferences_text_attributes.page \
preferences_voice.page
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]