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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
<RefEntry ID="dbre.elem.SynopFragment">
<!-- Created by DTDParseRefentry version 0.94 -->
<!-- Consult http://www.ora.com/homepages/dtdparse/ -->
<!-- for more information. -->
<![ %dbre.ms.refmeta [
<RefMeta>
<IndexTerm><Primary>SynopFragment Element</Primary></IndexTerm>
<RefEntryTitle>SynopFragment</RefEntryTitle>
<RefMiscInfo>Element</RefMiscInfo>
</RefMeta>
]]>
<RefNameDiv>
<RefName>SynopFragment</RefName>
<RefPurpose>
Part of CmdSynopsis
</RefPurpose>
</RefNameDiv>
<![ %dbre.ms.refsynopsisdiv [
<RefSynopsisDiv><Title>Content Model</Title>
<Synopsis>
(<Link LinkEnd="dbre.elem.Arg">Arg</Link> | <Link LinkEnd="dbre.elem.Group">Group</Link>)+
</Synopsis>
<![ %dbre.ms.refsynopsisdiv.attr [
<RefSect2><Title>Attributes</Title>
<Para>
This element has <link linkend="dbre.x.common">common</link> and <link linkend="dbre.x.role"><sgmltag class=attribute>Role</></link> attributes.
</Para>
</RefSect2>
]]>
<![ %dbre.ms.refsynopsisdiv.tagmin [
<RefSect2><Title>Tag Minimization</Title>
<Para>
Both the start- and end-tags are required for this element.
</Para>
</RefSect2>
]]>
</RefSynopsisDiv>
]]>
<![ %dbre.ms.description [
<RefSect1><Title>Description</Title>
<para>Part of CmdSynopsis. It contains
one or more Args or Groups, in any order, and has
common attributes with ID required.
</para>
<![ %dbre.ms.description.parents [
<RefSect2><Title>Parents</Title>
<Para>
SynopFragment occurs in
<Link LinkEnd="dbre.elem.CmdSynopsis">CmdSynopsis</Link>.
</Para>
</RefSect2>
]]>
<![ %dbre.ms.description.children [
<RefSect2><Title>Children</Title>
<Para>
SynopFragment contains these elements:
<SimpleList Type=Inline>
<Member><Link LinkEnd="dbre.elem.Arg">Arg</Link></Member>
<Member><Link LinkEnd="dbre.elem.Group">Group</Link></Member>
</SimpleList>.
</Para>
</RefSect2>
]]>
</RefSect1>
]]>
<![ %dbre.ms.examples [
<RefSect1><Title>Examples</Title>
<programlisting>
<![ CDATA [
<cmdsynopsis>
<!-- This is a synopsis for the command foo.
The options -a and -x are optional and exclusive
The option -c takes a cheese and is optional and repeatable
The options -t and -k are referred to in another fragment
The options -i, -j, and -k are required and exclusive
The option -f takes a filename and is required
The -t and -k options specify the kind of milk and mold in an
optional and repeatable group
-->
<command>foo</command>
<group>
<arg>-a</arg>
<arg>-x</arg>
</group>
<group>
<arg rep=repeat>-c <replaceable>cheese</replaceable></arg>
<synopfragmentref linkend=cheesetype>cheesetype</synopfragmentref>
</group>
<group choice=req>
<arg>-i</arg>
<arg>-j</arg>
<arg>-k</arg>
</group>
<arg choice=req>-f <replaceable>filename</replaceable></arg>
<synopfragment id=cheesetype>
<group rep=repeat>
<arg>-t <replaceable>milk</replaceable></arg>
<arg>-k <replaceable>mold</replaceable></arg>
</group>
</synopfragment>
</cmdsynopsis>
]]>
</programlisting>
</RefSect1>
]]>
</RefEntry>
|
