[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: OVERVIEW_LINK_TO_TOC and other variables
From: |
Gavin Smith |
Subject: |
Re: OVERVIEW_LINK_TO_TOC and other variables |
Date: |
Mon, 3 Jan 2022 21:21:13 +0000 |
User-agent: |
Mutt/1.9.4 (2018-02-28) |
On Mon, Jan 03, 2022 at 12:38:09PM +0100, Patrice Dumas wrote:
> > > This is customized with the OVERVIEW_LINK_TO_TOC variable. It's not easy
> > > to find this out because the manual calls it the "Overview" and not the
> > > "Short Table of Contents":
> > >
> > > 'OVERVIEW_LINK_TO_TOC'
> > > If set, the cross-references in the Overview link to the
> > > corresponding Table of Contents entries; default true.
> > >
> > > My suggestion is to remove this variable and make the links in the
> > > @shortcontents link to the chapters themselves by default. Any comments?
> >
> > This has been set as the default while it was not the default in
> > texi2html, so it was set like that on purpose and I would guess that it
> > is expected by at least some users. What I would propose, instead is
> > * to rename OVERVIEW_LINK_TO_TOC as SHORT_TOC_LINK_TO_TOC
> > * if there is no table of contents output, link to the chapters even
> > if SHORT_TOC_LINK_TO_TOC is set
> Can I proceed with what I proposed?
That sounds fine. I don't mind if you rename OVERVIEW_LINK_TO_TOC or
not as long as the documentation is clear about what it does.