diff options
Diffstat (limited to 'docs-intro.xml')
| -rw-r--r-- | docs-intro.xml | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs-intro.xml b/docs-intro.xml new file mode 100644 index 0000000..44b1990 --- /dev/null +++ b/docs-intro.xml @@ -0,0 +1,40 @@ +<!-- $Id: docs-intro.xml,v 1.1 2003/09/22 16:34:23 tfox Exp $ --> + + <preface id="ch-intro"> + <title>Introduction</title> + + <para> + The goal of the Docs Project is to create easy-to-follow, task-based + documentation for &DISTRO; users and developers. Other than the + <citetitle>&IG;</citetitle>, each tutorial should be in DocBook XML + article format, with one article per topic. This way, writers can + contribute documentation about a specific topic without having to worry + about how it fits into a manual or how it flows with other topics. + </para> + + <para> + The following tools are used: + </para> + + <itemizedlist> + <listitem> + <para>DocBook XML v4.1</para> + </listitem> + <listitem> + <para>Custom XSLT stylesheets for both print and HTML versions</para> + </listitem> + <listitem> + <para>Custom scripts to generate PDF and HTML output (use <command>xmlto</command>)</para> + </listitem> + <listitem> + <para>Emacs with PSGML mode (optional, but recommended)</para> + </listitem> + </itemizedlist> + + <para> + The purpose of this document is to explain the tools used by the Docs + Project as well as to provide writing and tagging guidelines so that the + documentation is consistent and easy-to-follow. + </para> + + </preface> |