Add a section about acronyms to our style guide; based on what we
hashed out on doc@ and from the O'Reilly Style Guide.
This commit is contained in:
parent
2ded00de63
commit
727e63bc87
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=21613
1 changed files with 19 additions and 0 deletions
|
@ -176,6 +176,25 @@
|
|||
<literal><!doctype…></literal>.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>Acronyms</title>
|
||||
|
||||
<para>Acronyms should generally be spelled out the first time
|
||||
they appear in a book, as in: "Network Time Protocol (<acronym
|
||||
role="Network Time Protocol">NTP</acronym>)." After the
|
||||
acronym has been defined, you should generally use the acronym
|
||||
only (not the whole term, unless it makes more sense
|
||||
contextually to use the whole term). Usually, acronyms are
|
||||
defined only one per book. But if you prefer, you can also
|
||||
define them the first time they appear in each chapter.</para>
|
||||
|
||||
<para>The first three uses of an acronym should be enclosed in
|
||||
<acronym> tags, with a <literal>role</literal> attribute
|
||||
with the full term defined. This allows a link to the
|
||||
glossary to be created, and for mouseovers to be rendered with
|
||||
the fully expanded term.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>Indentation</title>
|
||||
|
||||
|
|
Loading…
Reference in a new issue