`<synblk>`

A syntax block organizes small pieces of a syntax definition into a larger piece.

Specialization hierarchy

The <synblk> element is specialized from <figgroup>. It is defined in the syntax-diagram domain module, which is a specialization of the programming domain module.

Content model

In order

Optional <title>
Zero or more

Attributes

The following attributes are available on this element: universal attributes.

Example

This section is non-normative.

The following code sample shows how <synblk> elements can be used to group sets of related options for user profile parameters. These syntax blocks might be used in many different sets of syntax.

<synblk id="profileopts">
  <title>Required profile options</title>
  <groupcomp><oper>--</oper><kwd>user</kwd><sep>=</sep><var>userid</var></groupcomp>
  <groupcomp><oper>--</oper><kwd>acctkey</kwd><sep>=</sep><var>keyfile</var></groupcomp>
  <groupcomp><oper>--</oper><kwd>region</kwd><sep>=</sep><var>homeregion</var></groupcomp>
</synblk>

This block can now be reused in syntax descriptions that always begin with the three profile parameters described in that syntax block:

<syntaxdiagram>
  <title>Request file listing</title>
  <groupseq>
    <kwd>clicmd</kwd>
    <synblk conkeyref="syntax-library/profileopts"/>
    <groupcomp><oper>--</oper><kwd>filelist</kwd><sep>=</sep><var>volumeid</var></groupcomp>
  </groupseq>
</syntaxdiagram>