File: refentry.xml

package info (click to toggle)
docbook-defguide 2.0.17%2Bsvn7549-3
  • links: PTS, VCS
  • area: main
  • in suites: lenny, squeeze
  • size: 101,040 kB
  • ctags: 261
  • sloc: xml: 426,495; perl: 4,471; python: 815; sh: 193; makefile: 181
file content (94 lines) | stat: -rw-r--r-- 2,920 bytes parent folder | download
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<refentry id="textdata.element" revision='4.2'>
<?dbhtml filename="textdata.html"?>
<refentryinfo>
<pubdate>$Date: 2002-06-11 03:20:20 +0200 (Tue, 11 Jun 2002) $</pubdate>
<releaseinfo>$Revision: 1615 $</releaseinfo>
</refentryinfo>

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

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

<para>This element points to an external entity containing text
to be inserted.
</para>

<note>
<para>Any markup in the text identified with <sgmltag>textdata</sgmltag>
will be escaped. In other words, this element is for inserting things
like program listings, not parts of an XML document. To break a document
into separate physical files, use entities.</para>
</note>

<refsect2 id="dbreproc.textdata"><title>Processing expectations</title>
<para>
&format.context; Insert the text.
</para>
<para>
There are two ways to provide content for <sgmltag>textdata</sgmltag>:
<sgmltag class='attribute'>entityref</sgmltag> or <sgmltag
class='attribute'>fileref</sgmltag>.  It is best to use only one of these
methods, however, if multiple sources are provided, 
<sgmltag class='attribute'>entityref</sgmltag> will be used in favor of 
<sgmltag class='attribute'>fileref</sgmltag>.
</para>
</refsect2> 

&textdata.parents.gen;

</refsect1>

<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>encoding</term>
<listitem>
<para>Identifies the encoding of the text in the external file.
Recommended best practice suggests that character encodings
<ulink url="ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets">registered
(as charsets)</ulink> with the Internet Assigned Numbers Authority
be referred to using their registered names.</para>
</listitem>
</varlistentry>
<varlistentry><term>entityref</term>
<listitem>
<para><sgmltag class="attribute">EntityRef</sgmltag> identifies the general entity
which contains (or points to) the external text.
</para>
</listitem>
</varlistentry>
<varlistentry><term>fileref</term>
<listitem>
<para><sgmltag class="attribute">FileRef</sgmltag> specifies the name of the file
which contains the external text.
</para>
</listitem>
</varlistentry>
<varlistentry><term>format</term>
<listitem>
<para><sgmltag class="attribute">Format</sgmltag> identifies the format of the
external text. The <sgmltag class="attribute">Format</sgmltag> must be a defined
notation.
</para>
</listitem>
</varlistentry>
<varlistentry><term>srccredit</term>
<listitem>
<para><sgmltag class="attribute">SrcCredit</sgmltag> contains details about the source 
of the external text.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>