Sandra Loosemore <san...@codesourcery.com> writes: > On 2/23/23 03:27, Arsen Arsenović via Gcc-patches wrote: >> The GCC manual has multiple indices. By creating an appendix which >> lists them, we help makeinfo present a more accessible way for the >> reader to see all the indices. >> gcc/ChangeLog: >> * doc/gcc.texi: Add the Indices appendix, to make texinfo >> generate nice indices overview page. >> (@copying): Move "This file documents the use of the GNU >> compilers" into @copying. Add quotations around cover texts. > > > I guess this patch is OK and is necessary to smooth over some misfeatures > in newer versions of Texinfo. In particular, comparing your sample output > https://www.aarsen.me/~arsen/final/gcc.html/index.html > > to my own fresh Texinfo 6.7-generated version with your patches applied, and > the existing online documention like > > https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc/index.html > > the order of the "Short Table of Contents" and longer "Table of Contents" have > been switched, so that in the new version you have to scroll all the way down > to the bottom of the page (ugh) to click on "Option Index". (Frankly, this > seems like a misfeature; the point of having a "Short Table of Contents" is > *not* to have to page through the long one to find a particular chapter.) > > I guess that is a Texinfo change? gcc.texi still has: > > @summarycontents > @contents > > in that order.
Found the change. HTML got support for CONTENTS_OUTPUT_LOCATION, which defaults to after_top, which ignores the inline location of these elements. Here's a patch:
From 0a0c9469301fb25c4b420a1ed4e381f5ea921d07 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Arsen=20Arsenovi=C4=87?= <ar...@aarsen.me>
Date: Thu, 9 Mar 2023 21:44:29 +0100
Subject: [PATCH] update_web_docs_git: Set CONTENTS_OUTPUT_LOCATION=inline
maintainer-scripts/ChangeLog:
* update_web_docs_git: Set CONTENTS_OUTPUT_LOCATION=inline in
order to put @shortcontents above contents. See
9dd976a4-4e09-d901-b949-6d5037567...@codesourcery.com on
gcc-patches.
---
maintainer-scripts/update_web_docs_git | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/maintainer-scripts/update_web_docs_git b/maintainer-scripts/update_web_docs_git
index 9ded1744df4..c9f14d1a4d1 100755
--- a/maintainer-scripts/update_web_docs_git
+++ b/maintainer-scripts/update_web_docs_git
@@ -169,7 +169,7 @@ for file in $MANUALS; do
if [ "$file" = "gnat_ugn" ]; then
includes="$includes -I gcc/gcc/ada -I gcc/gcc/ada/doc/gnat_ugn"
fi
- makeinfo --html --css-ref $CSS $includes -o ${file} ${filename}
+ makeinfo --html -c CONTENTS_OUTPUT_LOCATION=inline --css-ref $CSS $includes -o ${file} ${filename}
tar cf ${file}-html.tar ${file}/*.html
texi2dvi $includes -o ${file}.dvi ${filename} </dev/null >/dev/null && dvips -o ${file}.ps ${file}.dvi
texi2pdf $includes -o ${file}.pdf ${filename} </dev/null
--
2.39.2
I pushed the updated docs, and added that commit to my branch (as well
as rebasing it, as always).
> OTOH, I see that in your new version there is now a line with links
> [Contents][Index] before the Introduction. If adding this new appendix makes
> the [Index] link point at the indices, I think it is OK, although I'm still
> worried that the overall effect (even without the new version of Texinfo) is
> making the indices harder to find.
>
> I wonder, could we add something to the Introduction text like
>
> Tip: This manual is very long. If you're looking for something in particular,
> try searching the @ref{Option Index} or @ref{Concept and Symbol Index}.
>
> ???
Even with the above fixed, I think it'd be nice to add this text.
> -Sandra
--
Arsen Arsenović
signature.asc
Description: PGP signature
