1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
<refentry id="procedure.element">
<?dbhtml filename="procedure.html"?>
<refentryinfo>
<pubdate>$Date: 2004-05-19 17:56:44 +0200 (Wed, 19 May 2004) $</pubdate>
<releaseinfo>$Revision: 3588 $</releaseinfo>
</refentryinfo>
<refmeta>
<indexterm><primary>elements</primary>
<secondary>procedure</secondary></indexterm>
<refentrytitle>procedure</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>procedure</refname>
<refpurpose>&procedure.purpose;</refpurpose>
</refnamediv>
&procedure.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>
<para>A <sgmltag>Procedure</sgmltag> encapsulates a task composed of
<sgmltag>Step</sgmltag>s (and possibly, <sgmltag>SubSteps</sgmltag>).
Procedures are usually performed sequentially, unless individual
<sgmltag>Step</sgmltag>s direct the reader explicitly.
</para>
<para>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.
</para>
<para>The <sgmltag>task</sgmltag> element, added to DocBook in V4.3, provides
some of this infrastructure.</para>
<refsect2><title>Processing expectations</title>
<para>
&format.block;
</para>
</refsect2>
&procedure.parents.gen;
&procedure.children.gen;
</refsect1>
<refsect1><title>Examples</title>
<informalexample role="example-source">
<programlisting>&procedure.example.1.txt;</programlisting>
</informalexample>
<anchor id="ex.os.procedure.1" role="HACK-ex.out.start"/>
&procedure.example.1.gen;
<anchor id="ex.oe.procedure.1" role="HACK-ex.out.end"/>
&procedure.example.seealso.gen;
</refsect1>
</refentry>
|
