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

removed reference to the Open Content license.

This commit is contained in:
emmajane 2004-02-01 03:21:45 +00:00
parent a5f86d6fa7
commit 0491e4ad45
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,6 +3,12 @@
<article>
<articleinfo>
<title>Linux Documentation Project Reviewer HOWTO</title>
<author><firstname>Emma Jane</firstname><surname>Hogbin</surname>
<affiliation>
<orgname><ulink url="http://www.xtrinsic.com">xtrinsic</ulink></orgname>
<address><email>emmajane@xtrinsic.com</email></address>
</affiliation>
</author>
<author>
<firstname>David</firstname>
<surname>Merrill</surname>
@ -150,9 +156,7 @@ and make any necessary changes. If changes are
Of course, it is still polite, and advisable, to write the author anyway.</para>
<para>If a document is missing a copyright and/or license, it's recommended you advise the
author to choose and apply one. The most common free documentation licenses are the
<ulink url="http://www.gnu.org/copyleft/fdl.html">GNU Free Documentation License</ulink> (GFDL),
and the <ulink url="http://www.opencontent.org/openpub/">Open Publication License</ulink> (OPL).
author to choose and apply one. More information on licensing is available in the Metadata and Markup Review section.
</para>
</sect2>
@ -241,7 +245,7 @@ and make any necessary changes. If changes are
<para>If you are writing a shorter HOWTO (this will be most documents) you will need to use an <sgmltag>articleinfo</sgmltag>, if you are writing a longer guide you will need to use <sgmltag>bookinfo</sgmltag>.</para></formalpara>
</listitem>
<listitem><formalpara><title><sgmltag>title</sgmltag></title>
<para>Every document must contain a short, descriptive title. It should be reasonably unique, check other documents in the collection to make sure your document's title is distinctive from all other documents. Although it is not required, most <quote>HOWTO</quote> documents, contain the word <quote>HOWTO</quote> in the title.</para></formalpara>
<para>Every document must contain a short, descriptive title. It should be reasonably unique; check other documents in the collection to make sure your document's title is distinctive from all other documents. Although it is not required, most <quote>HOWTO</quote> documents contain the word <quote>HOWTO</quote> in the title.</para></formalpara>
</listitem>
<listitem><formalpara><title><sgmltag>abstract</sgmltag></title>
<para>A short description of your document must be included in the <sgmltag>abstract</sgmltag>. This description is typically one or two sentences in length.
@ -249,18 +253,18 @@ and make any necessary changes. If changes are
</listitem>
<listitem>
<formalpara><title><sgmltag>author</sgmltag></title>
<para>Every document must have an author. If there are multiple authors, you may use the <sgmltag>authorgroup</sgmltag>. If the document was prepared by an organization with no individual author, please use <sgmltag>authorcorp</sgmltag> instead.</para></formalpara>
<para>Every document must have an author. If there are multiple authors, you may use <sgmltag>authorgroup</sgmltag>. If the document was prepared by an organization with no individual author, please use <sgmltag>authorcorp</sgmltag> instead.</para></formalpara>
</listitem>
<listitem>
<formalpara><title><sgmltag>pubdate</sgmltag></title>
<para>The date of publication for the document. The date should be in the ISO standard of YYYY-MM-DD</para></formalpara></listitem>
<para>The date of publication for the document. The date should be in the ISO standard of YYYY-MM-DD.</para></formalpara></listitem>
<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>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></formalpara>
<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 preferred format is Major.Minor.Bugfix, where each section is an integer.
<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.
The most important thing is that we <emphasis>have</emphasis> a version