pdf-transform.dita 5.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  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="pdfdefault" xml:lang="en-US">
  5. <title>PDF processing modules</title>
  6. <shortdesc>The <option>PDF</option> (formerly known as <option>PDF2</option>) transformation process runs the
  7. pre-processing routine and follows it by a series of additional targets. These steps work together to create a
  8. merged set of content, convert the merged content to XSL-FO, and then format the XSL-FO file to PDF.</shortdesc>
  9. <prolog>
  10. <metadata>
  11. <keywords>
  12. <indexterm>DITAVAL<indexterm>PDF</indexterm></indexterm>
  13. <indexterm>Antenna House<indexterm><codeph>transform.fo2pdf</codeph></indexterm><indexterm><filepath>topic.fo</filepath></indexterm></indexterm>
  14. <indexterm>Apache FOP<indexterm><codeph>transform.fo2pdf</codeph></indexterm><indexterm><filepath>topic.fo</filepath></indexterm></indexterm>
  15. <indexterm>PDF<indexterm>preprocessing</indexterm></indexterm>
  16. <indexterm>targets<indexterm>PDF</indexterm></indexterm>
  17. <indexterm>XSLT<indexterm>PDF</indexterm></indexterm>
  18. <indexterm>RenderX<indexterm><codeph>transform.fo2pdf</codeph></indexterm><indexterm><filepath>topic.fo</filepath></indexterm></indexterm>
  19. <indexterm>XEP<index-see>RenderX</index-see></indexterm>
  20. <indexterm>index<indexterm>PDF</indexterm></indexterm>
  21. <indexterm><filepath>stage1.xml</filepath></indexterm>
  22. <indexterm>pipelines<indexterm>PDF</indexterm></indexterm>
  23. <indexterm><filepath>topic.fo</filepath></indexterm>
  24. <indexterm><filepath>stage1a.xml</filepath></indexterm>
  25. <indexterm><filepath>stage2.fo</filepath></indexterm>
  26. <indexterm><filepath>stage3.fo</filepath></indexterm>
  27. <indexterm><filepath>topic.fo</filepath></indexterm>
  28. </keywords>
  29. </metadata>
  30. </prolog>
  31. <conbody>
  32. <section>
  33. <p>The PDF process includes many Ant targets. During a typical conversion from map to PDF, the following targets
  34. are most significant.</p>
  35. <dl>
  36. <dlentry>
  37. <dt><codeph>map2pdf2</codeph></dt>
  38. <dd>Creates a merged file by calling a common Java merge module. It then calls the
  39. <codeph>publish.map.pdf</codeph> target to do the remainder of the work.</dd>
  40. </dlentry>
  41. <dlentry>
  42. <dt><codeph>publish.map.pdf</codeph></dt>
  43. <dd>Performs some initialization and then calls the <codeph>transform.topic2pdf</codeph> target to do the
  44. remainder of processing.</dd>
  45. </dlentry>
  46. <dlentry>
  47. <dt><codeph>transform.topic2pdf</codeph></dt>
  48. <dd>Converts the merged file to XSL-FO, generates the PDF, and deletes the <filepath>topic.fo</filepath> file,
  49. unless instructed to keep it.</dd>
  50. </dlentry>
  51. </dl>
  52. <p>The <codeph>transform.topic2pdf</codeph> target uses the following targets to perform those tasks:</p>
  53. <dl>
  54. <dlentry>
  55. <dt><codeph>transform.topic2fo</codeph></dt>
  56. <dd>Convert the merged file to an XSL-FO file. This process is composed of several sub-targets. </dd>
  57. </dlentry>
  58. <!-- Begin sub-targets -->
  59. <dlentry>
  60. <dt><codeph>transform.topic2fo.index</codeph></dt>
  61. <dd>Runs a Java process to set up index processing, based on the document language. This step generates the
  62. file <filepath>stage1.xml</filepath> in the temporary processing directory. </dd>
  63. </dlentry>
  64. <dlentry>
  65. <dt><codeph>transform.topic2fo.flagging</codeph></dt>
  66. <dd>Sets up preprocessing for flagging based on a DITAVAL file. This step generates the file
  67. <filepath>stage1a.xml</filepath> in the temporary processing directory.</dd>
  68. </dlentry>
  69. <dlentry>
  70. <dt><codeph>transform.topic2fo.main</codeph></dt>
  71. <dd>Does the bulk of the conversion from DITA to XSL-FO. It runs the XSLT-based process that creates
  72. <filepath>stage2.fo</filepath> in the temporary processing directory</dd>
  73. </dlentry>
  74. <dlentry>
  75. <dt><codeph>transform.topic2fo.i18n</codeph></dt>
  76. <dd>Does additional localization processing on the FO file; it runs a Java process that converts
  77. <filepath>stage2.fo</filepath> into <filepath>stage3.fo</filepath>, followed by an XSLT process that
  78. converts <filepath>stage3.fo</filepath> into <filepath>topic.fo</filepath>.</dd>
  79. </dlentry>
  80. <!-- End sub-targets -->
  81. <dlentry>
  82. <dt><codeph>transform.fo2pdf</codeph></dt>
  83. <dd>Converts the <filepath>topic.fo</filepath> file into PDF using the specified FO processor (Antenna House,
  84. XEP, or Apache FOP).</dd>
  85. </dlentry>
  86. <dlentry>
  87. <dt><codeph>delete.fo2pdf.topic.fo</codeph></dt>
  88. <dd>Deletes the <filepath>topic.fo</filepath> file, unless otherwise specified by setting an Ant property or
  89. command-line option.</dd>
  90. </dlentry>
  91. </dl>
  92. </section>
  93. </conbody>
  94. </concept>