summaryrefslogtreecommitdiffstats
path: root/en-US/examples/docbook.example
blob: 32c860c42e9b78da60a380195f1463fea37a43fc (plain)
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

<?xml version='1.0' encoding='utf-8' ?>
 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" 
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % BOOK_ENTITIES SYSTEM "Fedora_Cookbook.ent">
    %BOOK_ENTITIES;
]>
<!-- Do not edit above this line -->
<!-- 
     Please provide some information so we can give you credit:
     name: YOUR_NAME
     fas_id: YOUR_FEDORA_ACCT ( to verify you have signed the CLA )
     email: YOUR_EMAIL ( so the docs team can talk to you, not for publication )
-->

<section id="NAME_OF_ARTICLE">
  <title>Name Of Article</title>
  <para>
    Replace this text with an introduction to your tutorial.
  </para>
  <section id="NAME_OF_ARTICLE-ingredients">
    <title>Required Ingredients</title>
    <!-- list packages, services, other recipes etc that are required -->
    <itemizedlist>
      <listitem><para>
        Required package group
      </para></listitem>
      <listitem><para>
          <!-- 
               An ingredient can be another recipe, use the section id.
               This will automatically create a link to the referenced 
               section. 
          -->
          <xref linkend="section-id" />
      </para></listitem>
    </itemizedlist>
  </section>
  <section id="NAME_OF_ARTICLE-directions">
  <title>Directions</title>
    <procedure>
      <title>Creating a NAME_OF_ARTICLE</title>
      <step><para>
          Install required packages:
          <screen>
            <command>yum install PACKAGE_LIST</command>
          </screen>
      </para></step>
      <step>
        <para>
          Activate required services:
          <screen>
            <command>systemctl start SERVICE_NAME</command>
            <command>systemctl enable SERVICE_NAME</command>
          </screen>
        </para>
      </step>
      <step>
        <para>
          Edit some configuration file
        </para>
        <para>
          You might want to explain further about that change, in another package.
        </para>
      </step>
      <step><para>
          You're getting the idea about the steps by now. Continue describing the process.
      </para></step>
    </procedure>
  </section>

  <section>
    <title>References</title>
    <itemizedlist>
      <listitem>
        <para><ulink url="http://example.com">Upstream Documentation</ulink></para>
      </listitem>
      <listitem>
        <para><ulink url="http://example.com/myblog/posts/todays_date" /></para>
      </listitem>
    </itemizedlist>
  </section>

</section>