Debian Codegraph @

test/docbook/source/inline.xml

raw
1 <chapter xmlns="http://docbook.org/ns/docbook"
2 id="inline">
3 <title>Inline Elements</title>
4 <variablelist>
5 <varlistentry>
6 <term><sgmltag>abbrev</sgmltag></term>
7 <listitem><para>The word <wordasword>concatenate</wordasword> is frequently abbreviated
8 as either <abbrev>concat</abbrev> or simply <abbrev>cat</abbrev>.</para></listitem>
9 </varlistentry>
10
11 <varlistentry>
12 <term><sgmltag>accel</sgmltag></term>
13 <listitem><para>To see the authors of an application, select
14 <guimenuitem><accel>A</accel>bout</guimenuitem> from the
15 <guimenuitem><accel>H</accel>elp</guimenuitem> menu.</para></listitem>
16 </varlistentry>
17
18 <varlistentry>
19 <term><sgmltag>acronym</sgmltag></term>
20 <listitem><para><acronym>GNOME</acronym> stands for <acronym>GNU</acronym>
21 Network Object Model Environment.</para></listitem>
22 </varlistentry>
23
24 <varlistentry>
25 <term><sgmltag>action</sgmltag></term>
26 <listitem><para>Logging out will cause the session manager to perform
27 <action>session saving</action>.</para></listitem>
28 </varlistentry>
29
30 <varlistentry>
31 <term><sgmltag>application</sgmltag></term>
32 <listitem><para><application>Yelp</application> is the default help
33 viewer in GNOME.</para></listitem>
34 </varlistentry>
35
36 <varlistentry>
37 <term><sgmltag>citetitle</sgmltag></term>
38 <listitem><para>Please read <citetitle pubwork="article">A Pretty Good Article</citetitle>
39 and <citetitle pubwork="book">The Bestest Book Ever</citetitle>.</para></listitem>
40 </varlistentry>
41
42 <varlistentry>
43 <term><sgmltag>citation</sgmltag></term>
44 <listitem><para>Consult <citation>Walsh97</citation> for more information.</para></listitem>
45 </varlistentry>
46
47 <varlistentry>
48 <term><sgmltag>classname</sgmltag></term>
49 <listitem><para>The <classname>YelpDocument</classname> class provides on-demand
50 page transformations in <application>Yelp</application>.</para></listitem>
51 </varlistentry>
52
53 <varlistentry>
54 <term><sgmltag>code</sgmltag></term>
55 <listitem><para>Call <code>frobnicate(file)</code> to frobnicate the file.</para></listitem>
56 </varlistentry>
57
58 <varlistentry>
59 <term><sgmltag>command</sgmltag></term>
60 <listitem><para>To start <application>Yelp</application>, enter <command>yelp</command>
61 at the command line.</para></listitem>
62 </varlistentry>
63
64 <varlistentry>
65 <term><sgmltag>computeroutput</sgmltag></term>
66 <listitem><para>Runnin <command>scrollkeeper-get-content-list C</command> should output
67 something like <computeroutput>/tmp/scrollkeeper-shaunm/contents.1</computeroutput>.
68 Sometimes it also prints errors like <computeroutput role="stderr">I/O warning :
69 failed to load external entity
70 "/var/lib/scrollkeeper/en_US.UTF-8/scrollkeeper_cl.xml"</computeroutput>.</para></listitem>
71 </varlistentry>
72
73 <varlistentry>
74 <term><sgmltag>constant</sgmltag></term>
75 <listitem><para>The maximum legal length for a path name is
76 <constant class='limit'>PATH_MAX</constant>.</para></listitem>
77 </varlistentry>
78
79 <varlistentry>
80 <term><sgmltag>corpauthor</sgmltag></term>
81 <term><sgmltag>corpcredit</sgmltag></term>
82 <listitem><para>Some of the GNOME Documentation was written by
83 <corpauthor>Sun Microsystems</corpauthor>. Some technical editing was also done
84 by <corpcredit>Sun Microsystems</corpcredit>.</para></listitem>
85 </varlistentry>
86
87 <varlistentry>
88 <term><sgmltag>database</sgmltag></term>
89 <listitem><para>The <database>Pulse</database> database tracks everything
90 you need to know about your project.</para></listitem>
91 </varlistentry>
92
93 <varlistentry>
94 <term><sgmltag>email</sgmltag></term>
95 <listitem><para>To contact the GNOME Documentation Team, send an email to
96 <email>[email protected]</email>.</para></listitem>
97 </varlistentry>
98
99 <varlistentry>
100 <term><sgmltag>emphasis</sgmltag></term>
101 <listitem><para>This is <emphasis>italic</emphasis>, and this is
102 <emphasis role="bold">bold</emphasis>.</para></listitem>
103 </varlistentry>
104
105 <varlistentry>
106 <term><sgmltag>envar</sgmltag></term>
107 <listitem><para>The <envar>YELP_DEBUG</envar> environment variable can be used to
108 control the debugging output in <application>Yelp</application>.</para></listitem>
109 </varlistentry>
110
111 <varlistentry>
112 <term><sgmltag>errorcode</sgmltag></term>
113 <term><sgmltag>errorname</sgmltag></term>
114 <term><sgmltag>errortext</sgmltag></term>
115 <term><sgmltag>errortype</sgmltag></term>
116 <listitem><para>On most DOS-derived systems, functions signal a
117 <errortext>File Not Found</errortext> error by returning <errorcode>2</errorcode>
118 (<errorname>ENOENT</errorname>). This is usually a <errortype>recoverable</errortype>
119 (non-fatal) error.</para></listitem>
120 </varlistentry>
121
122 <varlistentry>
123 <term><sgmltag>exceptionname</sgmltag></term>
124 <listitem><para>If the world is ending, this function will throw the exception
125 <exceptionname>ArmageddonException</exceptionname>.</para></listitem>
126 </varlistentry>
127
128 <varlistentry>
129 <term><sgmltag>filename</sgmltag></term>
130 <listitem><para>This text was written in the file
131 <filename>testbook.xml</filename>.</para></listitem>
132 </varlistentry>
133
134 <varlistentry>
135 <term><sgmltag>firstterm</sgmltag></term>
136 <listitem><para>This document has example <firstterm>tables</firstterm>, and in
137 particular <firstterm linkend="cals-tables">CALS tables</firstterm>.</para></listitem>
138 </varlistentry>
139
140 <varlistentry>
141 <term><sgmltag>foreignphrase</sgmltag></term>
142 <listitem><para>Free software is sometimes called <foreignphrase>libre</foreignphrase>
143 software.</para></listitem>
144 </varlistentry>
145
146 <varlistentry>
147 <term><sgmltag>function</sgmltag></term>
148 <listitem><para>The function <function>g_strdup</function> duplicates a string.</para></listitem>
149 </varlistentry>
150
151 <varlistentry>
152 <term><sgmltag>glossterm</sgmltag></term>
153 <listitem><para>There's no glossary entry for <glossterm>frobnicate</glossterm>. This
154 links implicitly to the definition of <glossterm>button</glossterm>, but we have to use
155 an explicit link for <glossterm linkend="gloss-button">buttons</glossterm>.</para></listitem>
156 </varlistentry>
157
158 <varlistentry>
159 <term><sgmltag>guibutton</sgmltag></term>
160 <term><sgmltag>guiicon</sgmltag></term>
161 <term><sgmltag>guilabel</sgmltag></term>
162 <term><sgmltag>guimenu</sgmltag></term>
163 <term><sgmltag>guimenuitem</sgmltag></term>
164 <term><sgmltag>guisubmenu</sgmltag></term>
165 <listitem><para>You can select what fonts to use under the <guilabel>Fonts</guilabel>
166 heading in the dialog. To close the dialog, click the <guibutton>Close</guibutton> button.
167 To open a file, select <guimenuitem>Open</guimenuitem> from the <guimenu>File</guimenu>
168 menu or click the <guiicon><inlinegraphic
169 fileref="file:///usr/share/icons/gnome/22x22/status/stock_open.png"/></guiicon> icon
170 on the toolbar. To open a recent file, select a file from the <guisubmenu>Open Recent</guisubmenu>
171 submenu of the <guimenu>File</guimenu> menu.</para></listitem>
172 </varlistentry>
173
174 <varlistentry>
175 <term><sgmltag>hardware</sgmltag></term>
176 <listitem><para>Unfortunately, your <hardware>hard drive</hardware> cannot be
177 fixed by simply blowing into it like an old game cartridge.</para></listitem>
178 </varlistentry>
179
180 <varlistentry>
181 <term><sgmltag>inlineequation</sgmltag></term>
182 <term><sgmltag>mathphrase</sgmltag></term>
183 <listitem><para>Fermat's last theorem says that <inlineequation>
184 <alt>x^n + y^n ≠ z^n ∀ n > 2</alt>
185 <mathphrase>x<superscript>n</superscript> + y<superscript>n</superscript> ≠ z<superscript>n</superscript> ∀ n ≠ 2</mathphrase></inlineequation>.</para></listitem>
186 </varlistentry>
187
188 <varlistentry>
189 <term><sgmltag>interface</sgmltag></term>
190 <listitem><para>In old-school DocBook, we'd use the <sgmltag>interface</sgmltag>
191 tag for the <interface>Close</interface> button.</para></listitem>
192 </varlistentry>
193
194 <varlistentry>
195 <term><sgmltag>interfacename</sgmltag></term>
196 <listitem><para>This class implements <interfacename>GtkCellLayout</interfacename>.</para></listitem>
197 </varlistentry>
198
199 <varlistentry>
200 <term><sgmltag>keycap</sgmltag></term>
201 <term><sgmltag>keycode</sgmltag></term>
202 <term><sgmltag>keysym</sgmltag></term>
203 <listitem><para>The <keycap>F1</keycap> key on an IBM PC keyboard generates the
204 scan code <keycode>0x3B</keycode> when pressed. This value is defined as
205 <keysym>KEY_F1</keysym>.</para></listitem>
206 </varlistentry>
207
208 <varlistentry>
209 <term><sgmltag>keycombo</sgmltag></term>
210 <listitem><para>To copy the selection to the clipboard, press
211 <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>.</para></listitem>
212 </varlistentry>
213
214 <varlistentry>
215 <term><sgmltag>lineannotation</sgmltag></term>
216 <listitem><para>Do not run this command if you value your data:</para>
217 <screen>find . -type f -exec shred -fuz {} \; <lineannotation>shred all files at any depth</lineannotation></screen></listitem>
218 </varlistentry>
219
220 <varlistentry>
221 <term><sgmltag>literal</sgmltag></term>
222 <listitem><para>Set <envar>YELP_DEBUG</envar> to <literal>function-calls</literal> to
223 see all the major function calls inside <application>Yelp</application>.</para></listitem>
224 </varlistentry>
225
226 <varlistentry>
227 <term><sgmltag>markup</sgmltag></term>
228 <listitem><para>To italicize text on Wikipedia, type <markup>''text''</markup>.</para></listitem>
229 </varlistentry>
230
231 <varlistentry>
232 <term><sgmltag>medialabel</sgmltag></term>
233 <listitem><para>To being installing <application>Frobnicator</application>, insert
234 the disc labelled <medialabel>Frobnicator Install</medialabel>.</para></listitem>
235 </varlistentry>
236
237 <varlistentry>
238 <term><sgmltag>menuchoice</sgmltag></term>
239 <listitem><para>You can open a new window by selecting <menuchoice>
240 <shortcut><keycombo><keycap>Ctrl</keycap><keycap>N</keycap></keycombo></shortcut>
241 <guimenu>File</guimenu><guimenuitem>New Window</guimenuitem></menuchoice>.</para></listitem>
242 </varlistentry>
243
244 <varlistentry>
245 <term><sgmltag>methodname</sgmltag></term>
246 <listitem><para>The <methodname>set_label()</methodname> method sets the text of the
247 button to <parameter><replaceable>label</replaceable></parameter>.</para></listitem>
248 </varlistentry>
249
250 <varlistentry>
251 <term><sgmltag>mousebutton</sgmltag></term>
252 <listitem><para>Click with the <mousebutton>middle</mousebutton> mouse button to
253 paste the contents of the PRIMARY selection.</para></listitem>
254 </varlistentry>
255
256 <varlistentry>
257 <term><sgmltag>option</sgmltag></term>
258 <listitem><para>The <option>-rf</option> option to the <command>ls</command>
259 command has been known to cause mental anguish.</para></listitem>
260 </varlistentry>
261
262 <varlistentry>
263 <term><sgmltag>optional</sgmltag></term>
264 <listitem>
265 <synopsis><command>yelp <optional><option>-p</option></optional></command></synopsis>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry>
270 <term><sgmltag>ooclass</sgmltag></term>
271 <term><sgmltag>ooexception</sgmltag></term>
272 <term><sgmltag>oointerface</sgmltag></term>
273 <listitem><para>The <ooclass><classname>Mallard</classname></ooclass> class
274 implements the <oointerface><interfacename>Quacks</interfacename></oointerface>
275 interface. The <methodname>quack</methodname> method may throw the
276 <ooexception><exceptionname>Muted</exceptionname></ooexception>
277 exception.</para></listitem>
278 </varlistentry>
279
280 <varlistentry>
281 <term><sgmltag>parameter</sgmltag></term>
282 <listitem><para>The <parameter>db2html.funcsynopsis.style</parameter> allows you
283 to set the style of function synopses to either <literal>'KR'</literal> or
284 <literal>'ANSI'</literal>.</para></listitem>
285 </varlistentry>
286
287 <varlistentry>
288 <term><sgmltag>personname</sgmltag></term>
289 <listitem><para>My name is
290 <personname><firstname>Shaun</firstname><surname>McCance</surname></personname>,
291 or <personname><firstname>Shaun</firstname><othername>William</othername>
292 <surname>McCance</surname></personname>. You may also call me <personname>
293 <honorific>Mr</honorific><surname>Mojo</surname></personname>.</para></listitem>
294 </varlistentry>
295
296 <varlistentry>
297 <term><sgmltag>productname</sgmltag></term>
298 <listitem><para><productname class="trade">Frobnicator</productname> is the
299 only solution for frobnicating your files.</para></listitem>
300 </varlistentry>
301
302 <varlistentry>
303 <term><sgmltag>prompt</sgmltag></term>
304 <listitem><para>The prototypical prompt is <prompt>$</prompt>, but most people
305 use something like <prompt>[<replaceable>user</replaceable>@<replaceable>host</replaceable> <replaceable>dir</replaceable>]</prompt>.</para></listitem>
306 </varlistentry>
307
308 <varlistentry>
309 <term><sgmltag>property</sgmltag></term>
310 <listitem><para>The <property>font_name</property> property can be used to set
311 the font on a widget in your <filename>.gtrc-2.0</filename> file.</para></listitem>
312 </varlistentry>
313
314 <varlistentry>
315 <term><sgmltag>quote</sgmltag></term>
316 <listitem><para>He said, <quote>The Mallard said <quote>Quack</quote>.</quote></para></listitem>
317 </varlistentry>
318
319 <varlistentry>
320 <term><sgmltag>replaceable</sgmltag></term>
321 <listitem><para>To view a DocBook file, simply run
322 <command>yelp <replaceable>file</replaceable></command>, where
323 <parameter><replaceable>file</replaceable></parameter>
324 is the name of the file.</para></listitem>
325 </varlistentry>
326
327 <varlistentry>
328 <term><sgmltag>returnvalue</sgmltag></term>
329 <listitem><para>The template <function>i18n.locale</function> returns
330 <returnvalue>C</returnvalue> if no language has been defined in the
331 document.</para></listitem>
332 </varlistentry>
333
334 <varlistentry>
335 <term><sgmltag>sgmltag</sgmltag></term>
336 <listitem><itemizedlist>
337 <listitem><para><sgmltag class="attribute">attribute</sgmltag></para></listitem>
338 <listitem><para><sgmltag class="attvalue">attvalue</sgmltag></para></listitem>
339 <listitem><para><sgmltag class="element">element</sgmltag></para></listitem>
340 <listitem><para><sgmltag class="emptytag">emptytag</sgmltag></para></listitem>
341 <listitem><para><sgmltag class="endtag">endtag</sgmltag></para></listitem>
342 <listitem><para><sgmltag class="genentity">genentity</sgmltag></para></listitem>
343 <listitem><para><sgmltag class="localname">localname</sgmltag></para></listitem>
344 <listitem><para><sgmltag class="namespace">namespace</sgmltag></para></listitem>
345 <listitem><para><sgmltag class="numcharref">numcharref</sgmltag></para></listitem>
346 <listitem><para><sgmltag class="paramentity">paramentity</sgmltag></para></listitem>
347 <listitem><para><sgmltag class="pi">pi</sgmltag></para></listitem>
348 <listitem><para><sgmltag class="prefix">prefix</sgmltag></para></listitem>
349 <listitem><para><sgmltag class="sgmlcomment">sgmlcomment</sgmltag></para></listitem>
350 <listitem><para><sgmltag class="starttag">starttag</sgmltag></para></listitem>
351 <listitem><para><sgmltag class="xmlpi">xmlpi</sgmltag></para></listitem>
352 </itemizedlist></listitem>
353 </varlistentry>
354
355 <varlistentry>
356 <term><sgmltag>shortcut</sgmltag></term>
357 <listitem><para>You can open a new window by selecting <menuchoice>
358 <shortcut><keycombo><keycap>Ctrl</keycap><keycap>N</keycap></keycombo></shortcut>
359 <guimenu>File</guimenu><guimenuitem>New Window</guimenuitem></menuchoice>.</para></listitem>
360 </varlistentry>
361
362 <varlistentry>
363 <term><sgmltag>structfield</sgmltag></term>
364 <term><sgmltag>structname</sgmltag></term>
365 <listitem><para>The <structfield>reqs_pending</structfield> field is a list
366 of all the <structname>Request</structname> instances that are currently open
367 for this <structname>YelpDocument</structname>.</para></listitem>
368 </varlistentry>
369
370 <varlistentry>
371 <term><sgmltag>subscript</sgmltag></term>
372 <term><sgmltag>superscript</sgmltag></term>
373 <listitem><para>Here is a <sgmltag>subscript</sgmltag><subscript>sub<subscript>scr<subscript>ipt</subscript></subscript></subscript>.
374 Here is a <sgmltag>superscript</sgmltag><superscript>super<superscript>scr<superscript>ipt</superscript></superscript></superscript>.</para></listitem>
375 </varlistentry>
376
377 <varlistentry>
378 <term><sgmltag>symbol</sgmltag></term>
379 <listitem><para>No more than <symbol>MAX_DUCKS</symbol> ducks may exist
380 at any single time.</para></listitem>
381 </varlistentry>
382
383 <varlistentry>
384 <term><sgmltag>systemitem</sgmltag></term>
385 <listitem><para>The GNOME web site is hosted on
386 <systemitem>window.gnome.org</systemitem>.</para></listitem>
387 </varlistentry>
388
389 <varlistentry>
390 <term><sgmltag>token</sgmltag></term>
391 <listitem><para>The character ∀ is parsed into <token>FORALL</token>.</para></listitem>
392 </varlistentry>
393
394 <varlistentry>
395 <term><sgmltag>trademark</sgmltag></term>
396 <listitem><para>Here are some trademarks: <trademark class="copyright">copyright</trademark>
397 <trademark class="registered">registered</trademark>
398 <trademark class="service">service</trademark>
399 <trademark class="trade">trade</trademark>.</para></listitem>
400 </varlistentry>
401
402 <varlistentry>
403 <term><sgmltag>type</sgmltag></term>
404 <listitem><para>Strings are stored as <type>gchar*</type> references.</para></listitem>
405 </varlistentry>
406
407 <varlistentry>
408 <term><sgmltag>uri</sgmltag></term>
409 <listitem><para>Grab the latest Mallard stuff at
410 <uri>svn+ssh://svn.gnome.org/svn/gnome-doc-utils/trunk/sandbox/mallard/</uri>.</para></listitem>
411 </varlistentry>
412
413 <varlistentry>
414 <term><sgmltag>userinput</sgmltag></term>
415 <listitem><para>Type <userinput>foo</userinput> at the prompt.</para></listitem>
416 </varlistentry>
417
418 <varlistentry>
419 <term><sgmltag>varname</sgmltag></term>
420 <listitem><para>In Perl, <varname>@ARGV</varname> contains the command line
421 parameters used when the script was run.</para></listitem>
422 </varlistentry>
423
424 <varlistentry>
425 <term><sgmltag>wordasword</sgmltag></term>
426 <listitem><para>A <wordasword>term</wordasword> in Algebra has a very different
427 meaning than a <sgmltag>term</sgmltag> in DocBook.</para></listitem>
428 </varlistentry>
429
430 </variablelist>
431 </chapter>