<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="\^\{\}\[\]\<\&" 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>
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/>
<Label Name="SixBack"/>
There are also three elements to typeset <Q>verbatim-like</Q> text.
(&see; <Ref Sect="Six"/>)<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:
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 < f</M>.
<P/>
Using the <C>Mode</C> attribute of a <C>Display</C> element formulae
like
<Display Mode="M">a \longrightarrow a \bmod m\prime</Display>
can also be displayed nicely in text and HTML output.
</Section>
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="\^\{\}\[\]\<\&" 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="What is a DTD" 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/>
One can generate index entries as follows (look up the words
<Q>&TeX;-UserGroup</Q>, <Q>RWTH</Q>, <Q>Aachen, Hauptbahnhof</Q>, and
<Q><Package>GAPDoc</Package>, for &GAP; programmers</Q>).
<Index Key="TeX-Usergroup">&TeX;-UserGroup</Index>
<Index>RWTH</Index>
<Index>Aachen <Subkey>Hauptbahnhof</Subkey></Index>
<Index Key="GAPDoc" Subkey="for GAP programmers"><Package>GAPDoc</Package>
<Subkey>for &GAP; programmers</Subkey></Index>
</Section>
<Section><Heading>Lists and Tables</Heading>
<Label Name="NineBack"/>
[&see; <Ref Sect="Nine"/>]<P/>
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>
<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.
<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="\^\{\}\[\]\<\&" 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>]]>
</Listing>
</Section>
<Section Label="Five"><Heading>Various Types of Text (Source)</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>]]>]<![CDATA[]></Alt>
<Alt Only="Text">Text</Alt> output.</Alt>
<P/>]]>
</Listing>
</Section>
<Section Label="Six"><Heading>Verbatim-like text (Source)</Heading>
[<Ref Label="SixBack"/>]
<Listing>
<![CDATA[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;]]>]<![CDATA[]>
</Listing>
Here is a <E>Log</E> of a &GAP; session using this function:
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]]]]>><![CDATA[</M> and <M>e < f</M>.
</Section>]]>
</Listing>
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="\^\{\}\[\]\<\&" 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/>
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>]]>
</Listing>
</Section>
<Section Label="Nine"><Heading>Lists and Tables (Source)</Heading>
[<Ref Label="NineBack"/>]
<Listing>
<![CDATA[<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>
<Section Label="Ten">
<Heading>Entities and Special Characters (Source)</Heading>
[<Ref Label="TenBack"/>]
<Listing>
<![CDATA[<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.
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.
