Add introspection glossary to documentation

[projects/chimara/chimara.git] / docs / reference / chimara-docs.sgml

diff --git a/docs/reference/chimara-docs.sgml b/docs/reference/chimara-docs.sgml
index 412d6a09303c39d52943f453ab63e1885dbe95d7..af494a7332962aa823c35fbbb6f863e6e65021c9 100644 (file)
--- a/docs/reference/chimara-docs.sgml
+++ b/docs/reference/chimara-docs.sgml
@@ -4,22 +4,21 @@
 <!ENTITY version SYSTEM "version.xml">
 ]>
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+
   <bookinfo>
     <title>Chimara Reference Manual</title>
-    <releaseinfo>
-      for Chimara &version;. The latest version of this documentation can be 
-      found on-line at <ulink role="online-location" 
-      url="http://[SERVER]/chimara/index.html">http://[SERVER]/chimara/</ulink>.
-    </releaseinfo>
+    <releaseinfo>for Chimara &version;</releaseinfo>
   </bookinfo>
 
-  <reference>
+  <reference id="chimara-api-reference">
     <title>Chimara API Reference</title>
     <xi:include href="xml/chimara-glk.xml"/>
     <xi:include href="xml/chimara-if.xml"/>
   </reference>
   
-  <reference>
+  <reference id="chimara-glk-api-spec">
     <title>Glk API Specification, version 0.7.0</title>
     <xi:include href="glk-front-matter.sgml"/>
     
@@ -27,7 +26,7 @@
     <xi:include href="glk-introduction.sgml"/>
     
     <!-- Chapter 1. Overall Structure -->
-    <chapter>
+    <chapter id="chimara-glk-spec-overall-structure">
       <title>Overall Structure</title>
       <!-- For Gtk-Doc post-processed SGML files, look in the xml directory-->
       <xi:include href="xml/glk-main-function.sgml"/>
@@ -41,17 +40,19 @@
     </chapter>
     
     <!-- Chapter 2. Character Encoding -->
-    <chapter>
+    <chapter id="chimara-glk-spec-character-encoding">
       <title>Character Encoding</title>
       <xi:include href="glk-character-encoding.sgml"/>
       <xi:include href="xml/glk-output.sgml"/>
       <xi:include href="xml/glk-line-input.sgml"/>
       <xi:include href="xml/glk-character-input.xml"/>
       <xi:include href="xml/glk-case.xml"/>
+         <xi:include href="xml/glk-normalize.xml"/>
+         <xi:include href="xml/glk-normalization.sgml"/>
     </chapter>
     
     <!-- Chapter 3. Windows -->
-    <chapter>
+    <chapter id="chimara-glk-spec-windows">
       <title>Windows</title>
       <xi:include href="glk-windows.sgml"/>
       <xi:include href="xml/glk-window-arrangement.sgml"/>
@@ -64,18 +65,18 @@
     </chapter>
     
     <!-- Chapter 4. Events -->
-    <chapter>
+    <chapter id="chimara-glk-spec-events">
       <title>Events</title>
       <xi:include href="xml/glk-events.xml"/>
       <xi:include href="xml/glk-character-input-events.xml"/>
       <xi:include href="xml/glk-line-input-events.xml"/>
-      <!--<xi:include href="xml/glk-mouse-events.xml"/>-->
+      <xi:include href="xml/glk-mouse-events.xml"/>
       <xi:include href="xml/glk-timer-events.xml"/>
       <xi:include href="xml/glk-other-events.sgml"/>
        </chapter>
        
        <!-- Chapter 5. Streams -->
-       <chapter>
+       <chapter id="chimara-glk-spec-streams">
          <title>Streams</title>
          <xi:include href="xml/glk-streams.xml"/>
          <xi:include href="xml/glk-print.xml"/>
@@ -84,13 +85,13 @@
          <xi:include href="xml/glk-stream-positions.xml"/>
          <xi:include href="xml/glk-styles.xml"/>
          <xi:include href="xml/glk-stylehints.xml"/>
