    | DocBook: The Definitive Guide 2.0.10 (Alpha) |
| | DocBook: The Definitive Guide 2.0.10 (Alpha) |
$Revision: 1.4 $
$Date: 2004/05/19 15:56:41 $
procedure — A list of operations to be performed in a well-defined sequence
procedure ::= (blockinfo?, (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|task| productionset|constraintdef|anchor|bridgehead|remark|highlights| abstract|authorblurb|epigraph|indexterm|beginpage)*, step+)
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 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.
The task element, added to DocBook in V4.3, provides some of this infrastructure.
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, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, task, taskprerequisites, taskrelated, tasksummary, tip, warning.
The following elements occur in procedure: abstract, address, anchor, authorblurb, beginpage, blockinfo, 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, task, tip, title, titleabbrev, variablelist, warning.
<!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
A Step
Another Step
Substeps can be nested indefinitely deep.
A Final Step
| | | |
| printhistory | | production |