<p>In this section we present examples for all the various types of text that are possible in <strong class="pkg">GAPDoc</strong>:</p>
<ul>
<li><p><em>This</em> is <em>emphasized</em>.</p>
</li>
<li><p><em>Keywords</em> are typeset like <code class="keyw">this</code> and <code class="keyw">that</code>.</p>
</li>
<li><p><em>Arguments</em> of functions have an element. They look like this: <var class="Arg">x</var> and <var class="Arg">y</var>.</p>
</li>
<li><p><em>Code</em> can be written with the Code element: <code class="code">if x = y then Print("Equal"); fi;</code> or <code class="code">while true do Print("Hello"); od;</code>.</p>
</li>
<li><p><em>Filenames</em> have their own element: <code class="file">/usr/local/ca/gap4r2</code> or <code class="file">pkg/xgap/doc</code>.</p>
</li>
<li><p><em>Buttons</em>, <em>menus</em>, <em>menu entries</em>, and such things are also supported: <strongclass="button">OK</strong> or <strong class="button">Cancel</strong>.</p>
</li>
<li><p><em>Packages</em> are typeset like this: <strong class="pkg">Small Groups Library</strong></p>
</li>
<li><p><em>Quoted</em> text: <q>This is a text in quotes.</q></p>
</li>
</ul>
<p><em>Paragraphs</em> are separated by the empty <code class="code">Par</code> or <code class="code">P</code> element.</p>
<p><em>Alternatives</em> for different output formats: This is other than LaTeX output, namely: <b>HTML</b> output.</p>
<p>There are also three elements to typeset <q>verbatim-like</q> text. (→ <a href="chapB.html#X824BD70087820CF0"><span class="RefLink">B.6</span></a>)</p>
<p>The first is a <em>Listing</em>:</p>
<div class="example"><pre>
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;
</pre></div>
<p>Here is a <em>Log</em> of a <strong class="pkg">GAP</strong> session using this function:</p>
<p>The first is the <em>normal math mode</em> of LaTeX: <span class="Math">b_i \cdot b_j = \sum_{k=1}^d h_{ijk} b_k</span>. Then there are <em>displayed formulae</em>:</p>
<p>If possible, use the <code class="code">Alt</code> element to specify a better readable text version of such a formula as in the following example:</p>
<pre class="normal">
d d d
----- ----- ----- -----
\ \ \ \
==> ( ) x_i b_i )( ) y_j b_j ) = ) ( ) x_i y_j h_ijk ) b_k
/ / / /
----- ----- ----- -----
i = 1 j = 1 k = 1 i,j
</pre>
<p>For small formulae without <q>difficult</q> parts use the <code class="code">M</code> element: <span class="SimpleMath">b_i</span>, <span class="SimpleMath">x^2</span>, <span class="SimpleMath">x^2 + 2x + 1 = (x + 1)^2</span>. Note that here whitespace matters for text (or HTML) output.</p>
<p>Here are two formulae containing less than characters which are special characters for XML: <span class="SimpleMath">a < b < c < d</span> and <span class="SimpleMath">e < f</span>.</p>
<p>Using the <code class="code">Mode</code> attribute of a <code class="code">Display</code> element formulae like</p>
<p class="pcenter">a ⟶ a mod m'
<p>can also be displayed nicely in text and HTMLoutput.</p>
<p>In this section we demonstrate various references to parts of this document. Here is a reference to this section: <a href="chap2.html#X833C410D85CF96A4"><span class="RefLink">2.3</span></a>. Here is a reference to chapter <a href="chap1.html#X80E2AD7481DD69D9"><span class="RefLink">1</span></a>, to appendix <a href="chapA.html#X7B53252784137533"><span class="RefLink">A</span></a>, and to subsection <a href="chap1.html#X7E193BD379F58A4C"><span class="RefLink">1.1-1</span></a>.</p>
<p>We distinguish among others references to functions (see <code class="func">f</code> (<a href="chap1.html#X7FA1D0937FA1D093"><span class="RefLink">1.2-1</span></a>)), to methods with tricky name (see <code class="func">\^\{\}<span>\</span>[<span>\</span>]\<\&</code> (<a href="chap1.html#X822B5C487B29E799"><span class="RefLink">1.2-2</span></a>)), to operations (see <code class="func">MyOperation</code> (<a href="chap1.html#X7D33C2597988F481"><span class="RefLink">1.2-3</span></a>)), to methods (see <code class="func">MyOperation</code> (<a href="chap1.html#X783DCD4E826289D4"><span class="RefLink">1.2-4</span></a>) or <code class="func">MyOperation</code> (<a href="chap1.html#X7A5F4A287D06988C"><span class="RefLink">1.2-5</span></a>)), to filters (see <codeclass="func">IsBla</code> (<a href="chap1.html#X82954B687D2DF3C2"><span class="RefLink">1.2-7</span></a>)), to properties (see <code class="func">IsBlubb</code> (<a href="chap1.html#X80C364DD7C919CCE"><span class="RefLink">1.2-8</span></a>)), to attributes (see <code class="func">NumberBlobbs</code> (<a href="chap1.html#X8052A45E7F9F054C"><span class="RefLink">1.2-9</span></a>)), to variables (<code class="func">AllBlibbs</code> (<a href="chap1.html#X7C00E05A7DDEF003"><span class="RefLink">1.2-10</span></a>)), to families (see <code class="func">BlibbsFamily</code> (<a href="chap1.html#X7CBC935A8142E374"><span class="RefLink">1.2-11</span></a>)), and to info classes (see <code class="func">InfoBlibbs</code> (<a href="chap1.html#X84D7D77378AD030A"><span class="RefLink">1.2-12</span></a>)).</p>
<p>There are also references to labels: see <a href="chap2.html#X833C410D85CF96A4"><span class="RefLink">here</span></a>, to other books: see <a href="../../../pkg/GAPDoc-1.6.7/doc/chap3.html#X7B76F6F786521F6B"><span class="RefLink">GAPDoc: What is a DTD?</span></a> or <code class="func">IsSubgroup</code> (<a href="../../../doc/ref/chap39.html#X7839D8927E778334"><span class="RefLink">Reference: IsSubgroup</span></a>) in the <strong class="pkg">GAP</strong> reference manual.</p>
<p>References to sections come in two styles: <a href="chap1.html#X80E2AD7481DD69D9"><span class="RefLink">1</span></a> or <a href="chap1.html#X80E2AD7481DD69D9"><span class="RefLink"><spanclass="Heading">Sectioning Elements</span></span></a>.</p>
<p>Another type of cross referencing is bibliography. Here is a citation: <a href="chapBib.html#biBCR1">[CR81, (5.22)]</a> is an interesting lemma.</p>
<p>Email addresses have a special element: <span class="URL"><a href="mailto:Frank.Luebeck@Math.RWTH-Aachen.De">Frank.Luebeck@Math.RWTH-Aachen.De</a></span></p>
<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><strong class="pkg">GAPDoc</strong>, for <strong class="pkg">GAP</strong> programmers</q>).</p>
<p>Here is a table of special characters, the first two are special for XML and must be typed in by entities in <strong class="pkg">GAPDoc</strong> documents. The other characters are special for LaTeX but in <strong class="pkg">GAPDoc</strong> they can be typed directly.</p>
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.
