From owner-freebsd-doc@FreeBSD.ORG Wed May 8 12:28:33 2013 Return-Path: Delivered-To: doc@FreeBSD.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id 4850953B; Wed, 8 May 2013 12:28:33 +0000 (UTC) (envelope-from marc@blackend.org) Received: from smtp6-g21.free.fr (smtp6-g21.free.fr [IPv6:2a01:e0c:1:1599::15]) by mx1.freebsd.org (Postfix) with ESMTP id 396FEB6C; Wed, 8 May 2013 12:28:30 +0000 (UTC) Received: from emphyrio.blackend.org (unknown [88.179.1.53]) by smtp6-g21.free.fr (Postfix) with ESMTP id 863BA82241; Wed, 8 May 2013 14:28:23 +0200 (CEST) Received: from emphyrio.blackend.org (localhost [127.0.0.1]) by emphyrio.blackend.org (8.14.5/8.14.4) with ESMTP id r48CSMgs002268; Wed, 8 May 2013 14:28:22 +0200 (CEST) (envelope-from marc@emphyrio.blackend.org) Received: (from marc@localhost) by emphyrio.blackend.org (8.14.5/8.14.4/Submit) id r48CSL5f002267; Wed, 8 May 2013 14:28:21 +0200 (CEST) (envelope-from marc) Date: Wed, 8 May 2013 14:28:21 +0200 From: Marc Fonvieille To: Gabor Kovesdan Subject: Re: [CFR] Migrating the documentation to a real XML toolchain Message-ID: <20130508122821.GA1521@emphyrio.blackend.org> References: <512D2F9C.8080403@FreeBSD.org> <5142357A.9070301@FreeBSD.org> <5142D0C9.70905@FreeBSD.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <5142D0C9.70905@FreeBSD.org> X-Useless-Header: blackend.org X-Operating-System: FreeBSD 8.3-STABLE User-Agent: Mutt/1.5.21 (2010-09-15) Cc: doc@FreeBSD.org X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 08 May 2013 12:28:33 -0000 On Fri, Mar 15, 2013 at 08:42:01AM +0100, Gabor Kovesdan wrote: > > > > Good question. I know this is given as a reason why acronyms should > > always be marked up, and I thought I'd seen it at some point in the > > FreeBSD docs. But it does not do it now, and I may have been looking > > at something else. It is something that would really benefit the reader. > I also agree that it would be a nice feature but actually I don't even > understand how it is supposed to work at the moment. In most cases, the > markup does not hold the expansion, it just says e.g. > NFS but does not include what it needs to expand to. > We could add an attribute but then it would only appear if the attribute > is present. Shall we expand all occurrences (would mean lots of > redundancy) or just the first? It was supposed working in the same way as the trademarks, i.e., the 1st occurence is expanded/rendered. > Other idea would be to use a separate XML > database of acronym expansions, install it with the docs and let > JavaScript rewrite the acronyms. But in this case we have to think of > how to handle acronyms that can have multiple expansions. > -- Marc