image

Include artwork or images in a DITA topic by using the <image> element. The <image> element has optional attributes that indicate whether the placement of the included graphic or artwork should be inline (like a button or icon), or on a separate line for a larger image. An href attribute is required on the image element, as this attribute creates a pointer to the image, and allows the output formatting processor to bring the image into the text flow. To make the intent of the image more accessible for users using screen readers or text-only readers, always include a description of the image's content in the alt element.

Contains

(alt) (optional)

Contained by

title, shortdesc, body, section, example, desc, p, note, lq, sli, li, itemgroup, dthd, ddhd, dt, dd, fig, ph, stentry, draft-comment, fn, xref, linkinfo, entry, conbody, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, uicontrol, pt, pd, imagemap

Inheritance

topic/image

Attributes

Name	Description	Data Type	Default Value	Required?
href	The relative path or URL to the GIF or JPEG image. The href attribute uses conventional URL syntax to point to the resource: href="../images/construction.gif"	CDATA	#IMPLIED	No
keyref	Currently not implemented in DITA processors. Provides a key that a process can use to refer to the <image> by a key rather than referencing it directly.	NMTOKEN	#IMPLIED	No
alt	Alternative text that describes the image to provide accessibility to page readers, or provides a text description when an image cannot be displayed by the user's software. The alt attribute is deprecated; use the alt element instead.	CDATA	#IMPLIED	No
longdescref	A reference to a textual description of the graphic. This attribute supports creating accessible content.	CDATA	#IMPLIED	No
height	Indicates the maximum height of an image.	NMTOKEN	#IMPLIED	No
width	Indicates the maximum width of an image.	NMTOKEN	#IMPLIED	No
align	Controls the horizontal alignment of an image when placement is specified as "break." Allowable values (processor-validated) are: left, right, center, and current.	CDATA	#IMPLIED	No
placement	Indicates whether an image should be displayed inline or separated from the surrounding text. The default is inline. Allowable values are: inline or break.	CDATA	#IMPLIED	No
%univ-atts; (%select-atts;, %id-atts;, translate, xml:lang)	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

Example

<image href="bike.gif" " placement="break"><alt>Two-wheeled bicycle</alt></image>