[PATCH] Adding <acronym> elements to wlan Handbook section

Giorgos Keramidas keramida at freebsd.org
Fri Dec 12 02:51:22 UTC 2008


On Wed, 10 Dec 2008 23:36:22 +0200, Manolis Kiagias <sonic2000gr at gmail.com> wrote:
> I've seen it in the Handbook, but in very few parts. It is also rendered
> very nicely, and is not at all distracting. (A lightweight, dotted
> underline). See here for an example:
>
> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-ftp.html

That looks good.  I've started pushing to hg.hellug.gr some commits that
add this sort of role="" attribute to the wlan section :-)

Manolis, I have a question that is mostly a style issue though.

There are some compound acronyms in the wlan section, i.e. "WPA-TLS".
Would you prefer a separate <acronym> for "WPA" and "TLS" like

    <acronym role="Wi-Fi Protected Access">WPA</acronym>-<acronym
      role="Transport Layer Security">TLS</acronym>

or a single element like

    <acronym role="Wi-Fi Protected Access / Transport Layer
      Security">WPA-TLS</acronym>

The first seems more logical, and it would fit nicely with the set of
acronym entities (acronyms.ent) I proposed in another email of the
thread (eg. we won't have to introduce a new, special entity for
&acronym.wlan.wpa-tls; but we can reuse the WPA and TLS entities).  I am
not sure if it would result in aesthetically pleasing output when the
dotted underlines appear in separate words though.




More information about the freebsd-doc mailing list