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
|
<refentry id="tocentry.element">
<?dbhtml filename="tocentry.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>
<refmeta>
<indexterm><primary>elements</primary>
<secondary>tocentry</secondary></indexterm>
<refentrytitle>tocentry</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>tocentry</refname>
<refpurpose>&tocentry.purpose;</refpurpose>
</refnamediv>
&tocentry.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>
<para>
A <sgmltag>ToCentry</sgmltag> contains the title of an entry in a
<sgmltag>ToC</sgmltag>. In entries that allow nested structure, such as
<sgmltag>ToCchap</sgmltag>, this additional wrapper is necessary in order to
require that a title be present.
</para>
<refsect2><title>Processing expectations</title>
<para>
&format.block;
</para>
<para>
In real life, <sgmltag>ToC</sgmltag>s are usually generated automatically
by the presentation system and never have to be represented explicitly
in the document source.
</para>
</refsect2>
<refsect2 role='fu' revision="4.0"><title>&FutureChanges;</title>
<para>
<!--do not index this occurance-->
&fu.interfacedefinition;
</para>
</refsect2>
&tocentry.parents.gen;
&tocentry.children.gen;
</refsect1>
<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>linkend</term>
<listitem>
<para>
<sgmltag class="attribute">Linkend</sgmltag> points to the associated element in the document.
</para>
</listitem>
</varlistentry>
<varlistentry><term>pagenum</term>
<listitem>
<para>
<sgmltag class="attribute">PageNum</sgmltag> indicates the page on which this
<sgmltag>ToC</sgmltag> element appears in some version of the printed document.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Examples</title>
&tocentry.example.seealso.gen;
</refsect1>
</refentry>
|
