This is finally being updated; I hope to finish this in the next week.

1 files changed, 86 insertions, 94 deletions

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 @@
-<!-- $Id: tutorial.xml,v 1.2 2007/02/03 22:29:37 kwade Exp $ -->
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id: tutorial.xml,v 1.3 2007/06/23 05:24:16 pfrields Exp $ -->
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
@@ -8,101 +9,92 @@
 
 ]>
 
-  <chapter id="ch-tutorial">
-    <title>The Layout of a Tutorial</title>
-  
-  <para>
-    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.
-  </para>
-  
-    <section id="sn-tutorial-parent">
-      <title>The Parent File</title>
-      
-      <para>
-	Below is a sample parent file:
-      </para>
-    
-<screen>
-<computeroutput>
-&lt;!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
-
-&lt;!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../common/fedora-entities-en.xml"&gt;
-%FEDORA-ENTITIES-EN;
-
-&lt;!ENTITY VERSION "0.1"&gt;  &lt;!-- change version of tutorial here --&gt;
-
-&lt;!ENTITY DOCID "example-tutorial-&amp;VERSION; (2003-07-07)"&gt; &lt;!-- change last modified date here --&gt;
-
-&lt;!ENTITY LEGALNOTICE SYSTEM "../common/legalnotice-en.xml"&gt;
-
-
-]&gt;
-
-&lt;article id="example-tutorial" lang="en"&gt;
-  &lt;articleinfo&gt;
-    &lt;title&gt;Example Tutorial&lt;/title&gt;
-    &lt;copyright&gt;
-      &lt;year&gt;2003&lt;/year&gt;
-      &lt;holder&gt;&FORMAL-RHI;&lt;/holder&gt;
-      &lt;holder&gt;Tammy Fox&lt;/holder&gt;
-    &lt;/copyright&gt;
-    &lt;authorgroup&gt;
-      &lt;author&gt;
-	&lt;surname&gt;Fox&lt;/surname&gt;
-	&lt;firstname&gt;Tammy&lt;/firstname&gt;
-      &lt;/author&gt;
-    &lt;/authorgroup&gt;
-    &amp;LEGALNOTICE;
-  &lt;/articleinfo&gt;
-
-  &lt;section id="some-section"&gt;
-    &lt;title&gt;Some Section&lt;/title&gt;
-
-    &lt;para&gt;
-      This is an example section. You can also use section, section, etc.
-    &lt;/para&gt;
-
-    &lt;warning&gt;
-      &lt;title&gt;Warning&lt;/title&gt;
-      &lt;para&gt;
-	Example of an admonition.
-      &lt;/para&gt;
-    &lt;/warning&gt;
-
-  &lt;/section&gt;
-
-&lt;index id="generated-index"&gt;&lt;/index&gt;
-&lt;/article&gt;
-</computeroutput>
-</screen>
+<chapter id="ch-tutorial">
+  <title>The Layout of a Tutorial</title>
+  <para>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.</para>
+  <section id="sn-tutorial-article">
+    <title>The Article</title>
+    <indexterm>
+      <primary>tutorial layout</primary>
+      <secondary>article</secondary>
+    </indexterm>
+    <para>Below is a sample article:</para>
+    <screen><![CDATA[<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-    </section>
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fdp-entities.ent">
+%FEDORA-ENTITIES;
 
-    <section id="sn-tutorial-license">
-      <title>Including the License Information</title>
-    
-      <indexterm>
-	<primary>tutorial layout</primary>
-	<secondary>license</secondary>
-      </indexterm>
+]>
 
+<article id="sample-tutorial" lang="en_US">
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
+    href="fdp-info.xml"/>
+  <section id="some-section">
+    <title>Some Section</title>
+    <para>
+      This is an example section. You can nest sections or make
+      additional sections as needed.
+    </para>
+    <warning>
+      <title>Warning</title>
       <para>
-	All &PROJECT; manuals <emphasis>must</emphasis> contain the file
-	<filename>legalnotice.xml</filename>. This file makes the license for
-	the file the GNU Free Documentation License (FDL).
-      </para>
-      
-      <para>
-	The sample parent file shows how it is included.
+	Example of an admonition.
       </para>
-      
-    </section>
-    
-  </chapter>
-
-  
+    </warning>
+  </section>
+<index id="generated-index"/>
+</article>
+]]></screen>  
+  </section>
+  <section id="sn-tutorial-metadata">
+    <title>The Metadata</title>
+    <indexterm>
+      <primary>tutorial layout</primary>
+      <secondary>metadata</secondary>
+    </indexterm>
+    <para>The <filename>rpm-info.xml</filename> file contains all the
+      required metadata for the document.  This metadata includes title,
+      authorship, licensing, and revision history.  <xref
+	linkend="ex-rpminfo"/> illustrates the content of this
+      file:</para>
+    <example id="ex-rpminfo">
+      <title>Example <filename>rpm-info.xml</filename> File</title>
+      <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE rpm-info PUBLIC "-//Fedora//DTD Docs RPM-INFO V1.0//EN"
+ "http://docs.fedoraproject.org/dtds/rpm-info.dtd">
+
+<rpm-info>
+  <colophon>
+    <worker surname="Smith" firstname="John" othername="Q." 
+      id="JohnSmith" email="jsmith@example.com" 
+      wholename="John Q. Smith" initials="JS"/>
+  </colophon>
+  <author worker="JohnSmith"/>
+  <license>
+    <rights>OPL</rights>
+    <version>1.0</version>
+  </license>
+  <copyright>
+    <year>2006</year>
+    <holder>John Q. Smith</holder>
+  </copyright>
+  <title>My Tutorial</title>
+  <desc>A tutorial about something important</desc>
+  <changelog order="newest-first">
+    <revision date="2006-06-01" number="0.1" role="doc">
+      <author worker="JohnSmith"/>
+      <details>First draft</details>
+    </revision>
+  </changelog>
+</rpm-info>]]></programlisting>
+    </example>
+    <para>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.</para>
+  </section>
+</chapter>