diff options
| author | Paul W. Frields <stickster@gmail.com> | 2006-11-23 02:24:17 +0000 |
|---|---|---|
| committer | Paul W. Frields <stickster@gmail.com> | 2006-11-23 02:24:17 +0000 |
| commit | cbbe56e0e1c55e880dc080379c3f75e3356e230f (patch) | |
| tree | 15f24afbdcb55bb6c4e62617f02acf2e00837593 /en_US/docs-tutorial.xml | |
| parent | 5a1bc135e14df6e97088457c81b5ab2e268d21eb (diff) | |
Add en_US directory, new file structures
Diffstat (limited to 'en_US/docs-tutorial.xml')
| -rw-r--r-- | en_US/docs-tutorial.xml | 108 |
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> +<!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 sect1, sect2, etc. + </para> + + <warning> + <title>Warning</title> + <para> + Example of an admonition. + </para> + </warning> + + </section> + +<index id="generated-index"></index> +</article> +</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> + + |
