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

screen

screen — Text that a user sees or might see on a computer screen.

Synopsis

screen ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • All of:
    • continuation (enumeration)
      • “continues”
      • “restarts”
    • linenumbering (enumeration)
      • “numbered”
      • “unnumbered”
    • startinglinenumber (integer)
    • xml:space (enumeration)
      • “preserve”
    • language
  • width (nonNegativeInteger)

Additional Constraints

  • If this element is the root element, it must have a version attribute.

Description

A screen is a verbatim environment for displaying text that the user might see on a computer terminal. It is often used to display the results of a command.

Having less specific semantic overtones, screen is often used wherever a verbatim presentation is desired, but the semantic of programlisting is inappropriate.

Processing expectations

This element is displayed “verbatim”; whitespace and line breaks within this element are significant. The content of a screen element is usually displayed in a fixed-width font.

Attributes

Common attributes and common linking attributes.

continuation

Determines whether line numbering continues from the previous element or restarts.

Enumerated values:
“continues”

Line numbering continues from the immediately preceding element with the same name.

“restarts”

Line numbering restarts (begins at 1, usually).

language

Identifies the language (i.e. programming language) of the verbatim content.

linenumbering

Determines whether lines are numbered.

Enumerated values:
“numbered”

Lines are numbered.

“unnumbered”

Lines are not numbered.

startinglinenumber

Specifies the initial line number.

width

Specifies the width (in characters) of the element

xml:space

Can be used to indicate explicitly that whitespace in the verbatim environment is preserved. Whitespace must always be preserved in verbatim environments whether this attribute is specified or not.

Enumerated values:
“preserve”

Whitespace must be preserved.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example screen</title>

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

10/17/97   9:04         &lt;DIR&gt;    bin
10/16/97  14:11         &lt;DIR&gt;    DOS
10/16/97  14:40         &lt;DIR&gt;    Program Files
10/16/97  14:46         &lt;DIR&gt;    TEMP
10/17/97   9:04         &lt;DIR&gt;    tmp
10/16/97  14:37         &lt;DIR&gt;    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
</screen>

</article>

 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