1 <?xml version='1.0' encoding='UTF-8'?>
\r
2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
\r
3 xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="general">
\r
4 <title>General Elements and Other Elements not Discussed Elsewhere</title>
\r
6 <title>Overview</title>
\r
7 <para>Since DocBook was defined to describe a wide range of publishable content, it includes a
\r
8 number of elements that are used to perform common tasks. These elements include ones that
\r
9 specify superscripts and emphasis.</para>
\r
12 <title>Formatting Elements</title>
\r
13 <para>The following are common formatting elements used in DocBook:</para>
\r
15 <segtitle>Element</segtitle>
\r
16 <segtitle>Description</segtitle>
\r
19 <tag class="element">emphasis</tag>
\r
21 <seg>Specifies that the content of the element is to be emphasized by either
\r
22 <emphasis>italics</emphasis> or <emphasis role="strong">boldface</emphasis>. The default
\r
23 is to use italics. Specify boldface by setting the <tag class="attribute">role</tag>
\r
24 attribute to <tag class="attvalue">bold</tag>.</seg>
\r
25 </seglistitem><seglistitem>
\r
27 <tag class="element">literallayout</tag>
\r
29 <seg>Specifies that the content of the element is to be reproduced with all of the
\r
30 whitespace preserved.</seg>
\r
31 </seglistitem><seglistitem>
\r
33 <tag class="element">subscript</tag>
\r
35 <seg>Specifies that the content of the element is a subscript as in
\r
36 H<subscript>2</subscript>O.</seg>
\r
37 </seglistitem><seglistitem>
\r
39 <tag class="element">superscript</tag>
\r
41 <seg>Specifies that the content of the element is a superscript as in
\r
42 E=MC<superscript>2</superscript>.</seg>
\r
43 </seglistitem></segmentedlist>
\r
46 <title>General Computing Elements</title>
\r
47 <para>The following are elements used for describing computer technology:</para>
\r
49 <segtitle>Element</segtitle>
\r
50 <segtitle>Description</segtitle>
\r
53 <tag class="element">action</tag>
\r
55 <seg>Specifies that content describes a response to some user initiated action.</seg>
\r
56 </seglistitem><seglistitem>
\r
58 <tag class="element">application</tag>
\r
60 <seg>Specifies that the content is the name of a piece of software.</seg>
\r
61 </seglistitem><seglistitem>
\r
63 <tag class="element">computeroutput</tag>
\r
65 <seg>Specifies that the content is text printed on a computer display.</seg>
\r
66 </seglistitem><seglistitem>
\r
68 <tag class="element">database</tag>
\r
70 <seg>Specifies that the content is the name of a database, or part of a database.</seg>
\r
71 </seglistitem><seglistitem>
\r
73 <tag class="element">email</tag>
\r
75 <seg>Specifies that the content is an e-mail address.</seg>
\r
76 </seglistitem><seglistitem>
\r
78 <tag class="element">envar</tag>
\r
80 <seg>Specifies that the content is the name of an environment variable.</seg>
\r
81 </seglistitem><seglistitem>
\r
83 <tag class="element">errorcode</tag>
\r
85 <seg>Specifies that the content is an error code.</seg>
\r
86 </seglistitem><seglistitem>
\r
88 <tag class="element">errorname</tag>
\r
90 <seg>Specifies that the content is the name of an error.</seg>
\r
91 </seglistitem><seglistitem>
\r
93 <tag class="element">errortext</tag>
\r
95 <seg>Specifies that the content is the text generated when an error occurs.</seg>
\r
96 </seglistitem><seglistitem>
\r
98 <tag class="element">filename</tag>
\r
100 <seg>Specifies that the content is the name of a file.</seg>
\r
101 </seglistitem><seglistitem>
\r
103 <tag class="element">hardware</tag>
\r
105 <seg>Specifies that the content is a piece of computer hardware.</seg>
\r
106 </seglistitem><seglistitem>
\r
108 <tag class="element">option</tag>
\r
110 <seg>Specifies that the content is an option to a command.</seg>
\r
111 </seglistitem><seglistitem>
\r
113 <tag class="element">prompt</tag>
\r
115 <seg>Specifies that the content is the string used as a prompt for data on a computer
\r
117 </seglistitem><seglistitem>
\r
119 <tag class="element">userinput</tag>
\r
121 <seg>Specifies that the content is data a user enters into a computer system.</seg>
\r
122 </seglistitem></segmentedlist>
\r
125 <title>Other General Elements</title>
\r
126 <para>The following are other general use elements used in DocBook:</para>
\r
128 <segtitle>Element</segtitle>
\r
129 <segtitle>Description</segtitle>
\r
132 <tag class="element">abbrev</tag>
\r
134 <seg>Specifies that the content is an abbreviation.</seg>
\r
135 </seglistitem><seglistitem>
\r
137 <tag class="element">acronym</tag>
\r
139 <seg>Specifies that the content is an acronym.</seg>
\r
140 </seglistitem><seglistitem>
\r
142 <tag class="element">firstterm</tag>
\r
144 <seg>Specifies that the content is the first occurrence of a new term or is a term that is
\r
145 used a context specific manner.</seg>
\r
146 </seglistitem><seglistitem>
\r
148 <tag class="element">literal</tag>
\r
150 <seg>Specifies that the content is a literal value.</seg>
\r
151 </seglistitem><seglistitem>
\r
153 <tag class="element">optional</tag>
\r
155 <seg>Specifies that the content is optional information. It is typically used in command
\r
157 </seglistitem><seglistitem>
\r
159 <tag class="element">replaceable</tag>
\r
161 <seg>Specifies that the content represents a value that will be replaced by the user in
\r
162 using the product.</seg>
\r
163 </seglistitem></segmentedlist>
\r
166 <title>GUI Elements</title>
\r
167 <para>The following are DocBook elements used in documenting a GUI:</para>
\r
169 <segtitle>Element</segtitle>
\r
170 <segtitle>Description</segtitle>
\r
173 <tag class="element">accel</tag>
\r
175 <seg>Specifies that the content is a keyboard shortcut.</seg>
\r
176 </seglistitem><seglistitem>
\r
178 <tag class="element">guibutton</tag>
\r
180 <seg>Specifies that the content is the label on a GUI button.</seg>
\r
181 </seglistitem><seglistitem>
\r
183 <tag class="element">guilabel</tag>
\r
185 <seg>Specifies that the content is a label on a GUI element other than a button.</seg>
\r
186 </seglistitem><seglistitem>
\r
188 <tag class="element">guimenu</tag>
\r
190 <seg>Specifies that the content is the name of a menu.</seg>
\r
191 </seglistitem><seglistitem>
\r
193 <tag class="element">guimenuitem</tag>
\r
195 <seg>Specifies that the content is a selectable item on a menu.</seg>
\r
196 </seglistitem><seglistitem>
\r
198 <tag class="element">guisubmenu</tag>
\r
200 <seg>Specifies that the content is the name of a sub-menu.</seg>
\r
201 </seglistitem><seglistitem>
\r
203 <tag class="element">mousebutton</tag>
\r
205 <seg>Specifies that the content is the name of a mouse button.</seg>
\r
206 </seglistitem></segmentedlist>
\r