File: refentry.xml

package info (click to toggle)
docbook-defguide 2.0.17%2Bsvn9912-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, stretch
  • size: 93,428 kB
  • ctags: 299
  • sloc: xml: 396,482; perl: 4,471; python: 879; makefile: 150; sh: 80
file content (66 lines) | stat: -rw-r--r-- 1,854 bytes parent folder | download | duplicates (8)
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
<refentry id="refsection.element" revision='4.2'>
<?dbhtml filename="refsection.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>

<refmeta>
<indexterm><primary>elements</primary>
<secondary>refsection</secondary></indexterm>
<refentrytitle>refsection</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>refsection</refname>
<refpurpose>&refsection.purpose;</refpurpose>
</refnamediv>

&refsection.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>

<para>Reference pages have their own hierarchical structure. A
<sgmltag>RefSection</sgmltag> is a recursive division in a
<sgmltag>RefEntry</sgmltag>, analagous to a <sgmltag>Section</sgmltag> elsewhere
in the document.
</para>

<para>
The value of a separate hierarchical structure is that it allows
the content model of sections in reference pages to be
customized differently than the content model of sections
outside.
</para>

<refsect2><title>Processing expectations</title>
<para>
&format.block;
</para>
</refsect2>

&refsection.parents.gen;
&refsection.children.gen;

</refsect1>

<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>status</term>
<listitem>
<para><sgmltag class="attribute">Status</sgmltag> identifies the editorial or publication 
status of the <sgmltag>RefSection</sgmltag>.
</para>
<para>Publication status might be used to control formatting (for example,
printing a <quote>draft</quote> watermark on drafts) or processing (perhaps
a document with a status of <quote>final</quote> should not include any
components that are not final).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
&refsection.seealso.gen;
</refsect1>
</refentry>