Date: Tue, 16 Dec 2008 04:47:31 +0200 From: Giorgos Keramidas <keramida@freebsd.org> To: Hiroki Sato <hrs@freebsd.org> Cc: doc@freebsd.org Subject: Re: [PATCH] Adding <acronym> elements to wlan Handbook section Message-ID: <87myewygxo.fsf@kobe.laptop> In-Reply-To: <20081213.014606.247395509.hrs@allbsd.org> (Hiroki Sato's message of "Sat, 13 Dec 2008 01:46:06 %2B0900 (JST)") References: <87k5a63z2d.fsf@kobe.laptop> <e890cae60812112351h226d57fja3c481c56d7f4a7b@mail.gmail.com> <871vwdahna.fsf@kobe.laptop> <20081213.014606.247395509.hrs@allbsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--=-=-=
On Sat, 13 Dec 2008 01:46:06 +0900 (JST), Hiroki Sato <hrs@FreeBSD.org> wrote:
> Giorgos Keramidas <keramida@freebsd.org> wrote
> in <871vwdahna.fsf@kobe.laptop>:
> ke> On Fri, 12 Dec 2008 09:58:28 +0100, Gabor PALI <pgj@FreeBSD.org> wrote:
> ke> > Maybe you can have different versions in the .ent file, like you did
> ke> > in case of mailing lists (defer the design decisions :)):
> ke> >
> ke> > <!ENTITY acronym.wlan.wep '<acronym role="Wired Equivalent Privacy">WEP</acronym>'>
> ke> > <!ENTITY acronym.wlan.wep.name '<acronym>WEP</acronym>'>
> ke>
> ke> Heh, cool! I'll try to update the patch to include entities like this.
>
> Hmm, this is not directly related to your idea, but I did not noticed
> that role attrib is used for adding the description so far. I think
> this is incorrect from viewpoint of DocBook because it is for
> classification of the element, not real content. In DocBook
> vocabulary, <acronym> cannot have such a expanded text,
> unfortunately.
>
> As a workaround, how about using the following phrase:
>
> <acronym>WEP<remark role="acronym">Wired Equivalent Privacy</remark></acronym>
>
> I use <remark> with role attrib here (probably this is the only
> option which looks reasonable). The necessary changes to the
> stylesheet and an SGML example of vm-design/article.sgml are attached
> (indentation is incomplete, though). We need to rewrite the existing
> <acronym> elements, too.
>
> For entity definition, I like the following:
>
> <!ENTITY acronym.FOO '<acronym xreflabel="FOO">FOO<remark role="acronym">DESC OF FOO</remark></acronym>'>
>
> Generating link to glossary, suppressing rendering of <remark>, or so
> on can be controlled by stylesheet, so multiple definitions are not
> needed at the <!ENTITY> level, IMHO.
Very nice, thank you! :-)
I like the idea of moving content from role="xxx" attributes to real
content too.
What would our next steps be for this?
Perhaps something like this?
* Commit this to doc/share/sgml/freebsd.dsl
* Add share/sgml/acronyms.ent with some of the common entities
* Update the existing role="" attributes to use the entities for those
acronyms that need a tooltip, but a plain <acronym>FOO</acronym> for
all the rest.
--=-=-=
Content-Type: application/pgp-signature
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.9 (FreeBSD)
iEYEARECAAYFAklHFsgACgkQ1g+UGjGGA7auKgCfQ2q6OYhw1WD7IBzd922f4pnu
wcwAoLidPyoFF6xP63ZPvjtiKfBfvduJ
=4gz6
-----END PGP SIGNATURE-----
--=-=-=--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?87myewygxo.fsf>