1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>XAE User's Guide</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.18">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="book" id="c36b1">
<div class="titlepage">
<h1 class="title"><a name="c36b1">XAE User's Guide</a></h1>
<hr>
</div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt>1. <a href="#c36b1b1">Introduction</a></dt>
<dd>
<dl>
<dt> <a href="#c36b1b1b2">About XAE</a></dt>
<dt> <a href="#c36b1b1b3">Supported Platforms</a></dt>
<dt> <a href="#c36b1b1b4">Requirements</a></dt>
</dl>
</dd>
<dt>2. <a href="#c36b1b2">Quick Start</a></dt>
<dd>
<dl>
<dt> <a href="#c36b1b2b2">Creating the Skeleton Document</a></dt>
<dt> <a href="#c36b1b2b3">Contents of the Skeleton Book File</a></dt>
<dt> <a href="#c36b1b2b4">Editing the Short Book</a></dt>
<dd>
<dl>
<dt> <a href="#c36b1b2b4b2">Creating a Para Element</a></dt>
<dt> <a href="#c36b1b2b4b3">Tagging a Region</a></dt>
</dl>
</dd>
</dl>
</dd>
</dl>
</div>
<div id="c36b1b1" class="chapter">
<h2 class="title"><a name="c36b1b1">1. Introduction</a></h2>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt> <a href="#c36b1b1b2">About XAE</a></dt>
<dt> <a href="#c36b1b1b3">Supported Platforms</a></dt>
<dt> <a href="#c36b1b1b4">Requirements</a></dt>
</dl>
</div>
<p>Welcome to the <i>XAE User's Guide</i>.
This guide explains how to use the XAE to create, display, and
transform XML documents.
</p>
<div id="c36b1b1b2" class="section">
<h2 class="title" style="clear: all"><a name="c36b1b1b2"><b>About XAE</b></a></h2>
<p>The XML Authoring Environment (XAE) for Emacs is a
software package that allows you to use Emacs (or XEmacs) to
create, display, and transform XML documents. Features
include:
</p>
<div class="itemizedlist">
<ul>
<li><a name="c36b1b1b2b2a"></a><p>XML structure editor (<tt>psgml</tt>) mode
</p>
</li>
<li><a name="c36b1b1b2b2b1"></a><p>XSLT processor (Saxon)</p>
</li>
<li><a name="c36b1b1b2b2b2"></a><p>Comes with Docbook DTD and associated stylesheets</p>
</li>
<li><a name="c36b1b1b2b2b3"></a><p>Displays XML documents in your system's browser</p>
</li>
<li><a name="c36b1b1b2b2b4"></a><p>Caches compiled stylesheets</p>
</li>
</ul>
</div>
</div>
<div id="c36b1b1b3" class="section">
<h2 class="title" style="clear: all"><a name="c36b1b1b3"><b>Supported Platforms</b></a></h2>
<p>The XAE runs on all platforms that support Emacs and Java. This includes all versions
of Windows and most Unix and Linux systems.
</p>
</div>
<div id="c36b1b1b4" class="section">
<h2 class="title" style="clear: all"><a name="c36b1b1b4"><b>Requirements</b></a></h2>
<p>The XAE requires that the following software packages be installed on your system.</p>
<div class="itemizedlist">
<ul>
<li><a name="c36b1b1b4b2a"></a><p>Emacs or XEmacs</p>
</li>
<li><a name="c36b1b1b4b2b1"></a><p>Java runtime environment</p>
</li>
<li><a name="c36b1b1b4b2b2"></a><p><a href="http://cedet.sourceforge.net/eieio.shtml">eieio</a>
object-oriented Lisp programming package for Emacs
</p>
</li>
</ul>
</div>
</div>
</div>
<div id="c36b1b2" class="chapter">
<h2 class="title"><a name="c36b1b2">2. Quick Start</a></h2>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt> <a href="#c36b1b2b2">Creating the Skeleton Document</a></dt>
<dt> <a href="#c36b1b2b3">Contents of the Skeleton Book File</a></dt>
<dt> <a href="#c36b1b2b4">Editing the Short Book</a></dt>
<dd>
<dl>
<dt> <a href="#c36b1b2b4b2">Creating a Para Element</a></dt>
<dt> <a href="#c36b1b2b4b3">Tagging a Region</a></dt>
</dl>
</dd>
</dl>
</div>
<p>This chapter aims to teach you the basics using the XAE
by taking you step-by-step through the creation of a simple
XML document entitled <i>The Short Book</i>.
We start by creating a skeleton document.
</p>
<div id="c36b1b2b2" class="section">
<h2 class="title" style="clear: all"><a name="c36b1b2b2"><b>Creating the Skeleton Document</b></a></h2>
<p>To create the skeleton document,</p>
<div class="procedure">
<ol>
<li>
<p>Select
Files->XAE->Book from
the Emacs menubar.
</p>
<p>
<div class="screenshot">
<div class="mediaobject"><img src="images/new_book_menu.gif"></div>
</div>
</p>
<p>The XAE prompts you to enter the title of the new
book.
</p>
<p>
<div class="screenshot">
<div class="mediaobject"><img src="images/book_title_prompt.gif"></div>
</div>
</p>
</li>
<li>
<p>
Enter "The Short Book" at the prompt and press the Enter
key on your keyboard.
</p>
<p>The XAE creates the skeleton document.
</p>
<p>
<div class="screenshot">
<div class="mediaobject"><img src="images/new_book.gif"></div>
</div>
</p>
</li>
<li>
<p>Save the new book.</p>
<p>Use the
Files->Save Buffer
As... (C-x C-w) command to save the buffer.
You can save the book in the current directory or any
other suitable place on your file system.
</p>
</li>
</ol>
</div>
</div>
<div id="c36b1b2b3" class="section">
<h2 class="title" style="clear: all"><a name="c36b1b2b3"><b>Contents of the Skeleton Book File</b></a></h2>
<div class="table">
<p><a name="c36b1b2b3b1"></a><b>Table 2.1. Skeleton Book File Contents</b></p>
<table border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead>
<tr>
<th>
<p>Line</p>
</th>
<th>Contents</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>1</p>
</td>
<td>
<p>XML processing instruction for this
document. This processing instruction identifies
this document as an XML document.
</p>
</td>
</tr>
<tr>
<td>
<p>3</p>
</td>
<td>
<p>Document type declaration for this document.
It declares this book to be an instance
of the Docbook document type.
</p>
</td>
</tr>
<tr>
<td>
<p>5</p>
</td>
<td>Style sheet processing instruction for this
document. The processing instruction associates this
document with the Docbook HTML stylesheet. The Docbook
HTML stylesheet converts this document from XML to
HTML.
</td>
</tr>
<tr>
<td>
<p>7-12</p>
</td>
<td>
<p>Initial elements of this book.</p>
</td>
</tr>
<tr>
<td>
<p>14-21</p>
</td>
<td>
<p>default psgml-mode settings for this document.
psgml is an Emacs Lisp package that provides the XAE
with XML structured editing capabilites. When Emacs loads this
document, it sets buffer-local copies of the specified psgml
customization variables to the specified values.
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="c36b1b2b4" class="section">
<h2 class="title" style="clear: all"><a name="c36b1b2b4"><b>Editing the Short Book</b></a></h2>
<p> Now let's add some content to the Short Book. First, insert the word
"Introduction" into the title element of the first chapter. Next, let's
use the XAE's structured document editor (psgml mode) to add a first paragraph to
the introductory chapter. In so doing, we will learn how to use the editor
to create elements.
</p>
<div id="c36b1b2b4b2" class="section">
<h3 class="title"><a name="c36b1b2b4b2"><b>Creating a Para Element</b></a></h3>
<p>To add the paragraph element:</p>
<div class="procedure">
<ol>
<li>
<p>Position the Emacs text cursor anywhere between the
end of the first chapter's title element and the end of the first chapter.
</p>
</li>
<li>
<p>Select Markup from the Emacs menubar.</p>
<p>You should see a "parsing DTD" message in the Emacs minibuffer. This
indicates that Emacs is parsing the Docbook DTD of which "The Short Book"
is an instance. The Docbook DTD has more than 300 elements. However, parsing
it should take no longer than 30 seconds. If it seems to be taking a very
long time, it is probably because you have not byte-compiled the PSGML lisp code.
If not, you should kill and restart Emacs and byte-compile PSGML before
proceeding further.
</p>
<p>When Emacs is done parsing the DTD, it displays a menu of elements that
you can create after a chapter title.
</p>
<p>
<div class="screenshot">
<div class="mediaobject"><img src="images/create_para_elem.gif"></div>
</div>
</p>
</li>
<li>
<p>Select para from the menu.</p>
<p>Emacs inserts a para element after the title
element and positions the Emacs text cursor inside the element so that
you can enter the element's content.
</p>
<p>
<div class="screenshot">
<div class="mediaobject"><img src="images/create_para_elem2.gif"></div>
</div>
</p>
</li>
<li>
<p>Insert the sentence, "Welcome to a very short book." in the
element.
</p>
</li>
</ol>
</div>
</div>
<div id="c36b1b2b4b3" class="section">
<h3 class="title"><a name="c36b1b2b4b3"><b>Tagging a Region</b></a></h3>
<p>Suppose that we want to emphasize "very" in the sentence we just added.
We can do this by tagging the word as a Docbook emphasis element.
</p>
<p>To emphasize "very" in the sentence we just added:</p>
<div class="procedure">
<ol>
<li>
<p>Select the region of the Emacs buffer containing "very."</p>
</li>
<li>
<p>Select Markup->Tag Region from the Emacs menubar.
</p>
<p>
<div class="screenshot">
<div class="mediaobject"><img src="images/tag_region_cmd.gif"></div>
</div>
</p>
<p>Emacs displays a menu of elements that you can create around the
selected region at this point in the document.
</p>
<p>
<div class="screenshot">
<div class="mediaobject"><img src="images/tag_region_menu.gif"></div>
</div>
</p>
</li>
<li>
<p>Select emphasis from the menu.
</p>
<p>Emacs inserts an emphasis start and end tag around "very" in the
buffer.
</p>
<p>
<div class="screenshot">
<div class="mediaobject"><img src="images/emphasis_element.gif"></div>
</div>
</p>
</li>
</ol>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
