Add AutoDoc record to PackageInfo and use entities for packages

This commit is contained in:
Glen Whitney 2018-08-21 12:33:38 -07:00
parent b5207d0067
commit 31773603de
3 changed files with 25 additions and 16 deletions

View File

@ -47,7 +47,7 @@ SetPackageInfo( rec(
"The <span class=\"pkgname\">RAQ</span> package provides researchers ", "The <span class=\"pkgname\">RAQ</span> package provides researchers ",
"with means of representing and computing with general one-sided ", "with means of representing and computing with general one-sided ",
"quasigroups, but more more particularly with racks and quandles. ", "quasigroups, but more more particularly with racks and quandles. ",
"This package builds on fundamentals of non-associated algebra ", "This package builds on fundamentals of non-associative algebra ",
"established in the <span class=\"pkgname\">LOOPS</span> package, and ", "established in the <span class=\"pkgname\">LOOPS</span> package, and ",
"and provides enhanced functionality, libraries, and implementations ", "and provides enhanced functionality, libraries, and implementations ",
"as compared to the earlier <span class=\"pkgname\">RIG</span> package ", "as compared to the earlier <span class=\"pkgname\">RIG</span> package ",
@ -72,6 +72,16 @@ SetPackageInfo( rec(
ExternalConditions := [] ExternalConditions := []
), ),
AutoDoc := rec(
entities := rec(
RAQ := "<Package>RAQ</Package>",
LOOPS := "<Package>LOOPS</Package>",
RIG := "<Package>RIG</Package>"
),
TitlePage := rec(
Abstract := ReplacedString(ReplacedString(~.AbstractHTML, "</span>", ";"),
"<span class=\"pkgname\">", "&") ),
),
AvailabilityTest := ReturnTrue, AvailabilityTest := ReturnTrue,
BannerString := Concatenation("--\nRAQ, Racks And Quandles in GAP, Version ", BannerString := Concatenation("--\nRAQ, Racks And Quandles in GAP, Version ",
~.Version, ".\n--\n"), ~.Version, ".\n--\n"),

View File

@ -7,31 +7,31 @@
<!-- <!--
#! @Chapter Introduction #! @Chapter Introduction
#! @AutoDocPlainText --> #! @AutoDocPlainText -->
The RAQ package provides a variety of facilities for constructing and The &RAQ; package provides a variety of facilities for constructing and
computing with one-sided quasigroups, racks, and quandles in GAP. computing with one-sided quasigroups, racks, and quandles in &GAP;.
<!--@Section Installation <!--@Section Installation
@AutoDocPlainText --> @AutoDocPlainText -->
RAQ uses no external binaries, so installation consists only of placing its &RAQ; uses no external binaries, so installation consists only of placing its
unpacked file tree in a directory in your package search path, e.g. the pkg unpacked file tree in a directory in your package search path, e.g. the `pkg`
directory of your GAP installation, or perhaps the .gap/pkg subdirectory of directory of your &GAP; installation, or perhaps the `.gap/pkg` subdirectory of
your home directory. your home directory.
<!--@Acknowledgements <!--@Acknowledgements
@AutoDocPlainText --> @AutoDocPlainText -->
The authors of RAQ would like to acknowledge their debt to the creators of The authors of &RAQ; would like to acknowledge their debt to the creators of
RIG, an earlier package for Racks in GAP; chief among them is Leandro &RIG;, an earlier package for Racks in &GAP;, chief among whom is Leandro
Vendramin. RIG was an inspiration for the creation of RAQ, and using and Vendramin. &RIG; was an inspiration for the creation of &RAQ;, and using and
reading that package suggested many features needed in the development of reading that package suggested many features needed in the development of
RAQ. &RAQ;.
<!--@Chapter Introduction <!--@Chapter Introduction
@Section A first spin @Section A first spin
@AutoDocPlainText --> @AutoDocPlainText -->
Perhaps the following GAP interactive session, which constructs the Perhaps the following &GAP; interactive session, which constructs the
conjugation quandle of the symmetric group on three elements and then performs conjugation quandle of the symmetric group on three elements and then performs
a few simple computations on that quandle, will give the flavor of RAQ. (It is a few simple computations on that quandle, will give the flavor of &RAQ;. (It is
presumed that the RAQ package has already been loaded with presumed that the &RAQ; package has already been loaded with
`LoadPackage("RAQ");` prior to these example commands being executed.) `LoadPackage("RAQ");` prior to these example commands being executed.)
<!--@BeginExampleSession ``` --> <!--@BeginExampleSession ``` -->
``` ```
@ -49,7 +49,7 @@ gap> elt[4]*elt[3]; # So this will produce (1,2,3)^{-1}(1,2)(1,2,3)
<!--@EndExampleSession <!--@EndExampleSession
@AutoDocPlainText --> @AutoDocPlainText -->
Note in particular that RAQ generally, unless otherwise specifically Note in particular that &RAQ; generally, unless otherwise specifically
requested, produces __left__ quandles and racks. (That is to say, quandles in requested, produces __left__ quandles and racks. (That is to say, quandles in
which for any fixed element $l$, the "left-multiplication by $l$" operation which for any fixed element $l$, the "left-multiplication by $l$" operation
$x\mapsto l*x$ is a permutation of the quandle.) $x\mapsto l*x$ is a permutation of the quandle.)

View File

@ -2,6 +2,5 @@
# build the documentation for RAQ via AutoDoc # build the documentation for RAQ via AutoDoc
LoadPackage("AutoDoc"); LoadPackage("AutoDoc");
AutoDoc(rec(scaffold := true, AutoDoc(rec(autodoc := rec(files := ["README.md"])));
autodoc := rec(files := ["README.md"])));
QUIT; QUIT;