aboutsummaryrefslogtreecommitdiffstats
path: root/docs/en/xml/conventions.xml
blob: 24986d66b4c4d4b7e51e7a663130b2fff90a7d28 (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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<section id="conventions">
  <title>Document Conventions</title>

  <indexterm zone="conventions">
    <primary>conventions</primary>
  </indexterm>

  <para>This document uses the following conventions:</para>

  <informaltable frame="none">
    <tgroup cols="2">
      <thead>
        <row>
          <entry>Descriptions</entry>

          <entry>Appearance</entry>
        </row>
      </thead>

      <tbody>
        <row>
          <entry>Warning</entry>

          <entry>
            <caution>
              <para>Don't run with scissors!</para>
            </caution>
          </entry>
        </row>

        <row>
          <entry>Hint</entry>

          <entry>
            <tip>
              <para>Would you like a breath mint?</para>
            </tip>
          </entry>
        </row>

        <row>
          <entry>Note</entry>

          <entry>
            <note>
              <para>Dear John...</para>
            </note>
          </entry>
        </row>

        <row>
          <entry>Information requiring special attention</entry>

          <entry>
            <warning>
              <para>Read this or the cat gets it.</para>
            </warning>
          </entry>
        </row>

        <row>
          <entry>File or directory name</entry>

          <entry>
            <filename>filename</filename>
          </entry>
        </row>

        <row>
          <entry>Command to be typed</entry>

          <entry>
            <command>command</command>
          </entry>
        </row>

        <row>
          <entry>Application name</entry>

          <entry>
            <application>application</application>
          </entry>
        </row>

        <row>
          <entry>
          Normal user's prompt under bash shell</entry>

          <entry>bash$</entry>
        </row>

        <row>
          <entry>
          Root user's prompt under bash shell</entry>

          <entry>bash#</entry>
        </row>

        <row>
          <entry>
          Normal user's prompt under tcsh shell</entry>

          <entry>tcsh$</entry>
        </row>

        <row>
          <entry>Environment variables</entry>

          <entry>
            <envar>VARIABLE</envar>
          </entry>
        </row>

        <row>
          <entry>Term found in the glossary</entry>

          <entry>
            <glossterm linkend="gloss-bugzilla">Bugzilla</glossterm>
          </entry>
        </row>

        <row>
          <entry>Code example</entry>

          <entry>
            <programlisting><sgmltag class="starttag">para</sgmltag>
Beginning and end of paragraph
<sgmltag class="endtag">para</sgmltag></programlisting>
          </entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>

  <para>  
	  This documentation is maintained in DocBook 4.1.2 XML format.
    Changes are best submitted as plain text or XML diffs, attached
    to a bug filed in the &bzg-bugs; component.
  </para>
  
</section>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->