custom-plugins.dita 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <concept id="custom-plugins">
  5. <title>Working with plug-ins</title>
  6. <shortdesc id="plugins-creating">You can install or create DITA-OT plug-ins to change the default output types in
  7. various ways, add entirely new kinds of output formats, or implement DITA topic specializations.</shortdesc>
  8. <prolog>
  9. <metadata>
  10. <keywords>
  11. <indexterm>DITA<indexterm>specializations</indexterm></indexterm>
  12. <indexterm start="plugins">plug-ins</indexterm>
  13. <indexterm>plug-ins<indexterm>benefits</indexterm></indexterm>
  14. <indexterm>plug-ins<indexterm>working with</indexterm></indexterm>
  15. </keywords>
  16. </metadata>
  17. </prolog>
  18. <conbody>
  19. <p>A plug-in consists of a directory, typically stored within the <filepath>plugins/</filepath> subdirectory of the
  20. DITA-OT installation. Every plug-in is controlled by a file named <filepath>plugin.xml</filepath>, which is
  21. located in the root directory of the plug-in.</p>
  22. <section id="plugin-benefits">
  23. <title>Plug-in benefits</title>
  24. <p>Plug-ins allow you to extend the toolkit in a way that is consistent, easy-to-share, and possible to preserve
  25. through toolkit upgrades.</p>
  26. <p>The DITA-OT plug-in mechanism provides the following benefits:</p>
  27. <ul>
  28. <li>Plug-ins can easily be shared with other users, teams, or companies. Typically, all users need to do is to
  29. unzip and run a single installation command. With many builds, even that installation step is automatic.</li>
  30. <li>Plug-ins permit overrides or customizations to grow from simple to complex over time, with no increased
  31. complexity to the extension mechanism.</li>
  32. <li>Plug-ins can be moved from version to version of DITA-OT by reinstalling or copying the directory from one
  33. installation to another. There is no need to re-integrate code based on updates to DITA-OT core
  34. processing.</li>
  35. <li>Plug-ins can build upon each other. If you like a plug-in, simply install that plug-in, and then create your
  36. own plug-in that builds on top of it. The two plug-ins can then be distributed to your team as a unit, or you
  37. can share your own extensions with the original provider.</li>
  38. </ul>
  39. </section>
  40. <section>
  41. <title>Plug-in details</title>
  42. <p>The following topics provide additional information on working with plug-ins and creating your own.</p>
  43. </section>
  44. </conbody>
  45. </concept>