Reference. Reference for the DocBook DTD

[Prev] [Next]


Area

Name

Area---Region defined in a graphic or code example

Synopsis

Content Model
  EMPTY

Attributes

This element has common and Role attributes.

Name Value(s) Type Default Value
Coords CDATA #REQUIRED  
Label CDATA #IMPLIED  
Linkends IDREFS #IMPLIED  
OtherUnits NAME #IMPLIED  
Units (CALSPair |LineColumn |LineRange |LineColumnPair |Other) #IMPLIED  

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

Area is an empty element holding information about a region, usually one- or two-dimensional, defined in a graphic or code example so that a callout description can be attached to it. It has optional Label, Units, and OtherUnits attributes, a required Coords attribute, and common attributes with ID required.

Parents

These elements contain Area: AreaSet, and AreaSpec.

Attributes

Label

Label holds an identifying number or string to be output in some manner when the element it is applied to is rendered.

Linkends

IDs of targets pointed to by this element.

Units

The default is implementation-specific and is dependent on the parent element (CALSPair for GraphicCO, LineColumn for ProgramListingCO and ScreenCO).

OtherUnits

OtherUnits holds the name of user-defined units to be used instead of a conventional selection from the values of the Units attribute.

Coords

Coords gives the coordinates for the Area or AreaSet in the format defined by the Units or OtherUnits attributes.

Examples

<PROGRAMLISTINGCO>
<AREASPEC UNITS="LINECOLUMN">
<AREA ID="sco123" COORDS="1 1">
<AREA ID="sco124" COORDS="6 9">
</AREASPEC>
<PROGRAMLISTING>
<SYSTEMITEM CLASS="PROMPT">%</SYSTEMITEM> <USERINPUT>make install</USERINPUT>
install -c -m 0644 rgb.txt /usr/lib/X11
install -c -m 0644 rgb.dir /usr/lib/X11
install -c -m 0644 rgb.pag /usr/lib/X11
install -c -s showrgb /usr/lib/X11
install in ./rgb done
</PROGRAMLISTING>
<CALLOUTLIST>
<TITLE>Comments on the Screen Shown Above</TITLE>
<CALLOUT AREAREFS="sco123">
<PARA>Note % prompt.</PARA>
</CALLOUT>
<CALLOUT AREAREFS="sco124">
<PARA>Note use of install without flag.
</PARA>
</CALLOUT>
</CALLOUTLIST>
</PROGRAMLISTINGCO>
<GRAPHICCO>
<AREASPEC UNITS="CALSPAIR">
<AREA ID="co123" LABEL="1" COORDS="100,100 550,935">
<AREA ID="co124" LABEL="2" COORDS="1500,1500 2175,3184">
</AREASPEC>
<GRAPHIC FILEREF="gr061ch05t2.gif" FORMAT="GIF"></GRAPHIC>
<CALLOUTLIST>
<TITLE>Comments on the Picture Above</TITLE>
<CALLOUT AREAREFS="co123">
<PARA>A bit too far down and left</PARA>
</CALLOUT>
<CALLOUT AREAREFS="co124">
<PARA>This is the most interesting part of the diagram.
</PARA>
</CALLOUT>
</CALLOUTLIST>
</GRAPHICCO>
<SCREENCO>
<AREASPEC UNITS="LINECOLUMN">
<AREA ID="sco123" COORDS="1 1">
<AREA ID="sco124" COORDS="6 9">
</AREASPEC>
<SCREEN ID="SC-1015-12-24" WIDTH="44">
<SYSTEMITEM CLASS="PROMPT">%</SYSTEMITEM> <USERINPUT>make install</USERINPUT>
install -c -m 0644 rgb.txt /usr/lib/X11
install -c -m 0644 rgb.dir /usr/lib/X11
install -c -m 0644 rgb.pag /usr/lib/X11
install -c -s showrgb /usr/lib/X11
install in ./rgb done
</SCREEN>
<CALLOUTLIST>
<TITLE>Comments on the Screen Shown Above</TITLE>
<CALLOUT AREAREFS="sco123">
<PARA>Note % prompt.</PARA>
</CALLOUT>
<CALLOUT AREAREFS="sco124">
<PARA>Note use of install without flag.
</PARA>
</CALLOUT>
</CALLOUTLIST>
</SCREENCO>


[Prev] arch.attrib
[Next] AreaSet
[Reference Home] [Davenport Group Home]