procedure — A list of operations to be performed in a well-defined sequence
procedure ::=
address
anchor
annotation
bibliolist
blockquote
bridgehead
calloutlist
caution
classsynopsis
cmdsynopsis
constraintdef
constructorsynopsis
destructorsynopsis
epigraph
equation
example
fieldsynopsis
figure
formalpara
funcsynopsis
glosslist
html:form
important
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)informalequation
informalexample
informalfigure
informaltable
(db.cals.informaltable)informaltable
(db.html.informaltable)itemizedlist
literallayout
mediaobject
methodsynopsis
msgset
note
orderedlist
para
procedure
productionset
programlisting
programlistingco
qandaset
remark
revhistory
screen
screenco
screenshot
segmentedlist
sidebar
simpara
simplelist
synopsis
table
(db.cals.table)table
(db.html.table)task
tip
variablelist
warning
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.
The task
element, added to DocBook in V4.3, provides
some of this infrastructure.
These elements contain procedure
: annotation
, answer
, appendix
, article
, bibliodiv
, bibliography
, bibliolist
, blockquote
, callout
, calloutlist
, caption
(db.caption), caution
, chapter
, colophon
, constraintdef
, dedication
, entry
, example
, figure
, footnote
, glossary
, glossdef
, glossdiv
, glosslist
, html:fieldset
, html:form
, important
, index
, indexdiv
, informalexample
, informalfigure
, itemizedlist
, legalnotice
, listitem
, msgexplan
, msgtext
, note
, orderedlist
, para
, 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
, td
, textobject
, th
, tip
, toc
, tocdiv
, variablelist
, warning
.
The following elements occur in procedure: address
, anchor
, annotation
, bibliolist
, blockquote
, bridgehead
, calloutlist
, caution
, classsynopsis
, cmdsynopsis
, constraintdef
, constructorsynopsis
, destructorsynopsis
, epigraph
, equation
, example
, fieldsynopsis
, figure
, formalpara
, funcsynopsis
, glosslist
, html:form
, 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
(db.cals.informaltable), informaltable
(db.html.informaltable), itemizedlist
, literallayout
, mediaobject
, methodsynopsis
, msgset
, note
, orderedlist
, para
, procedure
, productionset
, programlisting
, programlistingco
, qandaset
, remark
, revhistory
, screen
, screenco
, screenshot
, segmentedlist
, sidebar
, simpara
, simplelist
, step
, synopsis
, table
(db.cals.table), table
(db.html.table), task
, tip
, title
, titleabbrev
, variablelist
, warning
.
<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>