Chapter 7. The Layout of a Tutorial

7.1. The Parent File
7.2. Including the License Information

In this chapter, you will find an example of a Fedora 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.

7.1. 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 BOOKID "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>Red Hat, Inc.</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>