3.1.1.2.20 longdescref

The <longdescref> element supports a reference to a text description of the graphic or object. This element replaces the deprecated longdescref attribute on image and object elements.

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, map, concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap, classifyMap, subjectScheme, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary	no content

Contained by

Doctype	Content model
topic (base), map (base), topic (technical content), map (technical content), concept, reference, task (strict), task (general), bookmap, classifyMap, subjectScheme, machineryTask, learningBookmap, learningMap	image, object, hazardsymbol
ditabase, glossary, glossentry, glossgroup	image, object, glossSymbol, hazardsymbol
learningAssessment, learningContent, learningOverview, learningPlan, learningSummary	image, object

Inheritance

- topic/longdescref

Example

Figure 1. Longdescref which references a local DITA description

<image href="llama.jpg">
 <alt>Llama picture</alt>
 <longdescref href="my-pet-llama.dita"/>
</image>

Figure 2. Longdescref which references an external description

<image href="puffin.jpg">
 <alt>Puffin pigure</alt>
 <longdescref href="http://www.example.org/birds/puffin.html"
 scope="external"
 format="html"/>
</image>

Attributes

Name	Description	Data Type	Default Value	Required?
href	Provides a reference to a resource. See The href attribute for detailed information on supported values and processing implications.	CDATA	#IMPLIED	No
type	Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications.	CDATA	#IMPLIED	No
format	The format attribute identifies the format of the resource being referenced. See The format attribute for details on supported values.	CDATA	#IMPLIED	No
scope	The scope attribute identifies the closeness of the relationship between the current document and the target resource. See The scope attribute for more information on values.	(local \| peer \| external \| -dita-use-conref-target)	#IMPLIED	No
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, keyref	Keyref provides a redirectable reference based on a key defined within a map. See The keyref attribute for information on using this attribute. Class and outputclass are described in Other common DITA attributes

Parent topic: 3.1.1.2 Body elements

Previous topic: 3.1.1.2.19 lines

Next topic: 3.1.1.2.21 longquoteref

Return to main page.