How are mapping relationships documented in DITA specializations?

Documentation of Mapping Relationships in DITA Specializations: Mapping relationships in DITA specializations should be well-documented to provide clarity and guidance to content creators. The documentation ensures that users of the specialization understand how DITA elements are mapped, transformed, and presented in various output formats. Key aspects of documenting mapping relationships include:

  • Mapping Tables: Use mapping tables to document how source DITA elements (e.g., topics, sections) are mapped to target elements in different output formats. These tables provide a clear reference for content creators.
  • Element Descriptions: Describe each element’s role and purpose within the specialization, explaining its usage and how it affects the output format.
  • Example Scenarios: Provide example scenarios to illustrate how mapping works in practice. Show how specific DITA elements appear in different output formats.
  • Conditional Processing: Explain any conditional processing or filtering mechanisms applied during mapping. Detail the conditions under which elements are included or excluded.

Documentation of mapping relationships helps content creators make informed decisions about how to use the specialization effectively.

Example:

In a DITA specialization documentation for mapping to web and print outputs, a mapping table is used to illustrate the relationships between source DITA elements and the corresponding elements in HTML and PDF outputs.


<!-- Mapping Table -->
<table>
  <tr>
    <th>Source DITA Element</th>
    <th>HTML Output Element</th>
    <th>PDF Output Element</th>
  </tr>
  <tr>
    <td>concept</td>
    <td><div class="concept"></td>
    <td><section class="pdf-concept"></td>
  </tr>
  <tr>
    <td>task</td>
    <td><div class="task"></td>
    <td><section class="pdf-task"></td>
  </tr>
  <!-- Additional mapping rows -->
</table>