Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix HTML entities on the Digraphs homepage #721

Closed
wants to merge 5 commits into from

Conversation

forktree
Copy link
Contributor

This pull request possibly resolves Issue 711.

It appears this could be related to PR 684 in that the previous homepage was defined in raw HTML, whereas this is now defined using GAPDoc syntax and automatically generated using AutoDOC.

I should note that I can't find the Copyright nor Acknowledgements sections on the homepage, so don't know if they were parsed correctly beforehand.

Aidan Lau added 5 commits January 22, 2025 19:24
Following the GAPDoc manual [1],
this should make the package names

[1] -- https://docs.gap-system.org/pkg/gapdoc/doc/chap0_mj.html
specifically Chapter 3.7, Types of Text
As instructed by Chapter 3 of GAPDoc manual,
Section 3.9.2.

Taking new lines within the string does not
propagate the new lines to the output,
unlike LaTeX.
The GAPDoc Manual contains an example GAPDoc document in Appendix A,
document title 3k+1.xml,
where the Unicode character is used directly
as opposed to the character code from HTML/XML.
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"
@forktree forktree closed this Jan 22, 2025
@forktree forktree deleted the 711-fix-html branch January 22, 2025 20:19
@forktree forktree restored the 711-fix-html branch January 22, 2025 20:19
@forktree forktree deleted the 711-fix-html branch January 22, 2025 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix HTML entities on the Digraphs homepage
1 participant