← Back to branch summary

~clint-fewbar/ubuntu/precise/erlang/merge-15b

« back to all changes in this revision

Viewing changes to lib/erl_docgen/doc/src/refman_dtds.xml

  • Committer: Package Import Robot
  • Author(s): Sergei Golovan
  • Date: 2011-12-15 19:20:10 UTC
  • mfrom: (1.1.18) (3.5.15 sid)
  • mto: (3.5.16 sid)
  • mto: This revision was merged to the branch mainline in revision 33.
  • Revision ID: package-import@ubuntu.com-20111215192010-jnxcfe3tbrpp0big
Tags: 1:15.b-dfsg-1
* New upstream release.
* Upload to experimental because this release breaks external drivers
  API along with ABI, so several applications are to be fixed.
* Removed SSL patch because the old SSL implementation is removed from
  the upstream distribution.
* Removed never used patch which added native code to erlang beam files.
* Removed the erlang-docbuilder binary package because the docbuilder
  application was dropped by upstream.
* Documented dropping ${erlang-docbuilder:Depends} substvar in
  erlang-depends(1) manpage.
* Made erlang-base and erlang-base-hipe provide virtual package
  erlang-abi-15.b (the number means the first erlang version, which
  provides current ABI).

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/erl_docgen/doc/src/refman_dtds.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE chapter SYSTEM "chapter.dtd">
 
3
 
 
4
<chapter>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>1997</year><year>2011</year>
 
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
 
9
    </copyright>
 
10
    <legalnotice>
 
11
      The contents of this file are subject to the Erlang Public License,
 
12
      Version 1.1, (the "License"); you may not use this file except in
 
13
      compliance with the License. You should have received a copy of the
 
14
      Erlang Public License along with this software. If not, it can be
 
15
      retrieved online at http://www.erlang.org/.
 
16
    
 
17
      Software distributed under the License is distributed on an "AS IS"
 
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
19
      the License for the specific language governing rights and limitations
 
20
      under the License.
 
21
    
 
22
    </legalnotice>
 
23
 
 
24
    <title>Reference Manual DTDs</title>
 
25
    <prepared></prepared>
 
26
    <docno></docno>
 
27
    <date></date>
 
28
    <rev></rev>
 
29
    <file>refman_dtds.xml</file>
 
30
  </header>
 
31
 
 
32
  <p>There are five DTDs for writing manual pages about applications,
 
33
    shell commands, C libraries, Erlang modules and files, all with a
 
34
    similar structure:</p>
 
35
 
 
36
  <list type="bulleted">
 
37
    <item>A header.</item>
 
38
    <item>Name of the application/command/library/module/file.</item>
 
39
    <item>Short summary (one line).</item>
 
40
    <item>A longer description.</item>
 
41
    <item>"Formal" definitions of functions or commands.</item>
 
42
    <item>Optional sections of free text.</item>
 
43
    <item>Optional section with the name(s) and email(s) of the author(s).</item>
 
44
  </list>
 
45
 
 
46
  <p>The differences between the DTDs are the tags for the name,
 
47
    the short summary and some tags inside the "formal" definitions.</p>
 
48
 
 
49
  <section>
 
50
    <marker id="applicationDTD"></marker>
 
51
    <title>The application DTD</title>
 
52
 
 
53
    <p>The <c>application</c> DTD is intended for a Reference Manual and
 
54
      groups a set of manual pages into one unit. The structure is
 
55
      similar to the part DTD: first an introduction and then the manual
 
56
      pages, written in separate files with the
 
57
      <seealso marker="#apprefDTD">appref</seealso>,
 
58
      <seealso marker="#comrefDTD">comref</seealso>,
 
59
      <seealso marker="#crefDTD">cref</seealso>,
 
60
      <seealso marker="#erlrefDTD">erlref</seealso>, or
 
61
      <seealso marker="#filerefDTD">fileref</seealso> DTD.</p>
 
62
 
 
63
    <p>Example:</p>
 
64
    <pre>
 
65
&lt;?xml version="1.0" encoding="latin1" ?>
 
66
&lt;!DOCTYPE application SYSTEM "application.dtd">
 
67
&lt;application>
 
68
  &lt;header>
 
