Fix some HTML help output glitches #194
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
olebole
force-pushed
the
fix_html
branch
6 times, most recently
from
3d92b63
to
9e17a56
Compare
* Bad intro (should start with <!DOCTYPE html>) * The title is part of the header, not the body, * Comments are marked with <!-- comment -->, not with <! comment > * the NAME attribute of <A> is deprecated and should be replaced by ID, not necessarily of an <A> tag. * Paragraphs are marked with <P> tags, not witl <UL> tags * The logic often mixed <P>, <PRE>, <DL> tags * Many anchors had the same name; especially since all levels of <DL> tags were armed with an anchor. This is reduced to only the first level. * use lowercase tags
These are mostly * forgotten double quotes * usage of double quotes instead of arcsec unit (they confuse the parser as the parser starts a <tt> here) * format instructions within double-quoted strings (they confuse the parser as they are copied verbatim) * junk at the end of file * forgotten .le, .fi, or extra .nf
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The HTML output of the help has a number of problems which are fixed with the change of the lroff2html parser in this PR:
<!DOCTYPE html>)<!-- comment -->, not with<! comment >NAMEattribute of<A>is deprecated and should be replaced byID, not necessarily of an<A>tag.<P>tags, not witl<UL>tags<P>,<PRE>,<DL>tags<DL>tags were armed with an anchor. This is reduced to only the first level.Using a simple validating parser (
lxml.etree.HTMLParser), this helped to find a number of problems in the.hlpfiles:<tt>here)They are also all corrected.
With these changes, the output of a correct input file is (almost) correct. The only remaining systematic problem is that still some
<DL>tags have the same id. This is due to the simple logic behind them: the id is just the first word of the term, which is not unique f.e. in the REVISIONS section (there the first word is always the task name).The resulting (user oriented) HTML help pages are here: https://iraf.readthedocs.io/