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

---

ComputerOutput

Name

ComputerOutput -- Data, generally text, displayed or presented by a computer

Synopsis

Mixed Content Model

ComputerOutput ::=
((#PCDATA|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|Comment|Subscript|Superscript|InlineGraphic|
  InlineMediaObject|IndexTerm)+)

Attributes

Common attributes

Name	Type	Default
MoreInfo	Enumeration: None RefEntry	"None"

Tag Minimization

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

Parameter Entities

%cptr.char.mix;	%ndxterm.char.mix;	%para.char.mix;
%programlisting.content;	%refinline.char.mix;	%refname.char.mix;
%screen.content;	%tbl.entry.mdl;	%tech.char.class;
%title.char.mix;

Description

ComputerOutput identifies lines of text generated by a computer program (messages, results, or other output).

Note that ComputerOutput is not a verbatim environment, but an inline.

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information. It’s often presented 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 ComputerOutput: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, entry, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Interface, InterfaceDefinition, KeyCap, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Member, MsgAud, OLink, Option, Optional, Para, Parameter, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Property, Quote, RefDescriptor, RefEntryTitle, RefName, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput.

Children

The following elements occur in ComputerOutput: Action, Anchor, Application, ClassName, Command, Comment, ComputerOutput, Constant, Database, Email, EnVar, ErrorCode, ErrorName, ErrorType, Filename, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, IndexTerm, InlineGraphic, InlineMediaObject, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, MouseButton, MsgText, OLink, Option, Optional, Parameter, Prompt, Property, Replaceable, ReturnValue, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Type, ULink, UserInput, VarName.

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

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

Attributes

MoreInfo

If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the ComputerOutput.

See Also

Constant, EnVar, Filename, LineAnnotation, Literal, LiteralLayout, Markup, Option, Optional, Parameter, ProgramListing, Prompt, Replaceable, Screen, ScreenShot, SGMLTag, Synopsis, SystemItem, UserInput, VarName

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
The output from the date command,
<computeroutput>Sun  Nov 16, 1997  21:03:29</computeroutput>,
uses fixed-width fields so that it can easily be parsed.
</para>

The output from the date command, Sun Nov 16, 1997 21:03:29, uses fixed-width fields so that it can easily be parsed.

---

Prev	Home	Next
Comment	Up	ConfDates

Back to: DocBook: The Definitive Guide