summaryrefslogtreecommitdiff
path: root/templates/reference.page
blob: 1671db79e48609615a562448c8d1d688a4f20cbf (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
86
87
88
89
90
91
92
93
94
95
96
97
98
<?yelp-tmpl-desc Lists or tables of information for quick lookup?>
<page xmlns="http://projectmallard.org/1.0/"
      type="topic" style="reference" version="1.1"
      id="@ID@">
  <info>
    <!--
        Recommended statuses: stub incomplete draft outdated review candidate final
    -->
    <revision version="0.1" date="@DATE@" status="stub"/>

    <credit type="author copyright">
      <name>@NAME@</name>
      <email>@EMAIL@</email>
      <years>@YEAR@</years>
    </credit>

    <!--
        This puts a link to this topic on the index page.
        Change the xref to link it from another guide.
    -->
    <link type="guide" xref="index"/>

    <!--
        Think about whether other pages should be in the seealso list.
        The target page will automatically get a seealso link back.
    <link type="seealso" xref="someotherid"/>
    -->

    <!--
        Think about whether external resources should be in the seealso
        list. These require a title.
    <link type="seealso" href="http://someurl">
      <title>Link title</title>
    </link>
    -->

    <desc>Write a short page description here.</desc>

    <keywords>comma-separated list, of keywords, for search</keywords>
  </info>

  <title>@TITLE@</title>

  <p>Optionally provide introductory text.
  Use terms lists, tables, and bullet lists for reference material.</p>

  <terms>
    <title>Example terms list (title optional)</title>
    <item>
      <title>Term 1</title>
      <para>Description</para>
    </item>
    <item>
      <title>Term 2</title>
      <p>Terms can have multiple paragraphs.</p>
      <screen>Or any other block element.</screen>
    </item>
    <item>
      <title>Term 3.1</title>
      <title>Term 3.2</title>
      <p>Terms can also have multiple titles.</p>
    </item>
  </terms>

  <table>
    <title>Example table (title optional)</title>
    <thead>
      <tr>
        <th>Column 1</th>
        <th>Column 2</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>Row 1, column 1</td>
        <td>Row 1, column 2</td>
      </tr>
      <tr>
        <td>Row 2, column 1</td>
        <td>Row 2, column 2</td>
      </tr>
    </tbody>
  </table>

  <list>
    <title>Example list (title optional)</title>
    <item><p>Item 1</p></item>
    <item>
      <p>Item 2</p>
      <list>
        <item><p>Subitem 2.1</p></item>
        <item><p>Subitem 2.2</p></item>
      </list>
    </item>
    <item><p>Item 3</p></item>
  </list>

</page>