DocBook: The Definitive Guide By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
Prev		Next

---

Screen

Name

Screen -- Text that a user sees or might see on a computer screen

Synopsis

Mixed Content Model

Screen ::=
((CO|LineAnnotation|#PCDATA|FootnoteRef|XRef|Abbrev|Acronym|
  Citation|CiteRefEntry|CiteTitle|Emphasis|FirstTerm|
  ForeignPhrase|GlossTerm|Footnote|Phrase|Quote|Trademark|
  WordAsWord|Link|OLink|ULink|Action|Application|ClassName|
  Command|ComputerOutput|Database|Email|EnVar|ErrorCode|ErrorName|
  ErrorType|Filename|Function|GUIButton|GUIIcon|GUILabel|GUIMenu|
  GUIMenuItem|GUISubmenu|Hardware|Interface|InterfaceDefinition|
  KeyCap|KeyCode|KeyCombo|KeySym|Literal|Constant|Markup|
  MediaLabel|MenuChoice|MouseButton|MsgText|Option|Optional|
  Parameter|Prompt|Property|Replaceable|ReturnValue|SGMLTag|
  StructField|StructName|Symbol|SystemItem|Token|Type|UserInput|
  VarName|Anchor|Author|AuthorInitials|CorpAuthor|ModeSpec|
  OtherCredit|ProductName|ProductNumber|RevHistory|Comment|
  Subscript|Superscript|InlineGraphic|InlineMediaObject|
  InlineEquation|Synopsis|CmdSynopsis|FuncSynopsis|IndexTerm)+)

Attributes

Common attributes

Name	Type	Default
Width	NUMBER	None
Format	Enumerated notation: linespecific	"linespecific"

Tag Minimization

Both the start- and end-tags are required for this element.

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;	%sidebar.mix;
%tabentry.mix;	%tbl.entry.mdl;	%textobject.mix;

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 linebreaks within this element are significant. Screens are usually displayed in a fixed width font.

 Future Changes

The InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.

Parents

These elements contain Screen: Answer, Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Caption, Caution, Chapter, Colophon, 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, ScreenCO, Sect1, Sect2, Sect3, Sect4, Sect5, Section, SetIndex, Sidebar, SimpleSect, Step, TextObject, Tip, Warning.

Children

The following elements occur in Screen: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, CmdSynopsis, CO, Command, Comment, ComputerOutput, Constant, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, FuncSynopsis, Function, GlossTerm, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, IndexTerm, InlineEquation, InlineGraphic, InlineMediaObject, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, LineAnnotation, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, Synopsis, SystemItem, Token, Trademark, Type, ULink, UserInput, VarName, WordAsWord, XRef.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: Acronym, Footnote, IndexTerm.

Attributes

Format

The Format attribute applies the linespecific notation to all Screens. All white space and line breaks must be preserved.

Width

Width specifies the width (in characters) of the longest line in this Screen (formatters may use this value to determine scaling or rotation).

See Also

ComputerOutput, LineAnnotation, LiteralLayout, ProgramListing, ScreenShot, Synopsis, UserInput

Examples

<!DOCTYPE screen PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<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>

 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

For additional examples, see also LineAnnotation, ScreenCO.

---

Prev	Home	Next
SBR	Up	ScreenCO

Back to: DocBook: The Definitive Guide