From 727e63bc8794ae31fe7f712401f1f645d5a4ea35 Mon Sep 17 00:00:00 2001 From: Murray Stokely Date: Thu, 22 Jul 2004 03:35:38 +0000 Subject: [PATCH] Add a section about acronyms to our style guide; based on what we hashed out on doc@ and from the O'Reilly Style Guide. --- .../fdp-primer/writing-style/chapter.sgml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml index 7089a41784..56d807743c 100644 --- a/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml +++ b/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml @@ -176,6 +176,25 @@ <!doctype…>. + + Acronyms + + Acronyms should generally be spelled out the first time + they appear in a book, as in: "Network Time Protocol (NTP)." 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. + + The first three uses of an acronym should be enclosed in + <acronym> tags, with a role 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. + + Indentation