Next Up Previous Contents
Next: C.1.33 Element figurecontent
Up: C.1 Element listing
Previous: C.1.31 Element entry
[ID index][Keyword index]

C.1.32 Element figure

C.1.32.1 Description

A figure. The content of the figure, in the figurecontent elements, may be text or an image of some sort. The application will generate a figure number, and attach it to the figure caption supplied.

You specify the content of the figure by providing zero or more figurecontent elements, possibly followed by a single block of paragraphs of text. These are alternatives, so they might indicate the same figure as a EPS file and as a GIF. Because not all formats are appropriate to all media, it is up to the formatting application to select one of these alternatives and use that as the effective content of the figure.

Note that there are no formats which a formatter is required to recognise, so it is worthwhile providing a respectable spread of formats. Also there is at least one format (MetaPost) which no formatter presently recognises. Even in this case, it is worthwhile including a reference to such a `source' format, since the declaration will help keep the source for a figure associated with its result. If there are other formats you think should be declared here, please do suggest them.

For an example, see the documentation for the figurecontent element.

C.1.32.2 Parents

docbody, sect, subsect, subsubsect, subsubsubsect

C.1.32.3 Content

(update * , caption , figurecontent * , px * )

figure
 |_(update*,
 |__caption,
 |__figurecontent*,
 |__px*)

C.1.32.4 Attribute figure/alt

An alternative text for the content, displayed if the figure content cannot be shown. This is extremely useful in an online presentation of an image, if the final reader of the text cannot, or will not, use images.

C.1.32.5 Attribute figure/float

If the float attribute is present and has value `float', then the table may be moved to a more suitable place in the document, if this would help to avoid an ugly pagebreak, for example. If the attribute is missing or has the value `nofloat', then it is pinned to its current location.

C.1.32.6 Attribute figure/id

An ID which may be used to refer to this figure in references.

C.1.32.7 Attribute figure/export

If the export attribute is present, then it will be permitted for the ID to be referred to from outside this document.


Next Up Previous Contents
Next: C.1.33 Element figurecontent
Up: C.1 Element listing
Previous: C.1.31 Element entry
[ID index][Keyword index]
The Starlink SGML Set
Starlink System Note 70
Norman Gray, Mark Taylor
21 April 1999. Release DR-0.7-13. Last updated 24 August 2001