3.2.4.1.15 glossSymbol

The <glossSymbol> element identifies a standard image associated with the subject of the <glossterm>.

Contains

Doctype

Content model

ditabase, glossary, glossentry, glossgroup

( (alt) (optional) then (longdescref) (optional) )

Contained by

Doctype

Content model

ditabase, glossary, glossentry, glossgroup

glossBody

Inheritance

- topic/image concept/image glossentry/glossSymbol

Example
<glossentry id="atlanticpuffin">
  <glossterm>Atlantic Puffin</glossterm>
  <glossdef>A sea bird that lives in the atlantic</glossdef>
  <glossBody>
    <glossSymbol href="puffinicon.jpg" scope="local">
      <alt>Atlantic puffin icon</alt>
    </glossSymbol>
  </glossBody>
</glossentry>
Attributes

Name

Description

Data Type

Default Value

Required?

href

Provides a reference to the image. See 3.4.2.1 The href attribute for detailed information on supported values and processing implications.

CDATA

#IMPLIED

Yes

scope

The scope attribute identifies the closeness of the relationship between the current document and the target resource. See 3.4.2.10 The scope attribute for more information on values.

(local | peer | external | -dita-use-​conref-​target)

#IMPLIED

No

longdescref (deprecated)

A reference to a textual description of the graphic or object. This attribute supports creating accessible content. See 3.4.2.1 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

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. If a width value is specified and no height value is specified, the height will be scaled by the same factor as the width.

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 ignored.

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.

NMTOKEN

#IMPLIED

No

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 3.4.2.4.1 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

univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)

A set of related attributes, described in 3.4.1.3 univ-atts attribute group

     

global-atts attribute group (xtrf, xtrc)

A set of related attributes, described in 3.4.1.2 global-atts attribute group

     

class, outputclass, keyref

Class and outputclass are described in 3.4.1.9 Other common DITA attributes

     

Previous Topic:  3.2.4.1.14 glossSurfaceForm

Next Topic:  3.2.4.1.16 glossSynonym

Parent Topic:  3.2.4.1 Glossentry elements

Sibling Topics:

3.2.4.1.1 glossentry

3.2.4.1.2 glossterm

3.2.4.1.3 glossdef

3.2.4.1.4 glossAbbreviation

3.2.4.1.5 glossAcronym

3.2.4.1.6 glossAlt

3.2.4.1.7 glossAlternateFor

3.2.4.1.8 glossBody

3.2.4.1.9 glossPartOfSpeech

3.2.4.1.10 glossProperty

3.2.4.1.11 glossScopeNote

3.2.4.1.12 glossShortForm

3.2.4.1.13 glossStatus

3.2.4.1.14 glossSurfaceForm

3.2.4.1.16 glossSynonym

3.2.4.1.17 glossUsage