Playing around with barf
[rodin/chimara.git] / docs / reference / chimara-docs.sgml
1 <?xml version="1.0"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4 <!ENTITY version SYSTEM "version.xml">
5 ]>
6 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
7   <bookinfo>
8     <title>Chimara Reference Manual</title>
9     <releaseinfo>
10       for Chimara &version;. The latest version of this documentation can be 
11       found on-line at <ulink role="online-location" 
12       url="http://[SERVER]/chimara/index.html">http://[SERVER]/chimara/</ulink>.
13     </releaseinfo>
14   </bookinfo>
15
16   <reference>
17     <title>Chimara API Reference</title>
18     <xi:include href="xml/chimara-glk.xml"/>
19     <xi:include href="xml/chimara-if.xml"/>
20   </reference>
21   
22   <reference>
23     <title>Glk API Specification, version 0.7.0</title>
24     <xi:include href="glk-front-matter.sgml"/>
25     
26     <!-- Chapter 0. Introduction -->
27     <xi:include href="glk-introduction.sgml"/>
28     
29     <!-- Chapter 1. Overall Structure -->
30     <chapter>
31       <title>Overall Structure</title>
32       <!-- For Gtk-Doc post-processed SGML files, look in the xml directory-->
33       <xi:include href="xml/glk-main-function.sgml"/>
34       <xi:include href="xml/glk-exiting.xml"/>
35       <xi:include href="xml/glk-interrupt.xml"/>
36       <xi:include href="xml/glk-tick.xml"/>
37       <xi:include href="xml/glk-types.xml"/>
38       <xi:include href="xml/glk-opaque-objects.xml"/>
39       <xi:include href="xml/glk-gestalt.xml"/>
40       <xi:include href="xml/glk-api-conventions.sgml"/>
41     </chapter>
42     
43     <!-- Chapter 2. Character Encoding -->
44     <chapter>
45       <title>Character Encoding</title>
46       <xi:include href="glk-character-encoding.sgml"/>
47       <xi:include href="xml/glk-output.sgml"/>
48       <xi:include href="xml/glk-line-input.sgml"/>
49       <xi:include href="xml/glk-character-input.xml"/>
50       <xi:include href="xml/glk-case.xml"/>
51     </chapter>
52     
53     <!-- Chapter 3. Windows -->
54     <chapter>
55       <title>Windows</title>
56       <xi:include href="glk-windows.sgml"/>
57       <xi:include href="xml/glk-window-arrangement.sgml"/>
58       <xi:include href="xml/glk-window-opening.xml"/>
59       <xi:include href="xml/glk-window-constraints.xml"/>
60       <xi:include href="xml/glk-display-style.sgml"/>
61       <xi:include href="xml/glk-window-types.xml"/>
62       <xi:include href="xml/glk-echo-streams.xml"/>
63       <xi:include href="xml/glk-window-other.xml"/>
64     </chapter>
65     
66     <!-- Chapter 4. Events -->
67     <chapter>
68       <title>Events</title>
69       <xi:include href="xml/glk-events.xml"/>
70       <xi:include href="xml/glk-character-input-events.xml"/>
71       <xi:include href="xml/glk-line-input-events.xml"/>
72       <xi:include href="xml/glk-mouse-events.xml"/>
73       <xi:include href="xml/glk-timer-events.xml"/>
74       <xi:include href="xml/glk-other-events.sgml"/>
75         </chapter>
76         
77         <!-- Chapter 5. Streams -->
78         <chapter>
79           <title>Streams</title>
80           <xi:include href="xml/glk-streams.xml"/>
81           <xi:include href="xml/glk-print.xml"/>
82           <xi:include href="xml/glk-read.xml"/>
83           <xi:include href="xml/glk-closing-streams.xml"/>
84           <xi:include href="xml/glk-stream-positions.xml"/>
85           <xi:include href="xml/glk-styles.xml"/>
86           <xi:include href="xml/glk-stylehints.xml"/>
87           <!--<xi:include href="xml/glk-style-measure.xml"/>-->
88           <xi:include href="xml/glk-stream-types.xml"/>
89           <xi:include href="xml/glk-stream-other.xml"/>
90         </chapter>
91         
92         <!-- Chapter 6. File References -->
93         <chapter>
94           <title>File References</title>
95           <xi:include href="xml/glk-fileref.xml"/>
96           <xi:include href="xml/glk-fileref-types.xml"/>      
97       <xi:include href="xml/glk-fileref-other.xml"/>
98     </chapter>
99     
100     <!-- Chapter 7. Graphics -->
101     <chapter>
102       <title>Graphics</title>
103       <xi:include href="xml/glk-image-resources.xml"/>
104       <xi:include href="xml/glk-graphics-windows.xml"/>
105       <!--<xi:include href="xml/glk-graphics-text.xml"/>-->
106       <xi:include href="xml/glk-graphics-testing.xml"/>
107     </chapter>
108     
109     <!-- Chapter 8. Sound -->
110 <!--    <chapter>
111       <title>Sound</title>
112       <xi:include href="xml/glk-sound-channels.xml"/>
113       <xi:include href="xml/glk-playing-sounds.xml"/>
114       <xi:include href="xml/glk-sound-other.xml"/>
115       <xi:include href="xml/glk-sound-testing.xml"/>
116     </chapter>
117 -->    
118     <!-- Chapter 9. Hyperlinks -->
119     <chapter>
120       <title>Hyperlinks</title>
121       <xi:include href="xml/glk-creating-hyperlinks.xml"/>
122       <xi:include href="xml/glk-accepting-hyperlinks.xml"/>
123       <xi:include href="xml/glk-hyperlinks-testing.xml"/>
124     </chapter>
125     
126     <!-- Chapter 10. Porting, Adapting and Other Messy Bits -->
127     <xi:include href="glk-porting.sgml"/>
128    
129     <!-- Chapter 11. Appendices -->
130     <appendix>
131       <title>The Dispatch Layer</title>
132       <xi:include href="dispatch.sgml"/>
133       <xi:include href="xml/dispatch-interrogating.xml"/>
134       <xi:include href="xml/dispatch-dispatching.xml"/>
135       <xi:include href="xml/dispatch-prototypes.xml"/>
136       <xi:include href="xml/dispatch-library-functions.xml"/>
137       <xi:include href="dispatch-selectors.sgml"/>
138     </appendix>
139
140     <appendix>
141       <title>The Blorb Layer</title>
142       <xi:include href="blorb.sgml"/>
143       <xi:include href="xml/blorb-program.xml"/>
144       <xi:include href="blorb-library.sgml"/>
145       <xi:include href="xml/blorb-layer.xml"/>
146       <xi:include href="xml/blorb-errors.xml"/>
147     </appendix>
148     
149     <appendix>
150      <title>Glk Extensions</title>
151      <xi:include href="xml/glkext-startup.xml"/>
152      <xi:include href="xml/glkext-unix.xml"/>
153     </appendix>
154   </reference>
155 </book>