`<navref>`

A navigation reference is a reference to another map that is preserved as a transcluding link in the result deliverable, rather than resolved when the deliverable is produced. Output formats that support such linking can integrate the referenced resource when displaying the referencing map to an end user.

Usage information

The <navref> element is intended as a reference to a navigation resource that can be resolved at rendering time. It enables DITA maps to be published into a web-based information system where the referenced navigation is published independently (or might not be available at all). If available, the referenced navigation can then be resolved at rendering time.

Content model

EMPTY

Empty

Inheritance

- map/navref

The <navref> element is a base element type. It is defined in the map module.

Attributes

The following attributes are available on this element: universal attributes and the attribute defined below.

@mapref: Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.

The following attributes are available on this element: universal attributes and the attributes defined below.

@mapref: Specifies the URI of the map file or non-DITA resource to be referenced. It might reference a DITA map or a resource that is appropriate for a target help system. For example, it could reference an XML TOC file for use with Eclipse help.

Example

This section is non-normative.

In the following code sample, the map titled "MyComponent tasks" references the maps othermap2.ditamap and othermap3.ditamap:

<map>
 <title>MyComponent tasks</title>
 <navref mapref="../com.example.plugin.xml.doc/othermap1.ditamap"/>
 <navref mapref="../com.example.plugin.xml.doc/othermap2.ditamap"/>
</map>