From owner-freebsd-doc@FreeBSD.ORG Tue Jul 13 16:52:33 2004 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 63D9C16A4CE for ; Tue, 13 Jul 2004 16:52:33 +0000 (GMT) Received: from shrike.submonkey.net (cpc2-cdif3-6-0-cust204.cdif.cable.ntl.com [81.103.67.204]) by mx1.FreeBSD.org (Postfix) with ESMTP id 12FD043D4C for ; Tue, 13 Jul 2004 16:52:33 +0000 (GMT) (envelope-from setantae@submonkey.net) Received: from setantae by shrike.submonkey.net with local (Exim 4.34; FreeBSD) id 1BkQW8-000L5K-7C; Tue, 13 Jul 2004 17:52:32 +0100 Date: Tue, 13 Jul 2004 17:52:32 +0100 From: Ceri Davies To: Warren Block Message-ID: <20040713165232.GT29928@submonkey.net> Mail-Followup-To: Ceri Davies , Warren Block , doc@freebsd.org References: <20040712171533.R43767@wonkity.com> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="ggHp9WSrPOeNxb0b" Content-Disposition: inline In-Reply-To: <20040712171533.R43767@wonkity.com> X-PGP: finger ceri@FreeBSD.org User-Agent: Mutt/1.5.6i Sender: Ceri Davies cc: doc@freebsd.org Subject: Re: Handbook Acronyms X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 13 Jul 2004 16:52:33 -0000 --ggHp9WSrPOeNxb0b Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Mon, Jul 12, 2004 at 05:31:25PM -0600, Warren Block wrote: > In most books, the first use of an acronym or term is defined. With the= =20 > Handbook, that is probably not very helpful, since most users will not=20 > read it straight through and may miss the definition. >=20 > A glossary would help, particularly for HTML, where the definition is=20 > just a link away. This fails on paper versions of the Handbook, though. >=20 > Ideally, the first use of a glossary term in a chapter would have a=20 > short definition: >=20 > With NFS (Network File System), files may be... >=20 > In the HTML version, the entire "NFS (Network File System)" would be a=20 > link to the glossary. Later references and links would just be "NFS". >=20 > If every acronym is defined in the glossary, is it possible to generate= =20 > the link and definition the first time an acronym is used in a chapter? Yes, and that's the plan at the moment. Ceri --=20 It is not tinfoil, it is my new skin. I am a robot. --ggHp9WSrPOeNxb0b Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.4 (FreeBSD) iD8DBQFA9BNPocfcwTS3JF8RAt/sAJ9aa5ggvYCZBE4kvb8eZ4kaKOIXbwCghCQI 2Xaa69lzrGCYxq4CE+Mm2cQ= =b1mS -----END PGP SIGNATURE----- --ggHp9WSrPOeNxb0b--