<refsyn>

The <refsyn> element is a special section inside a reference topic. The section often contains syntax or signature content (for example, the calling syntax for a command-line utility or an API signature). The <refsyn> contains a brief, possibly diagrammatic description of the subject's interface or high-level structure.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

- topic/section reference/refsyn

Example

This section is non-normative.

Example 1. Reference topic for software material
<reference id="MyAPI">
  <title>MyAPI</title>
  <refbody>
    <refsyn>Describe the MyAPI syntax here, possibly
using synph or syntax elements markup for explicit 
definition of syntax or prototype construction.</refsyn>
  </refbody>
</reference>

Content model

(Text | <dl> | <div> | <fig> | <image> | <lines> | <lq> | <note> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <boolean> | <cite> | <keyword> | <ph> | <q> | <term> | <text> | <tm> | <xref> | <state> | <data> | <data-about> | <foreign> | <unknown> | <sectiondiv> | <title> | <draft-comment> | <fn> | <indextermref> | <indexterm> | <required-cleanup>)*

Contained by

<refbody>, <refbodydiv>

Zero or more of the following
  • Text
  • <boolean>
  • <cite>
  • <data>
  • <data-about>
  • <div>
  • <dl>
  • <draft-comment>
  • <fig>
  • <fn>
  • <foreign>
  • <image>
  • <indexterm>
  • <indextermref>
  • <keyword>
  • <lines>
  • <lq>
  • <note>
  • <object>
  • <ol>
  • <p>
  • <ph>
  • <pre>
  • <q>
  • <required-cleanup>
  • <sectiondiv>
  • <simpletable>
  • <sl>
  • <state>
  • <table>
  • <term>
  • <text>
  • <title>
  • <tm>
  • <ul>
  • <unknown>
  • <xref>

Contained by

  • <refbody>
  • <refbodydiv>

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 attribute group, outputclass, and spectitle.