DocBook 5.1: The Definitive Guide  (Version 1.5.3 for DocBook 5.1)

areaspec

areaspec — A collection of regions in a graphic or code example.

Synopsis

areaspec ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • Exactly one of:
    • units (enumeration)
      • “calspair”
      • “linecolumn”
      • “linecolumnpair”
      • “linerange”
    • Each of:
      • units (enumeration)
        • “other”
      • otherunits (NMTOKEN)

Required attributes are shown in bold.

Description

An areaspec holds a collection of regions and/or region sets in a graphic, program listing, or screen that are associated with callout descriptions. See area for a description of the attributes.

Processing expectations

Suppressed. This element provides data for processing but it is not expected to be rendered directly.

Attributes

Common attributes and common linking attributes.

otherunits

Identifies the units used in the coords attribute when the units attribute is “other” . This attribute is forbidden otherwise.

units

Identifies the units used in the coords attribute. The default units vary according to the type of callout specified: calspair for graphics and linecolumn for line-oriented elements.

Enumerated values:
“calspair”

Coordinates expressed as a pair of CALS graphic coordinates.

“linecolumn”

Coordinates expressed as a line and column.

“linecolumnpair”

Coordinates expressed as a pair of lines and columns.

“linerange”

Coordinates expressed as a line range.

Parents

These elements contain areaspec: imageobjectco, programlistingco, screenco.

Children

The following elements occur in areaspec: area (db.area), areaset.