summaryrefslogtreecommitdiffstats
path: root/en_US/docs-tutorial.xml
diff options
context:
space:
mode:
authorPaul W. Frields <stickster@gmail.com>2006-11-23 02:24:17 +0000
committerPaul W. Frields <stickster@gmail.com>2006-11-23 02:24:17 +0000
commitcbbe56e0e1c55e880dc080379c3f75e3356e230f (patch)
tree15f24afbdcb55bb6c4e62617f02acf2e00837593 /en_US/docs-tutorial.xml
parent5a1bc135e14df6e97088457c81b5ab2e268d21eb (diff)
Add en_US directory, new file structures
Diffstat (limited to 'en_US/docs-tutorial.xml')
-rw-r--r--en_US/docs-tutorial.xml108
1 files changed, 108 insertions, 0 deletions
diff --git a/en_US/docs-tutorial.xml b/en_US/docs-tutorial.xml
new file mode 100644
index 0000000..7944e62
--- /dev/null
+++ b/en_US/docs-tutorial.xml
@@ -0,0 +1,108 @@
+<!-- $Id: docs-tutorial.xml,v 1.1 2006/11/23 02:24:17 pfrields Exp $ -->
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- *************** Bring in Fedora entities *************** -->
+<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "fdp-entities.ent">
+%FEDORA-ENTITIES-EN;
+
+]>
+
+ <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>
+
+ <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 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 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;index id="generated-index"&gt;&lt;/index&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>
+
+