]> git.stg.codes - stg.git/blob - doc/xslt/tests/refentry.007.ns.xml
Added parameter description.
[stg.git] / doc / xslt / tests / refentry.007.ns.xml
1 <book xmlns="http://docbook.org/ns/docbook" version="5.0">
2 <info><title>Unit Test: refentry.007</title>
3
4 <releaseinfo role="CVS">$Id: refentry.007.xml 7282 2007-08-23 09:27:01Z xmldoc $</releaseinfo>
5 <author><personname><firstname>Norman</firstname><surname>Walsh</surname></personname><affiliation><address><email>ndw@nwalsh.com</email></address></affiliation></author>
6 </info>
7 <reference><info><title>Reference</title></info>
8
9 <refentry>
10   <info>
11     <authorgroup>
12       <author><personname><firstname>Norman</firstname><surname>Walsh</surname></personname><email>ndw@nwalsh.com</email><personblurb>
13           <para>Wrote the original version of this document.</para>
14         </personblurb></author>
15       <editor><personname><firstname>Michael(tm)</firstname><surname>Smith</surname></personname><contrib>Added a bunch of test cases.</contrib><email>smith@sideshowbarker.net</email></editor>
16     </authorgroup>
17     <copyright>
18       <year>2003</year>
19       <holder>Norman Walsh</holder>
20     </copyright>
21     <copyright>
22       <year>2006</year>
23       <holder>Michael(tm) Smith</holder>
24     </copyright>
25     <legalnotice>
26       <para>This file is a product of the DocBook Project.</para>
27     </legalnotice>
28     <legalnotice>
29       <para>Share and share alike.</para>
30     </legalnotice>
31   </info>
32 <refnamediv>
33 <refname>FirstName</refname>
34 <refname>SecondName</refname>
35 <refpurpose>Purpose for FirstName</refpurpose>
36 </refnamediv>
37
38 <refnamediv>
39 <refname>ThirdName</refname>
40 <refpurpose>Purpose for ThirdName</refpurpose>
41 </refnamediv>
42
43 <refsynopsisdiv>
44   <?dbfunclist ?>
45   <funcsynopsis>
46     <!-- * Yes, friend, Funcsynopsis is a verbatim -->
47     <funcsynopsisinfo>#include &lt;varargs.h&gt;
48 #include &lt;mouteyh.h&gt;
49 #include &lt;qlmppzj.h&gt;</funcsynopsisinfo>
50     <funcprototype>
51       <funcdef><type>float</type> <function>rand</function></funcdef>
52       <void/>
53     </funcprototype>
54
55     <funcprototype>
56       <funcdef>int <function>max</function></funcdef>
57       <varargs/>
58     </funcprototype>
59
60     <funcprototype>
61       <funcdef>int <function>idiv</function></funcdef>
62       <paramdef><type>int</type> <parameter>n</parameter></paramdef>
63       <paramdef><type>int</type> <parameter>m</parameter></paramdef>
64     </funcprototype>
65   </funcsynopsis>
66
67   <para>Another.</para>
68
69   <funcsynopsis>
70     <funcprototype>
71       <funcdef>void <function>qsort</function></funcdef>
72       <paramdef>void *<parameter>dataptr</parameter>[]</paramdef>
73       <paramdef>int <parameter>left</parameter></paramdef>
74       <paramdef>int <parameter>right</parameter></paramdef>
75       <paramdef>int (*<parameter>comp</parameter>)
76       <funcparams>void *, void *</funcparams></paramdef>
77     </funcprototype>
78   </funcsynopsis>
79
80   <funcsynopsis>
81     <funcprototype>
82       <funcdef>int <function>foo_frob_something</function></funcdef>
83       <paramdef>foo_sometype1 <parameter>foo_frob_parm1</parameter></paramdef>
84       <paramdef>foo_sometype1 <parameter>foo_frob_parm2</parameter></paramdef>
85       <paramdef>foo_sometype1 <parameter>foo_frob_parm3</parameter></paramdef>
86       <paramdef><type>int</type> (* <parameter>parm4</parameter> )
87       <funcparams>int a, int b, int c</funcparams>
88       </paramdef>
89       <paramdef>foo_sometype1 <parameter>foo_frob_parm5</parameter></paramdef>
90     </funcprototype>
91
92     <funcprototype>
93       <funcdef>int <function>foo_frob_something</function></funcdef>
94       <paramdef>foo_sometype1 <parameter>foo_frob_parm1</parameter></paramdef>
95       <paramdef>foo_sometype1 <parameter>foo_frob_parm2</parameter></paramdef>
96       <paramdef>foo_sometype1 <parameter>foo_frob_parm3</parameter></paramdef>
97       <paramdef><type>int</type> (* <parameter>parm4</parameter> )
98       <funcparams>int a, int b, int c</funcparams>
99       </paramdef>
100       <paramdef>foo_sometype1 <parameter>foo_frob_parm5</parameter></paramdef>
101     </funcprototype>
102   </funcsynopsis>
103 </refsynopsisdiv>
104
105 <refsection><info><title>Description</title></info>
106
107 <para>This is a minimal RefEntry.</para>
108
109 <para>The following is a Variablelist with a title.
110 <variablelist><info><title>My variablelist</title></info>
111   
112   <varlistentry>
113     <term>varlistentry term 1</term>
114     <listitem><para>some listitem text</para></listitem>
115   </varlistentry>
116   <varlistentry>
117     <term>varlistentry term 2</term>
118     <listitem><para>some more listitem text</para></listitem>
119   </varlistentry>
120 </variablelist>
121 </para>
122 <refsection><info><title>Subsection</title></info>
123
124 <para>This is a minimal RefEntry.</para>
125
126 <para>The following is a Variablelist with a title and a nested variablelist
127   <glosslist>
128     
129   <glossentry>
130     <glossterm>glossentry term 1</glossterm>
131     <glossdef><para>some glossdef text</para></glossdef>
132   </glossentry>
133   <glossentry>
134     <glossterm>glossentry term 2</glossterm>
135     <glossdef>
136       <variablelist>
137         <varlistentry>
138           <term>nested variablelist term 1</term>
139           <listitem><para>some variablelist text</para></listitem>
140         </varlistentry>
141         <varlistentry>
142           <term>nested variablelist term 2</term>
143           <listitem><para>some more variablelist text</para></listitem>
144         </varlistentry>
145       </variablelist>
146     </glossdef>
147   </glossentry>
148   </glosslist>
149 </para>
150
151 <refsection><info><title>Sub-subsection</title></info>
152
153 <para>This is a minimal RefEntry.</para>
154 </refsection>
155 </refsection>
156 </refsection>
157
158 <refsection><info><title>More Description</title></info>
159
160 <para>This is a not-so minimal RefEntry.</para>
161 <screen>
162 This is a screen [break here]
163 that starts with a line of space. [break here]
164 And it ends with a line of space.
165 </screen>
166
167 <para>normal paragraph here</para>
168
169 <screen>This is a screen [break here]
170 that does not start with a line of space. [break here]
171 And does not end with a line of space.</screen>
172
173 <para>This is a normal paragraph that contains a screen.
174 <screen>This is a screen within a normal paragraph [break here]
175 that does not start with a line of space. [break here]
176 And does not end with a line of space but is followed
177 by a line of space.</screen>
178 </para>
179
180 <para>This is another  normal paragraph that contains a screen.
181 <screen>This is a screen within a normal paragraph [break here]
182 that does not start with a line of space. [break here]
183 And does not end with a line of space and is not followed
184 by a line of space.</screen></para>
185
186 <para>This is another  normal paragraph that contains a screen.
187 <screen>
188 This is a screen within a normal paragraph [break here]
189 that starts with a line of space. [break here]
190 And ends with a line of space but is not followed by a line of space.
191 </screen></para>
192
193 <para>This is another  normal paragraph that contains a screen.
194 <screen>
195 This is a screen within a normal paragraph [break here]
196 that starts with a line of space. [break here]
197 And ends with a line of space and is followed by a line of space.
198 </screen>
199 </para>
200
201 <para>This is another  normal paragraph that contains a screen.
202 <screen>
203
204 This is a screen within a normal paragraph [break here]
205 that starts with a 2 lines of space. [break here]
206 And ends with 3 lines of space and is followed by a line of space.
207
208
209 </screen>
210 </para>
211
212 <para>This paragraph contains an itemizedlist with a title. The title
213 is “Mrignkwolmcng”.
214 <orderedlist inheritnum="ignore" continuation="restarts"><info><title>Mrignkwolmcng</title></info>
215   
216   <listitem>
217     <para>itemizedlist listitem 1</para>
218   </listitem>
219   <listitem>
220     <para>itemizedlist listitem 2</para>
221   </listitem>
222 </orderedlist>
223
224 This is some useless text that follows the “Mrignkwolmcng” orderedlist
225 in the same para.</para>
226
227 <para>The following is a Variablelist with a title and with a nested itemizedlist.
228 <variablelist><info><title>My variablelist</title></info>
229   
230   <varlistentry>
231     <term>varlistentry term 1</term>
232     <listitem>
233       <itemizedlist><info><title>nested itemizedlist</title></info>
234         
235         <listitem>
236           <para>itemizedlist listitem 1</para>
237         </listitem>
238         <listitem>
239           <para>itemizedlist listitem 2</para>
240         </listitem>
241       </itemizedlist>
242     </listitem>
243   </varlistentry>
244   <varlistentry>
245     <term>varlistentry term 2</term>
246     <listitem><para>some more listitem text</para></listitem>
247   </varlistentry>
248 </variablelist>
249 </para>
250
251 <para>The following is a Variablelist with a title and with a
252 nested Varlistentry that contains multiple Terms
253 <variablelist><info><title>My nested-multi-term-per-varlistentry variablelist</title></info>
254   
255   <varlistentry>
256     <term>Varlistentry term 1</term>
257     <listitem>
258       <variablelist>
259         <varlistentry>
260           <term>  varlistentry term 1.1</term>
261           <term>varlistentry term 1.2  </term>
262           <term>varlistentry         term 1.3</term>
263           <listitem><para>All 'bout terms 1.1, 1.2, and 1.3</para>
264           </listitem>
265         </varlistentry>
266       </variablelist>
267     </listitem>
268   </varlistentry>
269   <varlistentry>
270     <term>varlistentry term 2</term>
271     <listitem><para>some more listitem text</para></listitem>
272   </varlistentry>
273 </variablelist>
274 </para>
275
276 <refsection><info><title>Subsection</title></info>
277
278 <para>This is a minimal RefEntry.</para>
279 </refsection>
280 </refsection>
281
282 <refsection><info><title>Even More Description</title></info>
283
284 <para>This is an even less minimal RefEntry.</para>
285
286 <para>This is a paragraph. It contains the following segmentedlist,
287 titled “Gibbererish”, with several segtitle elements.
288 <segmentedlist>
289   
290   <segtitle>Floober</segtitle>
291   <segtitle>Buugler</segtitle>
292   <segtitle>Sstangooo</segtitle>
293   <segtitle>Borobinda</segtitle>
294   <seglistitem>
295   <seg>Bamalalaboonda Bamalalaboonda Bamalalaboonda Bamalalaboonda Bamalalaboonda Bamalalaboonda</seg>
296   <seg>Mondorotoluafu</seg>
297   <seg>Ganafutralinga</seg>
298   <seg>Patagularamakundra</seg>
299   </seglistitem>
300   <seglistitem>
301   <seg>Cadraracondar</seg>
302   <seg>Hentirotomaambu</seg>
303   <seg>BdomentriolaiaBdomentriolaiaBdomentriolaia</seg>
304   <seg>Candamalaturuanio</seg>
305   </seglistitem>
306 </segmentedlist>
307 This is some text that follows the segementedlist within the same
308 paragraph. The next part of this same paragraph is an
309 <tag>important</tag> admonition.
310 <important>
311   <para>It is very important that you read this. That’s why it stands
312   out the way that it does.</para>
313 </important>
314 </para>
315
316 <para>This is a para with a footnote
317   <footnote><para>Stuff here <programlisting>This is a program listing
318 that's two lines long.</programlisting></para>
319     and stuff after the
320 footnote</footnote></para>
321 </refsection>
322
323 </refentry>
324 </reference>
325 </book>