DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

Step

Name

Step -- A unit of action in a procedure

Synopsis

Content Model

Step ::=
(Title?,
 (((CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList|
    SimpleList|VariableList|Caution|Important|Note|Tip|Warning|
    LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO|
    ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|FormalPara|Para|
    SimPara|Address|BlockQuote|Graphic|GraphicCO|MediaObject|
    MediaObjectCO|InformalEquation|InformalExample|InformalFigure|
    InformalTable|Equation|Example|Figure|Table|MsgSet|Procedure|
    Sidebar|QandASet|Anchor|BridgeHead|Comment|Highlights|
    Abstract|AuthorBlurb|Epigraph|IndexTerm)+,
   (SubSteps,
    (CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList|
     SimpleList|VariableList|Caution|Important|Note|Tip|Warning|
     LiteralLayout|ProgramListing|ProgramListingCO|Screen|
     ScreenCO|ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|
     FormalPara|Para|SimPara|Address|BlockQuote|Graphic|GraphicCO|
     MediaObject|MediaObjectCO|InformalEquation|InformalExample|
     InformalFigure|InformalTable|Equation|Example|Figure|Table|
     MsgSet|Procedure|Sidebar|QandASet|Anchor|BridgeHead|Comment|
     Highlights|Abstract|AuthorBlurb|Epigraph|IndexTerm)*)?)|
  (SubSteps,
   (CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList|
    SimpleList|VariableList|Caution|Important|Note|Tip|Warning|
    LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO|
    ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|FormalPara|Para|
    SimPara|Address|BlockQuote|Graphic|GraphicCO|MediaObject|
    MediaObjectCO|InformalEquation|InformalExample|InformalFigure|
    InformalTable|Equation|Example|Figure|Table|MsgSet|Procedure|
    Sidebar|QandASet|Anchor|BridgeHead|Comment|Highlights|
    Abstract|AuthorBlurb|Epigraph|IndexTerm)*)))

Attributes

Common attributes

Name

Type

Default

Performance

Enumeration:

Optional
Required

"Required"

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

A Step identifies a unit of action in a Procedure. If a finer level of granularity is required for some steps, you can embed SubSteps in a Step. Embedded SubSteps contain Steps, so that substeps can be nested to any depth.

Processing expectations

Formatted as a displayed block. Steps are almost always numbered.

Parents

These elements contain Step: Procedure, SubSteps.

Children

The following elements occur in Step: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, QandASet, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, SubSteps, Synopsis, Table, Tip, Title, VariableList, Warning.

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

In some contexts, the following elements are excluded: Caution, Equation, Example, Figure, Important, IndexTerm, InformalTable, Note, Table, Tip, Warning.

Attributes

Performance

Performance specifies whether particular Step in a Procedure must be performed or is optional.

Examples

For examples, see Procedure.

PrevHomeNext
StateUpStreet

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.