The <navref> element 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 referenced resource 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 the file "other.xml", provided that the
file "other.xml" is available.
Note that not all output formats
support such linking. In order to include another map directly without
depending on the output format, use a <topicref> element with the
format attribute set to "ditamap". The effect is similar to a conref.
For example, the following markup represents a literal inclusion of
the map "other.ditamap":
<topicref href="other.ditamap" format="ditamap"/>
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 |
|---|
| 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 |
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>
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 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 |
Common attributes described in
Other common DITA attributes |
|
|
|