69
    &lt;title>Application name&lt;/title>
 
70
    &lt;prepared/>
 
71
    &lt;docno/>
 
72
    &lt;date/>
 
73
    &lt;rev/>
 
74
  &lt;/header>
 
75
 
 
76
  &lt;description>
 
77
    &lt;p>Application description...&lt;/p>
 
78
  &lt;/description>
 
79
  
 
80
  &lt;include file="module1">
 
81
  &lt;include file="module2">
 
82
&lt;/application>
 
83
    </pre>
 
84
  </section>
 
85
 
 
86
  <section>
 
87
    <marker id="applicationTAG"></marker>
 
88
    <title>&lt;application&gt;</title>
 
89
 
 
90
    <p>The top level tag of an <c>application</c> DTD.</p>
 
91
 
 
92
    <p>Contains a
 
93
      <seealso marker="header_tags">&lt;header&gt;</seealso>,
 
94
      an optional
 
95
      <seealso marker="user_guide_dtds#descriptionTAG">&lt;description&gt;</seealso>,
 
96
      followed by one or more
 
97
      <seealso marker="user_guide_dtds#includeTAG">&lt;include&gt;</seealso>.
 
98
    </p>
 
99
  </section>
 
100
 
 
101
  <section>
 
102
    <marker id="apprefDTD"></marker>
 
103
    <title>The appref DTD</title>
 
104
 
 
105
    <p>This is the DTD for writing an application manual page.</p>
 
106
 
 
107
    <p>Example:</p>
 
108
    <pre>
 
109
&lt;?xml version="1.0" encoding="latin1" ?>
 
110
&lt;!DOCTYPE appref SYSTEM "appref.dtd">
 
111
&lt;appref>
 
112
  &lt;header>
 
113
    &lt;title>Application name&lt;/title>
 
114
    &lt;prepared/>
 
115
    &lt;docno/>
 
116
    &lt;date/>
 
117
    &lt;rev/>
 
118
  &lt;/header>
 
119
 
 
120
  &lt;app>Application name&lt;/app>
 
121
 
 
122
  &lt;appsummary>A short application summary.&lt;/appsummary>
 
123
 
 
124
  &lt;description>
 
125
    &lt;p>A longer description of the application.&lt;/p>
 
126
  &lt;/description>
 
127
  
 
128
  &lt;section>
 
129
    &lt;title>Configuration&lt;/title>
 
130
 
 
131
      &lt;p>...&lt;/p>
 
132
  &lt;/section>
 
133
 
 
134
  ...
 
135
  
 
136
  &lt;authors>
 
137
    &lt;aname>Name of author&lt;/aname>
 
138
    &lt;email>Email of author&lt;/email>
 
139
  &lt;/authors>
 
140
&lt;/appref>
 
141
    </pre>
 
142
 
 
143
    <section>
 
144
      <marker id="apprefTAG"></marker>
 
145
      <title>&lt;appref&gt;</title>
 
146
 
 
147
      <p>The top level tag of an <c>appref</c> DTD.</p>
 
148
 
 
149
      <p>Contains
 
150
        <seealso marker="header_tags#headerTAG">&lt;header&gt;</seealso>,
 
151
        <seealso marker="#appTAG">&lt;app&gt;</seealso>,
 
152
        <seealso marker="#appsummaryTAG">&lt;appsummary&gt;</seealso>,
 
153
        <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
 
154
        zero or more
 
155
        <seealso marker="#sectionTAG">&lt;section&gt;</seealso> and
 
156
        <seealso marker="#funcsTAG">&lt;funcs&gt;</seealso>, 
 
157
        followed by zero or more 
 
158
        <seealso marker="#authorsTAG">&lt;authors&gt;</seealso>.</p>
 
159
    </section>
 
160
 
 
161
    <section>
 
162
      <marker id="appTAG"></marker>
 
163
      <title>&lt;app&gt;</title>
 
164
 
 
165
      <p>The application name. Contains plain text.</p>
 
166
    </section>
 
167
 
 
168
    <section>
 
169
      <marker id="appsummaryTAG"></marker>
 
170
      <title>&lt;appsummary&gt;</title>
 
171
 
 
172
      <p>Short summary. Contains plain text.</p>
 
173
    </section>
 
