dita2dita.dita 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  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 DITA Open Toolkit pre-processing operations, which resolve map references,
  8. keys, content references, code references and push metadata back and forth between maps and topics.</shortdesc>
  9. <prolog>
  10. <metadata>
  11. <keywords>
  12. <indexterm><cmdname>dita</cmdname> command<indexterm>normalized DITA</indexterm></indexterm>
  13. <indexterm>transformations<indexterm>normalized DITA</indexterm></indexterm>
  14. <indexterm>DITA<indexterm>normalized</indexterm></indexterm>
  15. <indexterm>metadata<indexterm>map</indexterm></indexterm>
  16. <indexterm>metadata<indexterm>topic</indexterm></indexterm>
  17. <indexterm>plug-ins<indexterm>dita2dita</indexterm></indexterm>
  18. <indexterm>dita2dita</indexterm>
  19. <indexterm>relationship tables<indexterm>normalized DITA</indexterm></indexterm>
  20. </keywords>
  21. </metadata>
  22. </prolog>
  23. <body>
  24. <p>In comparison to the source DITA files, the normalized DITA files are modified in the following ways:</p>
  25. <ul>
  26. <li>References from one DITA map to another are resolved</li>
  27. <li>Map-based links, such as those generated by map hierarchy and relationship tables, are added to the
  28. topics.</li>
  29. <li>Link text is resolved.</li>
  30. <li>Map attributes that cascade are made explicit on child elements.</li>
  31. <li>Map metadata such as index entries and copyrights are pushed into topics.</li>
  32. <li>Topic metadata such as navigation titles, link text and short descriptions are pulled from topics into the
  33. map.</li>
  34. <li>XML comments are removed.</li>
  35. </ul>
  36. <section id="applications">
  37. <title>Applications</title>
  38. <p>Normalized output may be useful in situations where post-processing of DITA content is required, but the
  39. downstream systems are limited in their ability to resolve DITA references.</p></section>
  40. <section id="generating-normalized-dita-output">
  41. <title>Generating normalized DITA output</title>
  42. <p>Run the <cmdname>dita</cmdname> command and set the value of the output <parmname>--format</parmname> option to
  43. <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>
  44. <p>where:</p>
  45. <ul>
  46. <li conref="../resources/conref-task.dita#ID/novice-variables-1"
  47. conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
  48. </ul>
  49. </section>
  50. </body>
  51. </topic>