Subject: Re: Autogenerating indexes in docbook
To: None <netbsd-docs@NetBSD.org>
From: Hiroki Sato <hrs@NetBSD.org>
Date: 04/25/2006 03:52:23
Content-Type: Text/Plain; charset=us-ascii
Jan Schaumann <email@example.com> wrote
js> Roland Illig <rillig@NetBSD.org> wrote:
js> > I would like to have an additional attribute for the <varname> tag, so
js> > that I can write <varname index="yes">CONFIGURE_ARGS</varname>, and the
js> > variable will automatically appear in the variable index (another
js> > appendix). From there, a backlink should go to the location where the
js> > variable is used (for both the HTML and the PDF output). In the
js> > page-oriented output formats, the index should contain line numbers, and
js> > in the one-page HTML and the plain text formats, the index should
js> > contain the section number.
js> > Is that possible or do we need to switch to another documentation format
js> > to do this?
js> It is my understanding that this should be possible. (Just as a side
js> note, I believe that operations like this are what make the processing
js> of the documents slow and resource intensive, as the entire document
js> tree needs to be processed to generate the index.)
Yes, possible. Generating index is still not so resource intensive
compared to the normal typeset process we are using now because
it can also be done together with generating ToC or so.
I think I will add this to my TODO list anyway.
BTW, should we have a complete reference manual for make variables
in pkgsrc as an appendix?
| Hiroki SATO
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2 (FreeBSD)
-----END PGP SIGNATURE-----