summaryrefslogtreecommitdiffstats
path: root/en_US/intro.xml
blob: f37d2cd5585a07fc2dcc5f2881d2d869e3e104e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<!-- $Id: intro.xml,v 1.3 2007/06/29 01:31:29 pfrields 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. The &FDP; uses the
    following tools:
  </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>
<!-- We've clipped this out for now.
    <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:
-->