The syntax block (<synblk>) element organizes small pieces of a syntax definition into a larger piece. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts, and reference information.
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 |
---|---|
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap | ( (title) (optional) then (fragment or fragref or groupchoice or groupcomp or groupseq or synnote or synnoteref) (any number) ) |
Contained by
Doctype | Content model |
---|---|
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), bookmap | syntaxdiagram |
Inheritance
+ topic/figgroup pr-d/synblk
Example
<synblk> <groupseq><kwd>this</kwd><sep>-</sep><kwd>is</kwd><sep>-</sep><kwd>a</kwd> <sep>-</sep><var>test</var></groupseq> </synblk>
Attributes
Name | Description | Data Type | Default Value | Required? |
---|---|---|---|---|
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
class, outputclass | Common attributes described in Other common DITA attributes |