From 6b8221ace8d57f4a60ac5608f601ec91a55793be Mon Sep 17 00:00:00 2001 From: "Paul W. Frields" Date: Fri, 29 Jun 2007 01:31:29 +0000 Subject: More content updates --- en_US/getting-files.xml | 45 ++++++++++++++++++++++++++++++++++++++++++++- 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 . - + The most powerful component in the &FDP; toolbox is + DocBook XML. DocBook XML is a specific + scheme for authoring technical documentation using + Extensible Markup Language, or + XML. XML allows authors to mark pieces of + content with descriptive tags. The following output is an example + of DocBook XML: + + A Very Short Article + This very short article is a + demonstration of DocBook XML in + its simplest form. Notice how the + tags describe + the content they surround, and how + that content fits into the meaning + of the text as a written work. +]]> + This example article, entitled A Very Short + Article, 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 + para tags. Text that requires emphasis is + marked with emphasis tags. The author does not + worry about the visual formatting such as italics or font size. + &FDP; build tools automatically perform all formatting + tasks. + 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. + DocBook is iself very well documented. For more information + about DocBook, visit . The + DocBook site also features complete browseable and downloadable + copies of DocBook: The Definitive Guide, + the canonical source for DocBook information. + + DocBook XML Versions + 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. +
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 @@ - + The goal of the &FDP; is to create easy-to-follow, task-based - documentation for &FED; users and developers. Other than the - &IG;, 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. - - - - The following tools are used: + documentation for &FED; users and developers. The &FDP; uses the + following tools: -- cgit