old-www/LDP/LDP-Author-Guide/html/index.html

911 lines
13 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML
><HEAD
><TITLE
>LDP Author Guide</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="NEXT"
TITLE="About this Guide"
HREF="aboutthisguide.html"></HEAD
><BODY
CLASS="book"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="BOOK"
><A
NAME="index"
></A
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="title"
><A
NAME="AEN2"
></A
>LDP Author Guide</H1
><H3
CLASS="author"
><A
NAME="AEN5"
></A
>Jorge Godoy</H3
><DIV
CLASS="affiliation"
><SPAN
CLASS="orgname"
><A
HREF="http://www.conectiva.com"
TARGET="_top"
>Conectiva S.A.</A
><BR></SPAN
><SPAN
CLASS="orgdiv"
>Publishing Department<BR></SPAN
><DIV
CLASS="address"
><P
CLASS="address"
><TT
CLASS="email"
>&#60;<A
HREF="mailto:godoy@metalab.unc.edu"
>godoy@metalab.unc.edu</A
>&#62;</TT
></P
></DIV
></DIV
><H3
CLASS="author"
><A
NAME="AEN14"
></A
>Emma Jane Hogbin</H3
><DIV
CLASS="affiliation"
><DIV
CLASS="address"
><P
CLASS="address"
><TT
CLASS="email"
>&#60;<A
HREF="mailto:emmajane@xtrinsic.com"
>emmajane@xtrinsic.com</A
>&#62;</TT
></P
></DIV
></DIV
><H3
CLASS="author"
><A
NAME="AEN20"
></A
>Mark F. Komarinski</H3
><DIV
CLASS="affiliation"
><DIV
CLASS="address"
><P
CLASS="address"
><TT
CLASS="email"
>&#60;<A
HREF="mailto:mkomarinski@wayga.org"
>mkomarinski@wayga.org</A
>&#62;</TT
></P
></DIV
></DIV
><H3
CLASS="author"
><A
NAME="AEN27"
></A
>David C. Merrill</H3
><DIV
CLASS="affiliation"
><DIV
CLASS="address"
><P
CLASS="address"
>david&nbsp;-AT-&nbsp;lupercalia.net</P
></DIV
></DIV
><P
CLASS="pubdate"
>2005-03-04<BR></P
><DIV
CLASS="revhistory"
><TABLE
WIDTH="100%"
BORDER="0"
><TR
><TH
ALIGN="LEFT"
VALIGN="TOP"
COLSPAN="3"
><B
>Revision History</B
></TH
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 4.84.74.64.54.44.34.24.1</TD
><TD
ALIGN="LEFT"
>2006-04-202005-03-042005-01-232004-07-142004-04-192004-04-042004-04-022004-01-27</TD
><TD
ALIGN="LEFT"
>Revised by: MGejhejhejhejhejhejhejh</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Added notes about prefered submission formats,
corrected links, packaged templates.Typo fixed in sample DocBook markup. Added new web-based authoring tool and information on LaTeX to DocBook conversions.Typos fixed in xmlto notes and book template. Copied information about
DocBook-capable word processing tools into the "Converting Documents
to DocBook XML" Appendix; added new XML editors; and information about tools to convert other formats to DocBook XML.Updated information regarding CVS accounts and connecting to the CVS server.Added editor credit requirements to the Using DocBook
section. Updated the submission procedure. New documents can now only
be added by one of the Review Coordinators after the successful
completion of each of the required reviews.Removed the section Contributing to The
LDP (replaced by Summary of The LDP Process).Added references for LyX to DocBook conversions in the
bibliography.Updated the license requirements and added them to the
table of contents (moved them out of the sub-section).</TD
></TR
></TABLE
></DIV
><DIV
><DIV
CLASS="abstract"
><A
NAME="AEN33"
></A
><P
></P
><P
>&#13; This guide describes the process of submitting and publishing a
document with The Linux Documentation Project (TLDP). It includes
information about the tools, toolchains and formats used by TLDP.
The document's primary audience is new TLDP authors, but it also
contains information for seasoned documentation authors.
</P
><P
></P
></DIV
></DIV
><HR></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>1. <A
HREF="aboutthisguide.html"
>About this Guide</A
></DT
><DD
><DL
><DT
>1.1. <A
HREF="purpose.html"
>About this Guide</A
></DT
><DT
>1.2. <A
HREF="theldp.html"
>About The LDP</A
></DT
><DT
>1.3. <A
HREF="feedback.html"
>Feedback</A
></DT
><DT
>1.4. <A
HREF="copyrights.html"
>Copyrights and Trademarks</A
></DT
><DT
>1.5. <A
HREF="acknowledgements.html"
>Acknowledgments and Thanks</A
></DT
><DT
>1.6. <A
HREF="conventions.html"
>Document Conventions</A
></DT
></DL
></DD
><DT
>2. <A
HREF="introduction.html"
>Authoring TLDP Documents: An Introduction</A
></DT
><DD
><DL
><DT
>2.1. <A
HREF="process.html"
>Summary of The LDP Process</A
></DT
><DT
>2.2. <A
HREF="mailinglists.html"
>Mailing Lists</A
></DT
></DL
></DD
><DT
>3. <A
HREF="propose.html"
>Writing Your Proposal</A
></DT
><DD
><DL
><DT
>3.1. <A
HREF="sg-subject.html"
>Choosing a Subject</A
></DT
><DT
>3.2. <A
HREF="scope.html"
>Scope of Your Document</A
></DT
><DT
>3.3. <A
HREF="unmaintained.html"
>Unmaintained and Out-of-date Documents</A
></DT
><DT
>3.4. <A
HREF="sg-outline.html"
>Developing an Outline</A
></DT
><DT
>3.5. <A
HREF="research.html"
>Research</A
></DT
></DL
></DD
><DT
>4. <A
HREF="write.html"
>Write</A
></DT
><DD
><DL
><DT
>4.1. <A
HREF="sg-writingstyle.html"
>Writing the Text</A
></DT
><DT
>4.2. <A
HREF="sg-editing.html"
>Edit and Proofread the Text</A
></DT
><DT
>4.3. <A
HREF="tools-writing.html"
>Tools for Writing, Editing and Maintaining your Document</A
></DT
></DL
></DD
><DT
>5. <A
HREF="ag-markup.html"
>Markup</A
></DT
><DD
><DL
><DT
>5.1. <A
HREF="markup.html"
>Markup: A General Overview</A
></DT
><DT
>5.2. <A
HREF="docbook-why.html"
>DocBook: What it is and why we use it</A
></DT
><DT
>5.3. <A
HREF="docbookxml.html"
>XML and SGML: Why we use XML</A
></DT
><DT
>5.4. <A
HREF="acceptedversions.html"
>Markup Languages Accepted by TLDP</A
></DT
></DL
></DD
><DT
>6. <A
HREF="distribute.html"
>Distributing Your Documentation</A
></DT
><DD
><DL
><DT
>6.1. <A
HREF="pre-distribute.html"
>Before Distributing Your Documentation</A
></DT
><DT
>6.2. <A
HREF="doc-licensing.html"
>Licensing and Copyright</A
></DT
><DT
>6.3. <A
HREF="crediting-ack.html"
>Acknowledgments</A
></DT
><DT
>6.4. <A
HREF="ag-review.html"
>TLDP Review Process</A
></DT
><DT
>6.5. <A
HREF="submission.html"
>Submission to LDP for publication</A
></DT
></DL
></DD
><DT
>7. <A
HREF="sg-maintaining.html"
>Maintenance</A
></DT
><DD
><DL
><DT
>7.1. <A
HREF="sg-maintaining-support.html"
>Maintaining Your Document</A
></DT
><DT
>7.2. <A
HREF="fixingerrors.html"
>Fixing Errors</A
></DT
></DL
></DD
><DT
><A
HREF="bibliography.html"
>References</A
></DT
><DT
>A. <A
HREF="templates.html"
>Templates</A
></DT
><DD
><DL
><DT
>A.1. <A
HREF="templates-book.html"
>Document Templates</A
></DT
><DT
>A.2. <A
HREF="templates-style.html"
>Style Sheets</A
></DT
><DT
>A.3. <A
HREF="templates-gdfl.html"
>GNU Free Documentation License</A
></DT
></DL
></DD
><DT
>B. <A
HREF="tools.html"
>System Setup: Editors, Validation and
Transformations</A
></DT
><DD
><DL
><DT
>B.1. <A
HREF="tools-distro.html"
>Tools for your operating
system</A
></DT
><DT
>B.2. <A
HREF="tools-edit.html"
>Editing tools</A
></DT
><DT
>B.3. <A
HREF="tools-validate.html"
>Validation</A
></DT
><DT
>B.4. <A
HREF="transformations.html"
>Transformations</A
></DT
><DT
>B.5. <A
HREF="dtd.html"
>DocBook DTD</A
></DT
><DT
>B.6. <A
HREF="doc-components.html"
>Formatting Documents</A
></DT
></DL
></DD
><DT
>C. <A
HREF="cvs.html"
>Concurrent Version System (CVS)</A
></DT
><DD
><DL
><DT
>C.1. <A
HREF="getaccount.html"
>Getting a CVS account</A
></DT
><DT
>C.2. <A
HREF="usingcvs.html"
>Using CVS</A
></DT
><DT
>C.3. <A
HREF="cvs-resources.html"
>CVS Resources</A
></DT
></DL
></DD
><DT
>D. <A
HREF="using-docbook.html"
>DocBook: Sample Markup</A
></DT
><DD
><DL
><DT
>D.1. <A
HREF="writing-docbook.html"
>General Tips and Tricks</A
></DT
><DT
>D.2. <A
HREF="section.html"
><TT
CLASS="sgmltag"
>&#60;section&#62;</TT
> and <TT
CLASS="sgmltag"
>&#60;sectN&#62;</TT
>: what's the difference?</A
></DT
><DT
>D.3. <A
HREF="commandprompt.html"
>Command Prompts</A
></DT
><DT
>D.4. <A
HREF="encoding-index.html"
>Encoding Indexes</A
></DT
><DT
>D.5. <A
HREF="inserting-pictures.html"
>Inserting Pictures</A
></DT
><DT
>D.6. <A
HREF="metadata-markup.html"
>Markup for Metadata</A
></DT
><DT
>D.7. <A
HREF="doc-bib.html"
>Bibliographies</A
></DT
><DT
>D.8. <A
HREF="tools-entities.html"
>Entities (shortcuts,
text macros and re-usable text)</A
></DT
><DT
>D.9. <A
HREF="namedfiles.html"
>Customizing your HTML files</A
></DT
></DL
></DD
><DT
>E. <A
HREF="x2docbook.html"
>Converting Documents to DocBook XML</A
></DT
><DD
><DL
><DT
>E.1. <A
HREF="txt2docbook.html"
>Text to DocBook</A
></DT
><DT
>E.2. <A
HREF="oo2docbook.html"
>OpenOffice.org to DocBook</A
></DT
><DT
>E.3. <A
HREF="word2docbook.html"
>Microsoft Word to DocBook</A
></DT
><DT
>E.4. <A
HREF="tex4ht.html"
>LaTeX to DocBook</A
></DT
><DT
>E.5. <A
HREF="lyx2docbook.html"
>LyX to DocBook</A
></DT
><DT
>E.6. <A
HREF="docbook2docbook.html"
>DocBook to DocBook Transformations</A
></DT
></DL
></DD
><DT
><A
HREF="glossary.html"
>Glossary</A
></DT
><DT
>F. <A
HREF="fdl.html"
>GNU Free Documentation License</A
></DT
><DD
><DL
><DT
>F.1. <A
HREF="fdl-preamble.html"
>0. PREAMBLE</A
></DT
><DT
>F.2. <A
HREF="fdl-section1.html"
>1. APPLICABILITY AND DEFINITIONS</A
></DT
><DT
>F.3. <A
HREF="fdl-section2.html"
>2. VERBATIM COPYING</A
></DT
><DT
>F.4. <A
HREF="fdl-section3.html"
>3. COPYING IN QUANTITY</A
></DT
><DT
>F.5. <A
HREF="fdl-section4.html"
>4. MODIFICATIONS</A
></DT
><DT
>F.6. <A
HREF="fdl-section5.html"
>5. COMBINING DOCUMENTS</A
></DT
><DT
>F.7. <A
HREF="fdl-section6.html"
>6. COLLECTIONS OF DOCUMENTS</A
></DT
><DT
>F.8. <A
HREF="fdl-section7.html"
>7. AGGREGATION WITH INDEPENDENT WORKS</A
></DT
><DT
>F.9. <A
HREF="fdl-section8.html"
>8. TRANSLATION</A
></DT
><DT
>F.10. <A
HREF="fdl-section9.html"
>9. TERMINATION</A
></DT
><DT
>F.11. <A
HREF="fdl-section10.html"
>10. FUTURE REVISIONS OF THIS LICENSE</A
></DT
><DT
>F.12. <A
HREF="fdl-using.html"
>Addendum</A
></DT
></DL
></DD
></DL
></DIV
><DIV
CLASS="LOT"
><DL
CLASS="LOT"
><DT
><B
>List of Tables</B
></DT
><DT
>D-1. <A
HREF="writing-docbook.html#table-useful-markup"
>Useful markup</A
></DT
></DL
></DIV
><DIV
CLASS="LOT"
><DL
CLASS="LOT"
><DT
><B
>List of Figures</B
></DT
><DT
>B-1. <A
HREF="tools-edit.html#AEN1567"
>epcEdit screen shot</A
></DT
><DT
>B-2. <A
HREF="tools-edit.html#AEN1598"
>nedit screen shot</A
></DT
><DT
>B-3. <A
HREF="tools-edit.html#AEN1659"
>Adding shell commands to nedit</A
></DT
><DT
>B-4. <A
HREF="tools-edit.html#AEN1682"
><SPAN
CLASS="application"
>nsgmls</SPAN
> output on success</A
></DT
></DL
></DIV
><DIV
CLASS="LOT"
><DL
CLASS="LOT"
><DT
><B
>List of Examples</B
></DT
><DT
>B-1. <A
HREF="tools-validate.html#ex-catalog-files"
>Setting the SGML_CATALOG_FILES and XML_CATALOG_FILES
Environmental Variables</A
></DT
><DT
>B-2. <A
HREF="tools-validate.html#example-catalog-sgml"
>Example of an SGML catalog</A
></DT
><DT
>B-3. <A
HREF="tools-validate.html#ex-catalog-xml"
>Sample XML Catalog file</A
></DT
><DT
>B-4. <A
HREF="tools-validate.html#xmllint-example"
>Debugging example using xmllint</A
></DT
><DT
>B-5. <A
HREF="transformations.html#ex-dsssl"
><SPAN
CLASS="QUOTE"
>"Installing"</SPAN
> DSSSL style sheets</A
></DT
><DT
>B-6. <A
HREF="transformations.html#ex-htmloutput"
>Example creating HTML output</A
></DT
><DT
>B-7. <A
HREF="dtd.html#ex-dtd"
><SPAN
CLASS="QUOTE"
>"Installing"</SPAN
> DocBook Document Type Definitions</A
></DT
><DT
>B-8. <A
HREF="doc-components.html#AEN2358"
>Style sheet to insert summaries in articles</A
></DT
><DT
>B-9. <A
HREF="doc-components.html#ex-entity-external-index"
>Configuring an external entity to include the
index</A
></DT
><DT
>D-1. <A
HREF="commandprompt.html#ex-programlisting"
>Command Prompt with <TT
CLASS="sgmltag"
>programlisting</TT
></A
></DT
><DT
>D-2. <A
HREF="commandprompt.html#ex-screen"
>Command Prompt with <TT
CLASS="sgmltag"
>screen</TT
></A
></DT
><DT
>D-3. <A
HREF="encoding-index.html#example-code-index"
>Code for the generation of an index</A
></DT
><DT
>D-4. <A
HREF="encoding-index.html#index-zone"
>Use of the attribute <TT
CLASS="sgmltag"
>zone</TT
></A
></DT
><DT
>D-5. <A
HREF="encoding-index.html#ex-index"
>Usage of values <TT
CLASS="sgmltag"
>startofrange</TT
> and <TT
CLASS="sgmltag"
>endofrange</TT
> on the attribute<TT
CLASS="sgmltag"
>class</TT
></A
></DT
><DT
>D-6. <A
HREF="inserting-pictures.html#ex-picture-fileref"
>Inserting a picture</A
></DT
><DT
>D-7. <A
HREF="inserting-pictures.html#former-figure-imageobject"
>Using <TT
CLASS="sgmltag"
>&#60;imageobject&#62;</TT
></A
></DT
><DT
>D-8. <A
HREF="metadata-markup.html#ex-othercredit"
>Other Credit</A
></DT
><DT
>D-9. <A
HREF="metadata-markup.html#ex-editor"
>Editor</A
></DT
><DT
>D-10. <A
HREF="metadata-markup.html#sample-metadata"
>Sample Meta Data</A
></DT
><DT
>D-11. <A
HREF="doc-bib.html#ex-bib"
>A Bibliography</A
></DT
><DT
>D-12. <A
HREF="tools-entities.html#ex-entities"
>Adding
Entities</A
></DT
><DT
>D-13. <A
HREF="tools-entities.html#ex-entity-parameters"
>Use of parameter entities</A
></DT
></DL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="aboutthisguide.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>About this Guide</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>