صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
bn
/
se
2
0
انشعاب 0
پرونده‌ها مشکلات 0 درخواست واکشی 0 ویکی
درخت: e89bfafc3a
شاخه‌ها تگ‌ها
se
/
SE
/
stuff
/
dita-ot-2.3.3
/
doc
/
dev_ref
/
pdf-customization-example.html

pdf-customization-example.html 12 KB
تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138 
  1. <!DOCTYPE html
    2. 

  2.   SYSTEM "about:legacy-compat">
    3. 

  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="This scenario walks through the process of creating a very simple plug-in (com.example.print-pdf) that creates a new transformation type: print-pdf."><meta name="DC.Relation" scheme="URI" content="../dev_ref/pdf-customization.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugins-installing.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="dita2pdf-customization"><meta name="DC.Language" content="en"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Example: Creating a simple PDF plug-in</title></head><body id="dita2pdf-customization"><header role="banner"><div class="header">
    4. 

  4.   <p>DITA Open Toolkit</p>
    5. 

  5.   <hr>
    6. 

  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><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 class="active"><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. 

  7.   <h1 class="title topictitle1" id="ariaid-title1">Example: Creating a simple PDF plug-in</h1>
    8. 

  8.   
    9. 

  9.   <div class="body taskbody"><p class="shortdesc">This scenario walks through the process of creating a very simple plug-in
    10. 

  10.       (<code class="ph codeph">com.example.print-pdf</code>) that creates a new transformation type: <span class="keyword option">print-pdf</span>. </p>
    11. 

  11.     <section class="section context"><div class="tasklabel"><h2 class="sectiontitle tasklabel">About this task</h2></div>
    12. 

  12.       <p class="p">The <span class="keyword option">print-pdf</span> transformation has the following characteristics:</p>
    13. 

  13.       <ul class="ul">
    14. 

  14.         <li class="li">Uses A4 paper </li>
    15. 

  15.         <li class="li">Renders figures with a title at the top and a description at the bottom</li>
    16. 

  16.         <li class="li">Use em dashes as the symbols for unordered lists</li>
    17. 

  17.       </ul>
    18. 

  18.     </section>
    19. 

  19.     <div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
    20. 

  20.         <span class="ph cmd">In the <span class="ph filepath">plugins</span> directory, create a directory named
    21. 

  21.             <span class="ph filepath">com.example.print-pdf</span>.</span>
    22. 

  22.       </li><li class="li step stepexpand">
    23. 

  23.         <span class="ph cmd">In the new <span class="ph filepath">com.example.print-pdf</span> directory, create a plug-in configuration file
    24. 

  24.             (<span class="ph filepath">plugin.xml</span>) that declares the new <span class="keyword option">print-pdf</span> transformation and its
    25. 

  25.           dependencies.</span>
    26. 

  26.         <div class="itemgroup info">
    27. 

  27.           <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 1. </span><span class="ph filepath">plugin.xml</span> file</figcaption>
    28. 

  28.             
    29. 

  29.             <pre class="pre codeblock"><code>&lt;?xml version='1.0' encoding='UTF-8'?&gt;
    30. 

  30. &lt;plugin id="com.example.print-pdf"&gt;
    31. 

  31.   &lt;require plugin="org.dita.pdf2"/&gt;
    32. 

  32.   &lt;feature extension="dita.conductor.transtype.check" value="print-pdf"/&gt;
    33. 

  33.   &lt;feature extension="dita.transtype.print" value="print-pdf"/&gt;
    34. 

  34.   &lt;feature extension="dita.conductor.target.relative" file="integrator.xml"/&gt;
    35. 

  35. &lt;/plugin&gt;</code></pre>
    36. 

  36.           </figure>
    37. 

  37.         </div>
    38. 

  38.       </li><li class="li step stepexpand">
    39. 

  39.         <span class="ph cmd">Add an Ant script (<span class="ph filepath">integrator.xml</span>) to define the transformation type.</span>
    40. 

  40.         <div class="itemgroup info">
    41. 

  41.           <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 2. </span><span class="ph filepath">integrator.xml</span> file</figcaption>
    42. 

  42.             
    43. 

  43.             <pre class="pre codeblock"><code>&lt;?xml version='1.0' encoding='UTF-8'?&gt;
    44. 

  44. &lt;project name="com.example.print-pdf"&gt;
    45. 

  45.   &lt;target name="dita2print-pdf.init"&gt;
    46. 

  46.     &lt;property name="customization.dir" location="${dita.plugin.com.example.print-pdf.dir}/cfg"/&gt;
    47. 

  47.   &lt;/target&gt;
    48. 

  48.   &lt;target name="dita2print-pdf" depends="dita2print-pdf.init, dita2pdf2"/&gt;
    49. 

  49. &lt;/project&gt;</code></pre>
    50. 

  50.           </figure></div>
    51. 

  51.       </li><li class="li step stepexpand">
    52. 

  52.         <span class="ph cmd">In the new plug-in directory, add a <span class="ph filepath">cfg/catalog.xml</span> file that specifies the custom
    53. 

  53.           XSLT style sheets.</span>
    54. 

  54.         <div class="itemgroup stepxmp">
    55. 

  55.           <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 3. </span><span class="ph filepath">cfg/catalog.xml</span> file</figcaption>
    56. 

  56.             
    57. 

  57.             <pre class="pre codeblock"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
    58. 

  58. &lt;catalog prefer="system" xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
    59. 

  59.   &lt;uri name="cfg:fo/attrs/custom.xsl" uri="fo/attrs/custom.xsl"/&gt;
    60. 

  60.   &lt;uri name="cfg:fo/xsl/custom.xsl" uri="fo/xsl/custom.xsl"/&gt;
    61. 

  61. &lt;/catalog&gt;</code></pre>
    62. 

  62.           </figure>
    63. 

  63.         </div>
    64. 

  64.       </li><li class="li step stepexpand">
    65. 

  65.         <span class="ph cmd">Create the <span class="ph filepath">cfg/fo/attrs/custom.xsl</span> file, and add attribute and variable overrides to
    66. 

  66.           it.</span>
    67. 

  67.         <div class="itemgroup stepxmp">For example, add the content highlighted with bold to change the page size to A4.<figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 4. </span><span class="ph filepath">cfg/fo/attrs/custom.xsl</span> file</figcaption>
    68. 

  68.             
    69. 

  69.             <pre class="pre codeblock"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
    70. 

  70. &lt;xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
    71. 

  71.                 version="2.0"&gt;
    72. 

  72.  <strong class="ph b"> &lt;!-- Change page size to A4 --&gt;
    73. 

  73.   &lt;xsl:variable name="page-width"&gt;210mm&lt;/xsl:variable&gt;
    74. 

  74.   &lt;xsl:variable name="page-height"&gt;297mm&lt;/xsl:variable&gt;</strong>
    75. 

  75. &lt;/xsl:stylesheet&gt;</code></pre>
    76. 

  76.           </figure></div>
    77. 

  77.       </li><li class="li step stepexpand">
    78. 

  78.         <span class="ph cmd">Create the <span class="ph filepath">cfg/fo/xsl/custom.xsl</span> file, and add XSLT overrides to it.</span>
    79. 

  79.         <div class="itemgroup stepxmp">For example, the following code changes the rendering of <code class="keyword markupname xmlelement">&lt;figure&gt;</code> elements.<figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 5. </span><span class="ph filepath">cfg/fo/xsl/custom.xsl</span> file</figcaption>
    80. 

  80.             
    81. 

  81.             <pre class="pre codeblock"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
    82. 

  82. &lt;xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
    83. 

  83.                 xmlns:xs="http://www.w3.org/2001/XMLSchema"
    84. 

  84.                 xmlns:fo="http://www.w3.org/1999/XSL/Format"
    85. 

  85.                 version="2.0"&gt;
    86. 

  86.   &lt;!-- Move figure title to top and description to bottom --&gt;
    87. 

  87.   &lt;xsl:template match="*[contains(@class,' topic/fig ')]"&gt;
    88. 

  88.     &lt;fo:block xsl:use-attribute-sets="fig"&gt;
    89. 

  89.       &lt;xsl:call-template name="commonattributes"/&gt;
    90. 

  90.       &lt;xsl:if test="not(@id)"&gt;
    91. 

  91.         &lt;xsl:attribute name="id"&gt;
    92. 

  92.           &lt;xsl:call-template name="get-id"/&gt;
    93. 

  93.         &lt;/xsl:attribute&gt;
    94. 

  94.       &lt;/xsl:if&gt;
    95. 

  95.       &lt;xsl:apply-templates select="*[contains(@class,' topic/title ')]"/&gt;
    96. 

  96.       &lt;xsl:apply-templates select="*[not(contains(@class,' topic/title ') or contains(@class,' topic/desc '))]"/&gt;
    97. 

  97.       &lt;xsl:apply-templates select="*[contains(@class,' topic/desc ')]"/&gt;
    98. 

  98.     &lt;/fo:block&gt;
    99. 

  99.   &lt;/xsl:template&gt;
    100. 

  100. &lt;/xsl:stylesheet&gt;</code></pre>
    101. 

  101.           </figure></div>
    102. 

  102.       </li><li class="li step stepexpand">
    103. 

  103.         <span class="ph cmd">Create an English-language variable-definition file (<span class="ph filepath">cfg/common/vars/en.xml</span>) and make
    104. 

  104.           any necessary modifications to it.</span>
    105. 

  105.         <div class="itemgroup stepxmp">For example, the following code removes the period after the number for an ordered-list item; it also
    106. 

  106.           specifies that the bullet for an unordered list item should be an em dash.<figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 6. </span><span class="ph filepath">cfg/common/vars/en.xml</span> file</figcaption>
    107. 

  107.             
    108. 

  108.             <pre class="pre codeblock"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
    109. 

  109. &lt;vars xmlns="http://www.idiominc.com/opentopic/vars"&gt;
    110. 

  110.   &lt;!-- Remove dot from list number --&gt;
    111. 

  111.   &lt;variable id="Ordered List Number"&gt;&lt;param ref-name="number"/&gt;&lt;/variable&gt;
    112. 

  112.   &lt;!-- Change unordered list bullet to an em dash --&gt;
    113. 

  113.   &lt;variable id="Unordered List bullet"&gt;&amp;#x2014;&lt;/variable&gt;
    114. 

  114. &lt;/vars&gt;</code></pre>
    115. 

  115.           </figure></div>
    116. 

  116.       </li></ol>
    117. 

  117.     <section class="section result"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Results</h2></div>
    118. 

  118.       <p class="p">The new plug-in directory has the following layout and files:</p>
    119. 

  119.       <pre class="pre codeblock"><code>com.example.print-pdf/
    120. 

  120.   cfg/
    121. 

  121.     common/
    122. 

  122.       vars/
    123. 

  123.         en.xml
    124. 

  124.     fo/
    125. 

  125.       attrs/
    126. 

  126.         custom.xsl
    127. 

  127.       xsl/
    128. 

  128.         custom.xsl
    129. 

  129.     catalog.xml
    130. 

  130.   integrator.xml
    131. 

  131.   plugin.xml</code></pre>
    132. 

  132.     </section>
    133. 

  133.     <section class="section postreq"><div class="tasklabel"><h2 class="sectiontitle tasklabel">What to do next</h2></div>
    134. 

  134.       <p class="p">Run <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/bin/<span class="keyword cmdname">dita</span></span> <span class="keyword option">-install</span> to install the plug-in and make the <span class="keyword option">print-pdf</span> transformation
    135. 

  135.         available.</p>
    136. 

  136.     </section>
    137. 

  137.   </div>
    138. 

  138. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../dev_ref/pdf-customization.html" title="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.">Customizing PDF output</a></div></div><div class="linklist linklist relinfo reltasks"><strong>Related tasks</strong><br><div><a class="link" href="../dev_ref/plugins-installing.html" title="Use the dita command to install a plug-in.">Installing plug-ins</a></div></div></nav></article></main></body></html>
    139.