174
  </section>
 
175
 
 
176
  <section>
 
177
    <marker id="comrefDTD"></marker>
 
178
    <title>The comref DTD</title>
 
179
 
 
180
    <p>This is the DTD for writing a command manual page.</p>
 
181
 
 
182
    <p>Example:</p>
 
183
    <pre>
 
184
&lt;?xml version="1.0" encoding="latin1" ?>
 
185
&lt;!DOCTYPE comref SYSTEM "comref.dtd">
 
186
&lt;comref>
 
187
  &lt;header>
 
188
    &lt;title>Command name&lt;/title>
 
189
    &lt;prepared/>
 
190
    &lt;docno/>
 
191
    &lt;date/>
 
192
    &lt;rev/>
 
193
  &lt;/header>
 
194
 
 
195
  &lt;com>Command name&lt;/com>
 
196
 
 
197
  &lt;comsummary>A short command summary.&lt;/comsummary>
 
198
 
 
199
  &lt;description>
 
200
    &lt;p>A long description of the command.&lt;/p>
 
201
  &lt;/description>
 
202
  
 
203
  &lt;funcs>
 
204
    &lt;func>
 
205
      &lt;name>command&lt;/name>
 
206
      &lt;name>command -flag &lt;arg>&lt;/name>
 
207
      &lt;fsummary>A short command summary (max 40 characters).&lt;/fsummary>
 
208
      &lt;desc>
 
209
        &lt;p>An extended command description.
 
210
      &lt;/desc>
 
211
    &lt;/func>
 
212
  &lt;/funcs>
 
213
 
 
214
  &lt;section>
 
215
    &lt;title>Options&lt;/title>
 
216
 
 
217
    &lt;p>...&lt;/p>
 
218
  &lt;/section>
 
219
  
 
220
  &lt;authors>
 
221
    &lt;aname>Name of author&lt;/aname>
 
222
    &lt;email>Email of author&lt;/email>
 
223
  &lt;/authors>
 
224
&lt;/comref>
 
225
    </pre>
 
226
 
 
227
    <section>
 
228
      <marker id="comrefTAG"></marker>
 
229
      <title>&lt;comref&gt;</title>
 
230
 
 
231
      <p>The top level tag for a <c>comref</c> DTD.</p>
 
232
 
 
233
      <p>Contains
 
234
        <seealso marker="header_tags#headerTAG">&lt;header&gt;</seealso>,
 
235
        <seealso marker="#comTAG">&lt;com&gt;</seealso>,
 
236
        <seealso marker="#comsummaryTAG">&lt;comsummary&gt;</seealso>,
 
237
        <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
 
238
        zero or more
 
239
        <seealso marker="#sectionTAG">&lt;section&gt;</seealso> and
 
240
        <seealso marker="#funcsTAG">&lt;funcs&gt;</seealso>, 
 
241
        followed by zero or more
 
242
        <seealso marker="#authorsTAG">&lt;authors&gt;</seealso>.</p>
 
243
    </section>
 
244
 
 
245
    <section>
 
246
      <marker id="comTAG"></marker>
 
247
      <title>&lt;com&gt;</title>
 
248
 
 
249
      <p>The command name. Contains plain text.</p>
 
250
    </section>
 
251
 
 
252
    <section>
 
253
      <marker id="comsummaryTAG"></marker>
 
254
 
 
255
      <title>&lt;comsummary&gt;</title>
 
256
 
 
257
      <p>Short summary. Contains plain text.</p>
 
258
    </section>
 
259
  </section>
 
260
 
 
261
  <section>
 
262
    <marker id="crefDTD"></marker>
 
263
    <title>The cref DTD</title>
 
264
 
 
265
    <p>This is the DTD for writing a C library manual page.</p>
 
266
 
 
267
    <p>Example:</p>
 
