[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: organization of the documentation of customization variables
From: |
Eli Zaretskii |
Subject: |
Re: organization of the documentation of customization variables |
Date: |
Wed, 27 Mar 2024 14:18:56 +0200 |
> Date: Tue, 26 Mar 2024 23:20:23 +0100
> From: Patrice Dumas <pertusus@free.fr>
>
> > I took the list and tried to sort it into sections. I may not have
> > done an especially good job of this, and there will likely be misplaced
> > variables. I suggest this could be taken as a starting point for
> > reorganising the manual.
>
> I started from that and did two nodes, as can be seen in the commit
> https://git.savannah.gnu.org/cgit/texinfo.git/commit/?id=c0a8822909514e947cefc7112986a2e704a023d0
>
> Before I continue, is what I did the expected content?
>From where I stand, yes, it's a very good starting point, thanks.
> Here is what I propose:
>
> * move HTML customization variables explanations to the 'Generating HTML'
> chapter, either in an already existing section where they would be
> inserted naturally (for example in the 'HTML CSS' section for
> customization variables related to CSS) or to new sections or
> subsections. For exampl, I think that the new 'HTML Output Structure
> Customization' node could be before 'Generating EPUB' or together with
> 'HTML Splitting', while 'File Names and Links Customization for HTML'
> could be after 'HTML Cross-references' probably with other
> customization variables nodes.
> * Move the 'HTML Customization Variables List' node to an appendix.
SGTM. I think making the customization stuff separate subsections
would be better, as many users will not need that in the mainline
reading of the manual. But that's a weak preference.