navref

The <navref> represents a pointer to another map which should be preserved as a transcluding link rather than resolved. Output formats that support such linking will integrate the target when displaying the referencing map to an end user.

For example, if a map is converted to the Eclipse help system format, the DITA element <navref mapref="other.ditamap"/> should be converted to the Eclipse element <link toc="other.xml"/>. When Eclipse loads the referencing map, it will replace this link element with the contents of other.xml, provided that other.xml is available.

Note that not all output formats will support such linking. In order to include target maps directly without depending on the output format, you may reference the map with a topicref while setting the format attribute to "ditamap". For example, the following markup represents a literal inclusion of the map "other.ditamap" (similar to a conref):

<topicref href="other.ditamap" format="ditamap"/>

Example

In this example, the map titled "MyComponent tasks" references the maps "othermap2.ditamap" and "othermap3.ditamap".

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

Contains

Doctype	Content model
map, bookmap	no content

Contained by

Doctype	Parents
bookmap, map	map, topicref, topichead, topicgroup

Inheritance:

- map/navref

Attributes

Name	Description	Data Type	Default Value	Required?
mapref	Specifies the URL (local filename, at least) of the map file to reference. It may point to a DITA map, or to a file that is appropriate for your output format (such as XML TOC file for Eclipse output).	CDATA	#IMPLIED	No
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;)	A set of related attributes, described at %univ-atts;	parameter entity	PE not applicable	Not applicable
%global-atts; (xtrf, xtrc)	A set of related attributes, described at %global-atts;	parameter entity	PE not applicable	Not applicable
class, outputclass	Common attributes described in Other common DITA attributes