Re: html structure revisited

[Per Bothner]

On 2/14/21 12:12 PM, Gavin Smith wrote:
> It's good that you are managing to understand the code and have
> made the changes that you wanted to.

Well, bits and pieces of it ...

> I have been looking at your patch and reading earlier mails on
> this topic.
>
> I have two main questions:
> * Why output extra <div> elements for split output, when there is
> only one section (not including subsections) per output file anyway?
> It's harmless, anyway.

It just feels more consistent: For every chapter there is a <div 
class="chapter">
element somewhere in the output, and for every section there is a <div 
class="section">
somewhere.  Perhaps you might want to put a blue frame around every chapter
and a green frame around every section, for a top-of-my-head
(useless?) styling task.  It also makes it easier for tools that
might try to combine/split/process the generated output.

> * What is the point of <div class="node">?

It does have a separate id "anchor":

<div class="section" id="Python-tips">
   <div class="node" id="Python-tips-1">

However, it doesn't look like the node links are actually used for anything.
Maybe if an index is generated?

If there is a need for id="Python-tips-1", perhaps it could go on the title:
  <h3 class="section" id="Python-tips-1">Python tips</h3>

Though I'm not sure if that is right; it depends what if anything
that link is used for.

> I propose not to output the <div> for "node" unless there is a good
> reason for it.

I have no objection.  It's always better to add it later if there is
a good use for it, rather than remove it if we don't.  Also we
might decide something similar but different is more useful. For example,
it might be useful to have a node-body that does *not* include the title:
  <h3 class="section">Python tips</h3>
  <div class="node-body">

Makes sense to defer the issue until there is a clear need.
--
        --Per Bothner
per@bothner.com   http://per.bothner.com/