268
    <pre><![CDATA[
 
269
<?xml version="1.0" encoding="latin1" ?>
 
270
<!DOCTYPE cref SYSTEM "cref.dtd">
 
271
<cref>
 
272
  <header>
 
273
    <title>C library name</title>
 
274
    <prepared/>
 
275
    <docno/>
 
276
    <date/>
 
277
    <rev/>
 
278
  </header>
 
279
 
 
280
  <lib>C library name</lib>
 
281
 
 
282
  <libsummary>A short C library summary.</libsummary>
 
283
 
 
284
  <description>
 
285
    <p>A longer description of the C library.</p>
 
286
  </description>
 
287
  
 
288
  <funcs>
 
289
    <func>
 
290
      <name><ret>void</ret><nametext>start(bar)</nametext></name>
 
291
      <name><ret>void</ret><nametext>start(foo)</nametext></name>
 
292
      <fsummary>A short function summary (max 40 characters).</fsummary>
 
293
      <type>
 
294
        <v>char bar</v>
 
295
        <v>int foo</v>
 
296
      </type>
 
297
      <desc>
 
298
        <p>An extended function description.</p>
 
299
      </desc>
 
300
    </func>
 
301
 
 
302
    ...
 
303
  </funcs>
 
304
 
 
305
  <section>
 
306
    <title>A title</title>
 
307
 
 
308
    <p>Some text...</p>
 
309
  </section>
 
310
  
 
311
  
 
312
</cref>
 
313
    ]]></pre>
 
314
 
 
315
    <section>
 
316
      <marker id="crefTAG"></marker>
 
317
      <title>&lt;cref&gt;</title>
 
318
 
 
319
      <p>The top level tag for a <c>cref</c> DTD.</p>
 
320
 
 
321
      <p>Contains
 
322
        <seealso marker="header_tags#headerTAG">&lt;header&gt;</seealso>,
 
323
        <seealso marker="#libTAG">&lt;lib&gt;</seealso>,
 
324
        <seealso marker="#libsummaryTAG">&lt;libsummary&gt;</seealso>,
 
325
        <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
 
326
        zero or more
 
327
        <seealso marker="#sectionTAG">&lt;section&gt;</seealso> and
 
328
        <seealso marker="#funcsTAG">&lt;funcs&gt;</seealso>, followed by
 
329
        zero or more
 
330
        <seealso marker="#authorsTAG">&lt;authors&gt;</seealso>.</p>
 
331
    </section>
 
332
 
 
333
    <section>
 
334
      <marker id="libTAG"></marker>
 
335
      <title>&lt;lib&gt;</title>
 
336
 
 
337
      <p>The C library name or acronym. Contains plain text.</p>
 
338
    </section>
 
339
 
 
340
    <section>
 
341
      <marker id="libsummaryTAG"></marker>
 
342
      <title>&lt;libsummary&gt;</title>
 
343
 
 
344
      <p>Short summary. Contains plain text.</p>
 
345
    </section>
 
346
  </section>
 
347
 
 
348
  <section>
 
349
    <marker id="erlrefDTD"></marker>
 
350
    <title>The erlref DTD</title>
 
351
 
 
352
    <p>This is the DTD for writing Erlang module manual pages.</p>
 
353
 
 
354
    <p>Example:</p>
 
355
    <pre>
 
356
&lt;?xml version="1.0" encoding="latin1" ?>
 
357
&lt;!DOCTYPE erlref SYSTEM "erlref.dtd">
 
358
&lt;erlref>
 
359
  &lt;header>
 
360
    &lt;title>Module name&lt;/title>
 
361
    &lt;prepared/>
 
362
    &lt;docno/>
 
363
    &lt;date/>
 
364
    &lt;rev/>
 
365
  &lt;/header>
 
366
 
 
367
  &lt;module>Module name&lt;/module>
 
368
 
 
369
  &lt;modulesummary>A short module summary.&lt;/modulesummary>
 
370
 
 
371
  &lt;description>
 
372
    &lt;p>A longer description of the module.&lt;/p>
 
373
  &lt;/description>
 
374
  
 
375
  &lt;funcs>
 
376
    &lt;func>
 
377
      &lt;name>start() -> Result&lt;/name>
 
378
      &lt;name>start(N) -> Result&lt;/name>
 
379
      &lt;fsummary>A short function summary (max 40 characters).&lt;/fsummary>
 
380
      &lt;type>
 
381
        &lt;v>Pid = pid()&lt;/v>
 
382
        &lt;v>N = int()&lt;/v>
 
383
        &lt;v>Result = {ok, Pid} | {error, Reason}&lt;/v>
 
