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.
- topic/section reference/refsyn
Figure 3-50 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>
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. |
||||
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) |
A set of related attributes, described in 3.4.1.3 univ-atts attribute group |
|||
A set of related attributes, described in 3.4.1.2 global-atts attribute group |
||||
Common attributes described in 3.4.1.9 Other common DITA attributes |