<sep>
The <sep>
element defines a character
that separates pieces of syntax in a syntax diagram.
Usage information
The separator occurs between keywords, operators, or groups in a syntax definition.
Specialization hierarchy
The <sep>
element is specialized from <ph>
.
It is defined in the syntax-diagram domain module, which is a specialization of the
programming domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
)*
- Text
-
<abbreviated-form>
-
<apiname>
-
<cmdname>
-
<data>
-
<foreign>
-
<keyword>
-
<markupname>
-
<msgnum>
-
<numcharref>
-
<option>
-
<parameterentity>
-
<parmname>
-
<sort-as>
-
<term>
-
<text>
-
<textentity>
-
<varname>
-
<wintitle>
-
<xmlatt>
-
<xmlelement>
-
<xmlnsname>
-
<xmlpi>
Attributes
The following attributes are available on this element: universal attributes.
For this element, the
@importance
attribute indicates
whether this item in a syntax diagram is optional, required,
or used by default. The attribute value is limited to
optional,
required,
default, or
-dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
@importance
- For this element, the
@importance
attribute indicates whether this item in a syntax diagram is optional, required, or used by default. The attribute value is limited to optional, required, default, or -dita-use-conref-target.
Example
This section is non-normative.
The following code sample shows how the
<sep>
element can be used to separate a
parameter name from a parameter value:
<syntaxdiagram id="validate">
<title>Validate account setup</title>
<groupseq>
<kwd>clicmd</kwd>
<groupcomp>
<oper>--</oper>
<kwd>user</kwd>
<sep>=</sep>
<var>userid</var>
</groupcomp>
<groupcomp>
<oper>--</oper>
<kwd>validate</kwd>
</groupcomp>
</groupseq>
</syntaxdiagram>