Home
Cross-referencing
Cross-references are a means of binding individual topics into a coherent and navigable document.
Cross-referencing elements in a topic
Cross-references to elements within topics such as figures and tables allow a reader to easily navigate through a document, whether it is in a page layout format or a hypertext format. The xref element is always used for cross-referencing elements within a topic.
Cross-referencing figures
Cross-references to figures are accomplished with the xref element with a type attribute of fig.

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
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.
- Types of cross-references
  A cross-reference is used in DITA to link or associate one piece of content with another. The cross-reference (xref) element is the primary mechanism for cross-referencing, but other elements also have cross-referencing functions.
- The xref element
  The cross-reference element is used for linking or otherwise cross-referencing text within a topic to other topics, elements within a topic, or resources external to the DITA collection.
- Avoiding in-text cross-references to topics
  Cross-references to other topics should be stored in the relationship table of the ditamap, external to the topic, and not in-line within the text of the topic.
- Cross-referencing topics and external resources
  Cross-references are commonly made to other DITA topics in a collection, and to information resources outside the collection. These external targets can be any type of electronic resource that can be addressed through a URI, including e-mail addresses, documents on a network file server, and Web content.
- Cross-referencing elements in a topic
  Cross-references to elements within topics such as figures and tables allow a reader to easily navigate through a document, whether it is in a page layout format or a hypertext format. The xref element is always used for cross-referencing elements within a topic.
  - Cross-referencing figures
    Cross-references to figures are accomplished with the xref element with a type attribute of fig.
  - Cross-referencing tables
    Cross-references to tables are accomplished with the xref element with a type attribute of table.
  - Cross-referencing to a page number
    There is no specific mechanism for cross-referencing a page number, because DITA is a source format and page numbers are output-dependent. In page layout outputs, a cross-reference to an element in a topic will be automatically generated as a page reference.
  - Cross-referencing a step
    Cross-references to steps are accomplished with the xref element with a type attribute of li.
  - Cross-referencing a transcluded element
    When re-using content with content references (conref), you must cross-reference to the instance of a conref transclusion, and not to the original source of the conref.
- Links in related-links sections
  When a topic requires cross-references to other topics where those cross-references will always be valid in the context of the topic, they should be contained within a related-links section after the topic body. In all other cases, cross-references should be defined in the relationship table of the ditamap.
- Managing cross-references
- Cross-references in titles
  You should not use cross-reference elements within topic titles.
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.

Cross-referencing figures

Cross-references to figures are accomplished with the xref element with a type attribute of fig.

When referring a reader to a figure (an image or illustration), you should not hard-code the figure number. In most editing environments, you won't know what the sequential figure number will be until the ditamap is processed to a deliverable document.

You must always use the xref element to cross-reference figures, with the type attribute set to fig.

Cross-references to figures will typically be rendered as the local language word for Figure, followed by the figure's sequential number in the topic (for hypertext outputs) or in the publication (for page layout documents). Because the figure number is not hard-coded, it will be recalculated each time the ditamap containing the topic is processed.

An example of the syntax of a cross-reference to a figure with an id attribute of fig_ej25_engine in the same topic is:

<xref href="#concept_ej25/fig_sample_darwin" type="fig"/>

You cannot cross-reference images, so if cross-references are important for your document, use figures rather than simple images. You should include a title element in all figure elements, as the title is used in the generation of cross-reference text in some publishing processes.