3.2.6.2.17 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

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

syntaxdiagram, synblk, groupseq, groupchoice, groupcomp, fragment

Inheritance

+ topic/xref pr-d/fragref

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 3.4.2.1 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.

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.

CDATA

#IMPLIED

No

platform

Indicates operating system and hardware.

CDATA

#IMPLIED

No

product

Contains the name of the product to which the element applies.

CDATA

#IMPLIED

No

audience

Indicates the intended audience for the element.

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.

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.

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 3.4.1.4 id-atts attribute group

     

localization-atts attribute group (translate, xml:lang, dir)

A set of related attributes, described in 3.4.1.6 localization-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.6.2.16 fragment

Next Topic:  3.2.6.2.18 synblk

Parent Topic:  3.2.6.2 Programming elements

Sibling Topics:

3.2.6.2.1 apiname

3.2.6.2.2 codeblock

3.2.6.2.3 coderef

3.2.6.2.4 codeph

3.2.6.2.5 option

3.2.6.2.6 parmname

3.2.6.2.7 parml

3.2.6.2.8 plentry

3.2.6.2.9 pt

3.2.6.2.10 pd

3.2.6.2.11 synph

3.2.6.2.12 syntaxdiagram

3.2.6.2.13 groupseq

3.2.6.2.14 groupchoice

3.2.6.2.15 groupcomp

3.2.6.2.16 fragment

3.2.6.2.18 synblk

3.2.6.2.19 synnote

3.2.6.2.20 synnoteref

3.2.6.2.21 kwd

3.2.6.2.22 var

3.2.6.2.23 oper

3.2.6.2.24 delim

3.2.6.2.25 sep

3.2.6.2.26 repsep