old-www/authors/index.html

408 lines
16 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<TITLE>The Linux Documentation Project: Authors - Contribute / Help</TITLE>
<META NAME="description" CONTENT="Linux Documentation Project Authors area">
</HEAD>
<BODY bgcolor="#AAAAAA" LINK="#003355" ALINK="#003355" VLINK="#003355">
<TABLE WIDTH="100%" BORDER="0" CELLPADDING="4" CELLSPACING="0">
<TR>
<TD ALIGN="center" VALIGN="top"><A HREF="../index.html"><IMG SRC="../images/ldp.gif" WIDTH="300" HEIGHT="120" ALIGN="absmiddle" BORDER="0" ALT="The Linux Documentation Project"></A>
</TR>
<TR BGCOLOR="#AAAAAA">
<TD ALIGN="center"><font face="arial,helvetica" color="#ffffff"><B>
<A HREF="../index.html"><font face="arial,helvetica" color="#ffffff">
home</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../docs.html#howto"><font face="arial,helvetica" color="#ffffff"> HOWTOs</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../guides.html"><font face="arial,helvetica" color="#ffffff">
Guides</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../docs.html#faq"><font face="arial,helvetica" color="#ffffff">
FAQs</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../docs.html#man"><font face="arial,helvetica" color="#ffffff">
man pages</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../docs.html#lg"><font face="arial,helvetica" color="#ffffff">
Linux Gazette</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../docs.html#lf"><font face="arial,helvetica" color="#ffffff">
LinuxFocus</font></A>
</B></font></TD>
</TR>
<TR BGCOLOR="#BBCCEE">
<TD ALIGN="center" VALIGN="center"><BR>
<H4><FONT FACE="arial,helvetica">
&nbsp;Linux Documentation Project: Authors - Contribute / Help</FONT></H4>
</TD></TR>
<TR><TD BGCOLOR="#FFFFFF">
<P><font face="Arial, Helvetica, sans-serif">
<!-- getting started -->
<table width="100%" border="0" cellspacing="2" cellpadding="2">
<tr align="left" valign="top">
<td width="99%" bgcolor="#BBCCEE" height="2">
<a name="gs"></a>
<font face="Arial, Helvetica, sans-serif"><b>
<font color="#000000">Getting Started</font>
</b></font>
</td>
</tr>
</table>
<p>
<font face="Arial, Helvetica, sans-serif">
The LDP is always looking for people to assist in the
<A href="../manifesto.html">quest</A> for developing and
providing free, high quality documentation for the
GNU/Linux operating system.
</p>
<p>
Potential volunteers should become familiar with the information
contained in the
<A href="../LDP/LDP-Author-Guide/index.html">LDP Author Guide</A>
(formerly known as the &quot;<i>HOWTO-HOWTO</i>&quot;).
They should also consider joining the general LDP discussion
list (<a href="mailto:discuss-subscribe@en.tldp.org.NOSPAM">discuss@en.tldp.org</a>).
Let us know what your skill set is, what you would like to
help the LDP with, etc. We are <i>always</i> in need of
volunteers!
</p>
<!-- tasks -->
<P><BR></P>
<table width="100%" border="0" cellspacing="2" cellpadding="2">
<tr align="left" valign="top">
<td width="99%" bgcolor="#BBCCEE" height="2">
<a name="tasks"></a>
<font face="Arial, Helvetica, sans-serif"><b>
<font color="#000000">Tasks</font>
</b></font>
</td>
</tr>
</table>
<p>
If you wish to volunteer to assist in the document authoring process,
here are some tasks that require attention:
<p>
<ul>
<li><p>Work on a <b><a href="inprogress.html">technical or language
review</a></b> of a new or existing document.</p></li>
<li><p>
Provide <b><a href="inprogress.html#markup">markup assistance</a></b> for
various documents.
</p>
</li>
<li><p>
Become an owner for these (currently)
<b><a href="unmaint.html">unmaintained documents</a></b>.
</p>
</li>
<li><p>
Write a new HOWTO, FAQ or Guide. Here is a list of
documents that are
&quot;<b><a href="inprogress.html">in progress</a></b>&quot;.
</p>
</li>
<li><p>
You can also <b><a href="suggest.html">suggest a document</a></b> (one
that needs to be written, or included from some other source) that
you believe should be part of the LDP collection.
</ul>
<!-- resources -->
<P><BR></P>
<table width="100%" border="0" cellspacing="2" cellpadding="2">
<tr align="left" valign="top">
<td width="99%" bgcolor="#BBCCEE" height="2">
<a name="resources"></a>
<font face="Arial, Helvetica, sans-serif"><b>
<font color="#000000">Resources</font>
</b></font>
</td>
</tr>
</table>
<p>
<ul>
<li><p>
First and foremost, consult the
<A href="../LDP/LDP-Author-Guide/index.html"><b>LDP Authoring Guide</b></A>
(formerly known as the &quot;<i>HOWTO-HOWTO</i>&quot;).
&nbsp;&nbsp;For additional guidelines on <i>style</i>, examine the
<A href="http://developer.gnome.org/documents/style-guide/"><b>GNOME
Documentation Style Guide</b></a>.
&nbsp;&nbsp;Documents related to <b>DocBook</b> can be
accessed <a href="#dbref">below</a>.
</p></li>
<li><p>
<strong>Flowcharts</strong> (in PDF) that outline various
TLDP processes:
<p><ul>
<li><A href="pubprocess.pdf"><b>TLDP Review and Publishing Process</b></A>
<li><A href="maint.pdf"><b>TLDP Document Maintenance Process</b></A>
</ul></p>
</li>
<li><p>
<A href="../manifesto.html"><b>License / manifesto</b></A> and
<A href="../mailinfo.html"><b>mailing list(s)</b></A>.
</p></li>
<li><p><b>DTDs</b>:
<p>
The LDP accepts documents marked-up in:<br><br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<b>Linuxdoc SGML; DocBook SGML v4.2, v4.1 or v3.x; and DocBook XML v4.2 or v4.1.2</b>
</p>
<p>
Copies of these DTDs are available here <i>(local LDP copies in zip format)</i>:
<p><ul>
<li><A href="tools/docbkx42.zip"><b>DocBook XML v4.2</b></A>
<li><A href="tools/docbkx412.zip"><b>DocBook XML v4.1.2</b></A>
<li><A href="tools/docbk42.zip"><b>DocBook SGML v4.2</b></A>
<li><A href="tools/docbk41.zip"><b>DocBook SGML v4.1</b></A>
<li><A href="tools/docbk31.zip"><b>DocBook SGML v3.1</b></A>
</ul></p>
</p>
<p>
They can also be found on <A href="http://www.oasis-open.org/docbook/">official
DocBook Homepage</a> (<i>http://www.oasis-open.org/docbook/</i>).
</p>
</p>
</li>
<li><p><b>Authoring Templates</b>:
<P><UL>
<li>DocBook <A href="template/big-howto-template.sgml">SGML source</A>
&nbsp;&nbsp;(<i>also shown as processed
<A href="template/index.html">HTML</A></i>). </li>
<li>DocBook <A href="template/Sample-HOWTO.xml">XML source</A>
&nbsp;&nbsp;(<i>also shown as processed
<A href="template/Sample-HOWTO.html">HTML</A></i>). </li>
<li>Linuxdoc <A href="template-ld/big-howto-template-ld.sgml">SGML source</A>
&nbsp;&nbsp;(<i>also shown as processed
<A href="template-ld/big-howto-template-ld.html">HTML</A></i>). </li>
<li>Linuxdoc <A href="template-ld/small-howto-template-ld.sgml">SGML source</A>
&nbsp;&nbsp;(<i>minimal template for smaller HOWTOs; also shown as processed
<A href="template-ld/small-howto-template-ld.html">HTML</A></i>). </li>
<li><a href="http://www.nyx.net/~sgjoen/The_LDP_HOWTO_Generator_ng.html">TLDP
HOWTO Generator</a> created by <i>Stein Gjoen</i> provides a set of fill-in
forms which in turn generate a customized Linuxdoc SGML template. </li>
</UL>
</P>
</p>
</li>
<li><p><b>DSSSL (stylesheets)</b>:
<p>The standard
<A href="http://docbook.sourceforge.net/projects/dsssl/"><b>DocBook DSSSL
Stylesheets</b></a> and
the <A href="tools/ldp.dsl"><b>LDP customized stylesheet</b></a> (ldp.dsl).
<i>Updated 2005-05-10</i>.
</p>
</li>
<li><p><b>XSL (stylesheets)</b>:
<p>The standard
<A href="http://docbook.sourceforge.net/projects/xsl/index.html"><b>DocBook
XSL Stylesheets</b></a>, and a set of
<A href="http://www.happy-monkey.net/docbook/"><b>LDP customized XSL stylesheets</b></a>.
Contact <a href="mailto:dhorton@NOSPAM.speakeasy.net">David Horton</a> if you
have questions or comments on the customized stylesheets.
<i>Updated 2004-09-10</i>.
</p>
</li>
<li><p><b>Entity files</b>:
<p>Local LDP copy (<a href="tools/entities.tar.gz">gzipped tar file</a>).
</p>
</li>
<li><a name="dbref"></a><p><b>DocBook Reference Material</b>:
<p>
<UL>
<li><A href="http://docbook.org/tdg/en/html/docbook.html"><b>DocBook: The
Definitive Guide</b></a>, by <i>Norman Walsh</i> and <i>Leonard Muellner</i>.
<br/>Another copy (PDF) is available <a href="http://www.karakas-online.de/downloads/docbook-the-definitive-guide-2.0.6.pdf">here</a> (<i>courtesy of Chris Karakas, <a href="http://www.karakas-online.de" target=
_new">www.karakas-online.de</a></i>).
</li>
<li><A href="http://docbook.org/tdg/en/html/quickref.html"><b>DocBook
Quick Reference</b></a> (4.1.2, 3.1, etc.)</li>
<li><A href="../HOWTO/DocBook-Demystification-HOWTO/"><b>DocBook
Demystification HOWTO</b></A>, by <i>Eric Raymond</i>. </li>
<li><A href="../HOWTO/DocBook-OpenJade-SGML-XML-HOWTO/"><b>DocBook
XML/SGML Processing Using OpenJade</b></A>, by <i>Saqib Ali</i>. </li>
<li><A href="../HOWTO/DocBook-Install/"><b>DocBook
Install mini-HOWTO</b></A>, by <i>Robert B. Easter</i>. </li>
<li><A href="http://hvdkooij.xs4all.nl/docs-docbook.en.cms"><b>Setup your
own docbook processing</b></a>, chronicled by
<i>Hugo van der Kooij</i>.</li>
<li><A href="http://docbook.godoy.homeip.net:81/"><b>Godoy's
DocBook SGML/XML reference page</b></a>, <i>(Jorge Godoy)</i>. </li>
<li><A href="http://www.docbook.org/tdg/en/html/ref-charents.html"><b>DocBook
Character Entity Reference</b></a>. </li>
<li>DocBook.org <a href="http://docbook.org/mailinglist/">mailing lists</a>. </li>
<li><a href="http://www.nwalsh.com/docs/tutorials/winwriters2001/">
<b>Introducing DocBook</b></a>, a slide show by <i>Norman Walsh</i>. </li>
<li><a href="http://acs40.arsdigita.com/doc/docbook-primer.html"><b>ArsDigita
DocBook Primer</b></a></li>
<li>A <a href="http://bgu.chez.tiscali.fr/doc/db4lyx/"><b>tutorial</b></a> on
Lyx &amp; DocBook.</li>
<li>From the IBM developerWorks library:
&quot;<a href="http://ibm.com/developerworks/library/l-docbk.html"><b>A gentle guide to DocBook</b></a>&quot;. </li>
<li><a href="http://jimweller.net/jim/dbxmlqs/"><b>DocBook XML
v4.1.2 Quick Start Guide</b></a> by <i>Jim Weller</i>. </li>
<li><a href="http://www.lodestar2.com/people/dyork/talks/2002/ols/docbook-tutorial/"><b>Single-Source Publishing with DocBook XML</b></a>
by <i>Dan York</i>. </li>
<li><a href="http://articles.linuxguru.net/view/202"><b>Docbook + Emacs</b></a>
an article by <i>Alejandro Imass</i>.
<li><a href="http://www.sagehill.net/docbookxsl/"><b>DocBook XSL: The Complete Guide</b></a>
by <i>Robert Stayton</i>.
<li><a href="http://www.snee.com/bob/sgmlfree/psgmqref.html"><b>Emacs/PSGML Quick Reference</b></a> by <i>Bob DuCharme</i> (also see
<a href="http://www.snee.com/bob/sgmlfree/">SGML CD: Free SGML Software and How to Use It</a>).
<li><a href="http://www.happy-monkey.net/docbook/gui-editor.html"><b>Writing DocBook XML With A GUI Editor</b></a>
by <i>David Horton</i>.
</UL>
</p>
</li>
<li><p><b>DocBook Environment &amp; Processing</b>:
<p><ul>
<li>A complete set of
<a href="http://wiki.docbook.org/topic/DebianGnuLinuxPackages"><b>Debian
packages</b></a> (<i>DocBook Wiki</i>) for installation.</li>
<li><i>Saqib Ali's</i> DocBook XML Validator & Transformer:
<a href="http://validate.sf.net"><b>http://validate.sf.net</b></a>
</li>
<li><A href="http://wiki.docbook.org/topic/ConvertOtherFormatsToDocBook"><b>List
of resources</b></a> for converting other formats to DocBook.</li>
<li><A href="http://txt2docbook.sourceforge.net/"><b>Txt2DocBook</b></a>, a tool that
allows one to convert a ascii (README-like) file to a valid
DocBook XML file.</li>
<li><a href="http://www.eecs.umich.edu/~ppadala/projects/tidy/"><b>html2db</b></a>,
written by
<a href="mailto:ppadala@cise.ufl.edu.NOSPAM">ppadala@cise.ufl.edu</a>,
does a good job of converting HTML to DocBook SGML/XML.
</li>
<li>The <a href="tools/ldp_mk"><b>LDP document processing script</b></a> (<em>ldp_mk</em>), a perl script
that produces all variants from a single source (SGML/XML). <i>Updated 2005-10-12</i>.
</li>
</ul>
</p>
</li>
<li><a name="linuxdoc"></a><p><b>LinuxDoc Information</b>:
<p>
<UL>
<li><a href="../HOWTO/Howtos-with-LinuxDoc.html"><b>Howtos-with-LinuxDoc
mini-HOWTO</b></a>, written by <i>David S. Lawyer</i>,
describes how to write HOWTOs using the simple LinuxDoc markup.
</li>
<li><a href="../HOWTO/Linuxdoc-Reference.html"><b>Linuxdoc Reference</b></a>,
written by <i>Uwe B&ouml;hme</i>,
is intended to be a reference for the SGML document type definition LinuxDoc. </li>
<li><a href="tools/ld2db.zip"><b>ld2db</b></a>,
developed by <i>Reuben Thomas</i>, is used to convert LinuxDoc SGML
to DocBook SGML. Be advised that the resultant filtered output should
be checked for accuracy. </li>
</UL>
</p>
</li>
<li><p><b>LinuxDoc Processing</b>:
<p>
<UL>
<li>The latest <a href="tools/linuxdoc-tools.tar.gz"><b>LinuxDoc
Tools</b></a> (v0.9.21; 595k). More information can be found
<a href="http://packages.qa.debian.org/l/linuxdoc-tools.html">here</a>. </li>
<li><a href="http://www.nyx.net/~sgjoen/The_LDP_HOWTO_Generator.html">TLDP
HOWTO Generator</a> created by <i>Stein Gjoen</i> provides a set of fill-in
forms which in turn generate a customized Linuxdoc SGML template. </li>
<li><i>Stein Gjoen's</i> TARPL page:
<a href="http://www.nyx.net/~sgjoen/tarpl.html"><b>http://www.nyx.net/~sgjoen/tarpl.html</b></a>
</li>
</UL>
</p>
</li>
<li><p><a name="pdf"></a><b>PDF/Postscript Output (ldp_print: v0.90, 2002-08-09)</b>:
<p>Toolset (<b>ldp_print</b>) that the LDP uses to produce PDF and PostScript
variants. Works on the single-HTML-file representation of
a DocBook SGML/XML instance - ONLY! See the README in the
<a href="tools/ldp_print.tgz">package</a> for details.
<b>ldp_print</b> relies on the
<a href="http://www.easysw.com/htmldoc/"><b>HTMLDOC</b></a> from
<a href="http://www.easysw.com/">Easy Software Products</a>.
</p>
</li>
<li><p><a name="cvs"></a><b>CVS information</b>:
<p>
<ul>
<li><a href="http://www.cvshome.org/"><b>cvshome.org</b></a>,
the Concurrent Versions System (cvs) home page. </li>
<li><a href="http://cvsbook.red-bean.com/"><b>Open Source Development
with CVS</b></a>, a book by <i>Karl Fogel</i>.
</li>
</ul>
</p>
</li>
<li><p><b>Misc</b>:
<p>
<ul>
<li><A href="http://www.dictionary.com/"><b>dictionary.com</b></a>. </li>
<li><A href="http://www.thesaurus.com/"><b>thesaurus.com</b></a>. </li>
<li><A href="http://www.webopedia.com/"><b>Webopedia</b></a> (online
dictionary and search engine for computer and Internet technology). </li>
</ul>
</p>
</li>
</ul>
<P>
<BR>
</TD></TR>
<TR BGCOLOR="#AAAAAA">
<TD ALIGN="center"><font face="arial,helvetica" color="#ffffff"><B>
<A HREF="../index.html"><font face="arial,helvetica" color="#ffffff">
home</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../docs.html#howto"><font face="arial,helvetica" color="#ffffff"> HOWTOs</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../guides.html"><font face="arial,helvetica" color="#ffffff">
Guides</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../docs.html#faq"><font face="arial,helvetica" color="#ffffff">
FAQs</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../docs.html#man"><font face="arial,helvetica" color="#ffffff">
man pages</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../docs.html#lg"><font face="arial,helvetica" color="#ffffff">
Linux Gazette</font></A>&nbsp;&nbsp;|&nbsp;&nbsp;
<A HREF="../docs.html#lf"><font face="arial,helvetica" color="#ffffff">
LinuxFocus</font></A>
</B></font></TD>
</TR>
<TR BGCOLOR="#AAAAAA">
<TD ALIGN="center"><font face="arial,helvetica" size="-1">
Last Modified: 2010-11-22&nbsp;|&nbsp;
<a href="mailto:feedback@en.tldp.org.NOSPAM">feedback@en.tldp.org</a></font></TD>
</TR>
</TABLE>
</BODY>
</HTML>