processing-pipeline-modules.dita 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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="processing-pipeline-modules" xml:lang="en-US">
  5. <title>Processing modules</title>
  6. <shortdesc>The DITA-OT processing pipeline is implemented using Ant. Individual modules within the Ant script are
  7. implemented in either Java or XSLT, depending on such factors as performance or requirements for customization.
  8. Virtually all Ant and XSLT modules can be extended by adding a plug-in to the toolkit; new Ant targets may be
  9. inserted before or after common processing, and new rules may be imported into common XSLT modules to override
  10. default processing.</shortdesc>
  11. <prolog>
  12. <metadata>
  13. <keywords>
  14. <indexterm>specializations<index-see>DITA<indexterm>specializations</indexterm></index-see></indexterm>
  15. <indexterm>DITA<indexterm>specializations</indexterm></indexterm>
  16. <indexterm>processing</indexterm>
  17. <indexterm>Ant<indexterm>extending</indexterm></indexterm>
  18. <indexterm>Java<indexterm>extending</indexterm><indexterm>processing modules</indexterm></indexterm>
  19. <indexterm>XSLT<indexterm>processing modules</indexterm></indexterm>
  20. <indexterm>preprocessing<indexterm>extension points (overview)</indexterm></indexterm>
  21. <indexterm>index<indexterm>sorting</indexterm></indexterm>
  22. <indexterm>pipelines<indexterm>Ant module</indexterm></indexterm>
  23. <indexterm>pipelines<indexterm>Java module</indexterm></indexterm>
  24. <indexterm>locale</indexterm>
  25. </keywords>
  26. </metadata>
  27. </prolog>
  28. <conbody>
  29. <section>
  30. <title>XSLT modules</title>
  31. <p>The XSLT modules use shell files. Typically, each shell file begins by importing common rules that apply to all
  32. topics. This set of common processing rules may in turn import additional common modules, such as those used for
  33. reporting errors or determining the document locale. After the common rules are imported, additional imports can
  34. be included in order to support processing for DITA specializations.</p>
  35. <p>For example, XHTML processing is controlled by the <filepath>xsl/dita2xhtml.xsl</filepath> file. The shell
  36. begins by importing common rules that are applicable to all general topics:
  37. <filepath>xslhtml/dita2htmlImpl.xsl</filepath>. After that, additional XSLT overrides are imported for
  38. specializations that require modified processing. For example, an override for reference topics is imported in
  39. order to add default headers to property tables. Additional modules are imported for tasks, for the highlighting
  40. domain, and for several other standard specializations. After the standard XSLT overrides occur, plug-ins may
  41. add in additional processing rules for local styles or for additional specializations.</p>
  42. </section>
  43. <section>
  44. <title>Java modules</title>
  45. <p>Java modules are typically used when XSLT is a poor fit, such as for processes that make use of standard Java
  46. libraries (like those used for index sorting). Java modules are also used in many cases where a step involves
  47. copying files, such as the initial process where source files are parsed and copied to a temporary processing
  48. directory.</p>
  49. </section>
  50. </conbody>
  51. </concept>