en_US/tutorial.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

<!-- $Id: tutorial.xml,v 1.1 2007/02/03 22:21:58 kwade Exp $ -->
<!DOCTYPE chapter 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>