384
        &lt;v>Reason = term()&lt;/v>
 
385
        &lt;d>A parameter description.&lt;/d>
 
386
      &lt;/type>
 
387
      &lt;desc>
 
388
        &lt;p>An extended function description.&lt;/p>
 
389
      &lt;/desc>
 
390
    &lt;/func>
 
391
 
 
392
    ...
 
393
  &lt;/funcs>
 
394
 
 
395
  &lt;section>
 
396
    &lt;title>Some Title&lt;/title>
 
397
    &lt;p>Some text...&lt;/p>
 
398
  &lt;/section>
 
399
  
 
400
  &lt;authors>
 
401
    &lt;aname>Name of author&lt;/aname>
 
402
    &lt;email>Email of author&lt;/email>
 
403
  &lt;/authors>
 
404
&lt;/erlref>
 
405
    </pre>
 
406
 
 
407
    <section>
 
408
      <marker id="erlrefTAG"></marker>
 
409
      <title>&lt;erlref&gt;</title>
 
410
 
 
411
      <p>The top level tag for an <c>erlref</c> DTD.</p>
 
412
 
 
413
      <p>Contains
 
414
        <seealso marker="header_tags#headerTAG">&lt;header&gt;</seealso>,
 
415
        <seealso marker="#moduleTAG">&lt;module&gt;</seealso>,
 
416
        <seealso marker="#modulesummaryTAG">&lt;modulesummary&gt;</seealso>,
 
417
        <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
 
418
        zero or more
 
419
        <seealso marker="#sectionTAG">&lt;section&gt;</seealso> and
 
420
        <seealso marker="#funcsTAG">&lt;funcs&gt;</seealso>, 
 
421
        followed by zero or more
 
422
        <seealso marker="#authorsTAG">&lt;authors&gt;</seealso>.</p>
 
423
    </section>
 
424
 
 
425
    <section>
 
426
      <marker id="moduleTAG"></marker>
 
427
      <title>&lt;module&gt;</title>
 
428
 
 
429
      <p>The module name. Contains plain text.</p>
 
430
    </section>
 
431
 
 
432
    <section>
 
433
      <marker id="modulesummaryTAG"></marker>
 
434
      <title>&lt;modulesummary&gt;</title>
 
435
 
 
436
      <p>Short summary. Contains plain text.</p>
 
437
    </section>
 
438
  </section>
 
439
 
 
440
  <section>
 
441
    <marker id="filerefDTD"></marker>
 
442
    <title>The fileref DTD</title>
 
443
 
 
444
    <p>This is the DTD for writing file manual pages. In OTP, this DTD
 
445
      is used for defining the format of for example <c>.rel</c> and
 
446
      <c>.app</c> files.</p>
 
447
 
 
448
    <p>Example:</p>
 
449
    <pre>
 
450
&lt;?xml version="1.0" encoding="latin1" ?>
 
451
&lt;!DOCTYPE fileref SYSTEM "fileref.dtd">
 
452
&lt;fileref>
 
453
  &lt;header>
 
454
    &lt;title>File name&lt;/title>
 
455
    &lt;prepared/>
 
456
    &lt;docno/>
 
457
    &lt;date/>
 
458
    &lt;rev/>
 
459
  &lt;/header>
 
460
 
 
461
  &lt;file>fileref&lt;/file>
 
462
 
 
463
  &lt;filesummary>A short file summary.&lt;/filesummary>
 
464
 
 
465
  &lt;description>
 
466
    &lt;p>A longer description of the file.&lt;/p>
 
467
  &lt;/description>
 
468
  
 
469
  &lt;section>
 
470
    &lt;title>File format&lt;/title>
 
471
 
 
472
    &lt;p>...&lt;/p>
 
473
  &lt;/section>
 
474
  
 
475
  &lt;authors>
 
476
    &lt;aname>Name of author&lt;/aname>
 
477
    &lt;email>Email of author&lt;/email>
 
478
  &lt;/authors>
 
479
&lt;/fileref>
 
480
    </pre>
 
481
 
 
482
    <p>The file reference manual can also contain function definitions,
 
483
      similar to the <c>erlref</c> DTD.</p>
 
484
 
 
485
    <section>
 
