docs: change id of the atkobject chapter
[platform/upstream/atk.git] / docs / atk-docs.sgml
index cf44911..2d9991e 100644 (file)
-<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-<!entity atk-AtkAction SYSTEM "sgml/atkaction.sgml">
-<!entity atk-AtkComponent SYSTEM "sgml/atkcomponent.sgml">
-<!entity atk-AtkEditabletext SYSTEM "sgml/atkeditabletext.sgml">
-<!entity atk-AtkHyperlink SYSTEM "sgml/atkhyperlink.sgml">
-<!entity atk-AtkHypertext SYSTEM "sgml/atkhypertext.sgml">
-<!entity atk-AtkImage SYSTEM "sgml/atkimage.sgml">
-<!entity atk-AtkNoOpObject SYSTEM "sgml/atknoopobject.sgml">
-<!entity atk-AtkNoOpObjectFactory SYSTEM "sgml/atknoopobjectfactory.sgml">
-<!entity atk-AtkObject SYSTEM "sgml/atkobject.sgml">
-<!entity atk-AtkObjectFactory SYSTEM "sgml/atkobjectfactory.sgml">
-<!entity atk-AtkRegistry SYSTEM "sgml/atkregistry.sgml">
-<!entity atk-AtkRelation SYSTEM "sgml/atkrelation.sgml">
-<!entity atk-AtkRelationSet SYSTEM "sgml/atkrelationset.sgml">
-<!entity atk-AtkSelection SYSTEM "sgml/atkselection.sgml">
-<!entity atk-AtkState SYSTEM "sgml/atkstate.sgml">
-<!entity atk-AtkStateSet SYSTEM "sgml/atkstateset.sgml">
-<!entity atk-AtkStreamableContent SYSTEM "sgml/atkstreamablecontent.sgml">
-<!entity atk-AtkTable SYSTEM "sgml/atktable.sgml">
-<!entity atk-AtkText SYSTEM "sgml/atktext.sgml">
-<!entity atk-AtkUtil SYSTEM "sgml/atkutil.sgml">
-<!entity atk-AtkValue SYSTEM "sgml/atkvalue.sgml">
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+  <!ENTITY atk-AtkAction SYSTEM "xml/atkaction.xml">
+  <!ENTITY atk-AtkComponent SYSTEM "xml/atkcomponent.xml">
+  <!ENTITY atk-AtkDocument SYSTEM "xml/atkdocument.xml">
+  <!ENTITY atk-AtkEditabletext SYSTEM "xml/atkeditabletext.xml">
+  <!ENTITY atk-AtkGObjectAccessible SYSTEM "xml/atkgobjectaccessible.xml">
+  <!ENTITY atk-AtkHyperlink SYSTEM "xml/atkhyperlink.xml">
+  <!ENTITY atk-AtkHyperlinkImpl SYSTEM "xml/atkhyperlinkimpl.xml">
+  <!ENTITY atk-AtkHypertext SYSTEM "xml/atkhypertext.xml">
+  <!ENTITY atk-AtkImage SYSTEM "xml/atkimage.xml">
+  <!ENTITY atk-AtkMisc SYSTEM "xml/atkmisc.xml">
+  <!ENTITY atk-AtkNoOpObject SYSTEM "xml/atknoopobject.xml">
+  <!ENTITY atk-AtkNoOpObjectFactory SYSTEM "xml/atknoopobjectfactory.xml">
+  <!ENTITY atk-AtkPlug SYSTEM "xml/atkplug.xml">
+  <!ENTITY atk-AtkObject SYSTEM "xml/atkobject.xml">
+  <!ENTITY atk-AtkObjectFactory SYSTEM "xml/atkobjectfactory.xml">
+  <!ENTITY atk-AtkRange SYSTEM "xml/atkrange.xml">
+  <!ENTITY atk-AtkRegistry SYSTEM "xml/atkregistry.xml">
+  <!ENTITY atk-AtkRelation SYSTEM "xml/atkrelation.xml">
+  <!ENTITY atk-AtkRelationSet SYSTEM "xml/atkrelationset.xml">
+  <!ENTITY atk-AtkSelection SYSTEM "xml/atkselection.xml">
+  <!ENTITY atk-AtkSocket SYSTEM "xml/atksocket.xml">
+  <!ENTITY atk-AtkState SYSTEM "xml/atkstate.xml">
+  <!ENTITY atk-AtkStateSet SYSTEM "xml/atkstateset.xml">
+  <!ENTITY atk-AtkStreamableContent SYSTEM "xml/atkstreamablecontent.xml">
+  <!ENTITY atk-AtkTable SYSTEM "xml/atktable.xml">
+  <!ENTITY atk-AtkTableCell SYSTEM "xml/atktablecell.xml">
+  <!ENTITY atk-AtkText SYSTEM "xml/atktext.xml">
+  <!ENTITY atk-AtkUtil SYSTEM "xml/atkutil.xml">
+  <!ENTITY atk-AtkValue SYSTEM "xml/atkvalue.xml">
+  <!ENTITY atk-AtkWindow SYSTEM "xml/atkwindow.xml">
+  <!ENTITY atk-AtkVersion SYSTEM "xml/atkversion.xml">
+  <!ENTITY version SYSTEM "version.xml">
 ]>
 
 <book>
   <bookinfo>
