summaryrefslogtreecommitdiffstats
blob: 452137631d4d71a2cb13ed681533c852025c8518 (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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
          "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<book>
<bookinfo>
<title>Unit Test: refentry.007</title>
<releaseinfo role="CVS">$Id: refentry.007.xml 7282 2007-08-23 09:27:01Z xmldoc $</releaseinfo>
<author><firstname>Norman</firstname><surname>Walsh</surname>
        <affiliation><address><email>ndw@nwalsh.com</email></address></affiliation>
</author>
</bookinfo>
<reference>
<title>Reference</title>
<refentry>
  <refentryinfo>
    <authorgroup>
      <author>
        <firstname>Norman</firstname><surname>Walsh</surname>
        <email>ndw@nwalsh.com</email>
        <personblurb>
          <para>Wrote the original version of this document.</para>
        </personblurb>
      </author>
      <editor>
        <contrib>Added a bunch of test cases.</contrib>
        <firstname>Michael(tm)</firstname><surname>Smith</surname>
        <email>smith@sideshowbarker.net</email>
      </editor>
    </authorgroup>
    <copyright>
      <year>2003</year>
      <holder>Norman Walsh</holder>
    </copyright>
    <copyright>
      <year>2006</year>
      <holder>Michael(tm) Smith</holder>
    </copyright>
    <legalnotice>
      <para>This file is a product of the DocBook Project.</para>
    </legalnotice>
    <legalnotice>
      <para>Share and share alike.</para>
    </legalnotice>
  </refentryinfo>
<refnamediv>
<refname>FirstName</refname>
<refname>SecondName</refname>
<refpurpose>Purpose for FirstName</refpurpose>
</refnamediv>

<refnamediv>
<refname>ThirdName</refname>
<refpurpose>Purpose for ThirdName</refpurpose>
</refnamediv>

<refsynopsisdiv>
  <?dbfunclist ?>
  <funcsynopsis>
    <!-- * Yes, friend, Funcsynopsis is a verbatim -->
    <funcsynopsisinfo
>#include &lt;varargs.h&gt;
#include &lt;mouteyh.h&gt;
#include &lt;qlmppzj.h&gt;</funcsynopsisinfo>
    <funcprototype>
      <funcdef><type>float</type> <function>rand</function></funcdef>
      <void/>
    </funcprototype>

    <funcprototype>
      <funcdef>int <function>max</function></funcdef>
      <varargs/>
    </funcprototype>

    <funcprototype>
      <funcdef>int <function>idiv</function></funcdef>
      <paramdef><type>int</type> <parameter>n</parameter></paramdef>
      <paramdef><type>int</type> <parameter>m</parameter></paramdef>
    </funcprototype>
  </funcsynopsis>

  <para>Another.</para>

  <funcsynopsis>
    <funcprototype>
      <funcdef>void <function>qsort</function></funcdef>
      <paramdef>void *<parameter>dataptr</parameter>[]</paramdef>
      <paramdef>int <parameter>left</parameter></paramdef>
      <paramdef>int <parameter>right</parameter></paramdef>
      <paramdef>int (*<parameter>comp</parameter>)
      <funcparams>void *, void *</funcparams></paramdef>
    </funcprototype>
  </funcsynopsis>

  <funcsynopsis>
    <funcprototype>
      <funcdef>int <function>foo_frob_something</function></funcdef>
      <paramdef>foo_sometype1 <parameter>foo_frob_parm1</parameter></paramdef>
      <paramdef>foo_sometype1 <parameter>foo_frob_parm2</parameter></paramdef>
      <paramdef>foo_sometype1 <parameter>foo_frob_parm3</parameter></paramdef>
      <paramdef><type>int</type> (* <parameter>parm4</parameter> )
      <funcparams>int a, int b, int c</funcparams>
      </paramdef>
      <paramdef>foo_sometype1 <parameter>foo_frob_parm5</parameter></paramdef>
    </funcprototype>

    <funcprototype>
      <funcdef>int <function>foo_frob_something</function></funcdef>
      <paramdef>foo_sometype1 <parameter>foo_frob_parm1</parameter></paramdef>
      <paramdef>foo_sometype1 <parameter>foo_frob_parm2</parameter></paramdef>
      <paramdef>foo_sometype1 <parameter>foo_frob_parm3</parameter></paramdef>
      <paramdef><type>int</type> (* <parameter>parm4</parameter> )
      <funcparams>int a, int b, int c</funcparams>
      </paramdef>
      <paramdef>foo_sometype1 <parameter>foo_frob_parm5</parameter></paramdef>
    </funcprototype>
  </funcsynopsis>
</refsynopsisdiv>

<refsect1>
<title>Description</title>
<para>This is a minimal RefEntry.</para>

<para>The following is a Variablelist with a title.
<variablelist>
  <title>My variablelist</title>
  <varlistentry>
    <term>varlistentry term 1</term>
    <listitem><para>some listitem text</para></listitem>
  </varlistentry>
  <varlistentry>
    <term>varlistentry term 2</term>
    <listitem><para>some more listitem text</para></listitem>
  </varlistentry>
</variablelist>
</para>
<refsect2>
<title>Subsection</title>
<para>This is a minimal RefEntry.</para>

<para>The following is a Variablelist with a title and a nested variablelist
  <glosslist>
    <title>My glosslist</title>
  <glossentry>
    <glossterm>glossentry term 1</glossterm>
    <glossdef><para>some glossdef text</para></glossdef>
  </glossentry>
  <glossentry>
    <glossterm>glossentry term 2</glossterm>
    <glossdef>
      <variablelist>
        <varlistentry>
          <term>nested variablelist term 1</term>
          <listitem><para>some variablelist text</para></listitem>
        </varlistentry>
        <varlistentry>
          <term>nested variablelist term 2</term>
          <listitem><para>some more variablelist text</para></listitem>
        </varlistentry>
      </variablelist>
    </glossdef>
  </glossentry>
  </glosslist>
</para>

<refsect3>
<title>Sub-subsection</title>
<para>This is a minimal RefEntry.</para>
</refsect3>
</refsect2>
</refsect1>

<refsect1>
<title>More Description</title>
<para>This is a not-so minimal RefEntry.</para>
<screen>
This is a screen [break here]
that starts with a line of space. [break here]
And it ends with a line of space.
</screen>

<para>normal paragraph here</para>

<screen>This is a screen [break here]
that does not start with a line of space. [break here]
And does not end with a line of space.</screen>

<para>This is a normal paragraph that contains a screen.
<screen>This is a screen within a normal paragraph [break here]
that does not start with a line of space. [break here]
And does not end with a line of space but is followed
by a line of space.</screen>
</para>

<para>This is another  normal paragraph that contains a screen.
<screen>This is a screen within a normal paragraph [break here]
that does not start with a line of space. [break here]
And does not end with a line of space and is not followed
by a line of space.</screen></para>

<para>This is another  normal paragraph that contains a screen.
<screen>
This is a screen within a normal paragraph [break here]
that starts with a line of space. [break here]
And ends with a line of space but is not followed by a line of space.
</screen></para>

<para>This is another  normal paragraph that contains a screen.
<screen>
This is a screen within a normal paragraph [break here]
that starts with a line of space. [break here]
And ends with a line of space and is followed by a line of space.
</screen>
</para>

<para>This is another  normal paragraph that contains a screen.
<screen>

This is a screen within a normal paragraph [break here]
that starts with a 2 lines of space. [break here]
And ends with 3 lines of space and is followed by a line of space.


</screen>
</para>

<para>This paragraph contains an itemizedlist with a title. The title
is “Mrignkwolmcng”.
<orderedlist>
  <title>Mrignkwolmcng</title>
  <listitem>
    <para>itemizedlist listitem 1</para>
  </listitem>
  <listitem>
    <para>itemizedlist listitem 2</para>
  </listitem>
</orderedlist>

This is some useless text that follows the “Mrignkwolmcng” orderedlist
in the same para.</para>

<para>The following is a Variablelist with a title and with a nested itemizedlist.
<variablelist>
  <title>My variablelist</title>
  <varlistentry>
    <term>varlistentry term 1</term>
    <listitem>
      <itemizedlist>
        <title>nested itemizedlist</title>
        <listitem>
          <para>itemizedlist listitem 1</para>
        </listitem>
        <listitem>
          <para>itemizedlist listitem 2</para>
        </listitem>
      </itemizedlist>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>varlistentry term 2</term>
    <listitem><para>some more listitem text</para></listitem>
  </varlistentry>
</variablelist>
</para>

<para>The following is a Variablelist with a title and with a
nested Varlistentry that contains multiple Terms
<variablelist>
  <title>My nested-multi-term-per-varlistentry variablelist</title>
  <varlistentry>
    <term>Varlistentry term 1</term>
    <listitem>
      <variablelist>
        <varlistentry>
          <term>  varlistentry term 1.1</term>
          <term>varlistentry term 1.2  </term>
          <term>varlistentry         term 1.3</term>
          <listitem><para>All 'bout terms 1.1, 1.2, and 1.3</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>varlistentry term 2</term>
    <listitem><para>some more listitem text</para></listitem>
  </varlistentry>
</variablelist>
</para>

<refsect2>
<title>Subsection</title>
<para>This is a minimal RefEntry.</para>
</refsect2>
</refsect1>

<refsect1>
<title>Even More Description</title>
<para>This is an even less minimal RefEntry.</para>

<para>This is a paragraph. It contains the following segmentedlist,
titled “Gibbererish”, with several segtitle elements.
<segmentedlist>
  <title>Gibbererish</title>
  <segtitle>Floober</segtitle>
  <segtitle>Buugler</segtitle>
  <segtitle>Sstangooo</segtitle>
  <segtitle>Borobinda</segtitle>
  <seglistitem>
  <seg>Bamalalaboonda Bamalalaboonda Bamalalaboonda Bamalalaboonda Bamalalaboonda Bamalalaboonda</seg>
  <seg>Mondorotoluafu</seg>
  <seg>Ganafutralinga</seg>
  <seg>Patagularamakundra</seg>
  </seglistitem>
  <seglistitem>
  <seg>Cadraracondar</seg>
  <seg>Hentirotomaambu</seg>
  <seg>BdomentriolaiaBdomentriolaiaBdomentriolaia</seg>
  <seg>Candamalaturuanio</seg>
  </seglistitem>
</segmentedlist>
This is some text that follows the segementedlist within the same
paragraph. The next part of this same paragraph is an
<sgmltag>important</sgmltag> admonition.
<important>
  <para>It is very important that you read this. That’s why it stands
  out the way that it does.</para>
</important>
</para>

<para>This is a para with a footnote
  <footnote
    ><para>Stuff here <programlisting>This is a program listing
that's two lines long.</programlisting></para>
    and stuff after the
footnote</footnote></para>
</refsect1>

</refentry>
</reference>
</book>