486
      <marker id="filerefTAG"></marker>
 
487
      <title>&lt;fileref&gt;</title>
 
488
 
 
489
      <p>The top level tag for a <c>fileref</c> DTD.</p>
 
490
 
 
491
      <p>Contains
 
492
        <seealso marker="header_tags#headerTAG">&lt;header&gt;</seealso>,
 
493
        <seealso marker="#fileTAG">&lt;file&gt;</seealso>,
 
494
        <seealso marker="#filesummaryTAG">&lt;filesummary&gt;</seealso>,
 
495
        <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
 
496
        zero or more
 
497
        <seealso marker="#sectionTAG">&lt;section&gt;</seealso> and
 
498
        <seealso marker="#funcsTAG">&lt;funcs&gt;</seealso>, 
 
499
        followed by zero or more
 
500
        <seealso marker="#authorsTAG">&lt;authors&gt;</seealso>.</p>
 
501
    </section>
 
502
 
 
503
    <section>
 
504
      <marker id="fileTAG"></marker>
 
505
      <title>&lt;file&gt;</title>
 
506
 
 
507
      <p>The name of the file or file type. Contains plain text.</p>
 
508
    </section>
 
509
 
 
510
    <section>
 
511
      <marker id="filesummaryTAG"></marker>
 
512
      <title>&lt;filesummary&gt;</title>
 
513
 
 
514
      <p>Short summary. Contains plain text.</p>
 
515
    </section>
 
516
  </section>
 
517
 
 
518
    <section>
 
519
    <marker id="descriptionTAG"></marker>
 
520
    <title>&lt;description&gt;</title>
 
521
 
 
522
    <p>The introduction after the title and before sections and
 
523
      "formal" definitions.</p>
 
524
 
 
525
    <p>Contains any combination and any number of
 
526
      <seealso marker="block_tags">block tags</seealso> except
 
527
      <c><![CDATA[<image>]]></c> and <c><![CDATA[<table>]]></c>.</p>
 
528
  </section>
 
529
 
 
530
  <section>
 
531
    <marker id="sectionTAG"></marker>
 
532
    <title>&lt;section&gt;</title>
 
533
 
 
534
    <p>Subdivisions of the document. Contains an optional
 
535
      <seealso marker="inline_tags#markerTAG">&lt;marker&gt;</seealso>,
 
536
      a <seealso marker="user_guide_dtds#titleTAG">&lt;title&gt;</seealso>,
 
537
      
 
538
      followed by any combination and any number of
 
539
      <seealso marker="block_tags">block tags</seealso> except
 
540
      <c><![CDATA[<image>]]></c> and <c><![CDATA[<table>]]></c>.</p>
 
541
  </section>
 
542
 
 
543
  <section>
 
544
    <marker id="funcsTAG"></marker>
 
545
    <title>&lt;funcs&gt;</title>
 
546
 
 
547
    <p>A group of "formal" function definitions.</p>
 
548
    
 
549
    <p>Contains one or more
 
550
      <seealso marker="#funcTAG">&lt;func&gt;</seealso>.</p>
 
551
  </section>
 
552
 
 
553
  <section>
 
554
    <marker id="funcTAG"></marker>
 
555
    <title>&lt;func&gt;</title>
 
556
 
 
557
    <p>A "formal" function definition.</p>
 
558
 
 
559
    <p>Contains one or more
 
560
      <seealso marker="#nameTAG">&lt;name&gt;</seealso>, followed by
 
561
      <seealso marker="#fsummaryTAG">&lt;fsummary&gt;</seealso>,
 
562
      <seealso marker="#typeTAG">&lt;type&gt;</seealso> (optional) and
 
563
      <seealso marker="#descTAG">&lt;desc&gt;</seealso> (optional).</p>
 
564
  </section>
 
565
 
 
566
  <section>
 
567
    <marker id="nameTAG"></marker>
 
568
    <title>&lt;name&gt;</title>
 
569
 
 
570
    <p>Function/command signature with name, arguments and return value.
 
571
      Contains plain text, except for the <c>cref</c> DTD where it
 
572
      contains a <c><![CDATA[<ret>]]></c> (return type, plain text) and
 
