How are visual elements linked to underlying technical descriptions, farming practices, and safety procedures in DITA?

November 10, 2023
|By Bryan Tipper

Linking visual elements to underlying technical descriptions, farming practices, and safety procedures in DITA is a fundamental aspect of creating comprehensive and informative agricultural documentation. DITA provides the capability to associate visual elements with textual content, ensuring that learners can access relevant information alongside images, diagrams, or videos.

Image Annotations

DITA allows for image annotations, where descriptive text can be linked to specific regions or elements within an image. For instance, in a diagram illustrating farming equipment, annotations can provide detailed explanations of each component. This enables learners to gain a deeper understanding of the visual elements within the context of farming practices.

Embedded Multimedia with Transcripts

When integrating multimedia such as videos or animations, DITA encourages the inclusion of transcripts or textual descriptions. These transcripts serve as accessible alternatives for users with disabilities and also provide textual explanations for the visual content. For example, a safety video demonstrating proper pesticide handling can include a transcript that outlines safety procedures step by step.

Hyperlinks to Related Topics

DITA enables the creation of hyperlinks within visual documentation to connect to related topics or sections containing detailed technical descriptions or safety guidelines. For example, a diagram of irrigation systems can include hyperlinks to topics explaining irrigation techniques, maintenance procedures, and safety precautions. This ensures that learners can seamlessly navigate between visual elements and in-depth textual information.

Example:

Here’s an example of how DITA links visual elements to underlying descriptions:


<topic id="tractor_components" version="1.2">
  <title>Tractor Components</title>
  <body>
    <p>Explore the various components of a tractor:

    <image src="tractor_components.png">
      <desc>Annotated diagram of tractor components.</desc>
      <alt-text>Diagram of tractor components</alt-text>
      <annotation>
        <area shape="rect" coords="100,50,200,150" href="component_description#engine" alt="Engine">
          <desc>Description of the engine component.</desc>
        </area>
        <area shape="rect" coords="250,80,350,180" href="component_description#wheels" alt="Wheels">
          <desc>Description of the wheels component.</desc>
        </area>
      </annotation>
    </image>
  </body>

In this example, a DITA topic uses image annotations to link specific areas of a tractor diagram to detailed component descriptions.