From 8e6d5fdfdbfe0310c80fbc5ef4c7697e9b55e214 Mon Sep 17 00:00:00 2001
From: Tammy Fox <tfox@redhat.com>
Date: Mon, 22 Sep 2003 16:34:23 +0000
Subject: add docs guide

---
 docs-tutorial.xml | 98 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 98 insertions(+)
 create mode 100644 docs-tutorial.xml

(limited to 'docs-tutorial.xml')

diff --git a/docs-tutorial.xml b/docs-tutorial.xml
new file mode 100644
index 0000000..e453830
--- /dev/null
+++ b/docs-tutorial.xml
@@ -0,0 +1,98 @@
+<!-- $Id: docs-tutorial.xml,v 1.1 2003/09/22 16:34:23 tfox Exp $ -->
+
+  <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, entities that should be used for this book specifically and more.
+  </para>
+  
+  <sect1 id="s1-tutorial-parent">
+    <title>The Parent File</title>
+    
+    <para>
+      Below is a sample parent file:
+    </para>
+    
+<screen>
+<computeroutput>
+&lt;!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+&lt;!ENTITY RH "Red Hat"&gt; &lt;!--The generic term "Red Hat" --&gt;
+&lt;!ENTITY FORMAL-RHI "&RH;, Inc."&gt; &lt;!--The generic term "Red Hat, Inc. --&gt;
+&lt;!ENTITY PROJECT "Fedora project"&gt; &lt;!-- Set the project name --&gt;
+&lt;!ENTITY NAME-TITLE "Fedora Project"&gt; &lt;!-- Set the project name, use for titles --&gt;
+&lt;!ENTITY DISTRO "Fedora Core"&gt; &lt;!-- Set the distro name --&gt;
+&lt;!ENTITY BOOKID "example-tutorial-0.1 (2003-07-07)"&gt; &lt;!-- change version of manual and date here --&gt;
+
+&lt;!ENTITY LEGALNOTICE SYSTEM "../legalnotice.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 sect1, sect2, 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;/article&gt;
+</computeroutput>
+</screen>
+
+  </sect1>
+
+  <sect1 id="s1-tutorial-license">
+    <title>Including the License Information</title>
+    
+    <indexterm>
+      <primary>tutorial layout</primary>
+      <secondary>license</secondary>
+    </indexterm>
+
+    <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.
+    </para>
+    
+  </sect1>
+
+  </chapter>
+
+  
-- 
cgit