File: refentry.xml

package info (click to toggle)
docbook-defguide 2.0.17%2Bsvn9912-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 93,432 kB
  • ctags: 299
  • sloc: xml: 396,482; perl: 4,471; python: 879; makefile: 150; sh: 80
file content (62 lines) | stat: -rw-r--r-- 1,621 bytes parent folder | download | duplicates (8)
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
<refentry id="substeps.element">
<?dbhtml filename="substeps.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>

<refmeta>
<indexterm><primary>elements</primary>
<secondary>substeps</secondary></indexterm>
<refentrytitle>substeps</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>substeps</refname>
<refpurpose>&substeps.purpose;</refpurpose>
</refnamediv>

&substeps.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>

<para>
A <sgmltag>Procedure</sgmltag> describes a sequence of
<sgmltag>Step</sgmltag>s that a reader is expected to perform.  If a
finer level of granularity is required for some steps, you can
use <sgmltag>SubSteps</sgmltag> to embed substeps within a
<sgmltag>Step</sgmltag>.
</para>
<para>
<sgmltag>SubSteps</sgmltag> contain <sgmltag>Step</sgmltag>s, so substeps can
be nested to any depth.
</para>

<refsect2><title>Processing expectations</title>
<para>
&format.block; <sgmltag>SubStep</sgmltag>s are almost always numbered.
</para>
</refsect2>


&substeps.parents.gen;
&substeps.children.gen;
</refsect1>
<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>performance</term>
<listitem>
<para>
<sgmltag class="attribute">Performance</sgmltag> specifies whether 
particular set of <sgmltag>Substep</sgmltag> in a <sgmltag>Procedure</sgmltag> must 
be performed or is optional.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Examples</title>

&substeps.example.seealso.gen;
</refsect1>
</refentry>