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

[Hiroki Sato]

Manolis Kiagias <sonic2000gr at gmail.com> wrote
  in <4941F694.3040600 at gmail.com>:

so> Giorgos Keramidas wrote:
so> > On Wed, 10 Dec 2008 23:36:22 +0200, Manolis Kiagias <sonic2000gr at gmail.com> wrote:
so> >
so> >> I've seen it in the Handbook, but in very few parts. It is also rendered
so> >> very nicely, and is not at all distracting. (A lightweight, dotted
so> >> underline). See here for an example:
so> >>
so> >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-ftp.html
so> >>
so> >
so> > That looks good.  I've started pushing to hg.hellug.gr some commits that
so> > add this sort of role="" attribute to the wlan section :-)
so> >
so> > Manolis, I have a question that is mostly a style issue though.
so> >
so> > There are some compound acronyms in the wlan section, i.e. "WPA-TLS".
so> > Would you prefer a separate <acronym> for "WPA" and "TLS" like
so> >
so> >     <acronym role="Wi-Fi Protected Access">WPA</acronym>-<acronym
so> >       role="Transport Layer Security">TLS</acronym>
so> >
so> > or a single element like
so> >
so> >     <acronym role="Wi-Fi Protected Access / Transport Layer
so> >       Security">WPA-TLS</acronym>
so> >
so> > The first seems more logical, and it would fit nicely with the set of
so> > acronym entities (acronyms.ent) I proposed in another email of the
so> > thread (eg. we won't have to introduce a new, special entity for
so> > &acronym.wlan.wpa-tls; but we can reuse the WPA and TLS entities).  I am
so> > not sure if it would result in aesthetically pleasing output when the
so> > dotted underlines appear in separate words though.
so> >
so> >
so> >
so> I agree that the first seems more logical and more effective as the
so> entities can be reused. However the difference is really very small, so
so> go along with the one you prefer.
so> As for the dotted lines, they are so subtle anyway that it won't make
so> much of a difference if they appear in separate words.

 This decision depends on the context, I think.  "EAP" and "TLS" are
 words describing individual elemental technologies, and "EAP-TLS"
 describes a different one using these technologies, not simple
 combination of the two.  In such a case, we should not reuse the
 definition in a way that it looks a combination of two acronyms.

--
| Hiroki SATO
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 195 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20081213/a7c447bf/attachment.sig>