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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>GAP (GAPDoc) - Chapter 2: How To Type a GAPDoc Document</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta name="generator" content="GAPDoc2HTML" />
<link rel="stylesheet" type="text/css" href="manual.css" />
<script src="manual.js" type="text/javascript"></script>
<script type="text/javascript">overwriteStyle();</script>
</head>
<body class="chap2" onload="jscontent()">
<div class="chlinktop"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a> <a href="chap1.html">1</a> <a href="chap2.html">2</a> <a href="chap3.html">3</a> <a href="chap4.html">4</a> <a href="chap5.html">5</a> <a href="chap6.html">6</a> <a href="chap7.html">7</a> <a href="chapA.html">A</a> <a href="chapB.html">B</a> <a href="chapC.html">C</a> <a href="chapBib.html">Bib</a> <a href="chapInd.html">Ind</a> </div>
<div class="chlinkprevnexttop"> <a href="chap0.html">[Top of Book]</a> <a href="chap0.html#contents">[Contents]</a> <a href="chap1.html">[Previous Chapter]</a> <a href="chap3.html">[Next Chapter]</a> </div>
<p id="mathjaxlink" class="pcenter"><a href="chap2_mj.html">[MathJax on]</a></p>
<p><a id="X7890CF967F3E2FED" name="X7890CF967F3E2FED"></a></p>
<div class="ChapSects"><a href="chap2.html#X7890CF967F3E2FED">2 <span class="Heading">How To Type a <strong class="pkg">GAPDoc</strong> Document</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap2.html#X7B3A544986A1A9EA">2.1 <span class="Heading">General XML Syntax</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X84E8D39687638CF0">2.1-1 <span class="Heading">Head of XML Document</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X780C79EB85C32138">2.1-2 <span class="Heading">Comments</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X82DBCCAD8358BB63">2.1-3 <span class="Heading">Processing Instructions</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X7A0FB16C7FEC0B53">2.1-4 <span class="Heading">Names in XML and Whitespace</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X79B130FC7906FB4C">2.1-5 <span class="Heading">Elements</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X7DD1DCB783588BD5">2.1-6 <span class="Heading">Start Tags</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X7E5A567E83005B62">2.1-7 <span class="Heading">End Tags</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X843A02A88514D919">2.1-8 <span class="Heading">Combined Tags for Empty Elements</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X78FB56C77B1F391A">2.1-9 <span class="Heading">Entities</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X84A95A19801EDE76">2.1-10 <span class="Heading">Special Characters in XML</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X7F49E7AD785AED22">2.1-11 <span class="Heading">Rules for Attribute Values</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X82E77E707A062908">2.1-12 <span class="Heading"><code class="code">CDATA</code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X8709BD337DA09ED5">2.1-13 <span class="Heading">Encoding of an XML Document</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X8561F07A81CABDD6">2.1-14 <span class="Heading">Well Formed and Valid XML Documents</span></a>
</span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap2.html#X7BDE59B17CF1D5D2">2.2 <span class="Heading">Entering <strong class="pkg">GAPDoc</strong> Documents</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X79171E047B069F94">2.2-1 <span class="Heading">Other special characters</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X7EAE0C5A835F126F">2.2-2 <span class="Heading">Mathematical Formulae</span></a>
</span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap2.html#X7BDFF6D37FBED400">2.2-3 <span class="Heading">More Entities</span></a>
</span>
</div></div>
</div>
<h3>2 <span class="Heading">How To Type a <strong class="pkg">GAPDoc</strong> Document</span></h3>
<p>In this chapter we give a more formal description of what you need to start to type documentation in <strong class="pkg">GAPDoc</strong> XML format. Many details were already explained by example in Section <a href="chap1.html#X7B47AFA881BFC9DC"><span class="RefLink">1.2</span></a> of the introduction.</p>
<p>We do <em>not</em> answer the question <q>How to <em>write</em> a <strong class="pkg">GAPDoc</strong> document?</q> in this chapter. You can (hopefully) find an answer to this question by studying the example in the introduction, see <a href="chap1.html#X7B47AFA881BFC9DC"><span class="RefLink">1.2</span></a>, and learning about more details in the reference Chapter <a href="chap3.html#X7859CFF180D52D49"><span class="RefLink">3</span></a>.</p>
<p>The definite source for all details of the official XML standard with useful annotations is:</p>
<p><span class="URL"><a href="https://www.xml.com/axml/axml.html">https://www.xml.com/axml/axml.html</a></span></p>
<p>Although this document must be quite technical, it is surprisingly well readable.</p>
<p><a id="X7B3A544986A1A9EA" name="X7B3A544986A1A9EA"></a></p>
<h4>2.1 <span class="Heading">General XML Syntax</span></h4>
<p>We will now discuss the pieces of text which can occur in a general XML document. We start with those pieces which do not contribute to the actual content of the document.</p>
<p><a id="X84E8D39687638CF0" name="X84E8D39687638CF0"></a></p>
<h5>2.1-1 <span class="Heading">Head of XML Document</span></h5>
<p>Each XML document should have a head which states that it is an XML document in some encoding and which XML-defined language is used. In case of a <strong class="pkg">GAPDoc</strong> document this should always look as in the following example.</p>
<div class="example"><pre>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Book SYSTEM "gapdoc.dtd">
</pre></div>
<p>See <a href="chap2.html#X8709BD337DA09ED5"><span class="RefLink">2.1-13</span></a> for a remark on the <q>encoding</q> statement.</p>
<p>(There may be local entity definitions inside the <code class="code">DOCTYPE</code> statement, see Subsection <a href="chap2.html#X7BDFF6D37FBED400"><span class="RefLink">2.2-3</span></a> below.)</p>
<p><a id="X780C79EB85C32138" name="X780C79EB85C32138"></a></p>
<h5>2.1-2 <span class="Heading">Comments</span></h5>
<p>A <q>comment</q> in XML starts with the character sequence <q><code class="code"><!--</code></q> and ends with the sequence <q><code class="code">--></code></q>. Between these sequences there must not be two adjacent dashes <q><code class="code">--</code></q>.</p>
<p><a id="X82DBCCAD8358BB63" name="X82DBCCAD8358BB63"></a></p>
<h5>2.1-3 <span class="Heading">Processing Instructions</span></h5>
<p>A <q>processing instruction</q> in XML starts with the character sequence <q><code class="code"><?</code></q> followed by a name (<q><code class="code">xml</code></q> is only allowed at the very beginning of the document to declare it being an XML document, see <a href="chap2.html#X84E8D39687638CF0"><span class="RefLink">2.1-1</span></a>). After that any characters may follow, except that the ending sequence <q><code class="code">?></code></q> must not occur within the processing instruction.</p>
<p> </p>
<p>And now we turn to those parts of the document which contribute to its actual content.</p>
<p><a id="X7A0FB16C7FEC0B53" name="X7A0FB16C7FEC0B53"></a></p>
<h5>2.1-4 <span class="Heading">Names in XML and Whitespace</span></h5>
<p>A <q>name</q> in XML (used for element and attribute identifiers, see below) must start with a letter (in the encoding of the document) or with a colon <q><code class="code">:</code></q> or underscore <q><code class="code">_</code></q> character. The following characters may also be digits, dots <q><code class="code">.</code></q> or dashes <q><code class="code">-</code></q>.</p>
<p>This is a simplified description of the rules in the standard, which are concerned with lots of unicode ranges to specify what a <q>letter</q> is.</p>
<p>Sequences only consisting of the following characters are considered as <em>whitespace</em>: blanks, tabs, carriage return characters and new line characters.</p>
<p><a id="X79B130FC7906FB4C" name="X79B130FC7906FB4C"></a></p>
<h5>2.1-5 <span class="Heading">Elements</span></h5>
<p>The actual content of an XML document consists of <q>elements</q>. An element has some <q>content</q> with a leading <q>start tag</q> (<a href="chap2.html#X7DD1DCB783588BD5"><span class="RefLink">2.1-6</span></a>) and a trailing <q>end tag</q> (<a href="chap2.html#X7E5A567E83005B62"><span class="RefLink">2.1-7</span></a>). The content can contain further elements but they must be properly nested. One can define elements whose content is always empty, those elements can also be entered with a single combined tag (<a href="chap2.html#X843A02A88514D919"><span class="RefLink">2.1-8</span></a>).</p>
<p><a id="X7DD1DCB783588BD5" name="X7DD1DCB783588BD5"></a></p>
<h5>2.1-6 <span class="Heading">Start Tags</span></h5>
<p>A <q>start-tag</q> consists of a less-than-character <q><code class="code"><</code></q> directly followed (without whitespace) by an element name (see <a href="chap2.html#X7A0FB16C7FEC0B53"><span class="RefLink">2.1-4</span></a>), optional attributes, optional whitespace, and a greater-than-character <q><code class="code">></code></q>.</p>
<p>An <q>attribute</q> consists of some whitespace and then its name followed by an equal sign <q><code class="code">=</code></q> which is optionally enclosed by whitespace, and the attribute value, which is enclosed either in single or double quotes. The attribute value may not contain the type of quote used as a delimiter or the character <q><code class="code"><</code></q>, the character <q><code class="code">&</code></q> may only appear to start an entity, see <a href="chap2.html#X78FB56C77B1F391A"><span class="RefLink">2.1-9</span></a>. We describe in <a href="chap2.html#X7F49E7AD785AED22"><span class="RefLink">2.1-11</span></a> how to enter special characters in attribute values.</p>
<p>Note especially that no whitespace is allowed between the starting <q><code class="code"><</code></q> character and the element name. The quotes around an attribute value cannot be omitted. The names of elements and attributes are <em>case sensitive</em>.</p>
<p><a id="X7E5A567E83005B62" name="X7E5A567E83005B62"></a></p>
<h5>2.1-7 <span class="Heading">End Tags</span></h5>
<p>An <q>end tag</q> consists of the two characters <q><code class="code"></</code></q> directly followed by the element name, optional whitespace and a greater-than-character <q><code class="code">></code></q>.</p>
<p><a id="X843A02A88514D919" name="X843A02A88514D919"></a></p>
<h5>2.1-8 <span class="Heading">Combined Tags for Empty Elements</span></h5>
<p>Elements which always have empty content can be written with a single tag. This looks like a start tag (see <a href="chap2.html#X7DD1DCB783588BD5"><span class="RefLink">2.1-6</span></a>) <em>except</em> that the trailing greater-than-character <q><code class="code">></code></q> is substituted by the two character sequence <q><code class="code">/></code></q>.</p>
<p><a id="X78FB56C77B1F391A" name="X78FB56C77B1F391A"></a></p>
<h5>2.1-9 <span class="Heading">Entities</span></h5>
<p>An <q>entity</q> in XML is a macro for some substitution text. There are two types of entities.</p>
<p>A <q>character entity</q> can be used to specify characters in the encoding of the document (can be useful for entering non-ASCII characters which you cannot manage to type in directly). They are entered with a sequence <q><code class="code">&#</code></q>, directly followed by either some decimal digits or an <q><code class="code">x</code></q> and some hexadecimal digits, directly followed by a semicolon <q><code class="code">;</code></q>. Using such a character entity is just equivalent to typing the corresponding character directly.</p>
<p>Then there are references to <q>named entities</q>. They are entered with an ampersand character <q><code class="code">&</code></q> directly followed by a name which is directly followed by a semicolon <q><code class="code">;</code></q>. Such entities must be declared somewhere by giving a substitution text. This text is included in the document and the document is parsed again afterwards. The exact rules are a bit subtle but you probably want to use this only in simple cases. Predefined entities for <strong class="pkg">GAPDoc</strong> are described in <a href="chap2.html#X84A95A19801EDE76"><span class="RefLink">2.1-10</span></a> and <a href="chap2.html#X7BDFF6D37FBED400"><span class="RefLink">2.2-3</span></a>.</p>
<p><a id="X84A95A19801EDE76" name="X84A95A19801EDE76"></a></p>
<h5>2.1-10 <span class="Heading">Special Characters in XML</span></h5>
<p>We have seen that the less-than-character <q><code class="code"><</code></q> and the ampersand character <q><code class="code">&</code></q> start a tag or entity reference in XML. To get these characters into the document text one has to use entity references, namely <q><code class="code">&lt;</code></q> to get <q><code class="code"><</code></q> and <q><code class="code">&amp;</code></q> to get <q><code class="code">&</code></q>. Furthermore <q><code class="code">&gt;</code></q> must be used to get <q><code class="code">></code></q> when the string <q><code class="code">]]></code></q> appears in element content (and not as delimiter of a <code class="code">CDATA</code> section explained below).</p>
<p>Another possibility is to use a <code class="code">CDATA</code> statement explained in <a href="chap2.html#X82E77E707A062908"><span class="RefLink">2.1-12</span></a>.</p>
<p><a id="X7F49E7AD785AED22" name="X7F49E7AD785AED22"></a></p>
<h5>2.1-11 <span class="Heading">Rules for Attribute Values</span></h5>
<p>Attribute values can contain entities which are substituted recursively. But except for the entities &lt; or a character entity it is not allowed that a < character is introduced by the substitution (there is no XML parsing for evaluating the attribute value, just entity substitutions).</p>
<p><a id="X82E77E707A062908" name="X82E77E707A062908"></a></p>
<h5>2.1-12 <span class="Heading"><code class="code">CDATA</code></span></h5>
<p>Pieces of text which contain many characters which can be misinterpreted as markup can be enclosed by the character sequences <q><code class="code"><![CDATA[</code></q> and <q><code class="code">]]></code></q>. Everything between these sequences is considered as content of the document and is not further interpreted as XML text. All the rules explained so far in this section do <em>not apply</em> to such a part of the document. The only document content which cannot be entered directly inside a <code class="code">CDATA</code> statement is the sequence <q><code class="code">]]></code></q>. This can be entered as <q><code class="code">]]&gt;</code></q> outside the <code class="code">CDATA</code> statement.</p>
<div class="example"><pre>
A nesting of tags like <a> <b> </a> </b> is not allowed.
</pre></div>
<p><a id="X8709BD337DA09ED5" name="X8709BD337DA09ED5"></a></p>
<h5>2.1-13 <span class="Heading">Encoding of an XML Document</span></h5>
<p>We suggest to use the UTF-8 encoding for writing <strong class="pkg">GAPDoc</strong> XML documents. But the tools described in Chapter <a href="chap5.html#X845E7FDC7C082CC4"><span class="RefLink">5</span></a> also work with ASCII or the various ISO-8859-X encodings (ISO-8859-1 is also called latin1 and covers most special characters for western European languages).</p>
<p><a id="X8561F07A81CABDD6" name="X8561F07A81CABDD6"></a></p>
<h5>2.1-14 <span class="Heading">Well Formed and Valid XML Documents</span></h5>
<p>We want to mention two further important words which are often used in the context of XML documents. A piece of text becomes a <q>well formed</q> XML document if all the formal rules described in this section are fulfilled.</p>
<p>But this says nothing about the content of the document. To give this content a meaning one needs a declaration of the element and corresponding attribute names as well as of named entities which are allowed. Furthermore there may be restrictions how such elements can be nested. This <em>definition of an XML based markup language</em> is done in a <q>document type definition</q>. An XML document which contains only elements and entities declared in such a document type definition and obeys the rules given there is called <q>valid (with respect to this document type definition)</q>.</p>
<p>The main file of the <strong class="pkg">GAPDoc</strong> package is <code class="file">gapdoc.dtd</code>. This contains such a definition of a markup language. We are not going to explain the formal syntax rules for document type definitions in this section. But in Chapter <a href="chap3.html#X7859CFF180D52D49"><span class="RefLink">3</span></a> we will explain enough about it to understand the file <code class="file">gapdoc.dtd</code> and so the markup language defined there.</p>
<p><a id="X7BDE59B17CF1D5D2" name="X7BDE59B17CF1D5D2"></a></p>
<h4>2.2 <span class="Heading">Entering <strong class="pkg">GAPDoc</strong> Documents</span></h4>
<p>Here are some additional rules for writing <strong class="pkg">GAPDoc</strong> XML documents.</p>
<p><a id="X79171E047B069F94" name="X79171E047B069F94"></a></p>
<h5>2.2-1 <span class="Heading">Other special characters</span></h5>
<p>As <strong class="pkg">GAPDoc</strong> documents are used to produce LaTeX and HTML documents, the question arises how to deal with characters with a special meaning for other applications (for example <q><code class="code">&</code></q>, <q><code class="code">#</code></q>, <q><code class="code">$</code></q>, <q><code class="code">%</code></q>, <q><code class="code">~</code></q>, <q><code class="code">\</code></q>, <q><code class="code">{</code></q>, <q><code class="code">}</code></q>, <q><code class="code">_</code></q>, <q><code class="code">^</code></q>, <q><code class="code"> </code></q> (this is a non-breakable space, <q><code class="code">~</code></q> in LaTeX) have a special meaning for LaTeX and <q><code class="code">&</code></q>, <q><code class="code"><</code></q>, <q><code class="code">></code></q> have a special meaning for HTML (and XML). In <strong class="pkg">GAPDoc</strong> you can usually just type these characters directly, it is the task of the converter programs which translate to some output format to take care of such special characters. The exceptions to this simple rule are:</p>
<ul>
<li><p>& and < must be entered as <code class="code">&amp;</code> and <code class="code">&lt;</code> as explained in <a href="chap2.html#X84A95A19801EDE76"><span class="RefLink">2.1-10</span></a>.</p>
</li>
<li><p>The content of the <strong class="pkg">GAPDoc</strong> elements <code class="code"><M></code>, <code class="code"><Math></code> and <code class="code"><Display></code> is LaTeX code, see <a href="chap3.html#X8145F6B37C04AA0A"><span class="RefLink">3.8</span></a>.</p>
</li>
<li><p>The content of an <code class="code"><Alt></code> element with <code class="code">Only</code> attribute contains code for the specified output type, see <a href="chap3.html#X850E69017945AE3E"><span class="RefLink">3.9-1</span></a>.</p>
</li>
</ul>
<p>Remark: In former versions of <strong class="pkg">GAPDoc</strong> one had to use particular entities for all the special characters mentioned above (<code class="code">&tamp;</code>, <code class="code">&hash;</code>, <code class="code">&dollar;</code>, <code class="code">&percent;</code>, <code class="code">&tilde;</code>, <code class="code">&bslash;</code>, <code class="code">&obrace;</code>, <code class="code">&cbrace;</code>, <code class="code">&uscore;</code>, <code class="code">&circum;</code>, <code class="code">&tlt;</code>, <code class="code">&tgt;</code>). These are no longer needed, but they are still defined for backwards compatibility with older <strong class="pkg">GAPDoc</strong> documents.</p>
<p><a id="X7EAE0C5A835F126F" name="X7EAE0C5A835F126F"></a></p>
<h5>2.2-2 <span class="Heading">Mathematical Formulae</span></h5>
<p>Mathematical formulae in <strong class="pkg">GAPDoc</strong> are typed as in LaTeX. They must be the content of one of three types of <strong class="pkg">GAPDoc</strong> elements concerned with mathematical formulae: <q><code class="code">Math</code></q>, <q><code class="code">Display</code></q>, and <q><code class="code">M</code></q> (see Sections <a href="chap3.html#X7AA02845868AA533"><span class="RefLink">3.8-1</span></a> and <a href="chap3.html#X7ABF42328467E966"><span class="RefLink">3.8-2</span></a> for more details). The first two correspond to LaTeX's math mode and display math mode. The last one is a special form of the <q><code class="code">Math</code></q> element type, that imposes certain restrictions on the content. On the other hand the content of an <q><code class="code">M</code></q> element is processed in a well defined way for text terminal or HTML output. The <q><code class="code">Display</code></q> element also has an attribute such that its content is processed as in <q><code class="code">M</code></q> elements.</p>
<p>Note that the content of these element is LaTeX code, but the special characters <q><code class="code"><</code></q> and <q><code class="code">&</code></q> for XML must be entered via the entities described in <a href="chap2.html#X84A95A19801EDE76"><span class="RefLink">2.1-10</span></a> or by using a <code class="code">CDATA</code> statement, see <a href="chap2.html#X82E77E707A062908"><span class="RefLink">2.1-12</span></a>.</p>
<p><a id="X7BDFF6D37FBED400" name="X7BDFF6D37FBED400"></a></p>
<h5>2.2-3 <span class="Heading">More Entities</span></h5>
<p>In <strong class="pkg">GAPDoc</strong> there are some more predefined entities:</p>
<div class="pcenter"><table class="GAPDocTable">
<caption class="GAPDocTable"><b>Table: </b>Predefined Entities in the <strong class="pkg">GAPDoc</strong> system</caption>
<tr>
<td class="tdleft"><code class="code">&GAP;</code></td>
<td class="tdleft"><strong class="pkg">GAP</strong></td>
</tr>
<tr>
<td class="tdleft"><code class="code">&GAPDoc;</code></td>
<td class="tdleft"><strong class="pkg">GAPDoc</strong></td>
</tr>
<tr>
<td class="tdleft"><code class="code">&TeX;</code></td>
<td class="tdleft">TeX</td>
</tr>
<tr>
<td class="tdleft"><code class="code">&LaTeX;</code></td>
<td class="tdleft">LaTeX</td>
</tr>
<tr>
<td class="tdleft"><code class="code">&BibTeX;</code></td>
<td class="tdleft">BibTeX</td>
</tr>
<tr>
<td class="tdleft"><code class="code">&MeatAxe;</code></td>
<td class="tdleft"><strong class="pkg">MeatAxe</strong></td>
</tr>
<tr>
<td class="tdleft"><code class="code">&XGAP;</code></td>
<td class="tdleft"><strong class="pkg">XGAP</strong></td>
</tr>
<tr>
<td class="tdleft"><code class="code">&copyright;</code></td>
<td class="tdleft">©</td>
</tr>
<tr>
<td class="tdleft"><code class="code">&nbsp;</code></td>
<td class="tdleft"><q> </q></td>
</tr>
<tr>
<td class="tdleft"><code class="code">&ndash;</code></td>
<td class="tdleft">–</td>
</tr>
</table><br />
</div>
<p>Here <code class="code">&nbsp;</code> is a non-breakable space character.</p>
<p>Additional entities are defined for some mathematical symbols, see <a href="chap3.html#X8145F6B37C04AA0A"><span class="RefLink">3.8</span></a> for more details.</p>
<p>One can define further local entities right inside the head (see <a href="chap2.html#X84E8D39687638CF0"><span class="RefLink">2.1-1</span></a>) of a <strong class="pkg">GAPDoc</strong> XML document as in the following example.</p>
<div class="example"><pre>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Book SYSTEM "gapdoc.dtd"
[ <!ENTITY MyEntity "some longish <E>text</E> possibly with markup">
]>
</pre></div>
<p>These additional definitions go into the <code class="code"><!DOCTYPE</code> tag in square brackets. Such new entities are used like this: <code class="code">&MyEntity;</code></p>
<div class="chlinkprevnextbot"> <a href="chap0.html">[Top of Book]</a> <a href="chap0.html#contents">[Contents]</a> <a href="chap1.html">[Previous Chapter]</a> <a href="chap3.html">[Next Chapter]</a> </div>
<div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a> <a href="chap1.html">1</a> <a href="chap2.html">2</a> <a href="chap3.html">3</a> <a href="chap4.html">4</a> <a href="chap5.html">5</a> <a href="chap6.html">6</a> <a href="chap7.html">7</a> <a href="chapA.html">A</a> <a href="chapB.html">B</a> <a href="chapC.html">C</a> <a href="chapBib.html">Bib</a> <a href="chapInd.html">Ind</a> </div>
<hr />
<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
</body>
</html>
|
