Goto Chapter:

GAPDoc

( Version 0.99 )

Frank Lübeck
e-mail: Frank.Luebeck@Math.RWTH-Aachen.De
WWW: http://www.math.rwth-aachen.de/~Frank.Luebeck

Max Neunhöffer
e-mail: Max.Neunhoeffer@Math.RWTH-Aachen.De
WWW: http://www.math.rwth-aachen.de/~Max.Neunhoeffer

Copyright

(C) 2000 by Frank Lübeck and Max Neunhöffer

We adopt the copyright regulations of GAP as detailed in the copyright notice in the GAP manual.

Contents

1. Introduction and Example
   1.1 XML
   1.2 A complete example
   1.3 Some questions
2. How To Type a GAPDoc Document
   2.1 General XML Syntax
      2.1-1 Head of XML Document
      2.1-2 Comments
      2.1-3 Processing Instructions
      2.1-4 Names in XML and Whitespace
      2.1-5 Elements
      2.1-6 Start Tags
      2.1-7 End Tags
      2.1-8 Combined Tags for Empty Elements
      2.1-9 Entities
      2.1-10 Special Characters in XML
      2.1-11 CDATA
      2.1-12 Encoding of an XML document
      2.1-13 Well Formed and Valid XML Documents
   2.2 Entering GAPDoc Documents
      2.2-1 More Special Characters
      2.2-2 Mathematical Formulae
      2.2-3 More Entities
3. The Document Type Definition
   3.1 What is a DTD?
   3.2 Overall Document Structure
      3.2-1 <Book>
      3.2-2 <TitlePage>
      3.2-3 <Title>
      3.2-4 <Subtitle>
      3.2-5 <Version>
      3.2-6 <Author>
      3.2-7 <Date>
      3.2-8 <Abstract>
      3.2-9 <Copyright>
      3.2-10 <Acknowledgements>
      3.2-11 <Colophon>
      3.2-12 <TableOfContents>
      3.2-13 <Bibliography>
      3.2-14 <TheIndex>
   3.3 Sectioning Elements
      3.3-1 <Body>
      3.3-2 <Chapter>
      3.3-3 <Heading>
      3.3-4 <Appendix>
      3.3-5 <Section>
      3.3-6 <Subsection>
   3.4 ManSection
      3.4-1 <ManSection>
      3.4-2 <Func>
      3.4-3 <Oper>
      3.4-4 <Meth>
      3.4-5 <Filt>
      3.4-6 <Prop>
      3.4-7 <Attr>
      3.4-8 <Var>
      3.4-9 <Fam>
      3.4-10 <InfoClass>
   3.5 Cross Referencing and Citations
      3.5-1 <Ref>
      3.5-2 <Label>
      3.5-3 <Cite>
      3.5-4 <Index>
      3.5-5 <URL>
      3.5-6 <Email>
      3.5-7 <Homepage>
   3.6 Structural Elements like Lists
      3.6-1 <List>
      3.6-2 <Mark>
      3.6-3 <Item>
      3.6-4 <Enum>
      3.6-5 <Table>
   3.7 Types of Text
      3.7-1 <Emph> and <E>
      3.7-2 <Quoted> and <Q>
      3.7-3 <Keyword> and <K>
      3.7-4 <Arg> and <A>
      3.7-5 <Code> and <C>
      3.7-6 <File> and <F>
      3.7-7 <Button> and <B>
      3.7-8 <Package>
      3.7-9 <Listing>
      3.7-10 <Log> and <Example>
      3.7-11 <Verb>
   3.8 Elements for Mathematical Formulae
      3.8-1 <Math> and <Display>
      3.8-2 <M>
   3.9 Everything else
      3.9-1 <Alt>
      3.9-2 <Par> and <P>
4. Distributing a Document into Several Files
   4.1 The Conventions
   4.2 A Tool for Collecting a Document
      4.2-1 ComposedXMLString
5. The Converters
   5.1 Producing Documentation from Source Files
      5.1-1 MakeGAPDocDoc
   5.2 Parsing XML Documents
      5.2-1 ParseTreeXMLString
      5.2-2 DisplayXMLStructure
      5.2-3 ApplyToNodesParseTree
      5.2-4 CheckAndCleanGapDocTree
      5.2-5 AddParagraphNumbersGapDocTree
   5.3 The Converters
      5.3-1 GAPDoc2LaTeX
      5.3-2 GAPDoc2Text
      5.3-3 GAPDoc2TextPrintTextFiles
      5.3-4 AddPageNumbersToSix
      5.3-5 PrintSixFile
      5.3-6 GAPDoc2HTML
      5.3-7 GAPDoc2HTMLPrintHTMLFiles
   5.4 Parsing BibTeX Files
      5.4-1 ParseBibFiles
      5.4-2 NormalizeNameAndKey
      5.4-3 WriteBibFile
   5.5 Text Utilities
      5.5-1 WHITESPACE
      5.5-2 TextAttr
      5.5-3 FormatParagraph
      5.5-4 SubstitutionSublist
      5.5-5 StripBeginEnd
      5.5-6 StripEscapeSequences
      5.5-7 RepeatedString
      5.5-8 NumberDigits
      5.5-9 PositionMatchingDelimiter
      5.5-10 WordsString
   5.6 Print Utilities
      5.6-1 PrintTo1
      5.6-2 StringPrint
      5.6-3 PrintFormattedString
      5.6-4 Page
      5.6-5 StringFile
A. The file 3k+1.xml
B. The File gapdoc.dtd

Goto Chapter:

generated by GAPDoc2HTML