`<refsyn>`

The <refsyn> element contains content that describes the syntax of a command.

Specialization hierarchy

The <refsyn> element is specialized from <section>. It is defined in the reference module.

Content model

Contained by

<refbody>, <refbodydiv>

Zero or more of the following

Text
<audio>
<cite>
<data>
<div>
<dl>
<draft-comment>
<example>
<fig>
<fn>
<foreign>
<image>
<include>
<indexterm>
<keyword>
<lines>
<lq>
<note>
<object>
<ol>
<p>
<ph>
<pre>
<properties>
<q>
<required-cleanup>
<simpletable>
<sl>
<table>
<term>
<text>
<title>
<tm>
<ul>
<video>
<xref>

Contained by

Inheritance

- topic/section reference/refsyn

The <refsyn> element is specialized from <section>. It is defined in the reference module.

Attributes

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

Example

This section is non-normative.

The following code sample shows how the <refsyn> element can be used to document the syntax for the Windows mkdir command:

<refsyn>
  <title>Syntax</title>
  <codeblock>mkdir <varname>drive</varname> <varname>directory</varname></codeblock>
  <parml>
    <plentry>
      <pt><varname>drive</varname></pt>
      <pd>Specifies the drive on which the new directory is created. This is an optional
          parameter.</pd>
    </plentry>
    <plentry>
      <pt><varname>path</varname></pt>
      <pd>Specifies the fully-qualified name of the new directory. This is a required
          parameter.</pd>
    </plentry>
  </parml>
</refsyn>