From owner-freebsd-doc@FreeBSD.ORG Fri Dec 12 08:58:49 2008 Return-Path: Delivered-To: doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id D3C2B106564A for ; Fri, 12 Dec 2008 08:58:49 +0000 (UTC) (envelope-from pali.gabor@googlemail.com) Received: from mail-ew0-f21.google.com (mail-ew0-f21.google.com [209.85.219.21]) by mx1.freebsd.org (Postfix) with ESMTP id 3865D8FC1D for ; Fri, 12 Dec 2008 08:58:49 +0000 (UTC) (envelope-from pali.gabor@googlemail.com) Received: by ewy14 with SMTP id 14so1913766ewy.19 for ; Fri, 12 Dec 2008 00:58:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlemail.com; s=gamma; h=domainkey-signature:received:received:sender:message-id:date:from :organization:user-agent:mime-version:to:cc:subject:references :in-reply-to:x-enigmail-version:content-type :content-transfer-encoding; bh=9ppBvkHOzi/eYF52AsYc9Mxg/YOXC5xcU+9I2IZG1BM=; b=gm1Pzk8Hg1eYc85y2uk/8jGGZykoT0VzZm1GGXpgtKK+E+gwNJ39rlB50bCTuGK9EZ +CpwpFJK/3qCqsYXym11aiZeVOBQPRC9M0+BHDFeHHjfBy9ywCgiv3cA1GmyIGmX9hVZ jpF4ZK4WON06ynnqfpKrsdKpDLd0FcjZQhWnU= DomainKey-Signature: a=rsa-sha1; c=nofws; d=googlemail.com; s=gamma; h=sender:message-id:date:from:organization:user-agent:mime-version:to :cc:subject:references:in-reply-to:x-enigmail-version:content-type :content-transfer-encoding; b=Csfuxz9Xc264l2pTXXObrulPKOt+FMbd1qB3QOBaotGbmHGtj//gv4zLrMMKSbUj6l rrrnKJPjfPuAF7mMV2TamceaacAKu6oi//+gRojHb3GzEf1QQmIKbN8YFCagKrJuYqzc RY4o0hVzRwrmcnoLv3oWtSii24AhbVsAUHrwY= Received: by 10.210.52.15 with SMTP id z15mr533109ebz.28.1229072328121; Fri, 12 Dec 2008 00:58:48 -0800 (PST) Received: from ?192.168.1.18? (oktnb24.inf.elte.hu [157.181.167.24]) by mx.google.com with ESMTPS id 34sm3245579nfu.33.2008.12.12.00.58.46 (version=TLSv1/SSLv3 cipher=RC4-MD5); Fri, 12 Dec 2008 00:58:47 -0800 (PST) Sender: =?UTF-8?B?UMOBTEkgR8OhYm9yIErDoW5vcw==?= Message-ID: <494227B4.3070504@FreeBSD.org> Date: Fri, 12 Dec 2008 09:58:28 +0100 From: Gabor PALI Organization: The FreeBSD Project User-Agent: Thunderbird 2.0.0.17 (X11/20081023) MIME-Version: 1.0 To: Rene Ladan References: <871vwfn418.fsf@kobe.laptop> <2a7894eb0812101310v2123a452q26b0e07630e7f209@mail.gmail.com> <878wqnafso.fsf@kobe.laptop> <2a7894eb0812101322o77b12fc9k8208f83d62481ad3@mail.gmail.com> <87k5a63z2d.fsf@kobe.laptop> In-Reply-To: X-Enigmail-Version: 0.95.7 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Cc: doc@freebsd.org, Giorgos Keramidas 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 08:58:49 -0000 Rene Ladan wrote: > 2008/12/12 Giorgos Keramidas : >> 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? >> > I am in favour of the full expansion, so that you can write > > Using &acronym.wlan.wep; encryption is not really safe anymore, > but a lot of people use it anyway. > > This form is shorter and we don't have to write the word "acronym" three times. Maybe you can have different versions in the .ent file, like you did in case of mailing lists (defer the design decisions :)): WEP'> WEP'> > Maybe the acronyms can link to the glossary of the Handbook as well? Hm, sounds interesting. I think it is a good idea. Add another entity, for example: WEP'> So the documentation writer has the freedom of choice how to mark up acronyms. It could be useful when one does not want to link all instances of an acronym, only the first in the section, for example. Thanks for saving us from lot of typing, Giorgos! :) Cheers, :g