dita2dita.dita 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <topic id="normalized-dita">
  5. <title>Normalized DITA</title>
  6. <shortdesc>The <codeph>dita</codeph> transformation generates normalized topics and maps from DITA input. The
  7. normalized output includes the results of the DITA Open Toolkit pre-processing operations, which resolve map
  8. references, keys, content references, code references and push metadata back and forth between maps and
  9. topics.</shortdesc>
  10. <body>
  11. <p>In comparison to the source DITA files, the normalized DITA files are modified in the following ways:</p>
  12. <ul>
  13. <li>References from one DITA map to another are resolved</li>
  14. <li>Map-based links, such as those generated by map hierarchy and relationship tables, are added to the
  15. topics.</li>
  16. <li>Link text is resolved.</li>
  17. <li>Map attributes that cascade are made explicit on child elements.</li>
  18. <li>Map metadata such as index entries and copyrights are pushed into topics.</li>
  19. <li>Topic metadata such as navigation titles, link text and short descriptions are pulled from topics into the
  20. map.</li>
  21. <li>XML comments are removed.</li>
  22. </ul>
  23. <section id="applications">
  24. <title>Applications</title>
  25. <p>Normalized output may be useful in situations where post-processing of DITA content is required, but the
  26. downstream systems are limited in their ability to resolve DITA references.</p></section>
  27. <section id="generating-normalized-dita-output">
  28. <title>Generating normalized DITA output</title>
  29. <p>Run the <cmdname>dita</cmdname> command and set the value of the output <parmname>--format</parmname> option to
  30. <option>dita</option>:</p><codeblock xml:space="preserve"><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>dita</option></codeblock>
  31. <p>where:</p>
  32. <ul>
  33. <li conref="../resources/conref-task.dita#ID/novice-variables-1"
  34. conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
  35. </ul>
  36. </section>
  37. </body>
  38. </topic>