pdf-customization.html 6.8 KB

1234567891011
  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 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><meta name="DC.Type" content="task"><meta name="description" content="You can create custom DITA-OT plug-ins that build on the default DITA to PDF transformation. Plug-ins can customize covers and page layouts, modify formatting, override logic of the default PDF plug-in, and much more."><meta name="DC.Relation" scheme="URI" content="../dev_ref/index.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/pdf-transformation-history.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/pdf-customization-approaches.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/pdf-customization-plugin-types.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/pdf-plugin-structure.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/pdf-customization-example.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/pdf-customization-best-practices.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/pdf-customization-resources.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="customizing-pdf-output"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Customizing PDF output</title></head><body id="customizing-pdf-output"><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 2.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../getting-started/index.html">Getting Started</a></li><li><a href="../user-guide/index.html">User Guide</a></li><li><a href="../parameters/index.html">Parameter Reference</a></li><li><a href="../dev_ref/index.html">Developer Reference</a><ul><li><a href="../dev_ref/DITA-OTArchitecture.html">DITA-OT Architecture</a></li><li><a href="../dev_ref/extending-the-ot.html">Extending the DITA-OT</a></li><li><a href="../dev_ref/plugin-creating.html">Creating plug-ins</a></li><li><a href="../dev_ref/plugin-extension-points.html">Extension points</a></li><li class="active"><a href="../dev_ref/pdf-customization.html">Customizing PDF output</a><ul><li><a href="../dev_ref/pdf-transformation-history.html">History of the PDF transformation</a></li><li><a href="../dev_ref/pdf-customization-approaches.html">PDF customization approaches</a></li><li><a href="../dev_ref/pdf-customization-plugin-types.html">Types of custom PDF plug-ins</a></li><li><a href="../dev_ref/pdf-plugin-structure.html">PDF plug-in structure</a></li><li><a href="../dev_ref/pdf-customization-example.html">Simple PDF plug-in example</a></li><li><a href="../dev_ref/pdf-customization-best-practices.html">Customization best practices</a></li><li><a href="../dev_ref/pdf-customization-resources.html">Custom PDF plug-in resources</a></li></ul></li><li><a href="../dev_ref/migration.html">Migrating customizations</a></li></ul></li><li><a href="../user-guide/dita-and-dita-ot-resources.html">DITA Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
  7. <h1 class="title topictitle1" id="ariaid-title1">Customizing PDF output</h1>
  8. <p class="shortdesc">You can create custom DITA-OT plug-ins that build on the default DITA to PDF transformation. Plug-ins can
  9. customize covers and page layouts, modify formatting, override logic of the default PDF plug-in, and much
  10. more.</p>
  11. <nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../dev_ref/pdf-transformation-history.html">History of the PDF transformation</a></strong><br>The DITA Open Toolkit PDF transformation was originally based on a third-party contribution by Idiom Technologies, and is commonly known as the “pdf2” plug-in.</li><li class="link ulchildlink"><strong><a href="../dev_ref/pdf-customization-approaches.html">PDF customization approaches</a></strong><br>Various methods may be used to customize the PDF output produced by the DITA Open Toolkit. Each of these approaches have advantages and shortcomings that should be considered when preparing a customization project. Some of these methods are considered “anti-patterns” with disadvantages that outweigh their apparent appeal. In most cases, you should create a custom PDF plug-in.</li><li class="link ulchildlink"><strong><a href="../dev_ref/pdf-customization-plugin-types.html">Types of custom PDF plug-ins</a></strong><br>There are two common types of plug-ins: A plug-in that simply sets the DITA-OT parameters to be used when a PDF is generated, and a plug-in that overrides aspects of the base DITA-OT PDF transformation. A plug-in can, of course, do both of these things.</li><li class="link ulchildlink"><strong><a href="../dev_ref/pdf-plugin-structure.html">PDF plug-in structure</a></strong><br>In cases that require substantial customizations, it is often useful to organize the files in a folder structure that mimics the hierarchy of the default PDF plug-in. This method facilitates comparisons with the default settings in the base PDF plug-in and makes it easier to migrate customizations to new toolkit versions.</li><li class="link ulchildlink"><strong><a href="../dev_ref/pdf-customization-example.html">Example: Creating a simple PDF plug-in</a></strong><br>This scenario walks through the process of creating a very simple plug-in (<code class="ph codeph">com.example.print-pdf</code>) that creates a new transformation type: <span class="keyword option">print-pdf</span>. </li><li class="link ulchildlink"><strong><a href="../dev_ref/pdf-customization-best-practices.html">Best practices for custom PDF plug-ins</a></strong><br>Adhering to certain development practices will properly isolate your code from that of the DITA Open Toolkit. This will make it easier to you to upgrade to new versions of the DITA-OT when they are released.</li><li class="link ulchildlink"><strong><a href="../dev_ref/pdf-customization-resources.html">Resources for custom PDF plug-ins</a></strong><br>There are several external resources that can help you generate and refine custom PDF plug-ins for the DITA Open Toolkit.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../dev_ref/index.html" title="The Developer Reference is designed to provide more advanced information about the DITA-OT. It is geared to an audience that needs information about the DITA-OT architecture, extending the DITA-OT, and creating DITA-OT plug-ins.">DITA Open Toolkit Developer Reference</a></div></div></nav></article></main></body></html>