mirror of https://github.com/tLDP/LDP
533 lines
16 KiB
XML
533 lines
16 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
|
|
<!--
|
|
A note to future authors and editors of this document:
|
|
Thank you a hundred times over for contributing!
|
|
|
|
The latest version of this document was editing using
|
|
the following system configuration:
|
|
Textwidth: 74 characters
|
|
Tabstop: 3 characters
|
|
In vim (the only editor that matters) that's:
|
|
:set textwidth=74
|
|
:set tabstop=3
|
|
|
|
Things that need fixing should be marked as such with either "TODO"
|
|
or "FIXME".
|
|
|
|
-->
|
|
|
|
<!-- Chapter One: About this guide -->
|
|
<!ENTITY ag-about SYSTEM "ag-about.xml">
|
|
<!ENTITY tldp SYSTEM "tldp.xml">
|
|
<!ENTITY thankyous SYSTEM "thankyous.xml">
|
|
<!ENTITY conventions SYSTEM "conventions.xml">
|
|
|
|
<!-- Chapter Two: Authoring TLDP Documents: An Introduction -->
|
|
<!ENTITY ag-overview SYSTEM "ag-overview.xml">
|
|
|
|
<!-- Chapter Three: Propose -->
|
|
<!ENTITY ag-proposal SYSTEM "ag-proposal.xml">
|
|
|
|
<!-- Chapter Four: Write -->
|
|
<!ENTITY ag-writing SYSTEM "ag-writing.xml">
|
|
|
|
<!-- Chapter Four: Markup -->
|
|
<!ENTITY ag-markup SYSTEM "ag-markup.xml">
|
|
<!ENTITY ldp-markup SYSTEM "accepted-markup.xml">
|
|
|
|
<!-- Chapter Five: Publish and Distribute -->
|
|
<!ENTITY ag-distribute SYSTEM "ag-distribute.xml">
|
|
<!ENTITY disclaimer SYSTEM "disclaimer.xml">
|
|
|
|
<!-- Chapter Six: Maintain -->
|
|
<!ENTITY ag-maintain SYSTEM "ag-maintain.xml">
|
|
|
|
<!-- Appendix A. Resources for new authors -->
|
|
<!ENTITY references SYSTEM "references.xml">
|
|
|
|
<!-- Appendix B. Editors, Validation and System Setup -->
|
|
<!ENTITY tools SYSTEM "tools.xml">
|
|
<!-- editors -->
|
|
<!ENTITY tools-edit SYSTEM "tools-edit.xml">
|
|
<!ENTITY tools-word-processors SYSTEM "tools-word-processors.xml">
|
|
<!ENTITY tools-text-editors SYSTEM "tools-text-editors.xml">
|
|
<!ENTITY configure-emacs SYSTEM "tools-emacs.xml">
|
|
<!ENTITY emacs-psgml-mode SYSTEM "tools-emacs-psgml.xml">
|
|
|
|
<!-- validation -->
|
|
<!ENTITY tools-validate SYSTEM "tools-validate.xml">
|
|
<!ENTITY why-validate SYSTEM "validate-why.xml">
|
|
|
|
<!-- transformation -->
|
|
<!ENTITY tools-transform SYSTEM "tools-transform.xml">
|
|
|
|
<!-- Appendix C. DocBook Samples, Document Components and Templates -->
|
|
<!ENTITY using-docbook SYSTEM "using-docbook.xml">
|
|
|
|
<!-- Appendix D. Transformations: Making HTML out of XML -->
|
|
<!ENTITY transformations SYSTEM "transformations.xml">
|
|
|
|
<!-- Appendix E. git -->
|
|
<!ENTITY git SYSTEM "git.xml">
|
|
|
|
<!-- Appendix F. Converting Documents to DocBook XML -->
|
|
<!ENTITY x2docbook SYSTEM "x2docbook.xml">
|
|
|
|
<!-- Appendix G. Converting Documents to DocBook XML -->
|
|
<!ENTITY templates SYSTEM "templates.xml">
|
|
|
|
<!-- Appendix H. The License -->
|
|
<!ENTITY gfdl SYSTEM "fdl-appendix.xml">
|
|
|
|
<!-- etc The Glossary -->
|
|
<!ENTITY glossary SYSTEM "glossary.xml">
|
|
|
|
<!-- etc The Index
|
|
<!ENTITY theindex SYSTEM "index.xml">
|
|
-->
|
|
|
|
<!-- Include files -->
|
|
<!ENTITY example-article SYSTEM "example-article.xml">
|
|
<!ENTITY example-book SYSTEM "example-book.xml">
|
|
<!ENTITY example-compile-sgml SYSTEM "compiles-sgml.xml">
|
|
<!ENTITY example-table SYSTEM "example-table.xml">
|
|
<!ENTITY dsl-example SYSTEM "dsl-example.xml">
|
|
|
|
<!-- Missing and obsolete files -->
|
|
<!--
|
|
<!ENTITY doc-index SYSTEM "index.xml">
|
|
-->
|
|
|
|
<!-- Text Macros -->
|
|
<!ENTITY conectivasa '<ulink url="http://www.conectiva.com">Conectiva S.A.</ulink>'>
|
|
<!ENTITY conectiva "Conectiva">
|
|
|
|
]>
|
|
|
|
<book id="index">
|
|
<bookinfo>
|
|
<title>LDP Author Guide</title>
|
|
<pubdate>2005-03-04</pubdate>
|
|
<author>
|
|
<firstname>Jorge</firstname>
|
|
<surname>Godoy</surname>
|
|
<affiliation>
|
|
<orgname>&conectivasa;</orgname>
|
|
<orgdiv>Publishing Department</orgdiv>
|
|
<address><email>godoy@metalab.unc.edu</email></address>
|
|
</affiliation>
|
|
</author>
|
|
<author>
|
|
<firstname>Emma Jane</firstname>
|
|
<surname>Hogbin</surname>
|
|
<affiliation><address><email>emmajane@xtrinsic.com</email></address></affiliation>
|
|
</author>
|
|
<author>
|
|
<firstname>Mark</firstname>
|
|
<othername>F.</othername>
|
|
<surname>Komarinski</surname>
|
|
<affiliation>
|
|
<address><email>mkomarinski@wayga.org</email></address>
|
|
</affiliation>
|
|
</author>
|
|
<author>
|
|
<firstname>David</firstname>
|
|
<othername>C.</othername>
|
|
<surname>Merrill</surname>
|
|
<affiliation>
|
|
<address>david -AT- lupercalia.net</address>
|
|
</affiliation>
|
|
</author>
|
|
|
|
<abstract>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</abstract>
|
|
|
|
<revhistory id="revhistory">
|
|
<revision>
|
|
<revnumber>4.8</revnumber>
|
|
<date>2006-04-20</date>
|
|
<authorinitials>MG</authorinitials>
|
|
<revremark>Added notes about prefered submission formats,
|
|
corrected links, packaged templates.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.7</revnumber>
|
|
<date>2005-03-04</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Typo fixed in sample DocBook markup. Added new web-based authoring tool and information on LaTeX to DocBook conversions.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.6</revnumber>
|
|
<date>2005-01-23</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>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.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.5</revnumber>
|
|
<date>2004-07-14</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Updated information regarding CVS accounts and connecting to the CVS server.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.4</revnumber>
|
|
<date>2004-04-19</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>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.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.3</revnumber>
|
|
<date>2004-04-04</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Removed the section Contributing to The
|
|
LDP (replaced by Summary of The LDP Process).</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.2</revnumber>
|
|
<date>2004-04-02</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Added references for LyX to DocBook conversions in the
|
|
bibliography.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.1</revnumber>
|
|
<date>2004-01-27</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Updated the license requirements and added them to the
|
|
table of contents (moved them out of the sub-section).</revremark>
|
|
</revision>
|
|
|
|
<!--
|
|
<revision>
|
|
<revnumber>4.0.11</revnumber>
|
|
<date>2004-01-04</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Incorporated notes and corrections from Martin A. Brown.</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>4.0.10</revnumber>
|
|
<date>2004-01-01</date>
|
|
<authorinitials>mg</authorinitials>
|
|
<revremark>Added new items to the glossary.</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>4.0.9</revnumber>
|
|
<date>2003-12-31</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Added two style sheets (CSS and DSL) to the template
|
|
section.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.0.8</revnumber>
|
|
<date>2003-12-22</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Updated the Transformation section to include XSL updates
|
|
from David Horton and Martin A. Brown.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.0.7</revnumber>
|
|
<date>2003-12-22</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Removed redundant information from the Transformation
|
|
section.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.0.6</revnumber>
|
|
<date>2003-12-21</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Simplified the language in the markup section (main
|
|
guide, not appendix).</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.0.5</revnumber>
|
|
<date>2003-12-21</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Incorporation of Machtelt Garrels (Tille)'s review.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.0.4</revnumber>
|
|
<date>2003-12-11</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Added markup HOWTO for bibliographies.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.0.3</revnumber>
|
|
<date>2003-12-11</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Language edits to the main guide (but not appendices).</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.0.2</revnumber>
|
|
<date>2003-12-10</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Reshuffled the "Distributing Your
|
|
Documentation" and re-wrote parts of it to improve the flow.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.0.1</revnumber>
|
|
<date>2003-12-09</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Incorporated document reviews from Martin A. Brown and
|
|
Charles Curley.</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>4.0 - alpha</revnumber>
|
|
<date>2003-12-08</date>
|
|
<authorinitials>ejh</authorinitials>
|
|
<revremark>Revised the structure of the document and shuffled
|
|
elements into place (a floating date until the final version is
|
|
ready).</revremark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<revnumber>3.15</revnumber>
|
|
<date>2002-12-16</date>
|
|
<authorinitials>gjf</authorinitials>
|
|
<revremark>Contribution by Jaime Irving Davila regarding ldp.dsl
|
|
usage. </revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.14</revnumber>
|
|
<date>2002-05-16</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>Added information about LDP Reviewer HOWTO. New reviewers are asked to read this document.</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.14</revnumber>
|
|
<date>2002-04-25</date>
|
|
<authorinitials>gf</authorinitials>
|
|
<revremark>Update meta-data information, resources; add articleinfo content</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.13</revnumber>
|
|
<date>2002-04-21</date>
|
|
<authorinitials>sp</authorinitials>
|
|
<revremark>We are now tldp.org</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.12</revnumber>
|
|
<date>2002-03-11</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>Bug fixes, learning PSGML, update e-mail address</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.11</revnumber>
|
|
<date>2002-01-26</date>
|
|
<authorinitials>sp</authorinitials>
|
|
<revremark>
|
|
Updated CVS information.
|
|
</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.10</revnumber>
|
|
<date>2001-12-15</date>
|
|
<authorinitials>dcm</authorinitials>
|
|
<revremark>
|
|
Updated contacting LDP information.
|
|
</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.9</revnumber>
|
|
<date>2001-11-27</date>
|
|
<authorinitials>sp</authorinitials>
|
|
<revremark>
|
|
Updated CVS information.
|
|
</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.8</revnumber>
|
|
<date>2001-09-25</date>
|
|
<authorinitials>dy</authorinitials>
|
|
<revremark>
|
|
XML/XSLT information.
|
|
</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.7</revnumber>
|
|
<date>2001-06-20</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>
|
|
Now under the GFDL.
|
|
</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.62</revnumber>
|
|
<date>2001-03-13</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>
|
|
Spelling and grammar changes from Dave Edwards (amoamasam@sympatico.ca).
|
|
Also performed some housecleaning from comments of discuss@en.tldp.org.
|
|
</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.6</revnumber>
|
|
<date>2001-01-10</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>
|
|
First revision in DocBook XML. Added section covering writing
|
|
in DB XML, since first rev is 4.1.
|
|
</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.51</revnumber>
|
|
<date>2001-01-05</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>sgedit (now tksgml) is not free, included link for pricing, more XML info</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.5</revnumber>
|
|
<date>Dec 4, 2000</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>Changed mailing list pointers to new lists.</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.4</revnumber>
|
|
<date>Dec 1, 2000</date>
|
|
<authorinitials>dcm</authorinitials>
|
|
<revremark>Added Crediting Translators and Converters</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.3</revnumber>
|
|
<date>Nov 11, 2000</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>Added links to SGML GPL and FDL</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.1</revnumber>
|
|
<date>Oct 10, 2000</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>Spelling changes, changed list of LDP policies to now
|
|
accept DocBook XML. More information about how to use *jade
|
|
with XML will follow.
|
|
</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3.0</revnumber>
|
|
<date>Aug 24, 2000</date>
|
|
<authorinitials>gjf</authorinitials>
|
|
<revremark>Integrated David Merrill's style guide document. Further clean-up and additions.</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>2.0</revnumber>
|
|
<date>Jul 13, 2000</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>Cleaned up using-docbook a bit. Moved some chapters</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>1.9</revnumber>
|
|
<date>Jun 26, 2000</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>Integrated Jorge's using-docbook document.</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>1.5</revnumber>
|
|
<date>Jun 14, 2000</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>Documented sgedit</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>1.4</revnumber>
|
|
<date>Jun 12, 2000</date>
|
|
<authorinitials>mfk</authorinitials>
|
|
<revremark>Documented vim and sgedit. Spelling and other
|
|
changes from ldp list. Also added LDP guidelines under style
|
|
guide.</revremark>
|
|
</revision>
|
|
-->
|
|
|
|
</revhistory>
|
|
</bookinfo>
|
|
|
|
|
|
<!-- Chapters
|
|
About this guide
|
|
Authoring Overview
|
|
Proposal
|
|
Writing
|
|
Markup
|
|
Publish and Distribute
|
|
Maintenance
|
|
-->
|
|
&ag-about;
|
|
&ag-overview;
|
|
&ag-proposal;
|
|
&ag-writing;
|
|
&ag-markup;
|
|
&ag-distribute;
|
|
&ag-maintain;
|
|
|
|
<!-- Appendix: References -->
|
|
&references;
|
|
|
|
<!-- Appendix: Sample Templates -->
|
|
&templates;
|
|
|
|
<!-- Appendix: Editors, Validation and System Setup -->
|
|
&tools;
|
|
|
|
<!-- Appendix: git -->
|
|
&git;
|
|
|
|
<!-- Appendix: Converting to DocBook XML 4.x
|
|
-->
|
|
&using-docbook;
|
|
|
|
<!-- Appendix: Converting Documents 2 DocBook -->
|
|
&x2docbook;
|
|
|
|
<!--
|
|
The sadly too short glossary
|
|
TODO: see the index terms? Add glossary items
|
|
for them. (see below re. index terms)
|
|
I'm stretching into the depths of my memory to remember
|
|
this...but...didn't Bin make a huge big "glossary" a few
|
|
months back? Should there be a link to that document?
|
|
-->
|
|
&glossary;
|
|
|
|
<!--
|
|
I /think/ this document is created at "run-time"
|
|
TODO: read the document and add index terms as
|
|
appropriate. Much thanks.
|
|
&theindex;
|
|
-->
|
|
|
|
<!--
|
|
The License
|
|
Print-wise it's a PITA to have Appendices after
|
|
the License...so I'm moving it to the very-very
|
|
end. Please move it back if you must.
|
|
-->
|
|
&gfdl;
|
|
|
|
</book>
|