| 123456789 |
- <!DOCTYPE html
- SYSTEM "about:legacy-compat">
- <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 use DITA-OT plug-ins to extend the DITA Open Toolkit."><meta name="DC.Relation" scheme="URI" content="../dev_ref/index.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugins-overview.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-xmlcatalog.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-anttarget.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-antpreprocess.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-newtranstype.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-overridestyle.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/using-plugin-URI-extension.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-addgeneratedtext.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-xsltparams.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-javalib.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-messages.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-newextensions.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/plugin-sample.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="plugins-creating"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Creating plug-ins</title></head><body id="plugins-creating"><header role="banner"><div class="header">
- <p>DITA Open Toolkit</p>
- <hr>
- </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 class="active"><a href="../dev_ref/plugin-creating.html">Creating plug-ins</a><ul><li><a href="../dev_ref/plugins-overview.html">Overview of plug-ins</a></li><li><a href="../dev_ref/plugin-xmlcatalog.html">Extending an XML catalog file</a></li><li><a href="../dev_ref/plugin-anttarget.html">Adding a new target to the Ant build process</a></li><li><a href="../dev_ref/plugin-antpreprocess.html">Adding an Ant target to the pre-processing pipeline</a></li><li><a href="../dev_ref/plugin-newtranstype.html">Adding a new transformation type</a></li><li><a href="../dev_ref/plugin-overridestyle.html">Overriding an XSLT-processing step</a></li><li><a href="../dev_ref/using-plugin-URI-extension.html">Referencing files from other plug-ins</a></li><li><a href="../dev_ref/plugin-addgeneratedtext.html">Modifying or adding generated text</a></li><li><a href="../dev_ref/plugin-xsltparams.html">Adding parameters to existing XSLT steps</a></li><li><a href="../dev_ref/plugin-javalib.html">Adding a Java library to the DITA-OT classpath parameter</a></li><li><a href="../dev_ref/plugin-messages.html">Adding new diagnostic messages</a></li><li><a href="../dev_ref/plugin-newextensions.html">Creating a new plug-in extension point</a></li><li><a href="../dev_ref/plugin-sample.html">Example plugin.xml file</a></li></ul></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></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">
- <h1 class="title topictitle1" id="ariaid-title1">Creating plug-ins</h1>
- <p class="shortdesc">You can use DITA-OT plug-ins to extend the DITA Open Toolkit.</p>
- <nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../dev_ref/plugins-overview.html">Overview of plug-ins</a></strong><br>Plug-ins enable users to extend the functionality of the DITA-OT. This might entail adding support for specialized document types, integrating processing overrides, or defining new output transformations.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-xmlcatalog.html">Extending an XML catalog file</a></strong><br>You can update either the main DITA-OT XML catalog or the XML catalog that is used by the PDF plug-in. This enables the DITA-OT to support new specializations and document-type shells.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-anttarget.html">Adding a new target to the Ant build process</a></strong><br>Use the Ant conductor extension point (<code class="ph codeph">dita.conductor.target.relative</code>) to make new targets available to the Ant processing pipeline. This can be done as part of creating a new transformation, extending pre-processing, or simply to make new Ant targets available to other plug-ins.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-antpreprocess.html">Adding an Ant target to the pre-processing pipeline</a></strong><br>You can add an Ant target to the pre-processing pipeline. This enables you to insert additional processing before or after the pre-processing chain or a specific step in the pre-processing operation.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-newtranstype.html">Adding a new transformation type</a></strong><br>Plug-ins can add an entirely new transformation type. The new transformation type can be very simple, such as an XHTML build that creates an additional control file; it also can be very complex, adding any number of new processing steps.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-overridestyle.html">Overriding an XSLT-processing step</a></strong><br>You can override specific XSLT-processing steps in both the pre-processing pipeline and certain DITA-OT transformations.</li><li class="link ulchildlink"><strong><a href="../dev_ref/using-plugin-URI-extension.html">Referencing files from other plug-ins</a></strong><br>Starting with DITA-OT 1.5.4, you can use the <span class="ph filepath">plugin:<var class="keyword varname">plugin-id</var></span> URI extension and the <span class="ph filepath">${dita.plugin.<var class="keyword varname">plugin-id</var>.dir}</span> Ant variable to reference the base path of another installed DITA-OT plug-in.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-addgeneratedtext.html">Modifying or adding generated text</a></strong><br>Generated text is the term for strings that are automatically added by the build, such as "Note" before the contents of a <note> element.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-xsltparams.html">Adding parameters to existing XSLT steps</a></strong><br>You can pass parameters from the Ant build to existing XSLT steps in both the pre-processing pipeline and certain DITA-OT transformations. This can be useful if you want to make the parameters available as global <code class="keyword markupname xmlelement"><xsl:param></code> values within XSLT overrides.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-javalib.html">Adding a Java library to the DITA-OT classpath parameter</a></strong><br>You can use the <code class="ph codeph">dita.conductor.lib.import</code> extension point to add an additional Java library to the DITA-OT <span class="keyword parmname">classpath</span> parameter.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-messages.html">Adding new diagnostic messages</a></strong><br>Use the <code class="ph codeph">dita.xsl.messages</code> extension point to add plug-in-specific messages to the diagnostic messages that are generated by the DITA-OT. These messages then can be used by any XSLT override.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-newextensions.html">Creating a new plug-in extension point</a></strong><br>If your plug-in needs to define its own extension point in an XML file, add the string "<code class="ph codeph">_template</code>" to the filename before the file suffix. When the plug-in is installed, this file will be processed like the built-in DITA-OT templates.</li><li class="link ulchildlink"><strong><a href="../dev_ref/plugin-sample.html">Example plugin.xml file</a></strong><br>The following is a sample of a <span class="ph filepath">plugin.xml</span> file. This file adds support for a new set of specialized DTDs, and includes an override for the XHTML output processor.</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>
|
