screenco
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# screenco

## Name

screenco — A screen with associated areas used in callouts

##

# Synopsis

### Content Model

    screenco ::=
    (areaspec,screen,calloutlist*)

### Attributes

Common attributes

### Parameter Entities

The following parameter entities contain screenco:

Parameter Entities
`%admon.mix;` | `%bookcomponent.content;` | `%component.mix;`
`%divcomponent.mix;` | `%example.mix;` | `%figure.mix;`
`%footnote.mix;` | `%glossdef.mix;` | `%indexdivcomponent.mix;`
`%legalnotice.mix;` | `%linespecific.class;` | `%para.mix;`
`%qandaset.mix;` | `%refcomponent.mix;` | `%revdescription.mix;`
`%sidebar.mix;` | `%tabentry.mix;` | `%tbl.entry.mdl;`
`%textobject.mix;` |  |

## Description

`Callout`s, 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 linebreaks 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 may be able to instantiate the linking relationships between the callout marks in the program listing and the annotations. Some systems may even be able to go a step further and generate the callout marks automatically from the coordinate information, but this level of sophistication is not mandatory.

### Parents

These elements contain screenco: `answer`, `appendix`, `article`, `bibliodiv`, `bibliography`, `blockquote`, `callout`, `caption`, `caution`, `chapter`, `colophon`, `constraintdef`, `dedication`, `entry`, `example`, `figure`, `footnote`, `glossary`, `glossdef`, `glossdiv`, `important`, `index`, `indexdiv`, `informalexample`, `informalfigure`, `legalnotice`, `listitem`, `msgexplan`, `msgtext`, `note`, `para`, `partintro`, `preface`, `procedure`, `qandadiv`, `qandaset`, `question`, `refsect1`, `refsect2`, `refsect3`, `refsynopsisdiv`, `revdescription`, `sect1`, `sect2`, `sect3`, `sect4`, `sect5`, `section`, `setindex`, `sidebar`, `simplesect`, `step`, `textobject`, `tip`, `warning`.

### Children

The following elements occur in screenco: `areaspec`, `calloutlist`, `screen`.

## See Also

`areaspec`, `calloutlist`, `co`, `graphicco`, `imageobjectco`, `mediaobjectco`, `programlistingco`.

## Examples

    <!DOCTYPE informalexample PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <informalexample>
    <screen>
     Volume in drive C is SYSTEM         Serial number is 2350:717C
     Directory of  C:\

    10/17/97   9:04         &lt;DIR>    bin
    10/16/97  14:11         &lt;DIR>    DOS            <co id="dos"/>
    10/16/97  14:40         &lt;DIR>    Program Files
    10/16/97  14:46         &lt;DIR>    TEMP
    10/17/97   9:04         &lt;DIR>    tmp
    10/16/97  14:37         &lt;DIR>    WINNT
    10/16/97  14:25             119  AUTOEXEC.BAT   <co id="autoexec.bat"/>
     2/13/94   6:21          54,619  COMMAND.COM    <co id="command.com"/>
    10/16/97  14:25             115  CONFIG.SYS     <co id="config.sys"/>
    11/16/97  17:17      61,865,984  pagefile.sys
     2/13/94   6:21           9,349  WINA20.386     <co id="wina20.386"/>
    </screen>
    <calloutlist>
    <callout arearefs="dos">
    <para>
    This directory holds <trademark>MS-DOS</trademark>, the
    operating system that was installed before <trademark>Windows
    NT</trademark>.
    </para>
    </callout>

    <callout arearefs="autoexec.bat command.com config.sys">
    <para>
    System startup code for DOS.
    </para>
    </callout>

    <callout arearefs="wina20.386">
    <para>
    Some sort of <trademark>Windows 3.1</trademark> hack for some 386 processors,
    as I recall.
    </para>
    </callout>
    </calloutlist>
    </informalexample>

     Volume in drive C is SYSTEM         Serial number is 2350:717C
     Directory of  C:\

    10/17/97   9:04         <DIR>    bin
    10/16/97  14:11         <DIR>    DOS
    10/16/97  14:40         <DIR>    Program Files
    10/16/97  14:46         <DIR>    TEMP
    10/17/97   9:04         <DIR>    tmp
    10/16/97  14:37         <DIR>    WINNT
    10/16/97  14:25             119  AUTOEXEC.BAT
     2/13/94   6:21          54,619  COMMAND.COM
    10/16/97  14:25             115  CONFIG.SYS
    11/16/97  17:17      61,865,984  pagefile.sys
     2/13/94   6:21           9,349  WINA20.386

| This directory holds MS-DOS™, the operating system that was installed before Windows NT™.
| System startup code for DOS.
| Some sort of Windows 3.1™ hack for some 386 processors, as I recall.

For additional examples, see also `screen` .

Prev | Home | Next
screen | Up | screeninfo

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.