GNOME.org
 

orca r4656 - trunk/docs/doc-set

Author: wwalker
Date: Sun Mar 29 20:21:22 2009
New Revision: 4656
URL: http://svn.gnome.org/viewvc/orca?rev=4656&view=rev

Log:
Add internals.sgml


Added:
   trunk/docs/doc-set/internals.sgml
Modified:
   trunk/docs/doc-set/internals.pdf

Modified: trunk/docs/doc-set/internals.pdf
==============================================================================
Binary files. No diff available.

Added: trunk/docs/doc-set/internals.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/doc-set/internals.sgml	Sun Mar 29 20:21:22 2009
@@ -0,0 +1,250 @@
+<!-- Copyright 2005-2008, Sun Microsystems, Inc. -->
+
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.0//EN"
+[
+<!ENTITY blurb SYSTEM "blurb.sgml">
+<!ENTITY legal SYSTEM "legal.sgml">
+<!ENTITY todo '<emphasis>TODO:</emphasis>'>
+<!ENTITY note '<emphasis>NOTE:</emphasis>'>
+<!ENTITY wkc 'well known command'>
+<!ENTITY detail '<emphasis>IMPLEMENTATION DETAIL:</emphasis>'>
+<!ENTITY issue '<emphasis>KNOWN ISSUE:</emphasis>'>
+<!ENTITY example '<emphasis>EXAMPLE:</emphasis>'>
+
+<!ENTITY architecture SYSTEM "architecture.sgml">
+<!ENTITY scriptguide SYSTEM "script_guide.sgml">
+  <!ENTITY scriptguidelink '<link linkend="scriptguide">Orca Script Writing Guide</link>'>
+]
+>
+
+<book>
+  <title>Orca Technical Reference</title>
+  <bookinfo>
+    &legal;
+  </bookinfo>
+
+  <!--
+  ************************************************************************
+  *                                                                      *
+  * FORWARD                                                              *
+  *                                                                      *
+  ************************************************************************
+  -->
+
+  <preface id="archforward"><title>Foreword</title>
+    &blurb;
+    <para>This book covers the overall architecture of Orca, including
+      a portion on writing custom scripts. The bulk of the user
+      information and user experience design can be found on the Orca
+      WIKI at http://live.gnome.org/Orca.</para>
+  </preface>
+
+  <!--
+  ************************************************************************
+  *                                                                      *
+  * INFRASTRUCTURE SUPPORT                                               *
+  *                                                                      *
+  ************************************************************************
+  -->
+
+  <chapter id="prereq"><title>Prerequisites</title>
+    <para>To help narrow the scope of the Orca development activity,
+      Orca uses existing software where available.  For example, as
+      mentioned in the requirements, Orca is a screen reader that
+      needs to be able to interact with speech synthesis, braille,
+      and screen magnification services, but it need not be the
+      provider of such services.  Given this, Orca has the following
+      dependencies:</para>
+
+    <section id="prereqgnome"><title>GNOME 2.22 or better</title> 
+      <para>The GNOME 2.22 desktop contains a number of bug fixes and
+        enhancements to the accessibility infrastructure.  These are
+        needed for Orca to run properly.  GNOME 2.22 also packages a
+        variety of other dependencies of Orca, including gnome-speech,
+        gnome-mag, pyatspi, etc.</para>
+    </section>
+
+    <section id="prereqpython"><title>Python v2.4 or better</title> 
+      <para>Orca is written in the Python programming language and
+        depends upon features found in Python versions 2.4 and
+        greater.</para>
+    </section>
+
+    <section id="prereqbrltty"><title>BrlTTY v3.7.2 or better</title>
+      <para>BrlTTY <citation><xref linkend="brltty"
+        endterm="brltty.abbrev"/></citation> provides access to a
+        variety of Braille displays, and consists of a library and a
+        daemon to provide programmatic interaction with the
+        display.</para>
+    </section>
+
+    <section id="prereqkeyboardnav"><title>Keyboard Navigation</title>
+      <para>As much as possible, Orca relies upon the keyboard
+        navigation methods built in to the native platform.  For
+        example, it is expected that the native platform will provide
+        access via traditional methods such as the "tab" key, keyboard
+        mnemonics, and keyboard accelerators.</para>
+    </section>
+  </chapter>
+
+  &architecture;
+  &scriptguide;
+
+  <!--
+  ************************************************************************
+  *                                                                      *
+  * I18N SUPPORT                                                         *
+  *                                                                      *
+  ************************************************************************
+  -->
+
+  <chapter id="i18n"><title>Internationalization (I18N) Support</title>
+    <para>All human-consumable text obtained from AT-SPI calls is
+      expected to be in a localized form.  As such, Orca does not
+      do any extra localization processing when working with text
+      obtained via the AT-SPI.</para>
+    <para>For text generated by Orca itself, Orca handles
+      internationalization and localization using the <citation><xref
+      linkend="gettext" endterm="gettext.abbrev"/></citation> support
+      of Python.  The gettext support of Python is similar to the GNU
+      gettext module.  Each human consumable string of Orca is US
+      English text wrapped in a call to gettext.gettext.  The call to
+      gettext.gettext will either return a localized string or default
+      to the US English text. Orca depends upon an active and thriving
+      community of open source translators to provide the
+      localizations.</para>
+    <para>The synthesis of localized speech is to be provided by the
+      underlying gnome-speech engine.  That is, Orca merely passes
+      localized text to the speech engine, which is responsible for
+      the correct interpretation and pronunciation.</para>
+    <para>The generation of localized braille is to be determined.
+      &todo; BrlTTY currently does not support this at the moment, but
+      it is expected that the BrlTTY developers will add this in the
+      future.</para>
+  </chapter>
+
+  <!--
+  ************************************************************************
+  *                                                                      *
+  * BIBLIOGRAPHY                                                         *
+  *                                                                      *
+  ************************************************************************
+  -->
+
+  <bibliography id="archbibliography">
+    <biblioentry role="unpublished" id="at-spi">
+      <abbrev id="at-spi.abbrev">AT-SPI</abbrev>
+      <authorgroup>
+        <author><firstname>Bill</firstname><surname>Haneman</surname></author>
+        <author><firstname>Marc</firstname><surname>Mulcahy</surname></author>
+        <author><firstname>Michael</firstname><surname>Meeks</surname></author>
+      </authorgroup>
+      <title><ulink url="http://directory.fsf.org/accessibility/at-spi.html";>
+        AT-SPI</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="acss">
+      <abbrev id="acss.abbrev">ACSS</abbrev>
+      <authorgroup>
+        <author><firstname>T.V.</firstname><surname>Raman</surname></author>
+      </authorgroup>
+      <title><ulink url="http://www.w3.org/TR/1998/REC-CSS2-19980512/aural.html";>Aural Style Sheets</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="bonobo">
+      <abbrev id="bonobo.abbrev">Bonobo</abbrev>
+      <author><firstname>George</firstname><surname>Lebl</surname></author>
+      <title><ulink url="http://lidn.sourceforge.net/articles/gnomenclatureintrotobonobo/";>
+        Gnomenclature: Intro to bonobo</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="brltty">
+      <abbrev id="brltty.abbrev">BRLTTY</abbrev>
+      <authorgroup>
+        <author><firstname>Dave</firstname><surname>Meilke</surname></author>
+        <author><firstname>Nicolas</firstname><surname>Pitre</surname></author>
+        <author><firstname>Stephane</firstname><surname>Doyon</surname></author>
+      </authorgroup>
+      <title><ulink url="http://directory.fsf.org/accessibility/brltty.html";>
+        BRLTTY</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="emacspeak">
+      <abbrev id="emacspeak.abbrev">Emacspeak</abbrev>
+      <authorgroup>
+        <author><firstname>T.V.</firstname><surname>Raman</surname></author>
+      </authorgroup>
+      <title><ulink url="http://emacspeak.sourceforge.net/";>Emacspeak</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="gail">
+      <abbrev id="gail.abbrev">GAIL</abbrev>
+      <author><firstname>Bill</firstname><surname>Haneman</surname></author>
+      <title><ulink url="http://freshmeat.net/projects/gail/";>
+        GAIL</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="gettext">
+      <abbrev id="gettext.abbrev">gettext</abbrev>
+      <author><surname>&todo; Unknown</surname></author>
+      <title><ulink url="http://docs.python.org/lib/module-gettext.html";>
+        gettext</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="gnome-mag">
+      <abbrev id="gnome-mag.abbrev">gnome-mag</abbrev>
+      <author><firstname>Bill</firstname><surname>Haneman</surname></author>
+      <title><ulink url="http://directory.fsf.org/accessibility/gnome-mag.html";>
+        gnome-mag</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="gnome-speech">
+      <abbrev id="gnome-speech.abbrev">gnome-speech</abbrev>
+      <authorgroup>
+        <author><firstname>Marc</firstname><surname>Mulcahy</surname></author>
+        <author><firstname>Michael</firstname><surname>Meeks</surname></author>
+      </authorgroup>
+      <title><ulink url="http://directory.fsf.org/accessibility/gnome-speech.html";>
+        gnome-speech</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="gnopernicus">
+      <abbrev id="gnopernicus.abbrev">Gnopernicus</abbrev>
+      <author><firstname>Remus</firstname><surname>Draica</surname></author>
+      <title><ulink url="http://directory.fsf.org/accessibility/gnopernicus.html";>
+        Gnopernicus</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="jaws">
+      <abbrev id="jaws.abbrev">JAWS</abbrev>
+      <author><firstname></firstname><surname>Freedom Scientific</surname></author>
+      <title><ulink url="http://www.freedomscientific.com/fsproducts/softwarejaws.asp";>
+        JAWS</ulink>
+    </title>
+    </biblioentry>
+
+    <biblioentry role="unpublished" id="xkb">
+      <abbrev id="xkb.abbrev">XKB</abbrev>
+      <authorgroup>
+        <author><firstname>Erik</firstname><surname>Fortune</surname></author>
+        <author><firstname>William</firstname><surname>Walker</surname></author>
+        <author><firstname>Donna</firstname><surname>Converse</surname></author>
+        <author><firstname>George</firstname><surname>Sachs</surname></author>
+      </authorgroup>
+      <title><ulink url="http://matrix.netsoc.tcd.ie/hcksplat/work/XKBlib.pdf";>
+        The XKB keyboard extension</ulink>
+    </title>
+    </biblioentry>
+  </bibliography>
+
+</book>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]