docs: change id of the atkobject chapter

[platform/upstream/atk.git] / docs / atk-docs.sgml

diff --git a/docs/atk-docs.sgml b/docs/atk-docs.sgml
index 6061efc..2d9991e 100644 (file)
--- a/docs/atk-docs.sgml
+++ b/docs/atk-docs.sgml
@@ -16,6 +16,7 @@
   <!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">
@@ -40,41 +41,80 @@
     <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-AtkGObjectAccessible;
-    &atk-AtkHyperlink;
     &atk-AtkHyperlinkImpl;
     &atk-AtkHypertext;
     &atk-AtkImage;
-    &atk-AtkNoOpObject;
-    &atk-AtkNoOpObjectFactory;
-    &atk-AtkObject;
-    &atk-AtkObjectFactory;
-    &atk-AtkPlug;
-    &atk-AtkRegistry;
-    &atk-AtkRelation;
-    &atk-AtkRelationSet;
     &atk-AtkSelection;
-    &atk-AtkSocket;
-    &atk-AtkState;
-    &atk-AtkStateSet;
     &atk-AtkStreamableContent;
     &atk-AtkTable;
     &atk-AtkTableCell;
     &atk-AtkText;
-    &atk-AtkUtil;
     &atk-AtkValue;
     &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>
 
@@ -125,6 +165,8 @@
   <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>