-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathindex.html
265 lines (218 loc) · 8.65 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="pkgreadme.css" type="text/css" rel="StyleSheet" />
<title>GAP package GAPDoc</title>
</head>
<body>
<!-- the header, probably package name -->
<h1><span class="pkg">GAP</span> package <span class="pkg">GAPDoc</span></h1>
<p class="maininfo">
<!-- author(s), possibly with link to homepage -->
<strong>Authors: </strong>
<a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/">Frank Lübeck</a>
(maintainer) and
Max Neunhöffer
<br />
<!-- needed software/versions, probably at least GAP,
maybe with appropriate links -->
<strong>Needs: </strong> <a href="https://www.gap-system.org">GAP</a> in
version at least 4.11.0<br />
and for creating high quality output of <span class="pkg">GAPDoc</span>
documents a sufficiently new version of <code>LaTeX/pdfLaTeX</code> and
certain <code>LaTeX</code> packages, <code>makeindex</code>.
<br />
<!-- operating system needed for this package -->
<strong>Operating systems: </strong> Any, on which <span
class="pkg">GAP</span> and the programs mentioned above are running.
<br />
<!-- current version, maybe further version info,
links to old versions ... -->
<strong>Current version: </strong> 1.6.7 (02/2024)
<br />
<!-- status of the package -->
<strong>Status:</strong> Accepted (since October 2006)
<br />
<!-- author/maintainer contact information, probably email
address(es) with link(s) -->
<strong>Contact: </strong>
<a href="mailto:[email protected]">
<br />
<!-- download location, maybe link to somewhere below -->
<strong>Download: </strong> See <a href="#ARCHS">below</a> for archives in
several formats.
<br />
<strong>Source repository and issue tracker: </strong>
<a
href="https://github.com/frankluebeck/GAPDoc">https://github.com/frankluebeck/GAPDoc</a>
<br />
<strong>History: </strong> This text file <a href="CHANGES.txt">CHANGES</a>
describes the most important differences to former versions of <span
class="pkg">GAPDoc</span>.
</p>
<!-- enclose paragraphs below in <p> and </p> tags -->
<h2>Description</h2>
<p>
This package describes a document format for writing
<span class="pkg">GAP</span> documentation.
</p>
<p>
The idea is to define a sufficiently abstract markup language for
<span class="pkg">GAP</span> documentation which can be (relatively
easily) converted into different output formats. We used <a
href="https://www.w3.org/XML/">XML</a> to define such a language.
</p>
<p>
This package provides:
</p>
<ul>
<li>Utilities to <strong>use</strong> the documentation
which is written in <span class="pkg">GAPDoc</span> format with the <span
class="pkg">GAP</span> help system.
If you don't want to write your own (package) documentation you can skip
to the last point of this list.
</li>
<li>
The description of a markup language for <span class="pkg">GAP</span>
documentation (which is defined using the XML standard).
</li>
<li>
Three example documents using this language: The <span
class="pkg">GAPDoc</span> documentation itself, a short example which
demonstrates all constructs defined in the <span class="pkg">GAPDoc</span>
language, and a very short example explained in the introduction of the
main documentation.
</li>
<li>
A mechanism for distributing documentation among several files,
including source code files.
</li>
<li>
<span class="pkg">GAP</span> programs (written by the first named
author) which produce from
documentation written in the GAPDoc language several document formats:
<ul>
<li>
text format with color markup for onscreen browsing.
</li>
<li>
LaTeX format and from this PDF- (and DVI)-versions with hyperlinks.
</li>
<li>
HTML (XHTML 1.0 strict) format for reading with a Web-browser (and
many hooks for CSS layout), including a version of the files which use
MathJAX for rendering mathemtical formulae.
</li>
</ul>
</li>
<li>
Utility <span class="pkg">GAP</span> programs which are used for the
above but can be of independent interest as well:
<ul>
<li>unicode strings with translations to and from other encodings
</li>
<li>further utilities for manipulating strings
</li>
<li>tools for dealing with BibTeX data
</li>
<li>another data format BibXMLext for bibliographical data including
tools to manipulate/translate them
</li>
<li>a tool <code>ComposedDocument</code> for composing documents
which are distributed in many files
</li>
</ul>
</li>
</ul>
<h2>Installation</h2>
<p>
Just unpack one of the <a href="#ARCHS">archives</a> given below in the
<code>pkg</code> subdirectory of your <span class="pkg">GAP</span>
installation.
</p>
<p>
Unpacking generates a subdirectory <code>GAPDoc-1.6.7</code>.
</p>
<p>
That's it! (Maybe you want to read the help section
'<code>?SetHelpViewer</code>' in the <span class="pkg">GAP</span> reference
manual.)
</p>
<p>
Installation outside the <span class="pkg">GAP</span> main directory: When
you don't have access to the directory of your main <span
class="pkg">GAP</span> installation
you can also install the package by unpacking inside a directory
<code>MYGAPDIR/pkg</code>. (Don't forget to call <code>gap</code> with
the <code>-l ";MYGAPDIR"</code> option.)
The only drawback with this
installation is that in the HTML version of the package documentation the
links to the main <span class="pkg">GAP</span> manuals don't work. You can
correct this by recompiling the HTML version of the documentation: Say
<code>cd GAPDoc*; gap makedocrel.g</code>.
</p>
<h2>Online Documentation</h2>
<!-- links to the documentation, maybe in several formats -->
<p>
Here is the documentation of the <span class="pkg">GAPDoc</span> package in
several output formats.
If you have installed the package as described above you can also access
all of these documents from the <span class="pkg">GAP</span> online help.
</p>
<h3> Main <span class="pkg">GAPDoc</span> documentation </h3>
<ul>
<li> <a href="doc/chap0.html">HTML-version</a> </li>
<li> <a href="doc/manual.pdf"><code>pdf</code>-version</a> </li>
<li> <a href="doc/manual.ps">postscript-version</a> (no color, for
printing)</li>
<li> text-version <a href="gapdoc.txt">with</a> and <a
href="gapdoc-nc.txt">without</a> color markup (you can read the colored
version with <code>less</code> on a terminal screen, if it looks like
garbage, type <code>-r<CR></code> or start with <code>less -r</code>)
</li>
</ul>
<p>
There is also an example document which uses all constructs which are
allowed in a <span class="pkg">GAPDoc</span> document. Here you can
compare directly the <span class="pkg">GAPDoc</span>-XML-source code and
how it looks like in each format.
</p>
<h3> Example <span class="pkg">GAPDoc</span> document </h3>
<ul>
<li> <a href="example/chap0.html">HTML-version</a> </li>
<li> <a href="example/manual.pdf"><code>pdf</code>-version</a> </li>
<li> <a href="example/manual.ps">postscript-version</a> (no color, for
printing)</li>
<li> text-version <a href="example.txt">with</a> and <a
href="example-nc.txt">without</a> color markup. </li>
</ul>
<h2><a name="ARCHS" />Package Archives for Download</h2>
<!-- direct links to package archives, maybe in several formats -->
<p>
The <span class="pkg">GAPDoc</span> package is availabe in several formats:
</p>
<ul>
<li>
<a href="GAPDoc-1.6.7.tar.gz"><code>GAPDoc-1.6.7.tar.gz</code></a>
(GNU <code>tar</code> archive, <code>gzip</code>'ed)
</li>
<li>
<a href="GAPDoc-1.6.7.tar.bz2"><code>GAPDoc-1.6.7.tar.bz2</code></a>
(GNU <code>tar</code> archive, <code>bzip2</code>'ed)
</li>
<li>
<a href="GAPDoc-1.6.7-win.zip"><code>GAPDoc-1.6.7-win.zip</code></a>
(with DOS/Windows style line breaks in text files)
</li>
</ul>
<hr />
<p class="foot">
<a href="mailto:[email protected]">Frank Lübeck</a> / Last modified:
Wed, 21 Feb 2024 17:24:28 +0100
</p>
</body>
</html>