preprocess-topicpull.dita 1.7 KB

123456789101112131415161718192021
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <concept id="preprocess-topicpull" xml:lang="en-US">
  5. <title>Pull content into topics (topicpull)</title>
  6. <shortdesc>The <codeph>topicpull</codeph> step pulls content into <xmlelement>xref</xmlelement> and
  7. <xmlelement>link</xmlelement> elements. This step is implemented in XSLT.</shortdesc>
  8. <conbody>
  9. <section><p>If an <xmlelement>xref</xmlelement> element does not contain link text, the target is examined and the link text is
  10. pulled. For example, a reference to a topic pulls the title of the topic; a reference to a list item pulls the
  11. number of the item. If the <xmlelement>xref</xmlelement> element references a topic that has a short
  12. description, and the <xmlelement>xref</xmlelement> element does not already contain a child
  13. <xmlelement>desc</xmlelement> element, a <xmlelement>desc</xmlelement> element is created that contains the
  14. text from the topic short description.</p><p>The process is similar for <xmlelement>link</xmlelement> elements. If the <xmlelement>link</xmlelement> element does
  15. not have a child <xmlelement>linktext</xmlelement> element, one is created with the appropriate link text.
  16. Similarly, if the <xmlelement>link</xmlelement> element does not have a child <xmlelement>desc</xmlelement>
  17. element, and the short description of the target can be determined, a <xmlelement>desc</xmlelement> element is
  18. created that contains the text from the topic short description.</p></section>
  19. </conbody>
  20. </concept>