procedure

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

Synopsis

procedure ::= [-]

Description

A procedure encapsulates a task composed of steps (and possibly, substeps). Procedures are usually performed sequentially, unless individual steps direct the reader explicitly.

Often it is important to ensure 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 preconditions in the first step and the results in the last step), or described outside the body of the procedure.

The task element, added to DocBook in V4.3, provides some of this infrastructure.

Processing expectations

Formatted as a displayed block.

Children

The following elements occur in procedure: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, caution, danger, db:stagedir, dialogue, drama, epigraph, equation, example, figure, formalpara, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.info), informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, note, orderedlist, para, poetry, procedure, qandaset, remark, result, revhistory, sidebar, simpara, simplelist, step, table, task, tip, title, titleabbrev, variablelist, warning.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example procedure</title>

<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>

</article>
An Example Procedure
  1. A Step

  2. Another Step

    1. Substeps can be nested indefinitely deep.

  3. A Final Step

Last revised by Norman Walsh on (git hash: c3457cab689d8fd89ba4252de204cf9a14e40acd 6a501344525f32f9834f0e4a5c3c3f8131803fa4 47fe34b28bad7941a61b9c1c17d47f6eed36cd04)