In this chapter we give a more formal description of what you need to start to type documentation in GAPDoc XML format. Many details were already explained by example in Section 1.2 of the introduction.
We do not answer the question "How to write a GAPDoc document?" in this chapter. You can (hopefully) find an answer to this question by studying the example in the introduction, see 1.2, and learning about more details in the reference Chapter 3..
The definite source for all details of the official XML standard with useful annotations is:
http://www.xml.com/axml/axml.html
Although this document must be quite technical, it is surprisingly well readable.
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.
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 GAPDoc document this should always look as in the following example.
<?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE Book SYSTEM "gapdoc.dtd"> |
See 2.1-12 for a remark on the "encoding" statement.
(There may be local entity definitions inside the DOCTYPE statement, see Subsection 2.2-3 below.)
A "comment" in XML starts with the character sequence "