[orca] Doc rewrite in progress: Where Am I
- From: Joanmarie Diggs <joanied src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [orca] Doc rewrite in progress: Where Am I
- Date: Wed, 15 Dec 2010 22:59:50 +0000 (UTC)
commit 4b46a52999ed61a71ca0574c55749813f87c5b1a
Author: Joanmarie Diggs <joanmarie diggs gmail com>
Date: Wed Dec 15 17:59:25 2010 -0500
Doc rewrite in progress: Where Am I
help/C/commands_where_am_i.page | 11 +++--
help/C/howto_whereami.page | 84 ++++++++++++++++++++++++++++++++++++++-
2 files changed, 89 insertions(+), 6 deletions(-)
---
diff --git a/help/C/commands_where_am_i.page b/help/C/commands_where_am_i.page
index 6a8e154..0823582 100644
--- a/help/C/commands_where_am_i.page
+++ b/help/C/commands_where_am_i.page
@@ -18,11 +18,14 @@
</info>
<title>Where Am I Commands</title>
<p>
- Orca's Where Am I commands give you context-senstive details about your
- present location. For instance, in tables, Where Am I will give you
- details about the table cell you are in, but in text it will present
- the current line along with any text which happens to be selected.
+ <app>Orca</app>'s Where Am I feature gives you context-sensitive details
+ about your present location. For instance, in tables, Where Am I will give
+ you details about the table cell you are in, but in text it will present
+ the current line along with any text which happens to be selected. The full
+ list of what you can expect <app>Orca</app> to present can be found in the
+ <link xref="howto_whereami">Introduction to Where Am I</link>.
</p>
+ <p><app>Orca</app> provides the following Where Am I commands:</p>
<list>
<item>
<p>Perform basic where am I:</p>
diff --git a/help/C/howto_whereami.page b/help/C/howto_whereami.page
index 97d798b..b2a270c 100644
--- a/help/C/howto_whereami.page
+++ b/help/C/howto_whereami.page
@@ -14,8 +14,88 @@
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
- <title>WhereAmI (WRITE ME)</title>
+ <title>WhereAmI</title>
<p>
- Write me
+ In addition to dedicated commands for reading the title bar and the
+ status bar, Orca provides two context-sensitive Where Am I commands:
+ Basic Where Am I and Detailed Where Am I. Basic Where Am I is implemented
+ for all objects. Detailed Where Am I is implemented just for those objects
+ for which there is a significant amount of information you may wish to know,
+ but likely will not wish to know all of the time.
+ </p>
+ <p>
+ The best way to become familiar with what Where Am I will present is to
+ give the <link xref="commands_where_am_i">Where Am I commands</link> a
+ try. However, to give you a better idea of the context-sensitive nature
+ of <app>Orca</app>'s Where Am I feature, consider the following:
+ </p>
+ <p>
+ For most widgets, you will at least be told the label and/or name, the
+ type or role of the widget, and the mnemonic and/or accelerator key if
+ they happen to exist. In addition:
+ </p>
+ <list>
+ <item>
+ <p>
+ If the widget is text, and you perform a basic Where Am I, you will be
+ told the current line if no text is selected. If text is selected,
+ however, a basic Where Am I will tell you what text is selected. A
+ detailed Where Am I within the text will also include the text
+ attributes.
+ </p>
+ </item>
+ <item>
+ <p>
+ If the widget can be checked, as is the case with checkboxes and
+ radio buttons, the checked state will be included.
+ </p>
+ </item>
+ <item>
+ <p>
+ If the widget is a list or list-like object, such as a combo box, radio
+ button group, or page tab list, the position of the current item will be
+ included.
+ </p>
+ </item>
+ <item>
+ <p>
+ If the widget is hierarchical, such as a tree, and you are on an
+ expandable node, you will be told if that node is expanded or not.
+ And if it is expanded, you will also be told how many children it
+ contains. In addition, the nesting level will also be provided.
+ </p>
+ </item>
+ <item>
+ <p>
+ If the widget is a progress bar or a slider, you will be told the
+ current percent.
+ </p>
+ </item>
+ <item>
+ <p>
+ If the widget is an icon within an icon group, a basic Where Am I
+ will include the object you are in, the item you are on, and the
+ number of items which are selected. In a detailed Where Am I, you
+ will also be told which items are selected.
+ </p>
+ </item>
+ <item>
+ <p>
+ If you are on a link, the type of link (same site, different site,
+ FTP link, etc.) will be included.
+ </p>
+ </item>
+ <item>
+ <p>
+ If you are in a table cell, the coordinates of that cell and the cell
+ headers will be included.
+ </p>
+ </item>
+ </list>
+ <p>
+ And so on. Again, the goal of <app>Orca</app>'s Where Am I is to provide
+ you with the details you are most likely interested in knowing about the
+ object you are currently in. To give Where Am I a try, see the list of
+ <link xref="commands_where_am_i">Where Am I commands</link>.
</p>
</page>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]