The <fragref> element provides a logical reference to a <fragment> element within a syntax diagram, so that you can reference a syntax fragment multiple times or pull a large section of syntax out of line for easier reading. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts, and reference information.

Content models

See appendix for information about this element in OASIS document type shells.


+ topic/xref pr-d/fragref


This markup example:
<syntaxdiagram frame="none">
 <fragref href="#syntax/overlay"></fragref>
 <fragment id="overlay">
might produce output like the following:


>--| Overlay |--+-input-filename-+--+-output-filename-+--------><
                '-*INFILE--------'  '-*OUTFILE--------'




The following attributes are available on this element: Universal attribute group (with a narrowed definition of @importance, given below), outputclass, and the attributes defined below.

A reference to a syntax diagram <fragment> element. The referenced <fragment> must be in the same diagram as the <fragref> element. See The href attribute for detailed information on supported values and processing implications.
The attribute indicates whether this item in a syntax diagram is optional or required. Output processors might indicate this designation in a generated diagram. Allowable values are:
This section of the syntax is optional.
This section of the syntax is required.
See Using the -dita-use-conref-target value for more information.

Return to main page.