Home Prev Up NextDocBook 5: The Definitive Guide (Version 1.0.4 for DocBook V5.0)

screen

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

Synopsis

Attributes

Common attributes and common linking attributes.

Additional attributes:

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

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.

Parents [+]

This element occurs in 74 elements.

Children [+]

This element contains 104 elements.

See Also

computeroutput, lineannotation, literallayout, programlisting, screenshot, synopsis, userinput

Examples

  1 <article xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example screen</title>
    
  4 <screen>
     Volume in drive C is SYSTEM         Serial number is 2350:717C
  6  Directory of  C:\
    
  8 10/17/97   9:04         &lt;DIR&gt;    bin
    10/16/97  14:11         &lt;DIR&gt;    DOS
 10 10/16/97  14:40         &lt;DIR&gt;    Program Files
    10/16/97  14:46         &lt;DIR&gt;    TEMP
 12 10/17/97   9:04         &lt;DIR&gt;    tmp
    10/16/97  14:37         &lt;DIR&gt;    WINNT
 14 10/16/97  14:25             119  AUTOEXEC.BAT
     2/13/94   6:21          54,619  COMMAND.COM
 16 10/16/97  14:25             115  CONFIG.SYS
    11/16/97  17:17      61,865,984  pagefile.sys
 18  2/13/94   6:21           9,349  WINA20.386
    </screen>
 20 
    </article>
  1 
  2  Volume in drive C is SYSTEM         Serial number is 2350:717C
     Directory of  C:\
  4 
    10/17/97   9:04         <DIR>    bin
  6 10/16/97  14:11         <DIR>    DOS
    10/16/97  14:40         <DIR>    Program Files
  8 10/16/97  14:46         <DIR>    TEMP
    10/17/97   9:04         <DIR>    tmp
 10 10/16/97  14:37         <DIR>    WINNT
    10/16/97  14:25             119  AUTOEXEC.BAT
 12  2/13/94   6:21          54,619  COMMAND.COM
    10/16/97  14:25             115  CONFIG.SYS
 14 11/16/97  17:17      61,865,984  pagefile.sys
     2/13/94   6:21           9,349  WINA20.386
Prev Home Next
sbr Up screenco
Last revised by Norman Walsh on 6 Jun 2011 (git hash: 6ffcc7640bbc5f852a318e452c9f210f03292cb9)

Copyright © 2010, 2011 Norman Walsh.