dita2dita.dita 3.0 KB

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