Home Prev Up Next DocBook Publishers: The Definitive Guide (Version 1.1.0 for DocBook Publishers V1.1 (based on DocBook V5.1b3))

procedure

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

Synopsis

Attributes

Common attributes and common linking attributes.

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.

Parents

These elements contain procedure: acknowledgements, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption, chapter, colophon, cover, dedication, dialogue, drama, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, index, informalexample, informalfigure, itemizedlist, legalnotice, linegroup, listitem, note, orderedlist, para, partintro, poetry, preface, procedure, qandadiv, qandaset, question, revdescription, section, setindex, sidebar, simplesect, step, task, taskprerequisites, taskrelated, tasksummary, textobject, toc, variablelist.

Children

The following elements occur in procedure: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, dialogue, drama, epigraph, equation, example, figure, formalpara, glosslist, 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, revhistory, sidebar, simpara, simplelist, step, table, task, title, titleabbrev, variablelist.

Examples

  1 <article xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example procedure</title>
    
  4 <procedure><title>An Example Procedure</title>
    <step>
  6   <para>    A Step
      </para>
  8 </step>
    <step>
 10   <para>    Another Step
      </para>
 12   <substeps>
        <step>
 14       <para>        Substeps can be nested indefinitely deep.
          </para>
 16     </step>
      </substeps>
 18 </step>
    <step>
 20   <para>    A Final Step
      </para>
 22 </step>
    </procedure>
 24 
    </article>

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  productname
Last revised by Norman Walsh on 6 Jun 2011 (git hash: 6ffcc7640bbc5f852a318e452c9f210f03292cb9)

Copyright © 2010, 2011 Norman Walsh.