-    <title>ATK Library Reference Manual</title>
+    <title>ATK - Accessibility Toolkit</title>
+    <releaseinfo>for ATK &version;</releaseinfo>
   </bookinfo>
 
-  <chapter id="atk">
-    <title>ATK Library</title>
+  <chapter id="overview">
+    <title>Overview</title>
+     <para>
+       GNOME provides support for accessibility devices using the ATK
+       framework. This framework defines a set of interfaces to which
+       graphical interface components adhere. This allows, for instance,
+       screen readers to read the text of an interface and interact with its
+       controls. ATK support is built into GTK+ and the rest of the GNOME
+       platform, so any application using GTK+ will have reasonable
+       accessibility support for free.
+     </para>
+
+     <para>
+     Nonetheless, you should be aware of accessibility issues when when
+     developing your applications. Although GTK+ interfaces provide
+     reasonable accessibility by default, you can often improve how well
+     your program behaves with accessibility tools by providing additional
+     information to ATK. If you develop custom widgets, you should ensure
+     that they expose their properties to ATK
+     </para>
+
+  </chapter>
+
+  <chapter id="base-object">
+    <title>Base accessibility object</title>
+    &atk-AtkObject;
+  </chapter>
+
+  <chapter id="toolkit">
+    <title>Event and toolkit support</title>
+    &atk-AtkUtil;
+  </chapter>
+
+  <chapter id="interfaces">
+    <title>ATK Interfaces</title>
     &atk-AtkAction;
     &atk-AtkComponent;
+    &atk-AtkDocument;
     &atk-AtkEditabletext;
-    &atk-AtkHyperlink;
+    &atk-AtkHyperlinkImpl;
     &atk-AtkHypertext;
     &atk-AtkImage;
-    &atk-AtkNoOpObject;
-    &atk-AtkNoOpObjectFactory;
-    &atk-AtkObject;
-    &atk-AtkObjectFactory;
-    &atk-AtkRegistry;
-    &atk-AtkRelation;
-    &atk-AtkRelationSet;
     &atk-AtkSelection;
-    &atk-AtkState;
-    &atk-AtkStateSet;
     &atk-AtkStreamableContent;
     &atk-AtkTable;
+    &atk-AtkTableCell;
     &atk-AtkText;
-    &atk-AtkUtil;
     &atk-AtkValue;
-   </chapter>
+    &atk-AtkWindow;
+  </chapter>
+
+  <chapter id="data">
+    <title>Basic accessible data types</title>
+    &atk-AtkRange;
+    &atk-AtkRelation;
+    &atk-AtkRelationSet;
+    &atk-AtkState;
+    &atk-AtkStateSet;
+  </chapter>
+
+  <chapter id="accessibles">
+    <title>Custom accessible objects</title>
+    &atk-AtkGObjectAccessible;
+    &atk-AtkHyperlink;
+    &atk-AtkNoOpObject;
+    &atk-AtkPlug;
+    &atk-AtkSocket;
+  </chapter>
+
+  <chapter id="utilities">
+    <title>Utilities</title>
+    &atk-AtkNoOpObjectFactory;
+    &atk-AtkObjectFactory;
+    &atk-AtkRegistry;
+    &atk-AtkVersion;
+  </chapter>
+
+  <chapter id="deprecated">
+    <title>Deprecated Interfaces</title>
+    &atk-AtkMisc;
+  </chapter>
+
+  <index id="api-index-full">
+    <title>Index of all symbols</title>
+  </index>
+  <index id="api-index-deprecated" role="deprecated">
+    <title>Index of deprecated symbols</title>
+  </index>
+  <index id="api-index-1-3" role="1.3">
+    <title>Index of new symbols in 1.3</title>
+  </index>
+  <index id="api-index-1-4" role="1.4">
+    <title>Index of new symbols in 1.4</title>
+  </index>
+  <index id="api-index-1-6" role="1.6">
+    <title>Index of new symbols in 1.6</title>
+  </index>
+  <index id="api-index-1-9" role="1.9">
+    <title>Index of new symbols in 1.9</title>
+  </index>
+  <index id="api-index-1-12" role="1.12">
+    <title>Index of new symbols in 1.12</title>
+  </index>
+  <index id="api-index-1-13" role="1.13">
+    <title>Index of new symbols in 1.13</title>
+  </index>
+  <index id="api-index-1-20" role="1.20">
+    <title>Index of new symbols in 1.20</title>
+  </index>
+  <index id="api-index-1-22" role="1.22">
+    <title>Index of new symbols in 1.22</title>
+  </index>
+  <index id="api-index-1-30" role="1.30">
+    <title>Index of new symbols in 1.30</title>
+  </index>
+  <index id="api-index-2-2" role="2.2">
+    <title>Index of new symbols in 2.2</title>
+  </index>
+  <index id="api-index-2-8" role="2.8">
+    <title>Index of new symbols in 2.8</title>
+  </index>
+  <index id="api-index-2-10" role="2.10">
+    <title>Index of new symbols in 2.10</title>
+  </index>
+  <index id="api-index-2-12" role="2.12">
+    <title>Index of new symbols in 2.12</title>
+  </index>
 </book>