Date: Wed, 4 Apr 2001 10:32:59 +0100 From: Nik Clayton <nik@freebsd.org> To: Murray Stokely <murray@osd.bsdi.com> Cc: Nik Clayton <nik@freebsd.org>, freebsd-doc@freebsd.org Subject: Re: Indexing the Handbook Message-ID: <20010404103259.C45781@canyon.nothing-going-on.org> In-Reply-To: <Pine.BSF.4.31.0103282230500.8770-100000@meow.osd.bsdi.com>; from murray@osd.bsdi.com on Wed, Mar 28, 2001 at 10:41:26PM -0800 References: <20010223144043.A46865@canyon.nothing-going-on.org> <Pine.BSF.4.31.0103282230500.8770-100000@meow.osd.bsdi.com>
next in thread | previous in thread | raw e-mail | index | archive | help
--uXxzq0nDebZQVNAZ Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Wed, Mar 28, 2001 at 10:41:26PM -0800, Murray Stokely wrote: > % Do we also run the risk of having lots of different index terms, all > % subtly different? I don't know. >=20 > This is very easy to correct in practice. The HTML index that gets > created is of course in alphabetical order, so very similar index > terms that should probably be compounded are very easy to spot, and in > fact I did this for several terms in my original patch (all relating > to singular vs plural use of a noun). Good point. > % Is this something we could use entities for? > % > % <!ENTITY index.p.stack_frame > % "<indexterm><primary>stack frame</primary></indexterm>"> > % > % and then write > % > % &index.p.stack_frame; > % > % in the documentation? > % > % As I say, I don't know. >=20 > I'm not sure what the best way is either, but I think this is a very > minor style nit when compared with the complete absence of an index in > our printed documentation. Replcaing the indexterms with entities is > just a matter of search and replace, so we can easily change our minds > later once we've actually got some experience working with an index. Also true. > I would like to commit this patch to the Developers Handbook and > continue adding index terms to that document. If things get ugly then > we can find a better way before touching the FreeBSD Handbook. >=20 > Are there any objections to me proceeding with this? No objection from here. Looking through doc.docbook.mk, I think there's a bug with GEN_INDEX, and the html and html-split formats (I think there's a possibility for it to use the FORMATS=3Dhtml index.sgml when, in fact, FORMATS=3Dhtml-split. I'll try and test that out and fix it if it is a problem. N --=20 FreeBSD: The Power to Serve http://www.freebsd.org/ FreeBSD Documentation Project http://www.freebsd.org/docproj/ --- 15B8 3FFC DDB4 34B0 AA5F 94B7 93A8 0764 2C37 E375 --- --uXxzq0nDebZQVNAZ Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.0.4 (FreeBSD) Comment: For info see http://www.gnupg.org iEYEARECAAYFAjrK6ksACgkQk6gHZCw343UzYgCfYKOgPXJo/jVo8YbpmbdGmb+t MccAn3c2yDE8PzWCVFhpxOtxm/lPj15l =dak3 -----END PGP SIGNATURE----- --uXxzq0nDebZQVNAZ-- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010404103259.C45781>