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
|
<refentry id="replaceable.element">
<?dbhtml filename="replaceable.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>
<refmeta>
<indexterm><primary>elements</primary>
<secondary>replaceable</secondary></indexterm>
<refentrytitle>replaceable</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>replaceable</refname>
<refpurpose>&replaceable.purpose;</refpurpose>
</refnamediv>
&replaceable.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>
<para>
<sgmltag>Replaceable</sgmltag> is used to mark text that describes
<emphasis>what</emphasis> a user is supposed to enter, but not the
<emphasis>actual text</emphasis> that they are supposed to enter.
</para>
<para>
It is used to identify a class of object
in the document, in which the user is expected to replace the text that
identifies the class
with some specific instance of that class. A canonical example is
<screen>
<![CDATA[
<replaceable>filename</replaceable>
]]>
</screen>
in which the user is expected to provide the name of some specific file
to replace the text <quote>filename.</quote>
</para>
<refsect2><title>Processing expectations</title>
<para>
&format.inline; Usually, the text is given special typographic treatment,
such as italics, as a clue to the user that this is replaceable text.
Often the font used is described in a <quote>conventions</quote> section at
the beginning of the document.
</para>
</refsect2>
&replaceable.parents.gen;
&replaceable.children.gen;
</refsect1>
<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>class</term>
<listitem>
<para>
<sgmltag class="attribute">Class</sgmltag> identifies the type of the replaceable
information.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
&replaceable.seealso.gen;
</refsect1>
<refsect1><title>Examples</title>
&replaceable.example.seealso.gen;
</refsect1>
</refentry>
|
