From owner-freebsd-doc@FreeBSD.ORG Fri Dec 12 02:30:30 2008 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 0938B1065670 for ; Fri, 12 Dec 2008 02:30:30 +0000 (UTC) (envelope-from keramida@freebsd.org) Received: from igloo.linux.gr (igloo.linux.gr [62.1.205.36]) by mx1.freebsd.org (Postfix) with ESMTP id 8ED9C8FC08 for ; Fri, 12 Dec 2008 02:30:29 +0000 (UTC) (envelope-from keramida@freebsd.org) Received: from kobe.laptop (adsl179-214.kln.forthnet.gr [77.49.0.214]) (authenticated bits=128) by igloo.linux.gr (8.14.3/8.14.3/Debian-5) with ESMTP id mBC2UJpc031453 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT); Fri, 12 Dec 2008 04:30:25 +0200 Received: from kobe.laptop (kobe.laptop [127.0.0.1]) by kobe.laptop (8.14.3/8.14.3) with ESMTP id mBC2UIiD005574; Fri, 12 Dec 2008 04:30:18 +0200 (EET) (envelope-from keramida@freebsd.org) Received: (from keramida@localhost) by kobe.laptop (8.14.3/8.14.3/Submit) id mBC2UIQq005573; Fri, 12 Dec 2008 04:30:18 +0200 (EET) (envelope-from keramida@freebsd.org) From: Giorgos Keramidas To: "Murray Stokely" References: <871vwfn418.fsf@kobe.laptop> <2a7894eb0812101310v2123a452q26b0e07630e7f209@mail.gmail.com> <878wqnafso.fsf@kobe.laptop> <2a7894eb0812101322o77b12fc9k8208f83d62481ad3@mail.gmail.com> Date: Fri, 12 Dec 2008 04:30:18 +0200 In-Reply-To: <2a7894eb0812101322o77b12fc9k8208f83d62481ad3@mail.gmail.com> (Murray Stokely's message of "Wed, 10 Dec 2008 13:22:57 -0800") Message-ID: <87k5a63z2d.fsf@kobe.laptop> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.0.60 (berkeley-unix) MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-MailScanner-ID: mBC2UJpc031453 X-Hellug-MailScanner: Found to be clean X-Hellug-MailScanner-SpamCheck: not spam, SpamAssassin (not cached, score=-4.296, required 5, autolearn=not spam, ALL_TRUSTED -1.80, AWL 0.10, BAYES_00 -2.60) X-Hellug-MailScanner-From: keramida@freebsd.org X-Spam-Status: No Cc: freebsd-doc@freebsd.org Subject: Re: [PATCH] Adding elements to wlan Handbook section X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 12 Dec 2008 02:30:30 -0000 On Wed, 10 Dec 2008 13:22:57 -0800, "Murray Stokely" wrote: > In that case this looks great to me. I agree with Manolis that adding > the role="definition" for the first instance of each acronym is > helpful. I really thought we were already doing this in parts of the > Handbook, but I may be misremembering. I started adding a role="" at the first instance of each WLAN-specific acronym and I noticed that I was typing the same expansions again and again all over the place. This is a bit error prone, so it seemed more natural to add a ``set of "standard" acronym expansions''. Does something like this look useful for other sorts of acronyms too? %%% # HG changeset patch # User keramida # Date 1229048467 -7200 # Node ID c8a6e126654fba80e290d6c93568d551a0c10473 # Parent 669337240ff11759179bde192d61b69a6be769ea Add support for a set of 'standard' acronym expansions. I got a bit sick of typing role="the same text" all the time, and this gives us an easy point to redefine an acronym expansion without having to crawl the entire doc/ tree, so here it is. diff -r 669337240ff1 -r c8a6e126654f share/sgml/acronyms.ent --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/share/sgml/acronyms.ent Fri Dec 12 04:21:07 2008 +0200 @@ -0,0 +1,21 @@ + + + + + + + + + + + + diff -r 669337240ff1 -r c8a6e126654f share/sgml/articles.ent --- a/share/sgml/articles.ent Wed Dec 10 22:51:06 2008 +0200 +++ b/share/sgml/articles.ent Fri Dec 12 04:21:07 2008 +0200 @@ -8,6 +8,8 @@ %man; %freebsd; + +%acronyms; %authors; diff -r 669337240ff1 -r c8a6e126654f share/sgml/books.ent --- a/share/sgml/books.ent Wed Dec 10 22:51:06 2008 +0200 +++ b/share/sgml/books.ent Fri Dec 12 04:21:07 2008 +0200 @@ -10,6 +10,8 @@ %bookinfo; %freebsd; + +%acronyms; %authors; diff -r 669337240ff1 -r c8a6e126654f share/sgml/catalog --- a/share/sgml/catalog Wed Dec 10 22:51:06 2008 +0200 +++ b/share/sgml/catalog Fri Dec 12 04:21:07 2008 +0200 @@ -23,6 +23,9 @@ PUBLIC "-//FreeBSD//DOCUMENT DocBook Language Neutral Stylesheet//EN" "freebsd.dsl" +PUBLIC "-//FreeBSD//ENTITIES DocBook FreeBSD Acronyms Entity Set//EN" + "acronyms.ent" + PUBLIC "-//FreeBSD//ENTITIES DocBook FreeBSD Articles Entity Set//EN" "articles.ent" %%% I have only added a few acronym expansions now, but this already makes it possible to write things like: Using WEP encryption is not really safe anymore, but a lot of people use it anyway. We can probably go a step further and define: WEP'> but I wanted to ask the rest of doc@ first what they think about a list of acronym expansions that is shared like this? If yes, which form of entity would you prefer to have? One that expands to the "Name of the Acronym" or one that expands to the full element? Giorgos