Skip to content

Commit

Permalink
Rewrite AbstractHTML in HTML format
Browse files Browse the repository at this point in the history
This is not ideal because we should probably reuse the abstract
definition as provided to the Autodoc package.

--------------------------------

AbstractHTML is the text displayed on the package overview web page of
GAP.

AutoDoc Abstract is the text displayed on the title (home) page of digraphs.

The Autodoc package uses the GAPDoc specification for input [1],
whereas AbstractHTML, provided by GAP itself [2],
requires the string in HTML.

There may be a way to convert one to the other,
e.g. convert AutoDoc.TitlePage.Abstract from GAPDoc-formatted
into HTML-formatted string.
Possibly the converter and parser functions
ParseTreeXMLString and GAPDoc2HTML provided by GAPDoc package could be
useful.

Another thing might be AutoDoc entities, as detailed in Chapter 4 of
their manual.

[1] -- AutoDOC Reference Manual
[2] -- GAP Reference Manual, Chapter 76, Section 76.3-15: "The
PackageInfo.g File"
  • Loading branch information
Aidan Lau committed Jan 22, 2025
1 parent 147132d commit dd1d97c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion PackageInfo.g
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,9 @@ AutoDoc := rec(
and independently Artur Schäfer.</Par>
""")),

AbstractHTML := ~.AutoDoc.TitlePage.Abstract));
AbstractHTML := Concatenation(["The <b>Digraphs</b> package is a <b>GAP</b> ",
"package containing methods for graphs, ",
"digraphs, and multidigraphs."])));

if not CompareVersionNumbers(GAPInfo.Version, "4.12") then
Unbind(IsKernelExtensionAvailable);
Expand Down

0 comments on commit dd1d97c

Please sign in to comment.