diff --git a/LDP/howto/docbook/LDP-Reviewer-HOWTO.xml b/LDP/howto/docbook/LDP-Reviewer-HOWTO.xml index 8e5be8ab..69bba79a 100644 --- a/LDP/howto/docbook/LDP-Reviewer-HOWTO.xml +++ b/LDP/howto/docbook/LDP-Reviewer-HOWTO.xml @@ -17,12 +17,18 @@
jyokley@us.ibm.com
- May 2001 + 2004-01-24 This document will help you review LDP documentation. It includes procedures, tips and techniques to make the process easier. + + 1.3 + 2004-01-24 + EJH + Added the metadata and markup review information. + 1.2 2003-11-09 @@ -202,38 +208,48 @@ and make any necessary changes. If changes are Metadata and Markup Review - Metadata and Markup Review - - + The LDP uses a series of scripts to transform documents into their published format. + + Required Metadata + The following elements are all required + + + <sgmltag>articleinfo</sgmltag> or <sgmltag>bookinfo</sgmltag> + If you are writing a shorter HOWTO (this will be most documents) you will need to use an articleinfo, if you are writing a longer guide you will need to use bookinfo. + + <sgmltag>title</sgmltag> + Every document must contain a short, descriptive title. Although it is not required, most HOWTO documents, contain the word HOWTO in the title. + + <sgmltag>abstract</sgmltag> + A short description of your document must be included in the abstract. This description is typically one or two sentences in length. + + + + <sgmltag>author</sgmltag> + Every document must have an author. If there are multiple authors, you may use the authorgroup. If the document was prepared by an organization with no individual author, please use authorcorp instead. + + + <sgmltag>pubdate</sgmltag> + The date of publication for the document. The date should be in the ISO standard of YYYY-MM-DD + copyright + 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. + + <sgmltag>revhistory</sgmltag> + A summary of revisions should be included in the document. For more information about their markup, please read the notes in the Author Guide's Markup for Metadata + + License and Legal Notice + 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 Author Guide. + + + email + The LDP must be able to reach any author of any document via email. Email addresses should be included in the author 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. + + Acknowledgements and Other Credits + 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. + + + Language Review