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. There are also optional attributes that indicate the size to which the included graphic or artwork should be scaled. An image element must specify an href attribute, a keyref attribute, or both. When both keyref and href are specified, the href is used as a fallback when the key reference cannot be resolved. The image addressed by the keyref or href is brought into the main flow of the content as rendered. To make the intent of the image more accessible for users using screen readers or text-only readers, authors should include a description of the image's content in the alt element.
|topic, map, concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap, classifyMap, subjectScheme, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary||( (alt) (optional) then (longdescref) (optional) )|
<image href="bike.gif" placement="break"> <alt>Two-wheeled bicycle</alt> </image>
|Name||Description||Data Type||Default Value||Required?|
|href||Provides a reference to the image. See The href attribute for detailed information on supported values and processing implications.||CDATA||#IMPLIED||No|
|scope||The scope attribute identifies the closeness of the relationship between the current document and the target resource. See The scope attribute for more information on values.||(local | peer | external | -dita-use-conref-target)||#IMPLIED||No|
|height||Indicates the vertical dimension for the resulting image display. If necessary, the image is scaled to the specified size. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels). Possible values include: "5", "5in", and "10.5cm". If a height value is specified and no width value is specified, the width will be scaled by the same factor as the height. If both a height value and width value are specified, some implementations may not be able to scale the two directions by a different factor and may therefore ignore one of the two values.||NMTOKEN||#IMPLIED||No|
|width||Indicates the horizontal dimension for the resulting image display. If necessary, the image is scaled to the specified size. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels). Possible values include: "5", "5in", and "10.5cm". If a width value is specified and no height value is specified, the height will be scaled by the same factor as the width. If both a height value and width value are specified, some implementations may not be able to scale the two directions by a different factor and may therefore ignore one of the two values.||NMTOKEN||#IMPLIED||No|
|align||Controls the horizontal alignment of an image when placement is specified as "break." Common values include left, right, and center.||CDATA||#IMPLIED||No|
|scale||Specifies a percentage by which to scale the image in the
absence of any specified image height or width; a value of 100 implies that the
image should be presented at its intrinsic size. If a value has been specified
for this image's height or width attribute (or both), the scale attribute is
It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation may (but need not) give an error message and may (but need not) recover by ignoring this attribute.
|scalefit||Allow an image to be scaled to fit within available space.
If, for a given image, any one of height, width, or scale is specified, those
attributes determine the graphic size, and any setting of scalefit is ignored.
If none of those attributes are specified and scalefit="yes", then the image is
scaled (the same factor in both dimensions) so that the graphic will just fit
within the available height or width (whichever is more constraining).
The available width would be the prevailing column (or table cell) width--that is, the width a paragraph of text would have if the graphic were a paragraph instead. The available height is implementation dependent, but if feasible, it is suggested to be the page (or table cell) height or some other reasonable value.
|(yes | no | -dita-use-conref-target)||#IMPLIED||No|
|placement||Indicates whether an image should be displayed inline or separated from the surrounding text. The processing default is inline. Allowable values are: inline or break. See Using the -dita-use-conref-target value for more information on the -dita-use-conref-target value.||(inline | break | -dita-use-conref-target)||inline||No|
|alt (deprecated)||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 (deprecated)||A reference to a textual description of the graphic or object. This attribute supports creating accessible content. See The href attribute for detailed information on supported values and processing implications. For examples of how this attribute is used in output, see this this topic on long descriptions. NOTE: This attribute is deprecated in favor of the longdescref subelement to this element.||CDATA||#IMPLIED||No|
|univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)||A set of related attributes, described in univ-atts attribute group|
|global-atts attribute group (xtrf, xtrc)||A set of related attributes, described in global-atts attribute group|
|class, outputclass, keyref||Keyref provides a redirectable reference based on a key defined within a map. See The keyref attribute for information on using this attribute. Class and outputclass are described in Other common DITA attributes|