Added underscore to prevent marshaller functions from being exported in library
[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>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     </chapter>
48     
49     <!-- Chapter 3. Windows -->
50     <chapter>
51       <title>Windows</title>
52       <xi:include href="glk-windows.sgml"/>
53       <xi:include href="xml/glk-window-arrangement.sgml"/>
54       <xi:include href="xml/glk-window-opening.xml"/>
55       <xi:include href="xml/glk-window-constraints.xml"/>
56       <xi:include href="xml/glk-display-style.sgml"/>
57       <xi:include href="xml/glk-window-types.xml"/>
58       <xi:include href="xml/glk-echo-streams.xml"/>
59       <xi:include href="xml/glk-window-other.xml"/>
60     </chapter>
61     
62     <!-- Chapter 4. Events -->
63     <chapter>
64       <title>Events</title>
65       <xi:include href="xml/glk-events.xml"/>
66       <xi:include href="xml/glk-character-input-events.xml"/>
67       <xi:include href="xml/glk-line-input-events.xml"/>
68       <xi:include href="xml/glk-mouse-events.xml"/>
69       <xi:include href="xml/glk-timer-events.xml"/>
70       <xi:include href="xml/glk-other-events.sgml"/>
71         </chapter>
72         
73         <!-- Chapter 5. Streams -->
74         <chapter>
75           <title>Streams</title>
76           <xi:include href="xml/glk-streams.xml"/>
77           <xi:include href="xml/glk-print.xml"/>
78           <xi:include href="xml/glk-read.xml"/>
79           <xi:include href="xml/glk-closing-streams.xml"/>
80           <xi:include href="xml/glk-stream-positions.xml"/>
81           <xi:include href="xml/glk-styles.xml"/>
82           <xi:include href="xml/glk-stylehints.xml"/>
83           <xi:include href="xml/glk-style-measure.xml"/>
84           <xi:include href="xml/glk-stream-types.xml"/>
85           <xi:include href="xml/glk-stream-other.xml"/>
86         </chapter>
87         
88         <!-- Chapter 6. File References -->
89         <chapter>
90           <title>File References</title>
91           <xi:include href="xml/glk-fileref.xml"/>
92           <xi:include href="xml/glk-fileref-types.xml"/>      
93       <xi:include href="xml/glk-fileref-other.xml"/>
94     </chapter>
95     
96     <!-- Chapter 7. Graphics -->
97     <chapter>
98       <title>Graphics</title>
99       <xi:include href="xml/glk-image-resources.xml"/>
100       <xi:include href="xml/glk-graphics-windows.xml"/>
101       <xi:include href="xml/glk-graphics-text.xml"/>
102       <xi:include href="xml/glk-graphics-testing.xml"/>
103     </chapter>
104     
105     <!-- Chapter 8. Sound -->
106     <chapter>
107       <title>Sound</title>
108       <xi:include href="glk-sound-resources.sgml"/>
109       <xi:include href="xml/glk-sound-channels.xml"/>
110       <xi:include href="xml/glk-playing-sounds.xml"/>
111       <xi:include href="xml/glk-sound-other.xml"/>
112       <xi:include href="xml/glk-sound-testing.xml"/>
113     </chapter>
114     
115     <!-- Chapter 9. Hyperlinks -->
116     <chapter>
117       <title>Hyperlinks</title>
118       <xi:include href="xml/glk-creating-hyperlinks.xml"/>
119       <xi:include href="xml/glk-accepting-hyperlinks.xml"/>
120       <xi:include href="xml/glk-hyperlinks-testing.xml"/>
121     </chapter>
122     
123     <!-- Chapter 10. Porting, Adapting and Other Messy Bits -->
124     <xi:include href="glk-porting.sgml"/>
125    
126     <!-- Chapter 11. Appendices -->
127     <appendix>
128       <title>The Dispatch Layer</title>
129       <xi:include href="dispatch.sgml"/>
130       <xi:include href="xml/dispatch-interrogating.xml"/>
131       <xi:include href="xml/dispatch-dispatching.xml"/>
132       <xi:include href="xml/dispatch-prototypes.xml"/>
133       <xi:include href="xml/dispatch-library-functions.xml"/>
134       <xi:include href="dispatch-selectors.sgml"/>
135     </appendix>
136
137     <appendix>
138       <title>The Blorb Layer</title>
139       <xi:include href="blorb.sgml"/>
140       <xi:include href="xml/blorb-program.xml"/>
141       <xi:include href="blorb-library.sgml"/>
142       <xi:include href="xml/blorb-layer.xml"/>
143       <xi:include href="xml/blorb-errors.xml"/>
144     </appendix>
145     
146     <appendix>
147      <title>Glk Extensions</title>
148      <xi:include href="xml/glkext-startup.xml"/>
149      <xi:include href="xml/glkext-unix.xml"/>
150      <xi:include href="xml/glkext-garglk.xml"/>
151     </appendix>
152   </reference>
153 </book>