LDP
/
LDP
mirror of https://github.com/tLDP/LDP
0
1
Fork 0
Code Releases Activity

Latin abbreviations and Title Caps clarification

This commit is contained in:
emmajane 2004-04-18 07:54:19 +00:00
parent 3ae03acfd3
commit 7fb2a1cbf5
1 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
LDP/howto/docbook/LDP-Reviewer-HOWTO.xml
View File

@ -275,8 +275,8 @@ and make any necessary changes. If changes are
<para>A summary of revisions should be included in the document. For more information about their markup, please read the notes in the <citetitle>Author Guide</citetitle>'s <ulink url="http://tldp.org/LDP/LDP-Author-Guide/html/metadata-markup.html">Markup for Metadata</ulink>.</para></formalpara>
<para>The initial release of a document should be marked up as Version 1.0. Subsequent updates should increment the version number appropriately. The preferred format is Major.Minor.Bugfix, where each section is an integer.
Some authors use Alan Cox style versions (e.g., 1.4pre-3) and some include
additional information (e.g., 1.3beta). This is acceptable but not encouraged.
Some authors use Alan Cox style versions (for example 1.4pre-3) and some include
additional information (for example 1.3beta). This is acceptable but not encouraged.
The most important thing is that we <emphasis>have</emphasis> a version
number so we know which version we are dealing with! Once a document goes through review it should
advance in minor or bugfix version number, depending on the amount of change introduced.</para>
@ -325,7 +325,7 @@ and make any necessary changes. If changes are
<itemizedlist>
<listitem><formalpara><title>Spelling</title>
<para> Spelling should conform to a standardized English spelling of terms. For words that are new
to the language and not yet standardized (e.g. technical Linux terminology that is generally accepted
to the language and not yet standardized (for example technical Linux terminology that is generally accepted
in the community), follow the most common spelling for the term.</para>
</formalpara>
@ -351,11 +351,14 @@ and make any necessary changes. If changes are
tone of the LDP documentation.</para>
</listitem>
<listitem><formalpara><title>Capitalization</title>
<para> The word <quote>HOWTO</quote> should always be in full caps with no hyphen.
Also, the document title should always be in title case. This means that first words in a title are always capitalized.
The only words not capitalized in a title are prepositions, articles, and proper nouns which would not be capitalized otherwise (e.g.
insmod). Other capitalization should follow rules of standard English.</para>
<listitem><formalpara><title>Use of capital letters</title>
<para>The word <quote>HOWTO</quote> should always be in full caps with no hyphen.
The document's title and section headings may follow one of two
conventions, but must be consistent throughout. Titles may either
capitalize only the first word, or may capitalize each word. In the
second case the only words not capitalized in a title are prepositions, articles,
and proper nouns which would not be capitalized otherwise (for
example: insmod). Other capitalization should follow rules of standard English.</para>
</formalpara></listitem>
<listitem><formalpara><title>Clarity</title>
@ -429,6 +432,12 @@ and make any necessary changes. If changes are
the document may not come to English as a primary language and, therefore, you should do your best to make sure
that the document is as easy to understand as possible. </para>
</formalpara></listitem>
<listitem><formalpara><title>Latin abbreviations</title>
<para>Avoid using abbreviations. e.g. (for example), et al. (and
others), etc (and so on) and i.e. (that is) should
always use the English equivalent.</para>
</formalpara></listitem>
</itemizedlist>
</sect1>