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

Moved version information to the metadata review, instead of the language 

review.
This commit is contained in:
emmajane 2004-02-01 02:08:45 +00:00
parent 1e91485ff7
commit 6c30f0ca1f
1 changed files with 12 additions and 13 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

@ -257,9 +257,17 @@ and make any necessary changes. If changes are
<listitem><formalpara><title>copyright</title>
<para>Authors will always retain the copyright to any documents they submit to the LDP. Although it is not required, a copyright notice may be included. A license, however, is always required.</para></formalpara>
</listitem>
<listitem><formalpara><title><sgmltag>revhistory</sgmltag></title>
<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>
</listitem>
<listitem><formalpara><title>Revision history (<sgmltag>revhistory</sgmltag>)</title>
<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>
<para>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.
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>
</formalpara></listitem>
<listitem><formalpara><title>License and Legal Notice</title>
<para>A license is required. The LDP currently accepts documents which are licensed under the GFDL, Creative Commons License and the LDP License. If you are using a license that is not listed it will need to be reviewed by our volunteers before the document is accepted. The full text of the license is required. A link is not sufficient. You may wish to include a disclaimer as part of the legal notice. A standard disclaimer is available from the <citetitle>Author Guide</citetitle>.</para></formalpara>
</listitem>
@ -376,21 +384,12 @@ and make any necessary changes. If changes are
then you should probably not re-write the text to make it sound better to you. </para>
</formalpara></listitem>
<listitem><formalpara><title>Versions</title>
<para> Every document should have a version number, preferably in the form
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.
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>
</formalpara></listitem>
<listitem><formalpara><title>Title</title>
<para>The title should be in proper title case. The general principle for this is that all words are
capitalized in a title except prepositions and articles (an article will be capitalized if it is the
first word in the title). The word HOWTO should be
in all capital letters. There should be no hyphens within the word HOWTO (with the exception of the Mini-HOWTO).
in all capital letters. There should be no hyphens within the word HOWTO.
The version should not be included in the title.</para>
</formalpara></listitem>