git: Line endings of README.txt
[projects/chimara/chimara.git] / 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>for Chimara &version;</releaseinfo>
10   </bookinfo>
11
12   <reference>
13     <title>Chimara API Reference</title>
14     <xi:include href="xml/chimara-glk.xml"/>
15     <xi:include href="xml/chimara-if.xml"/>
16   </reference>
17   
18   <reference>
19     <title>Glk API Specification, version 0.7.0</title>
20     <xi:include href="glk-front-matter.sgml"/>
21     
22     <!-- Chapter 0. Introduction -->
23     <xi:include href="glk-introduction.sgml"/>
24     
25     <!-- Chapter 1. Overall Structure -->
26     <chapter>
27       <title>Overall Structure</title>
28       <!-- For Gtk-Doc post-processed SGML files, look in the xml directory-->
29       <xi:include href="xml/glk-main-function.sgml"/>
30       <xi:include href="xml/glk-exiting.xml"/>
31       <xi:include href="xml/glk-interrupt.xml"/>
32       <xi:include href="xml/glk-tick.xml"/>
33       <xi:include href="xml/glk-types.xml"/>
34       <xi:include href="xml/glk-opaque-objects.xml"/>
35       <xi:include href="xml/glk-gestalt.xml"/>
36       <xi:include href="xml/glk-api-conventions.sgml"/>
37     </chapter>
38     
39     <!-- Chapter 2. Character Encoding -->
40     <chapter>
41       <title>Character Encoding</title>
42       <xi:include href="glk-character-encoding.sgml"/>
43       <xi:include href="xml/glk-output.sgml"/>
44       <xi:include href="xml/glk-line-input.sgml"/>
45       <xi:include href="xml/glk-character-input.xml"/>
46       <xi:include href="xml/glk-case.xml"/>
47           <xi:include href="xml/glk-normalize.xml"/>
48           <xi:include href="xml/glk-normalization.sgml"/>
49     </chapter>
50     
51     <!-- Chapter 3. Windows -->
52     <chapter>
53       <title>Windows</title>
54       <xi:include href="glk-windows.sgml"/>
55       <xi:include href="xml/glk-window-arrangement.sgml"/>
56       <xi:include href="xml/glk-window-opening.xml"/>
57       <xi:include href="xml/glk-window-constraints.xml"/>
58       <xi:include href="xml/glk-display-style.sgml"/>
59       <xi:include href="xml/glk-window-types.xml"/>
60       <xi:include href="xml/glk-echo-streams.xml"/>
61       <xi:include href="xml/glk-window-other.xml"/>
62     </chapter>
63     
64     <!-- Chapter 4. Events -->
65     <chapter>
66       <title>Events</title>
67       <xi:include href="xml/glk-events.xml"/>
68       <xi:include href="xml/glk-character-input-events.xml"/>
69       <xi:include href="xml/glk-line-input-events.xml"/>
70       <xi:include href="xml/glk-mouse-events.xml"/>
71       <xi:include href="xml/glk-timer-events.xml"/>
72       <xi:include href="xml/glk-other-events.sgml"/>
73         </chapter>
74         
75         <!-- Chapter 5. Streams -->
76         <chapter>
77           <title>Streams</title>
78           <xi:include href="xml/glk-streams.xml"/>
79           <xi:include href="xml/glk-print.xml"/>
80           <xi:include href="xml/glk-read.xml"/>
81           <xi:include href="xml/glk-closing-streams.xml"/>
82           <xi:include href="xml/glk-stream-positions.xml"/>
83           <xi:include href="xml/glk-styles.xml"/>
84           <xi:include href="xml/glk-stylehints.xml"/>
85           <xi:include href="xml/glk-style-measure.xml"/>
86           <xi:include href="xml/glk-stream-types.xml"/>
87           <xi:include href="xml/glk-stream-other.xml"/>
88         </chapter>
89         
90         <!-- Chapter 6. File References -->
91         <chapter>
92           <title>File References</title>
93           <xi:include href="xml/glk-fileref.xml"/>
94           <xi:include href="xml/glk-fileref-types.xml"/>      
95       <xi:include href="xml/glk-fileref-other.xml"/>
96     </chapter>
97     
98     <!-- Chapter 7. Graphics -->
99     <chapter>
100       <title>Graphics</title>
101       <xi:include href="xml/glk-image-resources.xml"/>
102       <xi:include href="xml/glk-graphics-windows.xml"/>
103       <xi:include href="xml/glk-graphics-text.xml"/>
104       <xi:include href="xml/glk-graphics-testing.xml"/>
105     </chapter>
106     
107     <!-- Chapter 8. Sound -->
108     <chapter id="chimara-chapter-Sound">
109       <title>Sound</title>
110       <xi:include href="glk-sound-resources.sgml"/>
111       <xi:include href="xml/glk-sound-channels.xml"/>
112       <xi:include href="xml/glk-playing-sounds.xml"/>
113       <xi:include href="xml/glk-sound-other.xml"/>
114       <xi:include href="xml/glk-sound-testing.xml"/>
115     </chapter>
116     
117     <!-- Chapter 9. Hyperlinks -->
118     <chapter>
119       <title>Hyperlinks</title>
120       <xi:include href="xml/glk-creating-hyperlinks.xml"/>
121       <xi:include href="xml/glk-accepting-hyperlinks.xml"/>
122       <xi:include href="xml/glk-hyperlinks-testing.xml"/>
123     </chapter>
124
125         <!-- Chapter 10. The System Clock -->
126         <chapter>
127           <title>The System Clock</title>
128           <xi:include href="xml/glk-clock.xml"/>
129           <xi:include href="xml/glk-clock-conversions.xml"/>
130           <xi:include href="xml/glk-clock-testing.xml"/>
131         </chapter>
132     
133     <!-- Chapter 11. Porting, Adapting and Other Messy Bits -->
134     <xi:include href="glk-porting.sgml"/>
135    
136     <!-- Appendices -->
137     <appendix>
138       <title>The Dispatch Layer</title>
139       <xi:include href="dispatch.sgml"/>
140       <xi:include href="xml/dispatch-interrogating.xml"/>
141       <xi:include href="xml/dispatch-dispatching.xml"/>
142       <xi:include href="xml/dispatch-prototypes.xml"/>
143       <xi:include href="xml/dispatch-library-functions.xml"/>
144       <xi:include href="dispatch-selectors.sgml"/>
145     </appendix>
146
147     <appendix>
148       <title>The Blorb Layer</title>
149       <xi:include href="blorb.sgml"/>
150       <xi:include href="xml/blorb-program.xml"/>
151       <xi:include href="blorb-library.sgml"/>
152       <xi:include href="xml/blorb-layer.xml"/>
153       <xi:include href="xml/blorb-errors.xml"/>
154     </appendix>
155     
156     <appendix>
157      <title>Glk Extensions</title>
158      <xi:include href="xml/glkext-startup.xml"/>
159      <xi:include href="xml/glkext-unix.xml"/>
160      <xi:include href="xml/glkext-garglk.xml"/>
161     </appendix>
162   </reference>
163   
164   <!-- Index -->
165   <index id="api-index">
166    <title>Index of symbols</title>
167    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
168   </index>
169 </book>