parameters-pdf.html 12 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2019"><meta name="DC.rights.owner" content="(C) Copyright 2019"><meta name="DC.type" content="reference"><meta name="description" content="Certain parameters are specific to the PDF transformation."><meta name="DC.relation" scheme="URI" content="../parameters/parameters_intro.html"><meta name="DC.relation" scheme="URI" content="../topics/dita2pdf.html"><meta name="DC.relation" scheme="URI" content="../parameters/parameters-base.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="pdf"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>PDF parameters</title></head><body id="pdf"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li><a href="../parameters/parameters-base.html">Common</a></li><li class="active"><a href="../parameters/parameters-pdf.html">PDF</a></li><li><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-xhtml.html">XHTML</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTML Help</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-other.html">Other</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/customizing.html">Customizing DITA-OT</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">PDF parameters</h1><div class="body refbody"><p class="shortdesc">Certain parameters are specific to the
  7. PDF transformation.</p><section class="section"><dl class="dl parml"><dt class="dt pt dlterm" id="pdf__args.artlbl"><span class="keyword parmname">args.artlbl</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.artlbl.desc">Specifies whether to generate a label for each image; the label will contain the image file name. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="pdf__args.bookmap-order"><span class="keyword parmname">args.bookmap-order</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.bookmap-order.desc">Specifies if the frontmatter and backmatter content order is retained in bookmap. The allowed values are <span class="keyword option">retain</span> and <span class="keyword option">discard</span>; the default value is <span class="keyword option">discard</span>.</dd><dt class="dt pt dlterm" id="pdf__args.bookmark.style"><span class="keyword parmname">args.bookmark.style</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.bookmark.style.desc">Specifies whether PDF bookmarks are by default expanded or collapsed. The allowed values are <span class="keyword option">EXPANDED</span> and <span class="keyword option">COLLAPSE</span>.</dd><dt class="dt pt dlterm" id="pdf__args.chapter.layout"><span class="keyword parmname">args.chapter.layout</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.chapter.layout.desc">Specifies whether chapter level TOCs are generated. The allowed values are <span class="keyword option">MINITOC</span> and <span class="keyword option">BASIC</span>; the default value is <span class="keyword option">MINITOC</span>.</dd><dt class="dt pt dlterm" id="pdf__args.fo.userconfig"><span class="keyword parmname">args.fo.userconfig</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.fo.userconfig.desc">Specifies the user configuration file for FOP.</dd><dt class="dt pt dlterm" id="pdf__args.xsl.pdf"><span class="keyword parmname">args.xsl.pdf</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.xsl.pdf.desc">Specifies an XSL file that is used to override the default XSL transformation.</dd><dd class="dd pd ddexpand">You must specify the fully qualified file name.</dd><dt class="dt pt dlterm" id="pdf__axf.cmd"><span class="keyword parmname">axf.cmd</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__axf.cmd.desc">Specifies the path to the Antenna House Formatter executable.</dd><dt class="dt pt dlterm" id="pdf__axf.opt"><span class="keyword parmname">axf.opt</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__axf.opt.desc">Specifies the user configuration file for Antenna House Formatter.</dd><dt class="dt pt dlterm" id="pdf__custom.xep.config"><span class="keyword parmname">custom.xep.config</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__custom.xep.config.desc">Specifies the user configuration file for RenderX.</dd><dt class="dt pt dlterm" id="pdf__customization.dir"><span class="keyword parmname">customization.dir</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__customization.dir.desc">Specifies the customization directory.</dd><dt class="dt pt dlterm" id="pdf__maxJavaMemory"><span class="keyword parmname">maxJavaMemory</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__maxJavaMemory.desc">Specifies the amount of memory allocated to the RenderX process.</dd><dt class="dt pt dlterm" id="pdf__org.dita.pdf2.chunk.enabled"><span class="keyword parmname">org.dita.pdf2.chunk.enabled</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__org.dita.pdf2.chunk.enabled.desc">Enables chunk attribute processing. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">true</span> – Enables chunk processing</li><li class="li"><span class="keyword option">false</span> (default) – Disables chunk processing</li></ul></dd><dt class="dt pt dlterm" id="pdf__org.dita.pdf2.i18n.enabled"><span class="keyword parmname">org.dita.pdf2.i18n.enabled</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__org.dita.pdf2.i18n.enabled.desc">
  8. <p class="p">Enables internationalization (I18N) font processing to provide per-character font selection for FO
  9. renderers that do not support the <code class="ph codeph">font-selection-strategy</code> property (such as Apache
  10. FOP).
  11. </p>
  12. <p class="p">When this feature is enabled, DITA-OT uses a font mapping process that takes the content language into
  13. consideration. The mapping process uses configuration files for each language to define characters that
  14. should be rendered with certain logical fonts, and font mappings that associate each logical font to
  15. physical font files.</p>
  16. <p class="p">The following values are allowed:</p>
  17. <ul class="ul">
  18. <li class="li"><span class="keyword option">true</span> (default) — Enables font mapping</li>
  19. <li class="li"><span class="keyword option">false</span> — Disables font mapping</li>
  20. </ul>
  21. <div class="note tip note_tip"><span class="note__title">Tip:</span> If you don’t use custom character mappings, turning off font mapping makes it easier to
  22. define custom fonts simply by changing font names in the XSL attributes files of your custom PDF
  23. plug-in. For details, see <a class="xref" href="http://www.elovirta.com/2016/02/18/font-configuration-in-pdf2.html" target="_blank">Font configuration in PDF2</a>.</div>
  24. </dd><dt class="dt pt dlterm" id="pdf__outputFile.base"><span class="keyword parmname">outputFile.base</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__outputFile.base.desc">Specifies the base file name of the generated PDF file.</dd><dd class="dd pd ddexpand">By default, the PDF file uses the base filename of the input
  25. <span class="ph filepath">.ditamap</span> file.
  26. </dd><dt class="dt pt dlterm" id="pdf__pdf.formatter"><span class="keyword parmname">pdf.formatter</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__pdf.formatter.desc">Specifies the XSL processor. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">ah</span> – Antenna House Formatter</li><li class="li"><span class="keyword option">xep</span> – RenderX XEP Engine</li><li class="li"><span class="keyword option">fop</span> (default) – Apache FOP</li></ul></dd><dd class="dd pd ddexpand">
  27. </dd><dt class="dt pt dlterm" id="pdf__publish.required.cleanup"><span class="keyword parmname">publish.required.cleanup</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__publish.required.cleanup.desc">Specifies whether draft-comment and required-cleanup elements are included in the output. The allowed values are <span class="keyword option">yes</span>, <span class="keyword option">no</span>, <span class="keyword option">yes</span>, and <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">The default value is the value of the <span class="keyword parmname">args.draft</span> parameter.
  28. <span class="ph">Corresponds to the XSLT parameter
  29. <span class="keyword parmname">publishRequiredCleanup</span>.</span><div class="note note note_note"><span class="note__title">Note:</span> This parameter is deprecated in
  30. favor of the <span class="keyword parmname">args.draft</span> parameter.
  31. </div></dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based transformations. Some parameters apply only to specific transformation types. These parameters can be passed as options to the dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div><div class="linklist relinfo relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/dita2pdf.html" title="The pdf transformation generates output in Portable Document Format.">PDF transformation</a></li></ul></div><div class="linklist relinfo relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that DITA Open Toolkit supports.">Common parameters</a></li></ul></div></nav></article></main></body></html>