Authors:
Frank Lübeck
(maintainer) and
Max Neunhöffer
Needs: GAP in
version at least 4.11.0
and for creating high quality output of GAPDoc
documents a sufficiently new version of LaTeX/pdfLaTeX
and
certain LaTeX
packages, makeindex
.
Operating systems: Any, on which GAP and the programs mentioned above are running.
Current version: 1.6.7 (02/2024)
Status: Accepted (since October 2006)
Contact:
Frank.Luebeck@Math.RWTH-Aachen.De
Download: See below for archives in
several formats.
Source repository and issue tracker:
https://github.com/frankluebeck/GAPDoc
History: This text file CHANGES
describes the most important differences to former versions of GAPDoc.
This package describes a document format for writing GAP documentation.
The idea is to define a sufficiently abstract markup language for GAP documentation which can be (relatively easily) converted into different output formats. We used XML to define such a language.
This package provides:
ComposedDocument
for composing documents
which are distributed in many files
Just unpack one of the archives given below in the
pkg
subdirectory of your GAP
installation.
Unpacking generates a subdirectory GAPDoc-1.6.7
.
That's it! (Maybe you want to read the help section
'?SetHelpViewer
' in the GAP reference
manual.)
Installation outside the GAP main directory: When
you don't have access to the directory of your main GAP installation
you can also install the package by unpacking inside a directory
MYGAPDIR/pkg
. (Don't forget to call gap
with
the -l ";MYGAPDIR"
option.)
The only drawback with this
installation is that in the HTML version of the package documentation the
links to the main GAP manuals don't work. You can
correct this by recompiling the HTML version of the documentation: Say
cd GAPDoc*; gap makedocrel.g
.
Here is the documentation of the GAPDoc package in several output formats. If you have installed the package as described above you can also access all of these documents from the GAP online help.
pdf
-version less
on a terminal screen, if it looks like
garbage, type -r<CR>
or start with less -r
)
There is also an example document which uses all constructs which are allowed in a GAPDoc document. Here you can compare directly the GAPDoc-XML-source code and how it looks like in each format.
pdf
-version The GAPDoc package is availabe in several formats:
GAPDoc-1.6.7.tar.gz
(GNU tar
archive, gzip
'ed)
GAPDoc-1.6.7.tar.bz2
(GNU tar
archive, bzip2
'ed)
GAPDoc-1.6.7-win.zip
(with DOS/Windows style line breaks in text files)
Frank Lübeck / Last modified: Wed, 21 Feb 2024 17:24:28 +0100