From 4d197e3651a69b3b660f16b0ab5da3ca9217da91 Mon Sep 17 00:00:00 2001 From: "Paul W. Frields" Date: Sat, 23 Jun 2007 05:24:16 +0000 Subject: This is finally being updated; I hope to finish this in the next week. --- en_US/acknowledgments.xml | 6 +- en_US/module-struct.xml | 40 +---------- en_US/rpm-info.xml | 8 ++- en_US/tutorial.xml | 180 ++++++++++++++++++++++------------------------ 4 files changed, 96 insertions(+), 138 deletions(-) diff --git a/en_US/acknowledgments.xml b/en_US/acknowledgments.xml index f6ce3de..1609186 100644 --- a/en_US/acknowledgments.xml +++ b/en_US/acknowledgments.xml @@ -11,7 +11,7 @@ Acknowledgments - This document is based on the a document started by Tammy Fox (tfox at + This document is based on a document started by Tammy Fox (tfox at redhat.com) and contributed to by Sandra Moore (smoore at redhat.com) and Johnray Fuller (jrfuller at redhat.com). @@ -37,11 +37,11 @@ A patch from Karsten Wade (kwade at redhat.com) has been applied to add . It was edited by Paul - W. Frields (stickstr5 at hotmail.com). + W. Frields (stickster at gmail.com). - A patch from Paul W. Frields (stickstr5 at hotmail.com) has been applied + A patch from Paul W. Frields (stickster at gmail.com) has been applied to add more explanation of the screen tag set to . diff --git a/en_US/module-struct.xml b/en_US/module-struct.xml index fcdb5e4..25851ec 100644 --- a/en_US/module-struct.xml +++ b/en_US/module-struct.xml @@ -98,7 +98,7 @@ -
+
The Document Build System The build system can render the document into another format such @@ -205,7 +205,7 @@ include $(shell $(find-makefile-common))]]> rules to actually build the document and the various archives.
-
+
The Document <filename>rpm-info.xml</filename> Each document module's primary language directory contains a file called rpm-info.xml. This file @@ -213,42 +213,6 @@ include $(shell $(find-makefile-common))]]> history, copyright, and contributor information. It follows a DTD specification included with the rest of the build system tools. - illustrates the content of - this file: - - Example <filename>rpm-info.xml</filename> File - - - - - - - - - - OPL - 1.0 - - - 2006 - John Q. Smith - - My Tutorial - A tutorial about something important - - - -
First draft
- - -]]> - - If you are not familiar with XML editing, copy and paste - this file from an existing module and then edit the values for - the various elements as appropriate. Consult &FDP; members and - help channels for more assistance if needed.
diff --git a/en_US/rpm-info.xml b/en_US/rpm-info.xml index 584bd55..cee28a8 100644 --- a/en_US/rpm-info.xml +++ b/en_US/rpm-info.xml @@ -1,5 +1,6 @@ - + 2004 2005 2006 + 2007 Red Hat, Inc. Tammy Fox Johnray Fuller @@ -34,12 +36,12 @@ Fedora Documentation Guide Guidelines and procedures for producing documentation for Fedora - + -
Update to new build requirements
+
Update to new content and build requirements
 diff --git a/en_US/tutorial.xml b/en_US/tutorial.xml index dc9c075..517739e 100644 --- a/en_US/tutorial.xml +++ b/en_US/tutorial.xml @@ -1,4 +1,5 @@ - + + - - The Layout of a Tutorial - - - In this chapter, you will find an example of a &PROJECT; documentation - parent file. This example is specific to the way the Docs Project uses - DocBook XML. The parent file contains the main structural format of the - book, a link to the entities file that contain common entities that should - be used, and an entity to change the version and date of the tutorial. - - -
- The Parent File - - - Below is a sample parent file: - - - - -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../common/fedora-entities-en.xml"> -%FEDORA-ENTITIES-EN; - -<!ENTITY VERSION "0.1"> <!-- change version of tutorial here --> - -<!ENTITY DOCID "example-tutorial-&VERSION; (2003-07-07)"> <!-- change last modified date here --> - -<!ENTITY LEGALNOTICE SYSTEM "../common/legalnotice-en.xml"> - - -]> - -<article id="example-tutorial" lang="en"> - <articleinfo> - <title>Example Tutorial</title> - <copyright> - <year>2003</year> - <holder>&FORMAL-RHI;</holder> - <holder>Tammy Fox</holder> - </copyright> - <authorgroup> - <author> - <surname>Fox</surname> - <firstname>Tammy</firstname> - </author> - </authorgroup> - &LEGALNOTICE; - </articleinfo> - - <section id="some-section"> - <title>Some Section</title> - - <para> - This is an example section. You can also use section, section, etc. - </para> - - <warning> - <title>Warning</title> - <para> - Example of an admonition. - </para> - </warning> - - </section> - -<index id="generated-index"></index> -</article> - - + + The Layout of a Tutorial + In this chapter, you will find an example of a very short tutorial + as used by the &FDP;. This example is specific to the way the Docs + Project uses DocBook XML. The example consists of a set of files + used to hold the content and metadata for the tutorial. +
+ The Article + + tutorial layout + article + + Below is a sample article: + + +%FEDORA-ENTITIES; -
- Including the License Information - - - tutorial layout - license - +]> +
+ +
+ Some Section + + This is an example section. You can nest sections or make + additional sections as needed. + + + Warning - All &PROJECT; manuals must contain the file - legalnotice.xml. This file makes the license for - the file the GNU Free Documentation License (FDL). - - - - The sample parent file shows how it is included. + Example of an admonition. - -
- - - - + +
+ + +]]> +
+
+ The Metadata + + tutorial layout + metadata + + The rpm-info.xml file contains all the + required metadata for the document. This metadata includes title, + authorship, licensing, and revision history. illustrates the content of this + file: + + Example <filename>rpm-info.xml</filename> File + + + + + + + + + + OPL + 1.0 + + + 2006 + John Q. Smith + + My Tutorial + A tutorial about something important + + + +
First draft
+ + +]]> + + If you are not familiar with XML editing, copy and paste this + file from an existing module and then edit the values for the + various elements as appropriate. Consult &FDP; members and help + channels for more assistance if needed. +
+ -- cgit