<synph>

A syntax phrase is a small group of pieces of syntax.

Usage information

The <synph> element is used when a complete syntax diagram is not needed, but some of the syntax elements, such as <kwd>, <oper>, or <delim> are used within the text flow of the topic content.

Specialization hierarchy

The <synph> 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 | <codeph> | <delim> | <kwd> | <oper> | <option> | <parmname> | <sep> | <synph> | <text> | <var> )*

Zero or more

Attributes

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

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

Example

This section is non-normative.

The following code sample shows how the <synph> element can be used to identify a syntax phrase that must be run before a task:

<task id="setup-volume">
  <title>Setting up a new volume</title>
  <shortdesc>This task will help you set up a new volume for your account.</shortdesc>
  <taskbody>
    <prereq>Before starting this procedure, ensure that you have requested
      the volume using the <synph><kwd>request</kwd> <var>volumename</var></synph>
      command.</prereq>
    <!-- ... -->
  </taskbody>
</task>