imagemap

The imagemap element supports the basic functionality of the HTML "client-side" image map markup. Imagemap allows you to designate a linkable area or region over an image, allowing a link in that region to display another topic.

An HTML client-side image map binds an image to the navigation structure (the "map") by means of an ID association from the map to the image. In contrast, the DITA version of imagemap markup simply includes the target image as the first required element in the markup, followed by a sequence of area elements that represent the links associated with the contained image.

An imagemap structure can be output either to a standard HTML image map or to alternative forms of navigation (such as table-based image maps). When output as PDF, the minimal form would be to represent at least the image; advanced PDF output processors should be able to provide equivalent region-oriented hyperlinks.

The xref content contains the intended alternative text or hover text for the map area.

Example

A simple imagemap looks like this (note that the rendering will depend on how this markup is supported for particular output formats):
<imagemap>
 <image href="imagemapworld.jpg"></image>
 <area><shape>rect</shape><coords>2,0,53,59</coords>
  <xref href="d1-s1.xml">Section 1</xref>
 </area>
 <area><shape>rect</shape><coords>54,1,117,60</coords>
  <xref href="d1-s2.xml"></xref>
 </area>
 <area><shape>rect</shape><coords>54,62,114,116</coords>
  <xref href="#inline" type="topic"></xref>
 </area>
 <area><shape>circle</shape><coords>120,154,29</coords>
  <xref format="html" href="test.html"></xref>
 </area>
 <area><shape>poly</shape>
  <coords>246,39,200,35,173,52,177,86,215,90,245,84,254,65</coords>
  <xref format="pdf" href="test.pdf"></xref>
 </area>
</imagemap>

The areas defined correspond to this graphic image; with the areas visible:
Map of the world showing 5 areas

The values for use in the shape and coords elements must follow the guidelines defined for image maps in HTML 4.1, Client-side image maps: the MAP and AREA elements

Contains

Doctype Content model
ditabase, topic, task, reference, concept, glossary ( ( image) then ( area) (one or more) )

Contained by

Doctype Parents
ditabase p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, conbody, prereq, context, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, glossdef, pd
topic p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, pd
task p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, prereq, context, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, pd
concept p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, conbody, pd
reference p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, refsyn, proptypehd, propvaluehd, propdeschd, pd
glossary p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, conbody, glossdef, pd

Inheritance:

+ topic/fig ut-d/imagemap

Attributes

Name Description Data Type Default Value Required?
spectitle The specialized title attribute allows architects of specialized types to define a fixed or default title for a specialized element. Not intended for direct use by authors. CDATA #IMPLIED No
%display-atts; (scale, frame, expanse) A set of related attributes, described at %display-atts; parameter entity PE not applicable Not applicable
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) A set of related attributes, described at %univ-atts; parameter entity PE not applicable Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class, outputclass Common attributes described in Other common DITA attributes