<hazardsymbol>

The <hazardsymbol> element specifies a graphic. The graphic might represent a hazard, a hazardous situation, a result of not avoiding a hazard, or any combination of these messages.

Usage information

When a <hazardsymbol> element is directly contained by <messagepanel>, the <hazardsymbol> is assumed to be associated with the <typeofhazard> element. Otherwise, the image is associated with the containing element.

Rendering expectations

Processors SHOULD scale the object when values are provided for the @height and @width attributes. The following expectations apply:
  • If a height value is specified and no width value is specified, processors SHOULD scale the width by the same factor as the height.
  • If a width value is specified and no height value is specified, processors SHOULD scale the height by the same factor as the width.
  • If both a height value and width value are specified, implementations MAY ignore one of the two values when they are unable to scale to each direction using different factors.

Specialization hierarchy

The <hazardsymbol> element is specialized from <image>. It is defined in the hazard-statement domain module.

Content model

<alt> ?, <longdescref> ?

In order
  1. Optional <alt>
  2. Optional <longdescref>

Attributes

The following attributes are available on this element: universal attributes, @format, @href, @keyref, @scope, and the attributes defined below.

@align
Specifies the horizontal alignment of an image when placement is specified as break. Common values include left, right, and center.
@height
Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.
@placement
Specifies whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are: inline, break, and -dita-use-conref-target.
@scale
Specifies a percentage as an unsigned integer 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 the @height or @width attribute (or both), the @scale attribute is ignored.

It is an error if the value of this attribute is not an unsigned integer. In this case, the implementation might give an error message and might recover by ignoring this attribute.

@scalefit
Specifies whether an image is scaled up or down to fit within available space. Allowable values are yes, no, and -dita-use-conref-target. For a given image, if 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 by 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.

@width
Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.

For this element, @href specifies an image.

Example

The following code sample defines a hazard statement that specifies an image that illustrates the type of hazard:

<hazardstatement type="danger">
  <messagepanel>
    <typeofhazard>
      <hazardsymbol keyref="hazard-rotatingblade"/>
      Rotating blade</typeofhazard>
    <consequence>Moving parts can crush and cut.</consequence>
    <howtoavoid>Follow lockout procedure before servicing.</howtoavoid>
  </messagepanel>
</hazardstatement>