Language reference : Technical content elements : Domain elements : Programming elements : fragref
WebWorks  
fragref
The fragment reference (<fragref>) element provides a logical reference to a syntax definition fragment 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.
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
( text data or boolean 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 state or data or data-about or foreign or unknown) (any number)
Contained by
Doctype
Content model
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), bookmap
Inheritance
+ topic/xref pr-d/fragref
Example 368. Example
This markup example:
<syntaxdiagram frame="none">
<title>CopyFile</title>
<groupseq><kwd>COPYF</kwd></groupseq>
<groupcomp><var>input-filename</var><kwd>*INFILE</kwd></groupcomp>
<groupseq><var>output-filename</var><kwd>*OUTFILE</kwd></groupseq>
<fragref href="#syntax/overlay"></fragref>
<groupchoice><var>input-filename</var><kwd>*INFILE</kwd></groupchoice>
<groupchoice><var>output-filename</var><kwd>*OUTFILE</kwd></groupchoice>
<fragment id="overlay">
<title>Overlay</title>
<groupchoice><kwd>*OVERLAP</kwd><kwd>*Prompt</kwd></groupchoice>
</fragment>
</syntaxdiagram>
produces the following output:
CopyFile

>>-COPYF--input-filename*INFILE--output-filename--*OUTFILE------>

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

Overlay

|--+-*OVERLAP-+-------------------------------------------------|
'-*Prompt--'
Attributes
Name
Description
Data Type
Default Value
Required?
href
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. (Processing assumes the equivalent of scope="local" and format="dita".)
CDATA
#IMPLIED
No
importance
The attribute indicates whether this item in a syntax diagram is optional or required. Output processors may indicate this designation in a generated diagram. See this topic for more information on the -dita-use-​conref-​target value.
optional | required | -dita-use-​conref-​target
#IMPLIED
No
props
Root attribute from which new metadata attributes can be specialized. This is a property attribute which supports conditional processing for filtering or flagging. If no value is specified, but the attribute is specified on an ancestor within a map or within the related-links section, the value will cascade from the closest ancestor. The attribute takes a space-delimited set of values. However, when acting as a container for generalized attributes, the content model will be more complex; see Attribute generalization for more details.
CDATA
#IMPLIED
No
base
A generic attribute that has no specific purpose. It is intended to act as a base for specialized attributes that have a simple value syntax like the conditional processing attributes (one or more alphanumeric values separated by whitespace), but is not itself a filtering or flagging attribute. The attribute takes a space-delimited set of values. However, when acting as a container for generalized attributes, the content model will be more complex; see Attribute generalization for more details.
CDATA
#IMPLIED
No
platform
Indicates operating system and hardware. This is a property attribute which supports conditional processing for filtering or flagging. If no value is specified, but the attribute is specified on an ancestor within a map or within the related-links section, the value will cascade from the closest ancestor. The attribute takes a space-delimited set of values.
CDATA
#IMPLIED
No
product
Contains the name of the product to which the element applies. This is a property attribute which supports conditional processing for filtering or flagging. If no value is specified, but the attribute is specified on an ancestor within a map or within the related-links section, the value will cascade from the closest ancestor. The attribute takes a space-delimited set of values.
CDATA
#IMPLIED
No
audience
Indicates the intended audience for the element. This is a property attribute which supports conditional processing for filtering or flagging. If no value is specified, but the attribute is specified on an ancestor within a map or within the related-links section, the value will cascade from the closest ancestor. The attribute takes a space-delimited set of values.
CDATA
#IMPLIED
No
otherprops
This attribute can be used for any other properties that might be needed to describe an audience, or to provide selection criteria for the element. Alternatively, the props attribute may be specialized to provide a new metadata attribute instead of using the general otherprops attribute. This is a property attribute which supports conditional processing for filtering or flagging. If no value is specified, but the attribute is specified on an ancestor within a map or within the related-links section, the value will cascade from the closest ancestor. The attribute takes a space-delimited set of values.
CDATA
#IMPLIED
No
rev
Indicates a revision level of an element that identifies when the element was added or modified. It may be used to flag outputs when it matches a run-time parameter; it cannot be used for filtering. It is not sufficient to be used for version control.If no value is specified, but the attribute is specified on an ancestor within a map or within the related-links section, the value will cascade from the closest ancestor.
CDATA
#IMPLIED
No
status
The modification status of the current element.
new | changed | deleted | unchanged | -dita-use-​conref-​target
#IMPLIED
No
id-atts attribute group (id, conref, conrefend, conaction, conkeyref)
A set of related attributes, described in id-atts attribute group
localization-atts attribute group (translate, xml:lang, dir)
A set of related attributes, described in localization-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