| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE html
|
|---|
| 3 | PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|---|
| 4 | <html xml:lang="en-us" lang="en-us">
|
|---|
| 5 | <head>
|
|---|
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|---|
| 7 | <meta name="copyright" content="(C) Copyright 2005"/>
|
|---|
| 8 | <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
|
|---|
| 9 | <meta name="DC.Type" content="reference"/>
|
|---|
| 10 | <meta name="DC.Title" content="Ant parameters: PDF transformation"/>
|
|---|
| 11 | <meta name="abstract" content="Certain parameters are specific to the PDF2 transformation."/>
|
|---|
| 12 | <meta name="description" content="Certain parameters are specific to the PDF2 transformation."/>
|
|---|
| 13 | <meta name="DC.subject" content="Ant, parameters, args.bookmap-order, args.fo.userconfig, args.gen.task.lbl, args.rellinks, args.xsl.pdf, custom.xep.config, customization.dir, pdf.formatter, publish.required.cleanup, retain.topic.fo, XSLT parameters, org.dita.pdf2.use-out-temp, publishRequiredCleanup"/>
|
|---|
| 14 | <meta name="keywords" content="Ant, parameters, args.bookmap-order, args.fo.userconfig, args.gen.task.lbl, args.rellinks, args.xsl.pdf, custom.xep.config, customization.dir, pdf.formatter, publish.required.cleanup, retain.topic.fo, XSLT parameters, org.dita.pdf2.use-out-temp, publishRequiredCleanup"/>
|
|---|
| 15 | <meta name="DC.Relation" scheme="URI" content="../readme/dita-ot_ant_properties.html"/>
|
|---|
| 16 | <meta name="DC.Relation" scheme="URI" content="../readme/dita2pdf.html"/>
|
|---|
| 17 | <meta name="DC.Relation" scheme="URI" content="../readme/ant-parameters-all-transformation-types.html"/>
|
|---|
| 18 | <meta name="DC.Format" content="XHTML"/>
|
|---|
| 19 | <meta name="DC.Identifier" content="ant-parameters-pdf2-transformation"/>
|
|---|
| 20 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
|---|
| 21 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
|---|
| 22 | <title>Ant parameters: PDF transformation</title>
|
|---|
| 23 | </head>
|
|---|
| 24 | <body id="ant-parameters-pdf2-transformation">
|
|---|
| 25 |
|
|---|
| 26 |
|
|---|
| 27 | <h1 class="title topictitle1">Ant parameters: PDF transformation</h1>
|
|---|
| 28 |
|
|---|
| 29 |
|
|---|
| 30 |
|
|---|
| 31 |
|
|---|
| 32 | <div class="body refbody"><p class="shortdesc">Certain parameters are specific to the PDF2 transformation.</p>
|
|---|
| 33 |
|
|---|
| 34 |
|
|---|
| 35 | <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="table" frame="border" border="1" rules="all"><caption><span class="tablecap">Table 1. Ant parameters: PDF transformation</span></caption>
|
|---|
| 36 |
|
|---|
| 37 |
|
|---|
| 38 | <thead class="thead" align="left">
|
|---|
| 39 | <tr class="row">
|
|---|
| 40 | <th class="entry" valign="top" width="27.27272727272727%" id="d27497e79">Parameters</th>
|
|---|
| 41 |
|
|---|
| 42 | <th class="entry" valign="top" width="72.72727272727273%" id="d27497e82">Description</th>
|
|---|
| 43 |
|
|---|
| 44 | </tr>
|
|---|
| 45 |
|
|---|
| 46 | </thead>
|
|---|
| 47 |
|
|---|
| 48 | <tbody class="tbody">
|
|---|
| 49 | <tr id="ant-parameters-pdf2-transformation__args.bookmap-order" class="row">
|
|---|
| 50 | <td class="entry" valign="top" width="27.27272727272727%" headers="d27497e79 "><span class="keyword parmname">args.bookmap-order</span></td>
|
|---|
| 51 |
|
|---|
| 52 | <td class="entry" id="ant-parameters-pdf2-transformation__args.bookmap-order.desc" valign="top" width="72.72727272727273%" headers="d27497e82 ">Specifies if the frontmatter and backmatter content
|
|---|
| 53 | order is retained in bookmap. The allowed values are <span class="keyword option">retain</span> and
|
|---|
| 54 | <span class="keyword option">discard</span>; the default value is <span class="keyword option">discard</span>.</td>
|
|---|
| 55 |
|
|---|
| 56 | </tr>
|
|---|
| 57 |
|
|---|
| 58 | <tr class="row">
|
|---|
| 59 | <td class="entry" valign="top" width="27.27272727272727%" headers="d27497e79 "><span class="keyword parmname">args.fo.userconfig</span></td>
|
|---|
| 60 |
|
|---|
| 61 | <td class="entry" id="ant-parameters-pdf2-transformation__d874e43" valign="top" width="72.72727272727273%" headers="d27497e82 ">Specifies the user configuration file for
|
|---|
| 62 | FOP.</td>
|
|---|
| 63 |
|
|---|
| 64 | </tr>
|
|---|
| 65 |
|
|---|
| 66 | <tr class="row">
|
|---|
| 67 | <td class="entry" valign="top" width="27.27272727272727%" headers="d27497e79 "><span class="keyword parmname">args.gen.task.lbl</span></td>
|
|---|
| 68 |
|
|---|
| 69 | <td class="entry" id="ant-parameters-pdf2-transformation__d874e53" valign="top" width="72.72727272727273%" headers="d27497e82 ">Specifies whether to generate
|
|---|
| 70 | headings for sections within task topics. The allowed values are <span class="keyword option">YES</span>
|
|---|
| 71 | and <span class="keyword option">NO</span>; the default value is <span class="keyword option">NO</span>. <span class="ph">Corresponds to the XSLT parameter
|
|---|
| 72 | <span class="keyword parmname">GENERATE-TASK-LABELS</span>.</span></td>
|
|---|
| 73 |
|
|---|
| 74 | </tr>
|
|---|
| 75 |
|
|---|
| 76 | <tr class="row">
|
|---|
| 77 | <td class="entry" valign="top" width="27.27272727272727%" headers="d27497e79 "><span class="keyword parmname">args.rellinks</span></td>
|
|---|
| 78 |
|
|---|
| 79 | <td class="entry" id="ant-parameters-pdf2-transformation__d874e77" valign="top" width="72.72727272727273%" headers="d27497e82 ">
|
|---|
| 80 | <p class="p" id="ant-parameters-pdf2-transformation__d874e79">Specifies which links to include in the output. The
|
|---|
| 81 | following values are supported:</p>
|
|---|
| 82 |
|
|---|
| 83 | <ul class="ul">
|
|---|
| 84 | <li class="li"><span class="keyword option">none</span> – No links are included.</li>
|
|---|
| 85 |
|
|---|
| 86 | <li class="li"><span class="keyword option">all</span> – All links are included.</li>
|
|---|
| 87 |
|
|---|
| 88 | <li class="li"><span class="keyword option">nofamily</span> – Parent, child, next, and previous links are not
|
|---|
| 89 | included.</li>
|
|---|
| 90 |
|
|---|
| 91 | </ul>
|
|---|
| 92 |
|
|---|
| 93 | <p class="p">Default value depends on the transformation type.</p>
|
|---|
| 94 |
|
|---|
| 95 | </td>
|
|---|
| 96 |
|
|---|
| 97 | </tr>
|
|---|
| 98 |
|
|---|
| 99 | <tr id="ant-parameters-pdf2-transformation__args.xsl.pdf" class="row">
|
|---|
| 100 | <td class="entry" valign="top" width="27.27272727272727%" headers="d27497e79 "><span class="keyword parmname">args.xsl.pdf</span></td>
|
|---|
| 101 |
|
|---|
| 102 | <td class="entry" id="ant-parameters-pdf2-transformation__args.xsl.pdf.desc" valign="top" width="72.72727272727273%" headers="d27497e82 ">Specifies an XSL file that is used to override the default
|
|---|
| 103 | XSL transformation
|
|---|
| 104 | (<span class="ph filepath">plugins\org.dita.pdf2\xsl\fo\topic2fo_shell.xsl</span>). You must
|
|---|
| 105 | specify the fully qualified file name.</td>
|
|---|
| 106 |
|
|---|
| 107 | </tr>
|
|---|
| 108 |
|
|---|
| 109 | <tr id="ant-parameters-pdf2-transformation__custom.xep.config" class="row">
|
|---|
| 110 | <td class="entry" valign="top" width="27.27272727272727%" headers="d27497e79 "><span class="keyword parmname">custom.xep.config</span></td>
|
|---|
| 111 |
|
|---|
| 112 | <td class="entry" id="ant-parameters-pdf2-transformation__custom.xep.config.desc" valign="top" width="72.72727272727273%" headers="d27497e82 ">Specifies the user configuration file for
|
|---|
| 113 | RenderX.</td>
|
|---|
| 114 |
|
|---|
| 115 | </tr>
|
|---|
| 116 |
|
|---|
| 117 | <tr id="ant-parameters-pdf2-transformation__customization.dir" class="row">
|
|---|
| 118 | <td class="entry" valign="top" width="27.27272727272727%" headers="d27497e79 "><span class="keyword parmname">customization.dir</span></td>
|
|---|
| 119 |
|
|---|
| 120 | <td class="entry" valign="top" width="72.72727272727273%" headers="d27497e82 ">Specifies the customization directory.</td>
|
|---|
| 121 |
|
|---|
| 122 | </tr>
|
|---|
| 123 |
|
|---|
| 124 | <tr id="ant-parameters-pdf2-transformation__pdf.formatter" class="row">
|
|---|
| 125 | <td class="entry" valign="top" width="27.27272727272727%" headers="d27497e79 "><span class="keyword parmname">pdf.formatter</span></td>
|
|---|
| 126 |
|
|---|
| 127 | <td class="entry" valign="top" width="72.72727272727273%" headers="d27497e82 ">Specifies the XSL processor. The following values are supported:<ul class="ul">
|
|---|
| 128 | <li class="li"><span class="keyword option">ah</span> – Antenna House Formatter</li>
|
|---|
| 129 |
|
|---|
| 130 | <li class="li"><span class="keyword option">fop</span> (default) – Apache FOP</li>
|
|---|
| 131 |
|
|---|
| 132 | <li class="li"><span class="keyword option">xep</span> – RenderX XEP Engine</li>
|
|---|
| 133 |
|
|---|
| 134 | </ul>
|
|---|
| 135 | The full-easy-install package comes with Apache FOP; other XSL processors must be
|
|---|
| 136 | separately installed. </td>
|
|---|
| 137 |
|
|---|
| 138 | </tr>
|
|---|
| 139 |
|
|---|
| 140 | <tr id="ant-parameters-pdf2-transformation__publish.required.cleanup" class="row">
|
|---|
| 141 | <td class="entry" valign="top" width="27.27272727272727%" headers="d27497e79 "><span class="keyword parmname">publish.required.cleanup</span></td>
|
|---|
| 142 |
|
|---|
| 143 | <td class="entry" id="ant-parameters-pdf2-transformation__publish.required.cleanup.desc" valign="top" width="72.72727272727273%" headers="d27497e82 ">Specifies whether draft-comment and
|
|---|
| 144 | required-cleanup elements are included in the output. The allowed values are
|
|---|
| 145 | <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is the value of the
|
|---|
| 146 | <span class="keyword parmname">args.draft</span> parameter. <span class="ph">Corresponds to XSLT parameter
|
|---|
| 147 | <span class="keyword parmname">publishRequiredCleanup</span>.</span><div class="note note"><span class="notetitle">Note:</span> This parameter
|
|---|
| 148 | is deprecated in favor of the <span class="keyword parmname">args.draft</span>
|
|---|
| 149 | parameter.</div>
|
|---|
| 150 | </td>
|
|---|
| 151 |
|
|---|
| 152 | </tr>
|
|---|
| 153 |
|
|---|
| 154 | <tr id="ant-parameters-pdf2-transformation__retain.topic.fo" class="row">
|
|---|
| 155 | <td class="entry" valign="top" width="27.27272727272727%" headers="d27497e79 "><span class="keyword parmname">retain.topic.fo</span></td>
|
|---|
| 156 |
|
|---|
| 157 | <td class="entry" id="ant-parameters-pdf2-transformation__retain.topic.fo.desc" valign="top" width="72.72727272727273%" headers="d27497e82 ">Specifies whether to retain the generated FO file. The
|
|---|
| 158 | allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is
|
|---|
| 159 | <span class="keyword option">no</span>. If the configuration property
|
|---|
| 160 | <span class="keyword parmname">org.dita.pdf2.use-out-temp</span> is set to <span class="keyword option">false</span>,
|
|---|
| 161 | this parameter is ignored.</td>
|
|---|
| 162 |
|
|---|
| 163 | </tr>
|
|---|
| 164 |
|
|---|
| 165 | </tbody>
|
|---|
| 166 |
|
|---|
| 167 | </table>
|
|---|
| 168 | </div>
|
|---|
| 169 |
|
|---|
| 170 | </div>
|
|---|
| 171 |
|
|---|
| 172 | <div class="related-links">
|
|---|
| 173 | <div class="familylinks">
|
|---|
| 174 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../readme/dita-ot_ant_properties.html" title="Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based transformations. Finally, some parameters apply only to the specific transformation types.">Ant parameters</a></div>
|
|---|
| 175 | </div>
|
|---|
| 176 | <div class="relinfo relconcepts"><strong>Related concepts</strong><br/>
|
|---|
| 177 | <div><a class="link" href="../readme/dita2pdf.html" title="The pdf (or pdf2) transformation generates PDF output.">PDF transformation</a></div>
|
|---|
| 178 | </div>
|
|---|
| 179 | <div class="relinfo relref"><strong>Related reference</strong><br/>
|
|---|
| 180 | <div><a class="link" href="../readme/ant-parameters-all-transformation-types.html" title="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit.">Ant parameters: All transformations</a></div>
|
|---|
| 181 | </div>
|
|---|
| 182 | </div>
|
|---|
| 183 |
|
|---|
| 184 | </body>
|
|---|
| 185 | </html>
|
|---|
