help-texinfo
[Top][All Lists]
Advanced
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: HTML <title> node names: Not emitting 'Top (Manual name)'

From: pertusus
Subject: Re: HTML <title> node names: Not emitting 'Top (Manual name)'
Date: Sat, 16 Mar 2024 16:13:35 +0100 
On Sat, Mar 16, 2024 at 04:49:11PM +0200, Eli Zaretskii wrote:
> > Here are my interrogations.  First I have three questions about removed
> > HTML in the that look suspicious to me.  I think that it should be
> > checked if this is intended, my wild guess is that it is not:
> > 1) the Copyright notice in comments at the very beginning is removed.
> 
> Is it important?

I think so, it is purposely done that way, I believe, and matches with
the '(maintain)Copyright Notices' node information:

    When a file is automatically generated from some other file in the
 distribution, it is useful for the automatic procedure to copy the
 copyright notice and permission notice of the file it is generated from,
 if possible.  Alternatively, put a notice at the beginning saying which
 file it is generated from.

> > 2) the <link href=... rel=... > in <head> are removed, for example
> >   <link href="#Top" rel="start" title="top">
> >   <link href="#Starting-Rules" rel="next" title="Starting Rules">
> 
> Look at how the produced HTML looks vs the one on the site: those
> links are the "Short TOC", which is completely redundant for reading
> the manual on-line.

I do not understand that response.  Those links are usually not directly
visible, they are not links appearing directly in the document text,
they are informations on the page that can be used or not by the
browsers:

  https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link

There may potentially be cases where this is some redundant information
that may lead to a bad rendering, I guess, but it is not visible in
normal browsers.

> > 3) For non split output, the first header/navigation panel is removed.
> 
> Because it is not relevant and confusing.  It has links to
> "Distribution", "Contents", and "Index", all unnecessary, because they
> are right there in the TOC.

Ok.

> > The other main interrogation is about the manual-html-fix-index-1,
> > manual-html-fix-index-2 defun and closing </div> code in manual-html-mono
> > manual-html-node.  Most of these codes seems to do nothing nowadays,
> > except for one thing, adding, right after <body ...> an
> > <div id="content" class="inner">
> > and adding matching </div>.  The matching </div> is at the very end of the
> > file for the mono manual, and right before the table of contents
> > in the node split index.html file.  It is not clear to me what this div
> > is used for.
> 
> Sorry, I don't know.

Can it be omitted?

> > My last important interrogation is about CSS.  The whole CSS added by
> > texi2any is removed, instead of using the possibility offered by the
> > command-line.  My feeling is that what is done right now would be better
> > achieved either by calling with
> >  --css-include=/software/emacs/manual.css
> > although it may not lead to the wanted result if there is some
> > disagreement between the CSS output bu texi2any and the emacs CSS.
> > Another possibility would be to add a file named, for example
> > import_emacs_css.css which would only contain
> > 
> > @import url('/software/emacs/manual.css');
> > 
> > and use
> >   --css-ref=..../import_emacs_css.css
> > at the command-line.
> > 
> > I think that it would be better if the texi2any CSS was kept as some is
> > important for some features, such as copiable links.  In the CSS file
> > https://www.gnu.org/style.css I also noticed that some parts refer to
> > classes no longer used, which is ok if old releases are targeted, but
> > the new class is not there, which makes wonder if some of the code is
> > still needed.
> 
> Maybe.  I know very little about CSS and its effects on the produced
> HTML manuals.

Ok.  This is something that you should handle at some point, but maybe
it can be inored in a first step.

-- 
Pat
reply via email to
[Prev in Thread] Current Thread [Next in Thread]