OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: When to use <abbrev> tag?

We use DocBook 4.5 to produce documentation for computer software. I'm 
looking for advice on when I should use (e.g.) <abbrev> tags and when I 
should use something more specific (and complex). For example, HTTP, 
SSL, NFS, and LDAP are all abbreviations, but they are also protocols. 
MIT is both an abbrev. and an orgname. There are many examples. I don't 
have a clear argument why I should use one or the other.

The discussion becomes more interesting if you think about (e.g.) NFS 
and SSH because they could be categorized as protocols, services, etc. 
I've been trying to tag them by context; i.e., am I referring to xyz as 
a protocol, a resource, or what? I've had some success with this, but at 
the same time, "xyz" is *always* an abbreviation.

All suggestions welcome. Thanks a lot.


David O'Brien
IPA Content Author
Red Hat Asia Pacific

"We couldn't care less about comfort. We make you feel good."
Federico Minoli CEO Ducati Motor S.p.A.

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]