DocBook 5: The Definitive Guide

Name

screenco — A screen with associated areas used in callouts

Synopsis

screenco ::= (info? ^{db.titleforbidden.info}, areaspec, screen, calloutlist*)

Attribute synopsis

Common attributes and common linking attributes.

Description

The callouts, such as numbered bullets, are an annotation mechanism. In an online system, these bullets are frequently “hot,” and clicking on them navigates to the corresponding annotation.

A screenco is a wrapper around an areaspec and a screen. An areaspec identifies the locations (coordinates) in the screen where the callouts occur. The screenco may also contain the list of annotations in a calloutlist, although the calloutlist may also occur outside of the wrapper, elsewhere in the document.

It is also possible to embed co elements directly in the verbatim text, in order to avoid the overhead of calculating the correct coordinates. If you decide to follow this route, use a screen and a calloutlist without the screenco wrapper. A screenco must specify at least one coordinate.

For a complete description of callouts, see callout.

Processing expectations

Formatted as a displayed block. This element is displayed “verbatim”; whitespace and line breaks within this element are significant.

The mandatory processing expectations of a screenco are minimal: a system is expected to render the program listing and the callout list, if present.

If explicit co elements are embedded in a screen, they must generate appropriate callout marks.

In online environments, the processing system ...