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

---

Hardware

Name

Hardware -- A physical part of a computer system

Synopsis

Mixed Content Model

Hardware ::=
((#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

Hardware identifies some physical component of a computer system. Even though DocBook provides a broad range of inlines for describing the various software components of a system, it provides relatively few for describing hardware.

If you need to identify a number of different hardware components, you may wish to consider extending DocBook, or at least using the Role attribute to further classify Hardware.

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.

 Future Changes

In DocBook V4.0, the content model of Hardware will be constrained to (#PCDATA | Replaceable | InlineGraphic).

Parents

These elements contain Hardware: 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 Hardware: 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 Hardware.

See Also

Application, Database, Filename, MediaLabel, ProductName

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
The <acronym>IRQ</acronym> of the <hardware>SCSI Controller</hardware>
can be set to 7, 11, or 15.  The factory default setting is 7.
</para>

The IRQ of the SCSI Controller can be set to 7, 11, or 15. The factory default setting is 7.

---

Prev	Home	Next
GUISubmenu	Up	Highlights

Back to: DocBook: The Definitive Guide