-         <!--<xi:include href="xml/glk-style-measure.xml"/>-->
+         <xi:include href="xml/glk-style-measure.xml"/>
          <xi:include href="xml/glk-stream-types.xml"/>
          <xi:include href="xml/glk-stream-other.xml"/>
        </chapter>
        
        <!-- Chapter 6. File References -->
-       <chapter>
+       <chapter id="chimara-glk-spec-file-references">
          <title>File References</title>
          <xi:include href="xml/glk-fileref.xml"/>
          <xi:include href="xml/glk-fileref-types.xml"/>      
@@ -98,36 +99,45 @@
     </chapter>
     
     <!-- Chapter 7. Graphics -->
-<!--    <chapter>
+    <chapter id="chimara-glk-spec-graphics">
       <title>Graphics</title>
       <xi:include href="xml/glk-image-resources.xml"/>
       <xi:include href="xml/glk-graphics-windows.xml"/>
       <xi:include href="xml/glk-graphics-text.xml"/>
       <xi:include href="xml/glk-graphics-testing.xml"/>
     </chapter>
--->    
+    
     <!-- Chapter 8. Sound -->
-<!--    <chapter>
+    <chapter id="chimara-glk-spec-sound">
       <title>Sound</title>
+      <xi:include href="glk-sound-resources.sgml"/>
       <xi:include href="xml/glk-sound-channels.xml"/>
       <xi:include href="xml/glk-playing-sounds.xml"/>
       <xi:include href="xml/glk-sound-other.xml"/>
       <xi:include href="xml/glk-sound-testing.xml"/>
     </chapter>
--->    
+    
     <!-- Chapter 9. Hyperlinks -->
-<!--    <chapter>
+    <chapter id="chimara-glk-spec-hyperlinks">
       <title>Hyperlinks</title>
       <xi:include href="xml/glk-creating-hyperlinks.xml"/>
       <xi:include href="xml/glk-accepting-hyperlinks.xml"/>
       <xi:include href="xml/glk-hyperlinks-testing.xml"/>
     </chapter>
--->    
-    <!-- Chapter 10. Porting, Adapting and Other Messy Bits -->
+
+       <!-- Chapter 10. The System Clock -->
+       <chapter id="chimara-glk-spec-the-system-clock">
+         <title>The System Clock</title>
+         <xi:include href="xml/glk-clock.xml"/>
+         <xi:include href="xml/glk-clock-conversions.xml"/>
+         <xi:include href="xml/glk-clock-testing.xml"/>
+       </chapter>
+    
+    <!-- Chapter 11. Porting, Adapting and Other Messy Bits -->
     <xi:include href="glk-porting.sgml"/>
    
-    <!-- Chapter 11. Appendices -->
-    <appendix>
+    <!-- Appendices -->
+    <appendix id="chimara-glk-spec-the-dispatch-layer">
       <title>The Dispatch Layer</title>
       <xi:include href="dispatch.sgml"/>
       <xi:include href="xml/dispatch-interrogating.xml"/>
@@ -137,7 +147,7 @@
       <xi:include href="dispatch-selectors.sgml"/>
     </appendix>
 
-    <appendix>
+    <appendix id="chimara-glk-spec-the-blorb-layer">
       <title>The Blorb Layer</title>
       <xi:include href="blorb.sgml"/>
       <xi:include href="xml/blorb-program.xml"/>
@@ -146,10 +156,17 @@
       <xi:include href="xml/blorb-errors.xml"/>
     </appendix>
     
-    <appendix>
+    <appendix id="chimara-glk-spec-glk-extensions">
      <title>Glk Extensions</title>
      <xi:include href="xml/glkext-startup.xml"/>
      <xi:include href="xml/glkext-unix.xml"/>
+     <xi:include href="xml/glkext-garglk.xml"/>
     </appendix>
   </reference>
+  
+  <!-- Index -->
+  <index id="api-index">
+   <title>Index of symbols</title>
+   <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
 </book>