11 lines
No EOL
9.3 KiB
HTML
11 lines
No EOL
9.3 KiB
HTML
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Plug-ins allow you to extend the functionality of DITA-OT. This might entail adding support for specialized document types, integrating processing overrides, or defining new output transformations."><meta name="keywords" content="plug-ins, ideas for"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Plug-in use cases</title></head><body id="plugins-overview"><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 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a><ul><li><a href="../topics/plugin-benefits.html">Plug-in benefits</a></li><li><a href="../topics/plugin-configfile.html">Plug-in descriptor file</a></li><li><a href="../topics/plugin-coding-conventions.html">Coding conventions</a></li><li><a href="../topics/plugin-dependencies.html">Plug-in dependencies</a></li><li class="active"><a href="../topics/plugin-use-cases.html">Plug-in use cases</a><ul><li><a href="../topics/plugin-set-parameters.html">Setting parameters</a></li><li><a href="../topics/plugin-anttarget.html">Adding a new Ant target</a></li><li><a href="../topics/plugin-antpreprocess.html">Adding a pre-processing step</a></li><li><a href="../topics/plugin-newtranstype.html">Adding a new output format</a></li><li><a href="../topics/plugin-xsltparams.html">Adding new parameters</a></li><li><a href="../topics/plugin-overridestyle.html">Overriding XSLT steps</a></li><li><a href="../topics/plugin-javalib.html">Adding a Java library</a></li><li><a href="../topics/plugin-messages.html">Adding new messages</a></li><li><a href="../topics/plugin-newextensions.html">New extension points</a></li><li><a href="../topics/plugin-xmlcatalog.html">Extending an XML catalog file</a></li><li><a href="../topics/plugin-rewrite-rules.html">Rewriting file names</a></li><li><a href="../topics/implement-saxon-customizations.html">Saxon customizations</a></li></ul></li><li><a href="../topics/html-customization-plugins.html">Custom HTML plug-ins</a></li><li><a href="../topics/pdf-customization-plugins.html">Custom PDF plug-ins</a></li><li><a href="../topics/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/migration.html">Migrating customizations</a></li></ul></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
|
|
<h1 class="title topictitle1" id="ariaid-title1">Plug-in use cases</h1>
|
|
<p class="shortdesc">Plug-ins allow you to extend the functionality of DITA-OT. This might entail adding support for specialized
|
|
document types, integrating processing overrides, or defining new output transformations.</p>
|
|
|
|
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../topics/plugin-set-parameters.html">Setting parameters with plug-ins</a></strong><br>To ensure that output is always generated with the same settings, you can create a plug-in to define a new output format that automatically sets certain DITA-OT parameters.</li><li class="link ulchildlink"><strong><a href="../topics/plugin-anttarget.html">Adding a new target to the Ant build process</a></strong><br>As of DITA-OT 3.0, the <code class="ph codeph">ant.import</code> extension point can be used 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="../topics/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="../topics/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 HTML 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="../topics/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="../topics/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="../topics/plugin-javalib.html">Adding a Java library to the classpath</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="../topics/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 DITA-OT. These messages then can be used by any XSLT override.</li><li class="link ulchildlink"><strong><a href="../topics/plugin-newextensions.html">Creating a new plug-in extension point</a></strong><br>If your plug-in needs to define its own extension points 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="../topics/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 DITA-OT to support new specializations and document-type shells.</li><li class="link ulchildlink"><strong><a href="../topics/plugin-rewrite-rules.html">Adjusting file names in map-first pre-processing</a></strong><br>To dynamically adjust the names and locations of output files in the map-first pre-processing routine (<code class="ph codeph">preprocess2</code>), you can create a custom plug-in and specify the code that contains your custom rewrite rules.</li><li class="link ulchildlink"><strong><a href="../topics/implement-saxon-customizations.html">Adding Saxon customizations</a></strong><br>Plug-ins can contribute XSLT extension functions and collation URI resolvers. These customizations are automatically configured to work with Saxon when transformations are run using the DITA-OT <code class="keyword markupname xmlelement"><pipeline></code> task with custom XSLT.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/custom-plugins.html" title="In addition to adding plug-ins from the plug-in registry at dita-ot.org/plugins, you can create custom DITA-OT plug-ins of your own to modify the default output, add new output formats, support new languages, or implement DITA topic specializations.">Creating custom plug-ins</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2015/dita-ot_day.html#Creating_DITA_OT_constraint_specialisation_plugins" target="_blank" rel="external noopener" title="This presentation will address the problem of creating DITA constraints/specialisations to customize DITA to meet your specific needs. We will identify a problem, create a Relax NG constraint/specialization to solve it and convert that to DTD. All these will be packaged as a DITA-OT plugin.">Creating DITA-OT constraint/specialisation plugins</a></li></ul></div></nav></article></main></body></html> |