pdf-customization-resources.dita 5.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <reference id="ID">
  5. <title>Resources for custom PDF plug-ins</title>
  6. <titlealts>
  7. <navtitle>Custom PDF plug-in resources</navtitle>
  8. </titlealts>
  9. <shortdesc>There are several external resources that can help you generate and refine custom PDF plug-ins for the DITA
  10. Open Toolkit.</shortdesc>
  11. <refbody>
  12. <section id="pdf-plugin-generator">
  13. <title>PDF Plugin Generator</title>
  14. <p>This online tool, developed and maintained by Jarno Elovirta, enables you to generate a PDF customization
  15. plug-in automatically.</p>
  16. <p>The application at
  17. <xref href="http://dita-generator.elovirta.com/" format="html" scope="external"
  18. >dita-generator.elovirta.com</xref> walks you through the process of creating a custom PDF plug-in and allows
  19. you to adjust a variety of settings for your PDF output. For example, you can:</p>
  20. <ul>
  21. <li>Define the target environment, selecting from the most current and two previous versions of the DITA-OT</li>
  22. <li>Select the XSL formatting engine (FOP, Antenna House Formatter, or RenderX XEP)</li>
  23. <li>Specify page size, columns, and margins</li>
  24. <li>Select from (limited) options for headers and footers</li>
  25. <li>Specify layout options for chapters</li>
  26. <li>Select formatting for the following publication components:
  27. <ul>
  28. <li>Normal text</li>
  29. <li>Headings (levels one through four)</li>
  30. <li>Titles for sections and examples</li>
  31. <li>Tables and figures</li>
  32. <li>Notes and examples</li>
  33. <li>Lists (unordered, ordered, and definition)</li>
  34. <li>Code blocks and pre-formatted text</li>
  35. <li>Inline elements such as links and trademarks</li>
  36. </ul><draft-comment author="Kristen Eberlein" time="13 February 2016">
  37. <p>Given the technical level of our audience here, should we list DITA elements rather than the generic
  38. categories?</p>
  39. </draft-comment>
  40. <p>For each component, you can specify: </p>
  41. <ul>
  42. <li>Font family, size, weight, and style</li>
  43. <li>Color and background color</li>
  44. <li>Alignment, indentation, spacing, and padding</li>
  45. </ul></li>
  46. </ul>
  47. <note type="tip">The PDF Plugin Generator should be your first stop as you start developing a brand-new PDF
  48. customization plug-in.</note>
  49. </section>
  50. <section id="dita-for-print">
  51. <title><cite>DITA for Print: A DITA Open Toolkit Workbook</cite> (Second Edition, 2017)</title>
  52. <p>Authored by Leigh W. White, DITA Specialist at IXIASOFT, and published by XML Press, <cite>DITA for
  53. Print</cite> walks readers through developing a PDF customization from scratch. </p>
  54. <p>Here is an excerpt from the back cover:</p>
  55. <lq><cite>DITA for Print</cite> is for anyone who wants to learn how to create PDFs using the DITA Open Toolkit
  56. without learning everything there is to know about XSL-FO, XSLT, or XPath, or even about the DITA Open Toolkit
  57. itself. <cite>DITA for Print</cite> is written for non-programmers, by a non-programmer, and although it is
  58. written for people who have a good understanding of the DITA standard, you don't need a technical background to
  59. get custom PDFs up and running quickly.</lq>
  60. <p>This is an excellent, long-needed resource that was initially developed in 2013 for DITA-OT 1.8.</p>
  61. <p>The second edition has been revised to cover DITA Open Toolkit Version 2, including customizing the DITA 1.3
  62. troubleshooting topic type, localization strings, bookmarks, and the new back-cover functionality.</p>
  63. <note type="important">
  64. <p>The first edition of <cite>DITA for Print</cite> recommended copying entire files from the PDF2 plug-in to
  65. your custom plug-in. The DITA-OT project — and the second edition of the book — do not recommend this
  66. practice.</p>
  67. <p>Instead, you should copy only the specific attribute sets and templates that you want to override. Following
  68. this practice will more cleanly isolate your customizations from the DITA-OT code, which will make it easier
  69. for you to update your plug-ins to work with future versions of the DITA-OT.</p></note>
  70. </section>
  71. <section id="dita-for-practitioners">
  72. <title><cite>DITA for Practitioners: Volume 1, Architecture and Technology</cite> (2012)</title>
  73. <p>Authored by Eliot Kimber and published by XML Press, this seminal resource contains a chapter dedicated to the
  74. DITA Open Toolkit: “Running, Configuring, and Customizing the Open Toolkit”. In addition to a robust overview of
  75. DITA-OT customization and extension, the chapter contains a detailed example of customizing a PDF plug-in to
  76. specify 7" × 10" paper size and custom fonts for body text and headers.</p>
  77. <p>The DITA-OT chapter in <cite>DITA for Practitioners: Volume 1</cite> was written for DITA-OT 1.5.4, which was
  78. the latest stable version at the time it was written.</p>
  79. </section>
  80. </refbody>
  81. </reference>