[1X[5XGAPDoc[0m[1X[0m ( Version 1.2 ) June 2008 Frank Lübeck Max Neunhöffer Frank Lübeck Email: [7Xmailto:Frank.Luebeck@Math.RWTH-Aachen.De[0m Homepage: [7Xhttp://www.math.rwth-aachen.de/~Frank.Luebeck[0m Max Neunhöffer Email: [7Xmailto:neunhoef at mcs.st-and.ac.uk[0m Homepage: [7Xhttp://www-groups.mcs.st-and.ac.uk/~neunhoef/[0m ------------------------------------------------------- [1XCopyright[0m © 2000-2008 by Frank Lübeck and Max Neunhöffer We adopt the copyright regulations of [5XGAP[0m as detailed in the copyright notice in the [5XGAP[0m manual. ------------------------------------------------------- [1XContents (GAPDoc)[0X 1 Introduction and Example 1.1 XML 1.2 A complete example 1.3 Some questions 2 How To Type a [5XGAPDoc[0m 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 Rules for Attribute Values 2.1-12 [10XCDATA[0m 2.1-13 Encoding of an XML Document 2.1-14 Well Formed and Valid XML Documents 2.2 Entering [5XGAPDoc[0m Documents 2.2-1 Other 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 [10X<Book>[0m 3.2-2 [10X<TitlePage>[0m 3.2-3 [10X<Title>[0m 3.2-4 [10X<Subtitle>[0m 3.2-5 [10X<Version>[0m 3.2-6 [10X<TitleComment>[0m 3.2-7 [10X<Author>[0m 3.2-8 [10X<Date>[0m 3.2-9 [10X<Address>[0m 3.2-10 [10X<Abstract>[0m 3.2-11 [10X<Copyright>[0m 3.2-12 [10X<Acknowledgements>[0m 3.2-13 [10X<Colophon>[0m 3.2-14 [10X<TableOfContents>[0m 3.2-15 [10X<Bibliography>[0m 3.2-16 [10X<TheIndex>[0m 3.3 Sectioning Elements 3.3-1 [10X<Body>[0m 3.3-2 [10X<Chapter>[0m 3.3-3 [10X<Heading>[0m 3.3-4 [10X<Appendix>[0m 3.3-5 [10X<Section>[0m 3.3-6 [10X<Subsection>[0m 3.4 ManSectionâa special kind of subsection 3.4-1 [10X<ManSection>[0m 3.4-2 [10X<Func>[0m 3.4-3 [10X<Oper>[0m 3.4-4 [10X<Meth>[0m 3.4-5 [10X<Filt>[0m 3.4-6 [10X<Prop>[0m 3.4-7 [10X<Attr>[0m 3.4-8 [10X<Var>[0m 3.4-9 [10X<Fam>[0m 3.4-10 [10X<InfoClass>[0m 3.5 Cross Referencing and Citations 3.5-1 [10X<Ref>[0m 3.5-2 [10X<Label>[0m 3.5-3 [10X<Cite>[0m 3.5-4 [10X<Index>[0m 3.5-5 [10X<URL>[0m 3.5-6 [10X<Email>[0m 3.5-7 [10X<Homepage>[0m 3.6 Structural Elements like Lists 3.6-1 [10X<List>[0m 3.6-2 [10X<Mark>[0m 3.6-3 [10X<Item>[0m 3.6-4 [10X<Enum>[0m 3.6-5 [10X<Table>[0m 3.7 Types of Text 3.7-1 [10X<Emph>[0m and [10X<E>[0m 3.7-2 [10X<Quoted>[0m and [10X<Q>[0m 3.7-3 [10X<Keyword>[0m and [10X<K>[0m 3.7-4 [10X<Arg>[0m and [10X<A>[0m 3.7-5 [10X<Code>[0m and [10X<C>[0m 3.7-6 [10X<File>[0m and [10X<F>[0m 3.7-7 [10X<Button>[0m and [10X<B>[0m 3.7-8 [10X<Package>[0m 3.7-9 [10X<Listing>[0m 3.7-10 [10X<Log>[0m and [10X<Example>[0m 3.7-11 [10X<Verb>[0m 3.8 Elements for Mathematical Formulae 3.8-1 [10X<Math>[0m and [10X<Display>[0m 3.8-2 [10X<M>[0m 3.9 Everything else 3.9-1 [10X<Alt>[0m 3.9-2 [10X<Par>[0m and [10X<P>[0m 3.9-3 [10X<Br>[0m 3.9-4 [10X<Ignore>[0m 4 Distributing a Document into Several Files 4.1 The Conventions 4.2 A Tool for Collecting a Document 4.2-1 ComposedDocument 4.2-2 OriginalPositionDocument 5 The Converters and an XML Parser 5.1 Producing Documentation from Source Files 5.1-1 MakeGAPDocDoc 5.2 Parsing XML Documents 5.2-1 ParseTreeXMLString 5.2-2 StringXMLElement 5.2-3 EntitySubstitution 5.2-4 DisplayXMLStructure 5.2-5 ApplyToNodesParseTree 5.2-6 GetTextXMLTree 5.2-7 XMLElements 5.2-8 CheckAndCleanGapDocTree 5.2-9 AddParagraphNumbersGapDocTree 5.2-10 InfoXMLParser 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 SetGAPDocTextTheme 5.3-7 GAPDoc2HTML 5.3-8 GAPDoc2HTMLPrintHTMLFiles 5.3-9 InfoGAPDoc 5.3-10 SetGapDocLanguage 5.4 Testing Manual Examples 5.4-1 ManualExamples 5.4-2 ReadTestExamplesString 6 String and Text Utilities 6.1 Text Utilities 6.1-1 WHITESPACE 6.1-2 TextAttr 6.1-3 WrapTextAttribute 6.1-4 FormatParagraph 6.1-5 SubstitutionSublist 6.1-6 StripBeginEnd 6.1-7 StripEscapeSequences 6.1-8 RepeatedString 6.1-9 NumberDigits 6.1-10 PositionMatchingDelimiter 6.1-11 WordsString 6.1-12 Base64String 6.2 Unicode Strings 6.2-1 Unicode Strings and Characters 6.2-2 Encode 6.2-3 Lengths of UTF-8 strings 6.3 Print Utilities 6.3-1 PrintTo1 6.3-2 StringPrint 6.3-3 PrintFormattedString 6.3-4 Page 6.3-5 StringFile 7 Utilities for Bibliographies 7.1 Parsing BibTeX Files 7.1-1 ParseBibFiles 7.1-2 NormalizedNameAndKey 7.1-3 WriteBibFile 7.1-4 InfoBibTools 7.2 The BibXMLext Format 7.3 Utilities for BibXMLext data 7.3-1 Translating BibTeX to BibXMLext 7.3-2 HeuristicTranslationsLaTeX2XML.Apply 7.3-3 StringBibAsXMLext 7.3-4 ParseBibXMLextString 7.3-5 WriteBibXMLextFile 7.3-6 Bibliography Entries as Records 7.3-7 RecBibXMLEntry 7.3-8 AddHandlerBuildRecBibXMLEntry 7.3-9 StringBibXMLEntry 7.3-10 TemplateBibXML 7.4 Getting BibTeX entries from [5XMathSciNet[0m 7.4-1 SearchMR A The File [11X3k+1.xml[0m B The File [11Xgapdoc.dtd[0m C The File [11Xbibxmlext.dtd[0m -------------------------------------------------------