aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGabor Pali <pgj@FreeBSD.org>2009-01-21 23:49:33 +0000
committerGabor Pali <pgj@FreeBSD.org>2009-01-21 23:49:33 +0000
commitcf43250f83a3ce2c191cab49623fb1382bd9c3dc (patch)
treef4346e354be416ec02d86a1bbb0cdcd43f84770a
parent9979e08d143c48bb02d1db685be3af933909631d (diff)
downloaddoc-cf43250f83a3ce2c191cab49623fb1382bd9c3dc.tar.gz
doc-cf43250f83a3ce2c191cab49623fb1382bd9c3dc.zip
- Fix capitalization
- Eliminate reference to books for generalization ("document") - Use <sgmltag> where applicable - Mark up quotes with <quote> - Fix spelling of "non-breaking"
Notes
Notes: svn path=/head/; revision=33733
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml38
1 files changed, 19 insertions, 19 deletions
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 d6f8a670d3..6e8831fbc6 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
@@ -31,7 +31,7 @@
-->
<chapter id="writing-style">
- <title>Writing style</title>
+ <title>Writing Style</title>
<para>In order to promote consistency between the myriad authors of the
FreeBSD documentation, some guidelines have been drawn up for authors to
@@ -39,7 +39,7 @@
<variablelist>
<varlistentry>
- <term>Use American English spelling</term>
+ <term>Use American English Spelling</term>
<listitem>
<para>There are several variants of English, with different spellings
@@ -166,16 +166,16 @@
Style</ulink>, by William Strunk.</para>
<sect1 id="writing-style-guide">
- <title>Style guide</title>
+ <title>Style Guide</title>
- <para>To keep the source for the Handbook consistent when many different
+ <para>To keep the source for the documentation consistent when many different
people are editing it, please follow these style conventions.</para>
<sect2>
- <title>Letter case</title>
+ <title>Letter Case</title>
- <para>Tags are entered in lower case, <literal>&lt;para&gt;</literal>,
- <emphasis>not</emphasis> <literal>&lt;PARA&gt;</literal>.</para>
+ <para>Tags are entered in lower case, <sgmltag>para</sgmltag>,
+ <emphasis>not</emphasis> <sgmltag>PARA</sgmltag>.</para>
<para>Text that appears in SGML contexts is generally written in upper
case, <literal>&lt!ENTITY&hellip;&gt;</literal>, and
@@ -188,16 +188,16 @@
<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
+ they appear in a document, as in: <quote>Network Time Protocol (<acronym
+ role="Network Time Protocol">NTP</acronym>)</quote>. 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
+ defined only one per document. 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
- &lt;acronym&gt; tags, with a <literal>role</literal> attribute
+ <sgmltag>acronym</sgmltag> 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>
@@ -263,10 +263,10 @@ augroup END</programlisting>
</sect2>
<sect2>
- <title>Tag style</title>
+ <title>Tag Style</title>
<sect3>
- <title>Tag spacing</title>
+ <title>Tag Spacing</title>
<para>Tags that start at the same indent as a previous tag
should be separated by a blank line, and those that are not
@@ -302,7 +302,7 @@ augroup END</programlisting>
</sect3>
<sect3>
- <title>Separating tags</title>
+ <title>Separating Tags</title>
<para>Tags like <sgmltag>itemizedlist</sgmltag> which will
always have further tags inside them, and in fact do not take
@@ -332,13 +332,13 @@ augroup END</programlisting>
</sect2>
<sect2>
- <title>White space changes</title>
+ <title>White Space Changes</title>
<para>When committing changes, <emphasis>do not commit changes to the
content at the same time as changes to the
formatting</emphasis>.</para>
- <para>This is so that the teams that convert the Handbook to other
+ <para>This is so that the teams that convert the documentation to other
languages can quickly see what content has actually changed in your
commit, without having to decide whether a line has changed because of
the content, or just because it has been refilled.</para>
@@ -352,7 +352,7 @@ augroup END</programlisting>
</sect2>
<sect2>
- <title>Nonbreaking space</title>
+ <title>Non-Breaking Space</title>
<para>Avoid line breaks in places where they look ugly
or make it difficult to follow a sentence. Line breaks depend
@@ -364,7 +364,7 @@ augroup END</programlisting>
GB. Hardware compression &hellip;</literallayout>
<para>The general entity <literal>&amp;nbsp;</literal> prohibits
- line breaks between parts belonging together. Use nonbreaking
+ line breaks between parts belonging together. Use non-breaking
spaces in the following places:</para>
<itemizedlist>
@@ -389,7 +389,7 @@ GB. Hardware compression &hellip;</literallayout>
</sect1>
<sect1 id="writing-style-word-list">
- <title>Word list</title>
+ <title>Word List</title>
<para>The following is a small list of words spelled the way they
should be used in the FreeBSD Documentation Project. If the