diff options
Diffstat (limited to 'en_US/intro.xml')
-rw-r--r-- | en_US/intro.xml | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/en_US/intro.xml b/en_US/intro.xml new file mode 100644 index 0000000..e5295c0 --- /dev/null +++ b/en_US/intro.xml @@ -0,0 +1,62 @@ +<!-- $Id: intro.xml,v 1.1 2007/02/03 22:21:58 kwade Exp $ --> +<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + +<!-- *************** Bring in Fedora entities *************** --> +<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "fdp-entities.ent"> +%FEDORA-ENTITIES-EN; + +]> + + +<preface id="ch-intro"> + <title>Introduction</title> + + <para> + The goal of the &FDP; is to create easy-to-follow, task-based + documentation for &FED; 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.4</para> + </listitem> + <listitem> + <para>Custom XSLT stylesheets for both print and HTML + versions</para> + </listitem> + <listitem> + <para>Custom scripts to generate HTML output (use + <command>xmlto</command>)</para> + </listitem> + <listitem> + <para>Emacs with PSGML mode (optional, but recommended)</para> + </listitem> + <listitem> + <para>Emacs with nXML mode (optional)</para> + </listitem> + </itemizedlist> + + <para> + This document explains the tools used by the &FDP; and provides + writing and tagging guidelines to make &FED; documentation is + consistent and easy-to-follow. + </para> + +</preface> + +<!-- +Local variables: +mode: xml +fill-column: 72 +End: +--> |