CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutSign UpSign In

Real-time collaboration for Jupyter Notebooks, Linux Terminals, LaTeX, VS Code, R IDE, and more,
all in one place.

| Download

GAP 4.8.9 installation with standard packages -- copy to your CoCalc project to get it

Views: 418346
Tweet
Share
Share
1
  

2
  

3
                                     GAPDoc

4
  

5
  

6
                               ( Version 1.6.1 )

7
  

8
  

9
                                 November 2017

10
  

11
  

12
                                  Frank Lübeck

13
  

14
                                 Max Neunhöffer

15
  

16
  

17
  

18
  Frank Lübeck

19
      Email:    mailto:[email protected]

20
      Homepage: http://www.math.rwth-aachen.de/~Frank.Luebeck

21
  Max Neunhöffer

22
      Email:    mailto:neunhoef at mcs.st-and.ac.uk

23
      Homepage: http://www-groups.mcs.st-and.ac.uk/~neunhoef/

24
  

25
  -------------------------------------------------------

26
  Copyright

27
  © 2000-2017 by Frank Lübeck and Max Neunhöffer

28
  

29
  GAPDoc  is free software; you can redistribute it and/or modify it under the

30
  terms        of       the       GNU       General       Public       License

31
  (http://www.fsf.org/licenses/gpl.html)  as  published  by  the Free Software

32
  Foundation;  either  version 2 of the License, or (at your option) any later

33
  version.

34
  

35
  

36
  -------------------------------------------------------

37
  

38
  

39
  Contents (GAPDoc)

40
  

41
  1 Introduction and Example

42
    1.1 XML

43
    1.2 A complete example

44
    1.3 Some questions

45
  2 How To Type a GAPDoc Document

46
    2.1 General XML Syntax

47
      2.1-1 Head of XML Document

48
      2.1-2 Comments

49
      2.1-3 Processing Instructions

50
      2.1-4 Names in XML and Whitespace

51
      2.1-5 Elements

52
      2.1-6 Start Tags

53
      2.1-7 End Tags

54
      2.1-8 Combined Tags for Empty Elements

55
      2.1-9 Entities

56
      2.1-10 Special Characters in XML

57
      2.1-11 Rules for Attribute Values

58
      2.1-12 CDATA

59
      2.1-13 Encoding of an XML Document

60
      2.1-14 Well Formed and Valid XML Documents

61
    2.2 Entering GAPDoc Documents

62
      2.2-1 Other special characters

63
      2.2-2 Mathematical Formulae

64
      2.2-3 More Entities

65
  3 The Document Type Definition

66
    3.1 What is a DTD?

67
    3.2 Overall Document Structure

68
      3.2-1 <Book>

69
      3.2-2 <TitlePage>

70
      3.2-3 <Title>

71
      3.2-4 <Subtitle>

72
      3.2-5 <Version>

73
      3.2-6 <TitleComment>

74
      3.2-7 <Author>

75
      3.2-8 <Date>

76
      3.2-9 <Address>

77
      3.2-10 <Abstract>

78
      3.2-11 <Copyright>

79
      3.2-12 <Acknowledgements>

80
      3.2-13 <Colophon>

81
      3.2-14 <TableOfContents>

82
      3.2-15 <Bibliography>

83
      3.2-16 <TheIndex>

84
    3.3 Sectioning Elements

85
      3.3-1 <Body>

86
      3.3-2 <Chapter>

87
      3.3-3 <Heading>

88
      3.3-4 <Appendix>

89
      3.3-5 <Section>

90
      3.3-6 <Subsection>

91
    3.4 ManSection–a special kind of subsection

92
      3.4-1 <ManSection>

93
      3.4-2 <Func>

94
      3.4-3 <Oper>

95
      3.4-4 <Constr>

96
      3.4-5 <Meth>

97
      3.4-6 <Filt>

98
      3.4-7 <Prop>

99
      3.4-8 <Attr>

100
      3.4-9 <Var>

101
      3.4-10 <Fam>

102
      3.4-11 <InfoClass>

103
    3.5 Cross Referencing and Citations

104
      3.5-1 <Ref>

105
      3.5-2 <Label>

106
      3.5-3 <Cite>

107
      3.5-4 <Index>

108
      3.5-5 <URL>

109
      3.5-6 <Email>

110
      3.5-7 <Homepage>

111
    3.6 Structural Elements like Lists

112
      3.6-1 <List>

113
      3.6-2 <Mark>

114
      3.6-3 <Item>

115
      3.6-4 <Enum>

116
      3.6-5 <Table>

117
    3.7 Types of Text

118
      3.7-1 <Emph> and <E>

119
      3.7-2 <Quoted> and <Q>

120
      3.7-3 <Keyword> and <K>

121
      3.7-4 <Arg> and <A>

122
      3.7-5 <Code> and <C>

123
      3.7-6 <File> and <F>

124
      3.7-7 <Button> and <B>

125
      3.7-8 <Package>

126
      3.7-9 <Listing>

127
      3.7-10 <Log> and <Example>

128
      3.7-11 <Verb>

129
    3.8 Elements for Mathematical Formulae

130
      3.8-1 <Math> and <Display>

131
      3.8-2 <M>

132
    3.9 Everything else

133
      3.9-1 <Alt>

134
      3.9-2 <Par> and <P>

135
      3.9-3 <Br>

136
      3.9-4 <Ignore>

137
  4 Distributing a Document into Several Files

138
    4.1 The Conventions

139
    4.2 A Tool for Collecting a Document

140
      4.2-1 ComposedDocument

141
      4.2-2 OriginalPositionDocument

142
      4.2-3 FilenameGAP

143
  5 The Converters and an XML Parser

144
    5.1 Producing Documentation from Source Files

145
      5.1-1 MakeGAPDocDoc

146
    5.2 Parsing XML Documents

147
      5.2-1 ParseTreeXMLString

148
      5.2-2 StringXMLElement

149
      5.2-3 EntitySubstitution

150
      5.2-4 DisplayXMLStructure

151
      5.2-5 ApplyToNodesParseTree

152
      5.2-6 GetTextXMLTree

153
      5.2-7 XMLElements

154
      5.2-8 CheckAndCleanGapDocTree

155
      5.2-9 AddParagraphNumbersGapDocTree

156
      5.2-10 InfoXMLParser

157
    5.3 The Converters

158
      5.3-1 GAPDoc2LaTeX

159
      5.3-2 GAPDoc2Text

160
      5.3-3 GAPDoc2TextPrintTextFiles

161
      5.3-4 AddPageNumbersToSix

162
      5.3-5 PrintSixFile

163
      5.3-6 SetGAPDocTextTheme

164
      5.3-7 GAPDoc2HTML

165
      5.3-8 GAPDoc2HTMLPrintHTMLFiles

166
      5.3-9 Stylesheet files

167
      5.3-10 CopyHTMLStyleFiles

168
      5.3-11 SetGAPDocHTMLStyle

169
      5.3-12 InfoGAPDoc

170
      5.3-13 SetGapDocLanguage

171
    5.4 Testing Manual Examples

172
      5.4-1 ExtractExamples

173
      5.4-2 RunExamples

174
  6 String and Text Utilities

175
    6.1 Text Utilities

176
      6.1-1 WHITESPACE

177
      6.1-2 TextAttr

178
      6.1-3 WrapTextAttribute

179
      6.1-4 FormatParagraph

180
      6.1-5 SubstitutionSublist

181
      6.1-6 StripBeginEnd

182
      6.1-7 StripEscapeSequences

183
      6.1-8 RepeatedString

184
      6.1-9 NumberDigits

185
      6.1-10 LabelInt

186
      6.1-11 PositionMatchingDelimiter

187
      6.1-12 WordsString

188
      6.1-13 Base64String

189
    6.2 Unicode Strings

190
      6.2-1 Unicode Strings and Characters

191
      6.2-2 Encode

192
      6.2-3 Lengths of UTF-8 strings

193
      6.2-4 InitialSubstringUTF8String

194
    6.3 Print Utilities

195
      6.3-1 PrintTo1

196
      6.3-2 StringPrint

197
      6.3-3 PrintFormattedString

198
      6.3-4 Page

199
      6.3-5 StringFile

200
  7 Utilities for Bibliographies

201
    7.1 Parsing BibTeX Files

202
      7.1-1 ParseBibFiles

203
      7.1-2 NormalizedNameAndKey

204
      7.1-3 WriteBibFile

205
      7.1-4 LabelsFromBibTeX

206
      7.1-5 InfoBibTools

207
    7.2 The BibXMLext Format

208
    7.3 Utilities for BibXMLext data

209
      7.3-1 Translating BibTeX to BibXMLext

210
      7.3-2 HeuristicTranslationsLaTeX2XML.Apply

211
      7.3-3 StringBibAsXMLext

212
      7.3-4 ParseBibXMLextString

213
      7.3-5 WriteBibXMLextFile

214
      7.3-6 Bibliography Entries as Records

215
      7.3-7 RecBibXMLEntry

216
      7.3-8 AddHandlerBuildRecBibXMLEntry

217
      7.3-9 StringBibXMLEntry

218
      7.3-10 TemplateBibXML

219
    7.4 Getting BibTeX entries from MathSciNet

220
      7.4-1 SearchMR

221
  A The File 3k+1.xml

222
  B The File gapdoc.dtd

223
  C The File bibxmlext.dtd

224
  

225
  

226
  

227


228