Date: Wed, 8 May 2013 14:28:21 +0200 From: Marc Fonvieille <blackend@FreeBSD.org> To: Gabor Kovesdan <gabor@FreeBSD.org> Cc: doc@FreeBSD.org Subject: Re: [CFR] Migrating the documentation to a real XML toolchain Message-ID: <20130508122821.GA1521@emphyrio.blackend.org> In-Reply-To: <5142D0C9.70905@FreeBSD.org> References: <512D2F9C.8080403@FreeBSD.org> <alpine.BSF.2.00.1302261759420.49330@wonkity.com> <5142357A.9070301@FreeBSD.org> <alpine.BSF.2.00.1303141642470.84119@wonkity.com> <5142D0C9.70905@FreeBSD.org>
next in thread | previous in thread | raw e-mail | index | archive | help
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. > <acronym>NFS</acronym> 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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20130508122821.GA1521>