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 (72 lines) | stat: -rw-r--r-- 2,610 bytes parent folder | download | duplicates (4)
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
<refentry id="imageobjectco.element" revision='3.1'>
<?dbhtml filename="imageobjectco.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>

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

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

<para>
<sgmltag>Callout</sgmltag>s, such as numbered bullets, are an annotation mechanism.  In an
online system, these bullets are frequently <quote>hot,</quote> and clicking on
them navigates to the corresponding annotation.
</para>
<para>
A <sgmltag>ImageObjectCO</sgmltag> is a wrapper around an <sgmltag>AreaSpec</sgmltag> and
an <sgmltag>ImageObject</sgmltag>.  An <sgmltag>AreaSpec</sgmltag> identifies the locations
(coordinates)
on the image where the <sgmltag>Callout</sgmltag>s occur.
The <sgmltag>ImageObjectCO</sgmltag> may also contain the list of annotations in
a <sgmltag>CalloutList</sgmltag>, although the <sgmltag>CalloutList</sgmltag> may also
occur outside of the wrapper, elsewhere in the document.
</para>

<refsect2><title>Processing expectations</title>
<para>
&format.block; It may not be rendered at all, depending on its placement
within the <sgmltag>MediaObject</sgmltag> that contains it and
the constraints on the publishing system.  For a more detailed description
of the semantics involved, see <sgmltag>MediaObject</sgmltag>.
</para>
<para>
The mandatory processing expectations of a <sgmltag>ImageObjectCO</sgmltag> are
minimal: a system is expected to render the image, if possible, and the
callout list, if present.
</para>
<para>
In online environments, the processing system may be able to instantiate
the linking relationships between the callout marks on the image and
the annotations.  For example, an &HTML; presentation system might use the
coordinate information to construct a client-side image map.
Some processing systems may even be able to go a step further and generate
the callout marks automatically from the coordinate information.
But this level of sophistication is not mandatory.
</para>
</refsect2>


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

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