Skip to content

Commit f7eb177

Browse files
GAPgap
GAP
authored and
gap
committed
Updating for GAP 4.4.
git-svn-id: path/gapdoc/trunk@59
1 parent 4cb1b2c commit f7eb177

File tree

7 files changed

+309
-30
lines changed

7 files changed

+309
-30
lines changed

‎PkgInfo.g renamed to ‎PackageInfo.g

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
#############################################################################
22
##
3-
## PkgInfo file for the GAPDoc package. Frank Lübeck
4-
##
3+
## PackageInfo.g for the package `GAPDoc' Frank Lübeck
4+
5+
## With a new release of the package at least the entries .Version, .Date and
6+
## .ArchiveURL must be updated.
57

68
SetPackageInfo( rec(
7-
PkgName := "GAPDoc",
8-
Version := "0.99",
9-
Date := "02/04/2002",
10-
PkgInfoCVSRevision := "$Id: PkgInfo.g,v 1.2 2003-02-19 02:16:39 gap Exp $",
11-
ArchiveURL := "http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/gapdoc-0r99",
9+
10+
CVSVERSION := "$Id: PackageInfo.g,v 1.1 2003-06-20 15:29:01 gap Exp $",
11+
12+
PackageName := "GAPDoc",
13+
Subtitle := "A Meta Package for GAP Documentation",
14+
Version := "0.999",
15+
Date := "20/06/2003",
16+
ArchiveURL :=
17+
"http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/gapdoc-0.999",
1218
ArchiveFormats := ".tar.bz2",
1319
Persons := [
1420
rec(
@@ -19,7 +25,8 @@ Persons := [
1925
Email := "Frank.Luebeck@Math.RWTH-Aachen.De",
2026
WWWHome := "http://www.math.rwth-aachen.de/~Frank.Luebeck",
2127
Place := "Aachen",
22-
Institution := "Lehrstuhl D für Mathematik, RWTH Aachen"
28+
Institution := "Lehrstuhl D für Mathematik, RWTH Aachen",
29+
PostalAddress := "Dr. Frank Lübeck\nLehrstuhl D für Mathematik\nRWTH Aachen\nTemplergraben 64\n52062 Aachen\nGERMANY\n"
2330
),
2431
rec(
2532
LastName := "Neunhöffer",
@@ -29,19 +36,26 @@ Persons := [
2936
Email := "Max.Neunhoeffer@Math.RWTH-Aachen.De",
3037
WWWHome := "http://www.math.rwth-aachen.de/~Max.Neunhoeffer",
3138
Place := "Aachen",
32-
Institution := "Lehrstuhl D für Mathematik, RWTH Aachen"
39+
Institution := "Lehrstuhl D für Mathematik, RWTH Aachen",
40+
PostalAddress := "Dr. Max Neunhöffer\nLehrstuhl D für Mathematik\nRWTH Aachen\nTemplergraben 64\n52062 Aachen\nGERMANY\n"
3341
)
3442
],
3543
Status := "deposited",
44+
45+
# CommunicatedBy := "Mike Atkinson (St. Andrews)",
3646
#CommunicatedBy := "",
47+
# AcceptDate := "08/1999",
3748
#AcceptDate := "",
38-
README_URL := "http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/README",
39-
PkgInfoURL := "http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/PkgInfo.g",
40-
AbstractHTML := "This package contains a definition of a structure for <span class='pkgname'>GAP</span> (package) documentation, based on XML. It also contains conversion programs for producing text-, DVI-, PDF- or HTML-versions of such documents.",
49+
README_URL :=
50+
"http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/README",
51+
PackageInfoURL :=
52+
"http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/PackageInfo.g",
53+
AbstractHTML := "This package contains a definition of a structure for <span class='pkgname'>GAP</span> (package) documentation, based on XML. It also contains conversion programs for producing text-, DVI-, PDF- or HTML-versions of such documents, with hyperlinks if possible.",
4154
PackageWWWHome := "http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc",
4255
PackageDoc := [rec(
4356
BookName := "GAPDoc",
44-
Archive := "http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/gapdoc-doc-0r99.tar.bz2",
57+
# Archive := "http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/gapdoc-doc-0r99.tar.bz2",
58+
ArchiveURLSubset := ["doc"],
4559
HTMLStart := "doc/chap0.html",
4660
PDFFile := "doc/manual.pdf",
4761
SixFile := "doc/manual.six",
@@ -50,7 +64,8 @@ PackageDoc := [rec(
5064
),
5165
rec(
5266
BookName := "GAPDoc Example",
53-
Archive := "http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/gapdoc-example-0r99.tar.bz2",
67+
# Archive := "http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/gapdoc-example-0r99.tar.bz2",
68+
ArchiveURLSubset := ["example"],
5469
HTMLStart := "example/chap0.html",
5570
PDFFile := "example/manual.pdf",
5671
SixFile := "example/manual.six",
@@ -67,19 +82,17 @@ Dependencies := rec(
6782
),
6883
AvailabilityTest := ReturnTrue,
6984
AutoLoad := true,
70-
71-
# the banner
72-
BannerString := Concatenation(
85+
BannerString := Concatenation(
7386
" ######################################################################\n",
7487
" ## ##\n",
75-
" ## GAPDoc 0.99 (a GAP documentation meta-package) ##\n",
88+
" ## GAPDoc ", ~.Version, " (a GAP documentation meta-package) ##\n",
7689
" ## ##\n",
7790
" ## Questions and remarks to: Frank.Luebeck@Math.RWTH-Aachen.De ##\n",
7891
" ## Max.Neunhoeffer@Math.RWTH-Aachen.De ##\n",
7992
" ## ##\n",
8093
" ######################################################################\n\n"
8194
),
82-
Keywords := ["GAP documentation", "help system", "XML"]
95+
Keywords := ["GAP documentation", "help system", "XML", "pdf", "hyperlink"]
8396
));
8497

8598

‎README

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ INSTALLATION
4040
Just unpack one of the archives in the "pkg" subdirectory of your GAP
4141
installation. The archive is available in several formats:
4242

43-
gapdoc-0.99.zoo (use the "unzoo" or "unzoo.exe" from the GAP homepage)
44-
gapdoc-0.99.tar.gz (GNU tar archive, gzip'ed)
45-
gapdoc-0.99.tar.bz2 (GNU tar archive, bzip2'ed)
46-
gapdoc-0.99.zip (with UNIX style line breaks in text files)
47-
gapdoc-0.99-w.zip (with DOS/Windows style line breaks in text files)
43+
gapdoc-XXX.zoo (use the "unzoo" or "unzoo.exe" from the GAP homepage)
44+
gapdoc-XXX.tar.gz (GNU tar archive, gzip'ed)
45+
gapdoc-XXX.tar.bz2 (GNU tar archive, bzip2'ed)
46+
gapdoc-XXX-win.zip (with DOS/Windows style line breaks in text files)
4847

4948
Unpacking generates a subdirectory "gapdoc".
5049

50+
[no longer necessary from GAP 4.4 on:]
5151
To tell GAP about this package add the following line to the file "ALLPKG"
5252
in the "pkg" directory.
5353

‎index.html

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

0 commit comments

Comments
 (0)