diff options
-rw-r--r-- | en_US/getting-files.xml | 45 | ||||
-rw-r--r-- | en_US/intro.xml | 14 |
2 files changed, 47 insertions, 12 deletions
diff --git a/en_US/getting-files.xml b/en_US/getting-files.xml index 21c6481..7789d4e 100644 --- a/en_US/getting-files.xml +++ b/en_US/getting-files.xml @@ -56,7 +56,50 @@ To work on existing documents in CVS, refer to <xref linkend="ch-cvs"/>. </para> - + <para>The most powerful component in the &FDP; toolbox is + <firstterm>DocBook XML</firstterm>. DocBook XML is a specific + scheme for authoring technical documentation using + <firstterm>Extensible Markup Language</firstterm>, or + <acronym>XML</acronym>. XML allows authors to mark pieces of + content with descriptive tags. The following output is an example + of DocBook XML:</para> + <screen><![CDATA[<article> + <title>A Very Short Article</title> + <para>This very short article is a + demonstration of DocBook XML in + its simplest form. Notice how the + tags <emphasis>describe</emphasis> + the content they surround, and how + that content fits into the meaning + of the text as a written work.</para> +</article>]]></screen> + <para>This example article, entitled <citetitle>A Very Short + Article</citetitle>, consists of only a single paragraph. The + tags, or markup, surround elements of content to define the sense + in which they are used. A paragraph, for example, is marked with + <sgmltag>para</sgmltag> tags. Text that requires emphasis is + marked with <sgmltag>emphasis</sgmltag> tags. The author does not + worry about the visual formatting such as italics or font size. + &FDP; build tools automatically perform all formatting + tasks.</para> + <para>The custom tools built by the &FDP; render DocBook source into + a variety of formats for publication and distribution. They also + allow translators to create localized versions of the XML + documents for &DISTRO; users around the world. The flexibility of + XML allows for a single document to be used many times for many + purposes, like reusable code for a programmer.</para> + <para>DocBook is iself very well documented. For more information + about DocBook, visit <ulink url="http://www.docbook.org/"/>. The + DocBook site also features complete browseable and downloadable + copies of <citetitle>DocBook: The Definitive Guide</citetitle>, + the canonical source for DocBook information.</para> + <note> + <title>DocBook XML Versions</title> + <para>DocBook XML, like a computer progam, has version numbers. + The version used by &FDP; right now is &DBVER;. The DocBook web + site may document a slightly newer version, but the majority of + the schema still applies.</para> + </note> </section> <section id="sn-getting-files-names"> diff --git a/en_US/intro.xml b/en_US/intro.xml index 34e47c2..f37d2cd 100644 --- a/en_US/intro.xml +++ b/en_US/intro.xml @@ -1,4 +1,4 @@ -<!-- $Id: intro.xml,v 1.2 2007/02/05 22:06:10 pfrields Exp $ --> +<!-- $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" [ @@ -14,16 +14,8 @@ <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: + documentation for &FED; users and developers. The &FDP; uses the + following tools: </para> <itemizedlist> |