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

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 3-11 Longdescref which references a local DITA description

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

Figure 3-12 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 3.4.2.1 The href attribute for detailed information on supported values and processing implications.

CDATA

#IMPLIED

No

type

Describes the target of a reference. See 3.4.2.8 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 3.4.2.9 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 3.4.2.10 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 3.4.1.3 univ-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, keyref

Class and outputclass are described in 3.4.1.9 Other common DITA attributes

     

Previous Topic:  3.1.1.2.19 lines

Next Topic:  3.1.1.2.21 longquoteref

Parent Topic:  3.1.1.2 Body elements

Sibling Topics:

3.1.1.2.1 alt

3.1.1.2.2 cite

3.1.1.2.3 dd

3.1.1.2.4 desc

3.1.1.2.5 ddhd

3.1.1.2.6 dl

3.1.1.2.7 dlentry

3.1.1.2.8 dlhead

3.1.1.2.9 dt

3.1.1.2.10 draft-comment

3.1.1.2.11 dthd

3.1.1.2.12 example

3.1.1.2.13 fig

3.1.1.2.14 figgroup

3.1.1.2.15 fn

3.1.1.2.16 image

3.1.1.2.17 keyword

3.1.1.2.18 li

3.1.1.2.19 lines

3.1.1.2.21 longquoteref

3.1.1.2.22 lq

3.1.1.2.23 object

3.1.1.2.24 note

3.1.1.2.25 ol

3.1.1.2.26 p

3.1.1.2.27 param

3.1.1.2.28 ph

3.1.1.2.29 pre

3.1.1.2.30 q

3.1.1.2.31 section

3.1.1.2.32 sectiondiv

3.1.1.2.33 sl

3.1.1.2.34 sli

3.1.1.2.35 term

3.1.1.2.36 text

3.1.1.2.37 tm

3.1.1.2.38 ul

3.1.1.2.39 xref