Home
DITA map files
Relationship tables
Relationship tables are used to store linking relationships between topics in a collection in the ditamap, rather than in individual topics. Linking relationships are defined in a table-like structure, with rows in the table determining which topics are linked to which.
Link text for reltable related topic links
To control the text displayed in links automatically-generated from the relationship table, a linktext element must be added to the topicmeta for the topicref.

Introduction
Information types and topics
Topics are the building blocks of modular documents, and organising topics by semantic information types is one of the architectural features of DITA.
DITA map files
- Purpose of ditamap files
  DITA map files are used for defining the topics of a publication, specifying the topic sequence, and controlling linking between topics.
- Topic manifest
  Any topics referenced anywhere in the ditamap will be processed into the output publication.
- Topic hierarchy
  In DITA, the sequence and hierarchy of the topics to be published are defined in the ditamap through nested topicref elements.
- Relationship tables
  Relationship tables are used to store linking relationships between topics in a collection in the ditamap, rather than in individual topics. Linking relationships are defined in a table-like structure, with rows in the table determining which topics are linked to which.
  - Types of relationship tables
    Relationship tables can be designed to suit a variety of types of relationships, including one way links, and links associating concept, task and reference topics.
  - Labels for reltable related topic links
    The headings used to label generated related topic links in the output are based on the type attribute in the referencing topicref element.
  - Link text for reltable related topic links
    To control the text displayed in links automatically-generated from the relationship table, a linktext element must be added to the topicmeta for the topicref.
  - Storing relationship tables in separate, embedded ditamaps
    Even for medium-sized documents, it is easy for ditamap files to become unwieldy due to the number and complexity of topic references. You should take advantage of the modular nature of DITA to store relationship tables in separate ditamaps, embedded within the main ditamap, as soon as the ditamap becomes too large.
- Linking relationships
  DITA encourages the linking relationships to be stored outside the topic content. Links can be generated from topic hierarchies, relationship tables, and related-links section links.
- Inheritance and cascades in ditamaps
  Properties in ditamaps sometimes cascade from parent elements to child elements. Some values in ditamaps also override the equivalent values in referenced topics.
- Embedded (or nested) ditamaps
  The technique of using embedded, or nested, ditamaps can make it easier to manage documents by separating complex collections of topics into a number of smaller, simpler collections.
- DITA map vocabulary
- The bookmap feature
  Bookmaps are a specialisation of the base DITA map information type. Like ditamaps, bookmaps are containers for structure and context metadata, and do not contain any content. Bookmaps are used to describe page layout publishing outputs such as books, articles, manuals and research papers. They contain information structures that are specific to linear publications, such as tables of figures, title pages, chapters, sections and parts.
Syntax and mark-up
Language and punctuation
Graphics and figures
Cross-referencing
Cross-references are a means of binding individual topics into a coherent and navigable document.
Content re-use
Metadata, conditional processing, and indexing
The DITA documentation process
DITA authoring concepts
Moving from style-based authoring to a structured authoring methodology such as DITA requires a radically different approach to writing.

Link text for reltable related topic links

To control the text displayed in links automatically-generated from the relationship table, a linktext element must be added to the topicmeta for the topicref.

By default, the link text used for generated links will be the title of the target topic.

If you want the link generated by a reltable to have a different title to the title of the linked topic itself, you may think the technique would be to use a navtitle attribute in the topicref element. However, that doesn't work!

The technique to use is to add a topicmeta element to the topicref, and include a linktext element containing the name of the link text. The following example shows the technique.


<reltable>
...
  <topicref href="foo.xml"> 
    <topicmeta>
      <linktext>Replacement text</linktext>
    </topicmeta> 
  </topicref>
...
</reltable>