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