File: chapB.txt

package info (click to toggle)
gap-gapdoc 1.6.7-1
  • links: PTS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,596 kB
  • sloc: xml: 3,502; makefile: 244; javascript: 155; sh: 3
file content (555 lines) | stat: -rw-r--r-- 21,945 bytes parent folder | download 
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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
  
  B The Source
  
  
  B.1 TitlePage (Source)
  
  
    <TitlePage>
      <Title>A Complete Example (&see; <Ref Sect="One"/>)</Title>
      <Subtitle>Every element shows up</Subtitle>
      <Version>Version 1.6.7
    </Version>
      <TitleComment>
      If the subtitle ist not sufficient, this &lt;TitleComment> 
      element can be used for a slightly longer text on the front page.
      </TitleComment>
      <Author>Frank Lübeck 
              <Email>Frank.Luebeck@Math.RWTH-Aachen.De</Email> 
      </Author>
      <Author> Max Neunhöffer 
              <Email>neunhoef at mcs.st-and.ac.uk</Email>
      </Author>
      <Date>January 2022</Date>
      <Address>
      Lehrstuhl für Algebra und Zahlentheorie<Br/>Pontdriesch 
      14/16<Br/> 52062 Aachen<Br/> (Germany)
      </Address>
      <Abstract>This document tries to use all elements that exist in &GAPDoc;.
                In addition, the final output not only contains the usual
                content, but also an appendix with the source text. There
                are also links from the usual content to the corresponding
                source text. This should enable new users to learn &GAPDoc;
                quickly.
      </Abstract>
      <Copyright>&copyright; 2000-2022 by Frank Lübeck and Max Neunhöffer
      </Copyright>
      <Acknowledgements>We thank Lehrstuhl für Algebra und Zahlentheorie 
      (former Lehrstuhl D für Mathematik).
      </Acknowledgements>
      <Colophon>This is the Colophon page.
      </Colophon>
    </TitlePage>
  
  
  
  B.2 Before First Chapter (Source)
  
  
    <TableOfContents/>
    
    <Body>
    
      Text before chapter <Ref Chap="First"/>.
    
    <Chapter Label="First"><Heading>Sectioning Elements</Heading>
    
      Text before the section <Ref Sect="FirstSect"/>.
  
  
  
  B.3 First Chapter (Source)
  
  [1.0]
  
  
    <Section Label="FirstSect"><Heading>Normal subsections</Heading>
    
      <Subsection Label="Asub"><Heading>A subsection</Heading>
    
       This is text in the first subsection.
    
      </Subsection>
    
      <Subsection Label="Another"><Heading>Another subsection</Heading>
       
       This is text in the second subsection. This subsection 
       has a label, such that one can reference it.
    
      </Subsection>
    
     </Section>
  
  
  
  B.4 ManSections (Source)
  
  [1.2]
  
  
    <Section><Heading>ManSections</Heading>
    
      <ManSection>
       <Func Name="f" Arg="x[,y]" Comm="calculates something"/>
       <Returns>an element in <Ref Filt="IsBlubb" /> or <K>fail</K>.</Returns>
       <Description>
        This function calculates something.
       </Description>
      </ManSection>
    
      <ManSection>
       <Meth Name="\^\{\}\[\]\&lt;\&amp;" Arg="c" 
             Label="for nothing" Comm="tricky name"/>
       <Description>
        This method is for an operation with a tricky name.
       </Description>
      </ManSection>
    
      <ManSection>
       <Oper Name="MyOperation" Arg="x" Comm="calculates something"/>
       <Description>
        The operation <Ref Oper="MyOperation"/> operates on <Arg>x</Arg>.
       </Description>
      </ManSection>
       
      <ManSection>
       <Meth Name="MyOperation" Label="First" Arg="x" 
             Comm="generic method"/>
       <Description>
        This method calculates something by the generic method.
       </Description>
      </ManSection>
    
      <ManSection>
       <Meth Name="MyOperation" Label="for bla" Arg="x[, good_hint]"
             Comm="for bla arguments"/>
       <Description>
        This is the super-fast method for the operation
        <Ref Oper="MyOperation"/> if the argument <A>x</A> is in the
        representation <Ref Filt="IsBla"/>. It will become even faster if
        the optional argument <A>good_hint</A> is given.
       </Description>
      </ManSection>
    
      <ManSection>
       <Constr Name="MyConstructor" Arg="filt, x" Comm="constructs something"/>
       <Description>
        The constructor <Ref Oper="MyConstructor"/> constructs from <Arg>x</Arg>
        an object in <A>filt</A>.
       </Description>
      </ManSection>
    
      <ManSection>
       <Filt Name="IsBla" Arg="obj" Comm="representation bla"
             Type="representation"/>
       <Description>
        For objects in this representation there is a super-fast method
        (see <Ref Meth="MyOperation" Label="for bla"/>) for the operation
        <Ref Oper="MyOperation"/>.
       </Description>
      </ManSection>
    
      <ManSection>
       <Prop Name="IsBlubb" Arg="obj" Comm="property, whether object is blubb"/>
       <Description>
        A property.
       </Description>
      </ManSection>
    
      <ManSection>
       <Attr Name="NumberBlobbs" Arg="obj" Comm="number of blobbs"/>
       <Description>
        An attribute. Number of blobbs.
       </Description>
      </ManSection>
    
      <ManSection>
       <Var Name="AllBlibbs" Comm="list of all blibbs in the system"/>
       <Description>
        This global variable holds a list of all blibbs.
       </Description>
      </ManSection>
    
      <ManSection>
       <Fam Name="BlibbsFamily" Comm="family of blibbs"/>
       <Description>
        Family of all blibbs.
       </Description>
      </ManSection>
    
      <ManSection>
       <InfoClass Name="InfoBlibbs" Comm="InfoClass for the library of blibbs"/>
       <Description>
        This info class is used throughout the library of blibbs.
       </Description>
      </ManSection>
        
     </Section>
  
  
  
  B.5 Various Types of Text (Source)
  
  [2.0]
  
  
    <Chapter><Heading>Other Markup</Heading>
    
    <Section><Heading>Various types of text</Heading>
    
    In this section we present examples for all the various types of text
    that are possible in &GAPDoc;: 
    <List>
     <Item>
      <Emph>This</Emph> is <E>emphasized</E>.</Item>
     <Item>
      <E>Keywords</E> are typeset like <Keyword>this</Keyword> and <K>that</K>.
      </Item>
     <Item>
      <E>Arguments</E> of functions have an element. They look like this: 
        <Arg>x</Arg> and <A>y</A>.</Item>
     <Item> 
      <E>Code</E> can be written with the Code element: 
        <Code>if x = y then Print("Equal"); fi;</Code> or
        <C>while true do Print("Hello"); od;</C>.</Item> 
     <Item>
      <E>Filenames</E> have their own element:
        <File>/usr/local/ca/gap4r2</File> or <F>pkg/xgap/doc</F>.</Item>
     <Item>
      <E>Buttons</E>, <E>menus</E>, <E>menu entries</E>, and such things
        are also supported: <B>OK</B> or <Button>Cancel</Button>.</Item>
     <Item>
      <E>Packages</E> are typeset like this: 
        <Package>Small Groups Library</Package>
     </Item>
     <Item>
      <E>Quoted</E> text: <Q>This is a text in quotes.</Q>
     </Item>
    </List>
    
    <E>Paragraphs</E> are separated by the empty <C>Par</C> or <C>P</C> element.
    <Par/><E>Alternatives</E> for different output formats:
    
    <Alt Only="LaTeX">This is &LaTeX; output.</Alt>
    <Alt Not="LaTeX">This is other than &LaTeX; output, namely:
    <Alt Only="HTML"><![CDATA[<b>HTML</b>]]></Alt>
    <Alt Only="Text">Text</Alt> output.</Alt>
    
    <P/>
  
  
  
  B.6 Verbatim-like text (Source)
  
  [2.1]
  
  
    There are also three elements to typeset <Q>verbatim-like</Q> text.
    <P/>
    The first is a <E>Listing</E>:
    
    <Listing Type="GAP code">
    <![CDATA[Sieve := function(n)
      # Returns the primes less than n
      local l,p,i;
      l := [1..n]; Unbind(l[1]);
      p := 2;
      while p^2 <= n do
          if IsBound(l[p]) then
              i := 2 * p;
              while i <= n do Unbind(l[i]); i := i + p; od;
          fi;
          p := p + 1;
      od;
      return Compacted(l);
    end;]]>
    </Listing>
    
    Here is a <E>Log</E> of a &GAP; session using this function:
    
    <Log>
    gap&gt; Sieve(100);
    [ 2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61,
      67, 71, 73, 79, 83, 89, 97 ]
    gap&gt; Length(last);
    25
    </Log>
    
    Here is a &GAP; <E>Example</E> session that is automatically tested:
    
    <Example>
    gap&gt; s := Size(CharacterTable("M"));
    808017424794512875886459904961710757005754368000000000
    gap&gt; s &lt; 10^53;                     
    false
    gap&gt; s &lt; 10^54;
    true
    </Example>
    
    </Section>
  
  
  
  B.7 Formulae (Source)
  
  [2.2]
  
  
    <Section><Heading>Formulae</Heading>
    
    There are three types of formulae. <P/>
    The first is the <E>normal math mode</E> of &LaTeX;: 
    
    <Math>b_i \cdot b_j = \sum_{k=1}^d h_{ijk} b_k</Math>. 
    
    Then there are <E>displayed formulae</E>:
    <Display>
       \Longrightarrow \quad \left(\sum_{i=1}^d x_i b_i \right) \cdot
       \left(\sum_{j=1}^d y_j b_j \right) =
       \sum_{k=1}^d \left( \sum_{i,j} x_i y_j h_{ijk} \right) b_k 
    </Display>
    
    If possible,  use the <C>Alt</C> element  to specify a better  readable text
    version of such a formula as in the following example:<P/>
    
    <Alt Not="Text,HTML"><Display>
       \Longrightarrow \quad \left(\sum_{i=1}^d x_i b_i \right) \cdot
       \left(\sum_{j=1}^d y_j b_j \right) =
       \sum_{k=1}^d \left( \sum_{i,j} x_i y_j h_{ijk} \right) b_k 
    </Display></Alt>
    <Alt Only="Text,HTML"><Verb>
             d                d                 d   
           -----            -----             -----  -----                 
            \                \                 \      \                    
     ==> (   )  x_i b_i )(    )  y_i b_i ) =    )  (   )  x_i y_j h_ijk ) b_k
            /                /                 /      /                    
           -----            -----             -----  -----                
           i = 1            i = 1             k = 1   i,j                
    </Verb><P/></Alt>
    
    For small formulae without <Q>difficult</Q> parts use the <C>M</C>
    element: <M>b_i</M>,
    <M>x^2</M>, <M>x^2 + 2x + 1 = (x + 1)^2</M>. Note that here whitespace 
    matters for text (or HTML) output).<P/>
    
    Here are two formulae containing less than characters which are special
    characters for XML:
    <M><![CDATA[a < b < c < d]]></M> and  <M>e &lt; f</M>.
    </Section>
  
  
  
  B.8 Crossreferencing (Source)
  
  [2.3]
  
  
    <Section Label="Cross"><Heading>Crossreferencing</Heading>
    
    <Label Name="there"/>
    
    In this section we demonstrate various references to parts of this
    document. Here is a reference to this section: <Ref Sect="Cross"/>.
    Here is a reference to chapter <Ref Chap="First"/>, to appendix
    <Ref Appendix="Appendix"/>, and to subsection <Ref Subsect="Asub"/>. 
    <P/>
    
    We distinguish among others references 
     to functions (see <Ref Func="f"/>), 
     to methods with tricky name (see 
                     <Ref Meth="\^\{\}\[\]\&lt;\&amp;" Label="for nothing"/>),
     to operations (see <Ref Oper="MyOperation"/>), 
     to methods (see <Ref Meth="MyOperation" Label="First"/> or 
                     <Ref Meth="MyOperation" Label="for bla"/>), 
     to filters (see <Ref Filt="IsBla"/>), 
     to properties (see <Ref Prop="IsBlubb"/>),
     to attributes (see <Ref Attr="NumberBlobbs"/>), 
     to variables (<Ref Var="AllBlibbs"/>), 
     to families (see <Ref Fam="BlibbsFamily"/>),
     and to info classes (see <Ref InfoClass="InfoBlibbs"/>).
    <P/>
    
    There are also references to labels: see <Ref Text="here" Label="there"/>,
    to other books: see <Ref Sect="syntaxXML" BookName="gapdoc"/> or
    <Ref Oper="IsSubgroup" BookName="ref"/> in the &GAP; reference
    manual.
    <P/>
    
    References to sections come in two styles: 
    <Ref Chap="First" Style="Number"/>
    or <Ref Chap="First" Style="Text"/>.
    <P/>
    
    Another type of cross referencing is bibliography. Here is a 
    citation: <Cite Key="CR1" Where="(5.22)"/> is an interesting lemma.
    <P/>
    
    There are also URLs:<P/>
    
    <URL>https://www.math.rwth-aachen.de/LDfM/</URL><P/>
    
    Email addresses have a special element:
    <Email>Frank.Luebeck@Math.RWTH-Aachen.De</Email>
    <P/>
    
    and Homepages another one:
    <Homepage>https://www.math.rwth-aachen.de/~Frank.Luebeck/</Homepage>
    <P/>
    
    One can generate index entries as follows (look up the words 
    <Q>&TeX;-UserGroup</Q>, <Q>RWTH</Q>, and <Q>Aachen, Hauptbahnhof</Q>).
    <Index Key="TeX-Usergroup">&TeX;-UserGroup</Index>
    <Index>RWTH</Index>
    <Index>Aachen <Subkey>Hauptbahnhof</Subkey></Index>
    <Index Key="GAPDoc" Subkey="for GAP programmers">&GAPDoc; 
    <Subkey>for &GAP; programmers</Subkey></Index>
    
    </Section>
  
  
  
  B.9 Lists and Tables (Source)
  
  [2.4]
  
  
    <Section><Heading>Lists and Tables</Heading>
    
    There are
    <List>
     <Item>lists</Item>
     <Item>enumerations, and</Item>
     <Item>tables</Item>
    </List>
    or:
    <Enum>
     <Item>lists</Item>
     <Item>enumerations, and</Item>
     <Item>tables</Item>
    </Enum>
    or with marks:
    <List>
     <Mark>lists:</Mark><Item> not numbered</Item>
     <Mark>enumerations:</Mark><Item> numbered</Item>
     <Mark>tables:</Mark><Item> two-dimensional</Item>
    </List>
    
    Lists can also be nested:
    <Enum>
     <Item>
       <Enum>
         <Item>first item of inner enumeration </Item>
         <Item>second item of inner enumeration </Item>
       </Enum>
     </Item>
     <Item>
       <List>
         <Item>first item of inner list </Item>
         <Item>second item of inner list </Item>
       </List>
      </Item>
    </Enum>
    
    Here is a <E>table</E>:
    
    <Table Align="|r|c|l|">
     <Caption>Prices</Caption>
     <HorLine/>
      <Row>
       <Item>Object</Item><Item>Price</Item><Item>available</Item>
      </Row>
     <HorLine/>
     <HorLine/>
      <Row>
       <Item>Shoe</Item><Item>$1,00</Item><Item>there</Item>
      </Row>
     <HorLine/>
      <Row>
       <Item>Hat</Item><Item>$2,00</Item><Item>not there</Item>
      </Row>
     <HorLine/>
    </Table>
    
    </Section>
  
  
  
  B.10 Entities and Special Characters (Source)
  
  [2.5]
  
  
    <Section><Heading>Entities and Special Characters</Heading>
    <Label Name="TenBack"/>
    
    [&see; <Ref Sect="Ten"/>]<P/>
    
    Here is a table of special characters, the first two are special for
    XML and must be typed in by entities in &GAPDoc; documents. The other 
    characters are special for &LaTeX; but in &GAPDoc; they can be typed
    directly. 
    
    <Table Align="|c|c|c|c|c|c|c|c|c|c|c|c|c|" Label="charsInCDATA"> 
     <Caption>Special characters in character data</Caption>
     <HorLine/> <Row> 
      <Item><C>&amp;</C></Item>
      <Item><C>&lt;</C></Item>
      <Item><C>></C></Item>
      <Item><C>#</C></Item>
      <Item><C>$</C></Item>
      <Item><C>%</C></Item>
      <Item><C>~</C></Item>
      <Item><C>\</C></Item>   
      <Item><C>{</C></Item>
      <Item><C>}</C></Item>
      <Item><C>_</C></Item>
      <Item><C>^</C></Item>
      <Item><C>&nbsp;</C></Item>
     </Row> <HorLine/>
    </Table>
    
    And here are the predefined entities in &GAPDoc;:
    
    <Table Align="|l|l|">
    <Caption>Predefined Entities in the &GAPDoc; system</Caption>
    <HorLine/>
    <Row> <Item><C>&amp;GAP;</C></Item>       <Item>&GAP;</Item> </Row>
    <HorLine/>
    <Row> <Item><C>&amp;GAPDoc;</C></Item>    <Item>&GAPDoc;</Item> </Row>
    <HorLine/>
    <Row> <Item><C>&amp;TeX;</C></Item>       <Item>&TeX;</Item> </Row>
    <HorLine/>
    <Row> <Item><C>&amp;LaTeX;</C></Item>     <Item>&LaTeX;</Item> </Row>
    <HorLine/>
    <Row> <Item><C>&amp;BibTeX;</C></Item>    <Item>&BibTeX;</Item> </Row>
    <HorLine/>
    <Row> <Item><C>&amp;MeatAxe;</C></Item>   <Item>&MeatAxe;</Item> </Row>
    <HorLine/>
    <Row> <Item><C>&amp;XGAP;</C></Item>      <Item>&XGAP;</Item> </Row>
    <HorLine/>
    <Row> <Item><C>&amp;copyright;</C></Item> <Item>&copyright;</Item> </Row>
    <HorLine/>
    </Table>
    
    And some more for mathematical symbols: 
    &CC;, &ZZ;, &NN;, &PP;, &QQ;, &HH;, &RR;.
    
    </Section>
    
    </Chapter>
    
    </Body>
  
  
  
  B.11 Appendix (Source)
  
  [A.0]
  
    GAPDoc source  
    <Appendix><Heading>An Appendix</Heading>
    
    This is an appendix.
    </Appendix>