procedure
procedure — A list of operations to be performed in a well-defined sequence.
Synopsis
procedure ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Sequence of:
- One of:
- Zero or more of:
bridgeheaddialoguedramapoetryremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
- List elements
- Paragraph elements
- Publishing elements
- Technical elements
- Verbatim elements
- One or more of:
- One of:
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
<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>
A Step
Another Step
Substeps can be nested indefinitely deep.
A Final Step