| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
|---|
| 3 | <concept id="about_pdftransformation">
|
|---|
| 4 | <title>Understanding PDF Transformations</title>
|
|---|
| 5 | <shortdesc>Learning how DITA OT uses the FO plugin to generate PDF documents.
|
|---|
| 6 | </shortdesc>
|
|---|
| 7 | <prolog>
|
|---|
| 8 | <author>Rob Justice</author>
|
|---|
| 9 | <metadata>
|
|---|
| 10 | <keywords>
|
|---|
| 11 | <indexterm>FO Plugin</indexterm><indexterm>PDF transformations</indexterm>
|
|---|
| 12 | </keywords>
|
|---|
| 13 | </metadata>
|
|---|
| 14 | </prolog>
|
|---|
| 15 | <conbody>
|
|---|
| 16 | <p>DITA-OT performs PDF transformations differently than other output types. A separate software program, known as XSL formatter, is used
|
|---|
| 17 | to generate the PDF documents. By default, that engine is the FO Plugin, which also uses an Ant build script to generates several files and
|
|---|
| 18 | place them in the directory you specify with the <codeph>dita.temp.dir</codeph> property in your script. Several of these files are useful for
|
|---|
| 19 | debugging PDF-related transformation errors. However, the FO Plugin build script also deletes them by default. You can override this behavior
|
|---|
| 20 | by setting the value of the <codeph>clean.temp</codeph> ant property in your build script to "no," as shown in the following code snippet.
|
|---|
| 21 | <codeblock>< property name="clean.temp" value="no"/></codeblock></p>
|
|---|
| 22 | <note>The FO Plugin ant build script is located in the
|
|---|
| 23 | following directory: <codeph>DITA-OT<keyword keyref="release.version"/>\demo\fo\build.xml</codeph>.</note>
|
|---|
| 24 | <p>The following table describes the auto-generated files relevant to debugging PDF transformation errors.</p>
|
|---|
| 25 | <table>
|
|---|
| 26 | <tgroup cols="2">
|
|---|
| 27 | <colspec colname="COLSPEC10" colwidth="150*"/>
|
|---|
| 28 | <colspec colname="COLSPEC11" colwidth="250*"/>
|
|---|
| 29 | <thead>
|
|---|
| 30 | <row>
|
|---|
| 31 | <entry colname="COLSPEC10" valign="top">File Name</entry>
|
|---|
| 32 | <entry colname="COLSPEC11" valign="top">Description</entry>
|
|---|
| 33 | </row>
|
|---|
| 34 | </thead>
|
|---|
| 35 | <tbody>
|
|---|
| 36 | <row>
|
|---|
| 37 | <entry>
|
|---|
| 38 | <p><codeph>stage1.xml</codeph></p>
|
|---|
| 39 | </entry>
|
|---|
| 40 | <entry>
|
|---|
| 41 | Contains FO processing information related to your index entries.
|
|---|
| 42 | </entry>
|
|---|
| 43 | </row>
|
|---|
| 44 | <row>
|
|---|
| 45 | <entry>
|
|---|
| 46 | <codeph>stage2.fo</codeph>, <codeph>stage3.fo</codeph>
|
|---|
| 47 | </entry>
|
|---|
| 48 | <entry>
|
|---|
| 49 | Contains FO processing information related to your internationalization files.
|
|---|
| 50 | </entry>
|
|---|
| 51 | </row>
|
|---|
| 52 | <row>
|
|---|
| 53 | <entry>
|
|---|
| 54 | <codeph>buildfile_MERGED.xml</codeph>
|
|---|
| 55 | </entry>
|
|---|
| 56 | <entry>
|
|---|
| 57 | Contains all the processing information from the generated files and your content in a format that the FO Plugin can use
|
|---|
| 58 | to generate your PDF file.
|
|---|
| 59 | </entry>
|
|---|
| 60 | </row>
|
|---|
| 61 | </tbody>
|
|---|
| 62 | </tgroup>
|
|---|
| 63 | </table>
|
|---|
| 64 | <p>Examine the content of these files to determine the cause of PDF transformation errors.</p>
|
|---|
| 65 | <note>The Apache FOP formatter does not support the <codeph>indexlist</codeph> element for PDF.
|
|---|
| 66 | You can try using a different PDF renderer or engine by specifying a different value for the <codeph>
|
|---|
| 67 | pdf.formatter</codeph> ant property in the FO plugin build file, or add a <codeph>topicref</codeph> element
|
|---|
| 68 | in your build file with that links to a manually-created index file.</note>
|
|---|
| 69 | </conbody>
|
|---|
| 70 | </concept>
|
|---|