573
      a <c><![CDATA[<nametext>]]></c> (function name and arguments,
 
574
      plain text).</p>
 
575
 
 
576
    <p>In the case of an <c>erlref</c> DTD, it will
 
577
      automatically be added a
 
578
      <seealso marker="inline_tags#markerTAG">marker</seealso>,
 
579
      <c><![CDATA[<marker id="Name/Arity">]]></c> or
 
580
      <c><![CDATA[<marker id="Name">]]></c>, based on the contents of
 
581
      this tag before the function definition.</p>
 
582
 
 
583
    <p>Example: Consider the following name definition</p>
 
584
    <pre><![CDATA[
 
585
<name>foo(Arg1, Arg2) -> ok | {error, Reason}</name>
 
586
    ]]></pre>
 
587
 
 
588
    <p>Then a marker like this will be added
 
589
      <c><![CDATA[<marker id="foo/2">]]></c> before the function
 
590
      definition in the generated HTML. That is, referring to
 
591
      the function using
 
592
      <c><![CDATA[<seealso marker="#foo/2">foo/2</seealso>]]></c> will
 
593
      automatically work.</p>
 
594
  </section>
 
595
 
 
596
  <section>
 
597
    <marker id="fsummaryTAG"></marker>
 
598
    <title>&lt;fsummary&gt;</title>
 
599
 
 
600
    <p>Function/command summary. Contains plain text,
 
601
      <seealso marker="inline_tags#cTAG">&lt;c&gt;</seealso> and
 
602
      <seealso marker="inline_tags#emTAG">&lt;em&gt;</seealso>.</p>
 
603
  </section>
 
604
 
 
605
  <section>
 
606
    <marker id="typeTAG"></marker>
 
607
    <title>&lt;type&gt;</title>
 
608
 
 
609
    <p>Type declarations for the function/command.</p>
 
610
 
 
611
    <p>Contains one or more pairs of
 
612
      <seealso marker="#vTAG">&lt;v&gt;</seealso> and
 
613
      <seealso marker="#dTAG">&lt;d&gt;</seealso> (optional).</p>
 
614
  </section>
 
615
 
 
616
  <section>
 
617
    <marker id="vTAG"></marker>
 
618
    <title>&lt;v&gt;</title>
 
619
 
 
620
    <p>Type declaration for an argument or return value. Contains plain
 
621
      text.</p>
 
622
  </section>
 
623
 
 
624
  <section>
 
625
    <marker id="dTAG"></marker>
 
626
    <title>&lt;d&gt;</title>
 
627
 
 
628
    <p>Description for an argument or return value. Contains plain text,
 
629
      <seealso marker="inline_tags#cTAG">&lt;c&gt;</seealso> and
 
630
      <seealso marker="inline_tags#emTAG">&lt;em&gt;</seealso>.</p>
 
631
  </section>
 
632
 
 
633
  <section>
 
634
    <marker id="descTAG"></marker>
 
635
    <title>&lt;desc&gt;</title>
 
636
 
 
637
    <p>Function/command description. Contains
 
638
      <seealso marker="block_tags">block tags</seealso> except
 
639
      <c>&lt;image&gt;</c> and <c>&lt;table&gt;</c>.</p>
 
640
  </section>
 
641
 
 
642
  <section>
 
643
    <marker id="authorsTAG"></marker>
 
644
    <title>&lt;authors&gt;</title>
 
645
 
 
646
    <p>Authors of the manual page. The <c>authors</c> element is  optional.</p>
 
647
 
 
648
    <p>Contains one or more pairs of
 
649
      <seealso marker="#anameTAG">&lt;aname&gt;</seealso> and
 
650
      <seealso marker="#emailTAG">&lt;email&gt;</seealso>.</p>
 
651
  </section>
 
652
 
 
653
  <section>
 
654
    <marker id="anameTAG"></marker>
 
655
    <title>&lt;aname&gt;</title>
 
656
 
 
657
    <p>Author name. Contains plain text.</p>
 
658
  </section>
 
659
 
 
660
  <section>
 
661
    <marker id="emailTAG"></marker>
 
662
    <title>&lt;email&gt;</title>
 
663
 
 
664
    <p>Author email address. Contains plain text.</p>
 
665
  </section>
 
666
</chapter>
 
667