procedure
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# procedure

## Name

procedure — A list of operations to be performed in a well-defined sequence

##

# Synopsis

### Content Model

    procedure ::=
    ((title,titleabbrev?)?,
     (calloutlist|glosslist|itemizedlist|orderedlist|segmentedlist|
      simplelist|variablelist|caution|important|note|tip|warning|
      literallayout|programlisting|programlistingco|screen|screenco|
      screenshot|synopsis|cmdsynopsis|funcsynopsis|classsynopsis|
      fieldsynopsis|constructorsynopsis|destructorsynopsis|
      methodsynopsis|formalpara|para|simpara|address|blockquote|
      graphic|graphicco|mediaobject|mediaobjectco|informalequation|
      informalexample|informalfigure|informaltable|equation|example|
      figure|table|msgset|procedure|sidebar|qandaset|productionset|
      constraintdef|anchor|bridgehead|remark|highlights|abstract|
      authorblurb|epigraph|indexterm|beginpage)*,
     step+)

### Attributes

Common attributes

### Parameter Entities

The following parameter entities contain procedure:

Parameter Entities
`%admon.mix;` | `%bookcomponent.content;` | `%component.mix;`
`%compound.class;` | `%divcomponent.mix;` | `%qandaset.mix;`
`%refcomponent.mix;` | `%revdescription.mix;` | `%sidebar.mix;`

## Description

A `Procedure` encapsulates a task composed of `Step`s (and possibly, `SubSteps`). Procedures are usually performed sequentially, unless individual `Step`s direct the reader explicitly.

Often it is important to assure that certain conditions exist before a procedure is performed, and that the outcome of the procedure matches the expected results. DocBook does not provide explicit semantic markup for these pre- and post-conditions. Instead, they must be described as steps (check the pre-conditions in the first step and the results in the last step), or described outside the body of the procedure.

### Processing expectations

Formatted as a displayed block.

### Parents

These elements contain procedure: `answer`, `appendix`, `article`, `bibliodiv`, `bibliography`, `blockquote`, `callout`, `caution`, `chapter`, `constraintdef`, `glossary`, `glossdiv`, `important`, `index`, `listitem`, `msgexplan`, `msgtext`, `note`, `partintro`, `preface`, `procedure`, `qandadiv`, `qandaset`, `question`, `refsect1`, `refsect2`, `refsect3`, `refsynopsisdiv`, `revdescription`, `sect1`, `sect2`, `sect3`, `sect4`, `sect5`, `section`, `setindex`, `sidebar`, `simplesect`, `step`, `tip`, `warning`.

### Children

The following elements occur in procedure: `abstract`, `address`, `anchor`, `authorblurb`, `beginpage`, `blockquote`, `bridgehead`, `calloutlist`, `caution`, `classsynopsis`, `cmdsynopsis`, `constraintdef`, `constructorsynopsis`, `destructorsynopsis`, `epigraph`, `equation`, `example`, `fieldsynopsis`, `figure`, `formalpara`, `funcsynopsis`, `glosslist`, `graphic`, `graphicco`, `highlights`, `important`, `indexterm`, `informalequation`, `informalexample`, `informalfigure`, `informaltable`, `itemizedlist`, `literallayout`, `mediaobject`, `mediaobjectco`, `methodsynopsis`, `msgset`, `note`, `orderedlist`, `para`, `procedure`, `productionset`, `programlisting`, `programlistingco`, `qandaset`, `remark`, `screen`, `screenco`, `screenshot`, `segmentedlist`, `sidebar`, `simpara`, `simplelist`, `step`, `synopsis`, `table`, `tip`, `title`, `titleabbrev`, `variablelist`, `warning`.

## Examples

    <!DOCTYPE procedure PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <procedure><title>An Example Procedure</title>
    <step>
      <para>
        A Step
      </para>
    </step>
    <step>
      <para>
        Another Step
      </para>
      <substeps>
        <step>
          <para>
            Substeps can be nested indefinitely deep.
          </para>
        </step>
      </substeps>
    </step>
    <step>
      <para>
        A Final Step
      </para>
    </step>
    </procedure>

Procedure 1. An Example Procedure

1. A Step

2. Another Step

   1. Substeps can be nested indefinitely deep.

3. A Final Step

Prev | Home | Next
printhistory | Up | production

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.