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

Added information re. metadata reviews. Not ready for publication yet. 

Still need to add info about markup reviews.
This commit is contained in:
emmajane 2004-01-24 06:20:36 +00:00
parent 3038302db5
commit 770eda1742
1 changed files with 48 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -17,12 +17,18 @@
<address><email>jyokley@us.ibm.com</email></address>
</affiliation>
</author>
<pubdate>May 2001</pubdate>
<pubdate>2004-01-24</pubdate>
<abstract><para>This document will help you review LDP documentation.
It includes procedures, tips and techniques to make the process easier.</para>
</abstract>
<revhistory>
<revision>
<revnumber>1.3</revnumber>
<date>2004-01-24</date>
<authorinitials>EJH</authorinitials>
<revremark>Added the metadata and markup review information.</revremark>
</revision>
<revision>
<revnumber>1.2</revnumber>
<date>2003-11-09</date>
@ -202,38 +208,48 @@ and make any necessary changes. If changes are
</sect1>
<sect1 id="metadatareview"><title>Metadata and Markup Review</title>
<para>Metadata and Markup Review</para>
<!--
Required meta data
- articleinfo or bookinfo as appropriate
- title
- authorgroup or author (use authorcorp for organizations)
- pubdate in the format of YYYY-MM-DD (ISO standard for dates)
- revhistory including at least one revision with:
<revision>
<revnumber></revnumber>
<date></date>
<authorinitials></authorinitials>
<revremark></revremark>
</revision>
- legalnotice and/or license (License is REQUIRED)
- License. Options are: GFDL, Creative Commons or LDP license. Home grown
licenses will not be accepted without a very, very good reason. Full
license text must be included in the document.
- email where the author can be reached. Must be included in the author
tag, or as a comment in the full source (DocBook or LinuxDoc). The LDP
must be able to reach the author. If the LDP is unable to reach an author,
the document may be removed from the collection.
- abstract
- copyright notice
- acknowledgements (optional)
- other credits (optional)
- disclaimer (optional)
-->
<para>The LDP uses a series of scripts to transform documents into their published format.</para>
<sect2><title>Required Metadata</title>
<para>The following elements are all required</para>
<itemizedlist>
<listitem><formalpara><title><sgmltag>articleinfo</sgmltag> or <sgmltag>bookinfo</sgmltag></title>
<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. 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.
</para></formalpara>
</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>
</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>
<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>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>
<listitem>
<formalpara><title>email</title>
<para>The LDP must be able to reach any author of any document via email. Email addresses should be included in the <sgmltag>author</sgmltag> tag, but may be included in the DocBook source as a comment. Documents without email address will not be accepted into the collection. If the LDP is unable to reach an author, the document may be removed from the collection.</para></formalpara>
</listitem>
<listitem><formalpara><title>Acknowledgements and Other Credits</title>
<para>Very few, if any, documents are written only by one person. It is good form to thank those who helped you with either the writing, research, testing or reviewing of your document. If someone added markup, or translated your document to another language they should also be given credit.</para></formalpara>
</listitem>
</itemizedlist>
</sect2>
</sect1>
<sect1 id="languagereview"><title>Language Review</title>