3.1.2.1.4 anchor

The <anchor> element provides an integration point that another map can reference in order to insert its navigation into the current navigation tree. For those familiar with Eclipse help systems, this serves the same purpose as the <anchor> element in that system. It may not be supported for all output formats.

The <anchor> element is typically used to allow integration of run-time components. For build-time integration, you can instead use the conref or conkeyref attribute on an element inside the map. For example, a <topicref> element may use conref to pull in content at build-time from a <topicref> in another map.

Contains

Doctype

Content model

map, bookmap, classifyMap, subjectScheme, learningBookmap, learningMap

no content

Contained by

Doctype

Content model

map (base), map (technical content), bookmap, classifyMap, learningBookmap, learningMap

map, topicref, topichead, topicgroup, topicset, keydef

subjectScheme

map, topicref, subjectScheme, topichead, topicgroup, topicset, keydef

Inheritance

- map/anchor

Example

In this example, an anchor is defined with an ID of "a1".

<map>
  <title>MyComponent tasks</title>
  <topicref navtitle="Start here" href="start.dita" toc="yes">
    <navref mapref="othermap2.ditamap"/>
    <navref mapref="othermap3.ditamap"/>
    <anchor id="a1"/>
  </topicref>
</map>

The id on <anchor> can be referenced by the anchorref attribute on another map's <map> element. For example, the map to be integrated at that spot would be defined as follows.

<map anchorref="a1">
  <title>This map is pulled into the MyComponent task map</title>
  ...
</map>
Attributes

Name

Description

Data Type

Default Value

Required?

id

Provides an integration point that another map may reference in order to insert its navigation into the current navigation tree. The anchorref attribute on a map may be used to reference this attribute. See 2.1.3.4.1 ID attribute in the Architectural Specification for more details.

NMTOKEN

#REQUIRED

Yes

conref

This attribute is used to reference an ID on content that can be reused. See 3.4.2.4 The conref attribute for examples and details about the syntax.

CDATA

#IMPLIED

No

select-atts attribute group (props, base, platform, product, audience, otherprops, importance, rev, status)

A set of related attributes, described in 3.4.1.5 select-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.1.2.1.3 topicmeta

Next Topic:  3.1.2.1.5 navref

Parent Topic:  3.1.2.1 Basic map elements

Sibling Topics:

3.1.2.1.1 map

3.1.2.1.2 topicref

3.1.2.1.3 topicmeta

3.1.2.1.5 navref

3.1.2.1.6 reltable

3.1.2.1.7 relrow

3.1.2.1.8 relcell

3.1.2.1.9 relheader

3.1.2.1.10 relcolspec