File: refentry.xml

package info (click to toggle)
docbook-defguide 2.0.17%2Bsvn9912-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 93,432 kB
  • ctags: 299
  • sloc: xml: 396,482; perl: 4,471; python: 879; makefile: 150; sh: 80
file content (67 lines) | stat: -rw-r--r-- 1,830 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
67
<refentry id="refentrytitle.element">
<?dbhtml filename="refentrytitle.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>

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

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

<para>
A <sgmltag>RefEntryTitle</sgmltag> is the title of a reference page.
It is frequently the same as the first
<sgmltag>RefName</sgmltag> or the <sgmltag>RefDescriptor</sgmltag>, although it
may also be a longer, more general title.
</para>

<refsect2><title>Processing expectations</title>
<para>
&format.block;
</para>
<para>
Formatting reference pages may require a fairly sophisticated
processing system.  Much of the meta-information about a
reference page (its name, type, purpose, title, and
classification) is stored in wrappers near the beginning of
the <sgmltag>RefEntry</sgmltag>.
</para>
<para>
Common presentational features, such as titles and running
heads, may require data from several of these wrappers plus
some generated text. Other formatting often requires that
these elements be reordered.
</para>
</refsect2>

<refsect2 role='fu' revision="4.0"><title>&FutureChanges;</title>
<para>
<!--do not index this occurance-->
&fu.interfacedefinition;
</para>
</refsect2>


&refentrytitle.parents.gen;
&refentrytitle.children.gen;
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
&refentrytitle.seealso.gen;
</refsect1>
<refsect1><title>Examples</title>

&refentrytitle.example.seealso.gen;
</refsect1>
</refentry>