preprocess-metadata.dita 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "referenceconcept.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <concept id="preprocess-metadata" xml:lang="en-US">
  5. <title>Move metadata (move-meta-entries) and pull content into maps (mappull) </title>
  6. <shortdesc>The <codeph>move-meta-entries</codeph> step pushes metadata back and forth between maps and topics. For
  7. example, index entries and copyrights in the map are pushed into affected topics, so that the topics can be
  8. processed later in isolation while retaining all relevant metadata. This step is implemented in Java.</shortdesc>
  9. <prolog>
  10. <metadata>
  11. <keywords>
  12. <indexterm><xmlelement>topicref</xmlelement></indexterm>
  13. <indexterm><xmlelement>linktext</xmlelement></indexterm>
  14. <indexterm><xmlelement>shortdesc</xmlelement></indexterm>
  15. <indexterm><xmlatt>locktitle</xmlatt></indexterm>
  16. <indexterm><xmlatt>type</xmlatt></indexterm>
  17. <indexterm><xmlatt>toc</xmlatt></indexterm>
  18. <indexterm><xmlatt>print</xmlatt></indexterm>
  19. <indexterm>preprocessing
  20. <indexterm><codeph>move-meta-entries</codeph></indexterm></indexterm>
  21. <indexterm><codeph>move-meta-entries</codeph></indexterm>
  22. <indexterm>Java
  23. <indexterm>move-meta-entries</indexterm></indexterm>
  24. <indexterm>metadata
  25. <indexterm>moving</indexterm></indexterm>
  26. <indexterm>XSLT
  27. <indexterm><codeph>move-meta-entries</codeph></indexterm></indexterm>
  28. <indexterm>index
  29. <indexterm>entries in map file</indexterm></indexterm>
  30. <indexterm>TOC
  31. <index-see>table of contents</index-see></indexterm>
  32. </keywords>
  33. </metadata>
  34. </prolog>
  35. <conbody>
  36. <note>As of DITA-OT 2.2, the <codeph>move-meta-entries</codeph> and <codeph>mappull</codeph> steps have been merged.
  37. The <codeph>mappull</codeph> step has been moved into <codeph>move-meta-entries</codeph>.</note>
  38. <section>
  39. <p>The <codeph>mappull</codeph> step pulls content from referenced topics into maps, and then cascades data within
  40. maps. This step is implemented in XSLT.</p>
  41. <p>The <codeph>mappull</codeph> step makes the following changes to the DITA map:
  42. <ul>
  43. <li>Titles are pulled from referenced DITA topics. Unless the <xmlatt>locktitle</xmlatt> attribute is set to
  44. "yes", the pulled titles replace the navigation titles specified on the <xmlelement>topicref</xmlelement>
  45. elements.</li>
  46. <li>The <xmlelement>linktext</xmlelement> element is set based on the title of the referenced topic, unless it
  47. is already specified locally.</li>
  48. <li>The <xmlelement>shortdesc</xmlelement> element is set based on the short description of the referenced
  49. topic, unless it is already specified locally.</li>
  50. <li>The <xmlatt>type</xmlatt> attribute is set on <xmlelement>topicref</xmlelement> elements that reference
  51. local DITA topics. The value of the <xmlatt>type</xmlatt> attribute is set to value of the root element of
  52. the topic; for example, a <xmlelement>topicref</xmlelement> element that references a task topic is given a
  53. <xmlatt>type</xmlatt> attribute set to "task"".</li>
  54. <li>Attributes that cascade, such as <xmlatt>toc</xmlatt> and <xmlatt>print</xmlatt>, are made explicit on any
  55. child <xmlelement>topicref</xmlelement> elements. This allows future steps to work with the attributes
  56. directly, without reevaluating the cascading behavior.</li>
  57. </ul>
  58. </p>
  59. </section>
  60. </conbody>
  61. </concept>