3.2.3.4 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

Doctype	Content model
ditabase, reference	( text data or dl or parml or fig or syntaxdiagram or imagemap or image or lines or lq or note or hazardstatement or object or ol or p or pre or codeblock or msgblock or screen or simpletable or sl or table or ul or boolean or cite or keyword or apiname or option or parmname or cmdname or msgnum or varname or wintitle or ph or b or i or sup or sub or tt or u or codeph or synph or filepath or msgph or systemoutput or userinput or menucascade or uicontrol or q or term or abbreviated-form or tm or xref or state or data or data-about or foreign or unknown or sectiondiv or title or draft-comment or fn or indextermref or indexterm or required-cleanup ) (any number)
learningContent	( text data or dl or fig or imagemap or lcInteractionBase or lcTrueFalse or lcSingleSelect or lcMultipleSelect or lcSequencing or lcMatching or lcHotspot or lcOpenQuestion or image or lines or lq or note or lcInstructornote or object or ol or p or pre or simpletable or sl or table or ul or boolean or cite or keyword or ph or b or i or sup or sub or tt or u or q or term or tm or xref or state or data or data-about or foreign or unknown or sectiondiv or title or draft-comment or fn or indextermref or indexterm or required-cleanup ) (any number)

Contained by

Doctype	Content model
ditabase, reference, learningContent	refbody , refbodydiv

Inheritance

- topic/section reference/refsyn

Example

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>

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)	A set of related attributes, described in 3.4.1.3 univ-atts attribute group
global-atts attribute group (xtrf, xtrc)	A set of related attributes, described in 3.4.1.2 global-atts attribute group
class, outputclass	Common attributes described in 3.4.1.9 Other common DITA attributes

Previous Topic: 3.2.3.3 refbodydiv

Next Topic: 3.2.3.5 properties

Parent Topic: 3.2.3 Reference elements

Sibling Topics: