~ubuntu-branches/ubuntu/intrepid/bugzilla/intrepid

« back to all changes in this revision

Viewing changes to docs/xml/conventions.xml

  • Committer: Bazaar Package Importer
  • Author(s): Raphael Bossek
  • Date: 2008-06-27 22:34:34 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20080627223434-0ib57vstn43bb4a3
Tags: 3.0.4.1-1
* Update of French, Russian and German translations. (closes: #488251)
* Added Bulgarian and Belarusian translations.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
2
 
<section id="conventions">
3
 
  <title>Document Conventions</title>
4
 
 
5
 
  <indexterm zone="conventions">
6
 
    <primary>conventions</primary>
7
 
  </indexterm>
8
 
 
9
 
  <para>This document uses the following conventions:</para>
10
 
 
11
 
  <informaltable frame="none">
12
 
    <tgroup cols="2">
13
 
      <thead>
14
 
        <row>
15
 
          <entry>Descriptions</entry>
16
 
 
17
 
          <entry>Appearance</entry>
18
 
        </row>
19
 
      </thead>
20
 
 
21
 
      <tbody>
22
 
        <row>
23
 
          <entry>Caution</entry>
24
 
 
25
 
          <entry>
26
 
            <caution>
27
 
              <para>Don't run with scissors!</para>
28
 
            </caution>
29
 
          </entry>
30
 
        </row>
31
 
 
32
 
        <row>
33
 
          <entry>Hint or Tip</entry>
34
 
 
35
 
          <entry>
36
 
            <tip>
37
 
              <para>For best results... </para>
38
 
            </tip>
39
 
          </entry>
40
 
        </row>
41
 
 
42
 
        <row>
43
 
          <entry>Note</entry>
44
 
 
45
 
          <entry>
46
 
            <note>
47
 
              <para>Dear John...</para>
48
 
            </note>
49
 
          </entry>
50
 
        </row>
51
 
 
52
 
        <row>
53
 
          <entry>Warning</entry>
54
 
 
55
 
          <entry>
56
 
            <warning>
57
 
              <para>Read this or the cat gets it.</para>
58
 
            </warning>
59
 
          </entry>
60
 
        </row>
61
 
 
62
 
        <row>
63
 
          <entry>File or directory name</entry>
64
 
 
65
 
          <entry>
66
 
            <filename>filename</filename>
67
 
          </entry>
68
 
        </row>
69
 
 
70
 
        <row>
71
 
          <entry>Command to be typed</entry>
72
 
 
73
 
          <entry>
74
 
            <command>command</command>
75
 
          </entry>
76
 
        </row>
77
 
 
78
 
        <row>
79
 
          <entry>Application name</entry>
80
 
 
81
 
          <entry>
82
 
            <application>application</application>
83
 
          </entry>
84
 
        </row>
85
 
 
86
 
        <row>
87
 
          <entry>
88
 
          Normal user's prompt under bash shell</entry>
89
 
 
90
 
          <entry>bash$</entry>
91
 
        </row>
92
 
 
93
 
        <row>
94
 
          <entry>
95
 
          Root user's prompt under bash shell</entry>
96
 
 
97
 
          <entry>bash#</entry>
98
 
        </row>
99
 
 
100
 
        <row>
101
 
          <entry>
102
 
          Normal user's prompt under tcsh shell</entry>
103
 
 
104
 
          <entry>tcsh$</entry>
105
 
        </row>
106
 
 
107
 
        <row>
108
 
          <entry>Environment variables</entry>
109
 
 
110
 
          <entry>
111
 
            <envar>VARIABLE</envar>
112
 
          </entry>
113
 
        </row>
114
 
 
115
 
        <row>
116
 
          <entry>Term found in the glossary</entry>
117
 
 
118
 
          <entry>
119
 
            <glossterm linkend="gloss-bugzilla">Bugzilla</glossterm>
120
 
          </entry>
121
 
        </row>
122
 
 
123
 
        <row>
124
 
          <entry>Code example</entry>
125
 
 
126
 
          <entry>
127
 
            <programlisting><sgmltag class="starttag">para</sgmltag>
128
 
Beginning and end of paragraph
129
 
<sgmltag class="endtag">para</sgmltag></programlisting>
130
 
          </entry>
131
 
        </row>
132
 
      </tbody>
133
 
    </tgroup>
134
 
  </informaltable>
135
 
 
136
 
  <para>  
137
 
          This documentation is maintained in DocBook 4.1.2 XML format.
138
 
    Changes are best submitted as plain text or XML diffs, attached
139
 
    to a bug filed in the &bzg-bugs; component.
140
 
  </para>
141
 
  
142
 
</section>
143
 
 
144
 
<!-- Keep this comment at the end of the file
145
 
Local variables:
146
 
mode: sgml
147
 
sgml-always-quote-attributes:t
148
 
sgml-auto-insert-required-elements:t
149
 
sgml-balanced-tag-edit:t
150
 
sgml-exposed-tags:nil
151
 
sgml-general-insert-case:lower
152
 
sgml-indent-data:t
153
 
sgml-indent-step:2
154
 
sgml-local-catalogs:nil
155
 
sgml-local-ecat-files:nil
156
 
sgml-minimize-attributes:nil
157
 
sgml-namecase-general:t
158
 
sgml-omittag:t
159
 
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
160
 
sgml-shorttag:t
161
 
sgml-tag-region-if-active:t
162
 
End:
163
 
-->
164