From owner-freebsd-doc@FreeBSD.ORG Fri Jul 9 17:11: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 3998016A4D0 for ; Fri, 9 Jul 2004 17:11: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 C186943D31 for ; Fri, 9 Jul 2004 17:11:32 +0000 (GMT) (envelope-from setantae@submonkey.net) Received: from setantae by shrike.submonkey.net with local (Exim 4.34; FreeBSD) id 1BiyuK-000MTQ-43; Fri, 09 Jul 2004 18:11:32 +0100 Date: Fri, 9 Jul 2004 18:11:32 +0100 From: Ceri Davies To: Leonard Zettel Message-ID: <20040709171132.GD29928@submonkey.net> Mail-Followup-To: Ceri Davies , Leonard Zettel , freebsd-doc@FreeBSD.org References: <200407091038.52304.zettel@acm.org> <20040709160642.GB29928@submonkey.net> <200407091237.04562.zettel@acm.org> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="mmR5Tf+WJGm+vTLg" Content-Disposition: inline In-Reply-To: <200407091237.04562.zettel@acm.org> X-PGP: finger ceri@FreeBSD.org User-Agent: Mutt/1.5.6i Sender: Ceri Davies cc: freebsd-doc@FreeBSD.org Subject: Re: Acronyms believed harmful 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: Fri, 09 Jul 2004 17:11:33 -0000 --mmR5Tf+WJGm+vTLg Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Fri, Jul 09, 2004 at 12:37:04PM -0400, Leonard Zettel wrote: > On Friday 09 July 2004 12:06 pm, Ceri Davies wrote: > > On Fri, Jul 09, 2004 at 10:38:52AM -0400, Leonard Zettel wrote: > > > Things like DTD are not English, they > > > are jargon! They place an unnecessary > > > burden on the reader. This burden > > > falls most heavily on newbies and > > > (I would imagine) people to whom > > > English is a second (or third or fourth) > > > language - exactly the people who > > > most need the help of clear documentation. > > > > > > At a minimum I plead for the following rule: > > > all uses of acronyms in any document > > > should include the term fully spelled out > > > at the first appearance of said acronym. > > > > Well, there's a work in progress(ish) to have the first use of an > > acronym expand to a link to it's entry in the glossary. This can't > > happen until the glossary is full. Help to fill it. > > > Love to! How? You'll need to check out a copy of the doc tree and add entries to the glossary file doc/en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml. See also my mail to Bill Moran for areas to focus on. Thanks for the help! Ceri --=20 It is not tinfoil, it is my new skin. I am a robot. --mmR5Tf+WJGm+vTLg Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.4 (FreeBSD) iD8DBQFA7tHDocfcwTS3JF8RAueQAJ9v4yBN1eQ0HnyXH8p2YQ52Kw8pPgCeIM07 bsEeQ1xuUkOuNmH1W5Q1cOc= =japq -----END PGP SIGNATURE----- --mmR5Tf+WJGm+vTLg--