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 271. Example
Figure 94. 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>
Attributes
The following attributes are available on this element:
Universal attribute group,
outputclass, and
spectitle.
Parent topic