refsyn
The <refsyn> element is a special section inside a reference topic. The section often contains syntax or signature content (for example, a command-line utility's calling syntax, or an API's signature). The <refsyn> contains a brief, possibly diagrammatic description of the subject's interface or high-level structure.
Contains
Note: These models represent only the default document types distributed by OASIS. Actual content models will differ with each new document type.
Doctype | Content model |
ditabase, reference | |
learningContent | |
Contained by
Doctype | Content model |
ditabase, reference, learningContent | |
Inheritance
- topic/section reference/refsyn
Example 235. Example
Figure 67. 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
Name | Description | Data Type | Default Value | Required? |
spectitle | The specialized title attribute allows architects of specialized types to define a fixed or default title for a specialized element. Not intended for direct use by authors. | CDATA | #IMPLIED | No |
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | | | | |
global-atts attribute group (xtrf, xtrc) | | | | |
class, outputclass | | | | |
Parent topic