53 lines
No EOL
23 KiB
HTML
53 lines
No EOL
23 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="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extension points in org.dita.base</title></head><body id="org.dita.base-ext"><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></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a><ul><li class="active"><a href="../extension-points/extension-points-in-org.dita.base.html">Common processing</a></li><li><a href="../extension-points/extension-points-in-org.dita.eclipsehelp.html">Eclipse Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.html5.html">HTML5</a></li><li><a href="../extension-points/extension-points-in-org.dita.htmlhelp.html">HTML Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.pdf2.html">PDF</a></li><li><a href="../extension-points/extension-points-in-org.dita.xhtml.html">HTML-based output</a></li></ul></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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 generated" id="ariaid-title1">Extension points in <code class="ph codeph">org.dita.base</code></h1><div class="body refbody"><p class="shortdesc">The
|
|
<code class="ph codeph">org.dita.base</code> plug-in provides common extension points that are available to extend processing
|
|
in all transformations that DITA Open Toolkit supports. <span class="ph">
|
|
|
|
|
|
</span>
|
|
</p><section class="section"><dl class="dl"><dt class="dt dlterm" id="org.dita.base-ext__ant.import"><span class="keyword parmname">ant.import</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__ant.import.desc">Adds an Ant import to the main Ant build file.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.chunk.pre"><span class="keyword parmname">depend.preprocess.chunk.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.chunk.pre.desc">Runs an
|
|
Ant target before the <code class="ph codeph">chunk</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.clean-temp.pre"><span class="keyword parmname">depend.preprocess.clean-temp.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.clean-temp.pre.desc">Runs
|
|
an Ant target before the <code class="ph codeph">clean-temp</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.coderef.pre"><span class="keyword parmname">depend.preprocess.coderef.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.coderef.pre.desc">Runs an
|
|
Ant target before the <code class="ph codeph">coderef</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.conref.pre"><span class="keyword parmname">depend.preprocess.conref.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.conref.pre.desc">Runs an
|
|
Ant target before the <code class="ph codeph">conref</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.conrefpush.pre"><span class="keyword parmname">depend.preprocess.conrefpush.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.conrefpush.pre.desc">Runs
|
|
an Ant target before the <code class="ph codeph">conrefpush</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.copy-files.pre"><span class="keyword parmname">depend.preprocess.copy-files.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.copy-files.pre.desc">Runs
|
|
an Ant target before the <code class="ph codeph">copy-files</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.copy-flag.pre"><span class="keyword parmname">depend.preprocess.copy-flag.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.copy-flag.pre.desc">Runs
|
|
an Ant target before the <code class="ph codeph">copy-flag</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.copy-html.pre"><span class="keyword parmname">depend.preprocess.copy-html.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.copy-html.pre.desc">Runs
|
|
an Ant target before the <code class="ph codeph">copy-html</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.copy-image.pre"><span class="keyword parmname">depend.preprocess.copy-image.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.copy-image.pre.desc">Runs
|
|
an Ant target before the <code class="ph codeph">copy-image</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.copy-subsidiary.pre"><span class="keyword parmname">depend.preprocess.copy-subsidiary.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.copy-subsidiary.pre.desc">Runs an Ant target before the <code class="ph codeph">copy-subsidiary</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.debug-filter.pre"><span class="keyword parmname">depend.preprocess.debug-filter.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.debug-filter.pre.desc">Runs an Ant target before the <code class="ph codeph">debug-filter</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.gen-list.pre"><span class="keyword parmname">depend.preprocess.gen-list.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.gen-list.pre.desc">Runs
|
|
an Ant target before the <code class="ph codeph">gen-list</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.keyref.pre"><span class="keyword parmname">depend.preprocess.keyref.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.keyref.pre.desc">Runs an
|
|
Ant target before the <code class="ph codeph">keyref</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.maplink.pre"><span class="keyword parmname">depend.preprocess.maplink.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.maplink.pre.desc">Runs an
|
|
Ant target before the <code class="ph codeph">maplink</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.mappull.pre"><span class="keyword parmname">depend.preprocess.mappull.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.mappull.pre.desc">Runs an
|
|
Ant target before the <code class="ph codeph">mappull</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.mapref.pre"><span class="keyword parmname">depend.preprocess.mapref.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.mapref.pre.desc">Runs an
|
|
Ant target before the <code class="ph codeph">mapref</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.move-meta-entries.pre"><span class="keyword parmname">depend.preprocess.move-meta-entries.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.move-meta-entries.pre.desc">Runs an Ant target before the <code class="ph codeph">move-meta-entries</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.post"><span class="keyword parmname">depend.preprocess.post</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.post.desc">Runs an Ant
|
|
target after the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.pre"><span class="keyword parmname">depend.preprocess.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.pre.desc">Runs an Ant
|
|
target before the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__depend.preprocess.topicpull.pre"><span class="keyword parmname">depend.preprocess.topicpull.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__depend.preprocess.topicpull.pre.desc">Runs
|
|
an Ant target before the <code class="ph codeph">topicpull</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.basedir-resource-directory"><span class="keyword parmname">dita.basedir-resource-directory</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.basedir-resource-directory.desc">Flag to use basedir as resource directory</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.catalog.plugin-info"><span class="keyword parmname">dita.catalog.plugin-info</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.catalog.plugin-info.desc">Plug-in XML catalog information</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.conductor.lib.import"><span class="keyword parmname">dita.conductor.lib.import</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.conductor.lib.import.desc">Adds a Java
|
|
library to the DITA-OT classpath.</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.conductor.plugin"><span class="keyword parmname">dita.conductor.plugin</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.conductor.plugin.desc">Ant conductor plug-in information</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.conductor.target"><span class="keyword parmname">dita.conductor.target</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.conductor.target.desc">Adds an Ant
|
|
import to the main Ant build file.
|
|
<div class="p">
|
|
<div class="note attention note_attention"><span class="note__title">Attention:</span> This extension point is deprecated; use <code class="ph codeph">ant.import</code> instead.</div>
|
|
</div>
|
|
</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.conductor.target.relative"><span class="keyword parmname">dita.conductor.target.relative</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.conductor.target.relative.desc">Adds
|
|
an Ant import to the main Ant build file.
|
|
<div class="p">
|
|
<div class="note tip note_tip"><span class="note__title">Tip:</span> As of DITA-OT 3.0, the <code class="ph codeph">ant.import</code> extension point can be used
|
|
instead.</div>
|
|
</div>
|
|
</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.conductor.transtype.check"><span class="keyword parmname">dita.conductor.transtype.check</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.conductor.transtype.check.desc">
|
|
<p class="p">Adds a new value to the list of valid transformation types.</p>
|
|
<div class="note tip note_tip"><span class="note__title">Tip:</span> This extension point is still supported for backwards compatibility, but since DITA-OT 2.1,
|
|
any new customizations should instead use the <code class="keyword markupname xmlelement"><transtype></code> element in the
|
|
<a class="xref" href="../topics/plugin-configfile.html" title="The plug-in descriptor file (plugin.xml) controls all aspects of a plug-in, making each extension visible to the rest of the toolkit. The file uses pre-defined extension points to locate changes, and then integrates those changes into the core DITA-OT code.">Plug-in descriptor file</a> to define a new transformation.</div>
|
|
</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.html.extensions"><span class="keyword parmname">dita.html.extensions</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.html.extensions.desc">HTML file extension</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.image.extensions"><span class="keyword parmname">dita.image.extensions</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.image.extensions.desc">Image file extension</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.parser"><span class="keyword parmname">dita.parser</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.parser.desc">Custom DITA parser</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.preprocess.conref.param"><span class="keyword parmname">dita.preprocess.conref.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.preprocess.conref.param.desc">Content reference XSLT parameters</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.preprocess.debug-filter.param"><span class="keyword parmname">dita.preprocess.debug-filter.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.preprocess.debug-filter.param.desc">Debug filter module parameters</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.preprocess.map-reader.param"><span class="keyword parmname">dita.preprocess.map-reader.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.preprocess.map-reader.param.desc">Debug filter module parameters</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.preprocess.mappull.param"><span class="keyword parmname">dita.preprocess.mappull.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.preprocess.mappull.param.desc">Map pull XSLT parameters</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.preprocess.mapref.param"><span class="keyword parmname">dita.preprocess.mapref.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.preprocess.mapref.param.desc">Map reference XSLT parameters</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.preprocess.topic-reader.param"><span class="keyword parmname">dita.preprocess.topic-reader.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.preprocess.topic-reader.param.desc">Debug filter module parameters</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.preprocess.topicpull.param"><span class="keyword parmname">dita.preprocess.topicpull.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.preprocess.topicpull.param.desc">Topic pull XSLT parameters</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.resource.extensions"><span class="keyword parmname">dita.resource.extensions</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.resource.extensions.desc">Resource file extension</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.specialization.catalog"><span class="keyword parmname">dita.specialization.catalog</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.specialization.catalog.desc">Adds the
|
|
content of a catalog file to the main DITA-OT catalog file. <div class="note attention note_attention"><span class="note__title">Attention:</span> This extension point is
|
|
deprecated; use <code class="ph codeph">dita.specialization.catalog.relative</code> instead.</div></dd><dt class="dt dlterm" id="org.dita.base-ext__dita.specialization.catalog.relative"><span class="keyword parmname">dita.specialization.catalog.relative</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.specialization.catalog.relative.desc">Adds the content of a catalog file to the main DITA-OT catalog file.</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.transtype.print"><span class="keyword parmname">dita.transtype.print</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.transtype.print.desc">Defines a
|
|
transformation as a print type.</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.xsl.conref"><span class="keyword parmname">dita.xsl.conref</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.xsl.conref.desc">Content reference XSLT import</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.xsl.maplink"><span class="keyword parmname">dita.xsl.maplink</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.xsl.maplink.desc">Map link XSLT import</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.xsl.mappull"><span class="keyword parmname">dita.xsl.mappull</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.xsl.mappull.desc">Map pull XSLT import</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.xsl.mapref"><span class="keyword parmname">dita.xsl.mapref</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.xsl.mapref.desc">Map reference XSLT import</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.xsl.messages"><span class="keyword parmname">dita.xsl.messages</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.xsl.messages.desc">Adds new diagnostic
|
|
messages to DITA-OT.</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.xsl.strings"><span class="keyword parmname">dita.xsl.strings</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.xsl.strings.desc">Generated text</dd><dt class="dt dlterm" id="org.dita.base-ext__dita.xsl.topicpull"><span class="keyword parmname">dita.xsl.topicpull</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__dita.xsl.topicpull.desc">Topic pull XSLT import</dd><dt class="dt dlterm" id="org.dita.base-ext__package.support.email"><span class="keyword parmname">package.support.email</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__package.support.email.desc">Specifies the
|
|
e-mail address of the person who provides support for the DITA-OT plug-in.</dd><dt class="dt dlterm" id="org.dita.base-ext__package.support.name"><span class="keyword parmname">package.support.name</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__package.support.name.desc">Specifies the
|
|
person who provides support for the DITA-OT plug-in.</dd><dt class="dt dlterm" id="org.dita.base-ext__package.version"><span class="keyword parmname">package.version</span><span class="ph"></span></dt><dd class="dd" id="org.dita.base-ext__package.version.desc">Specifies the version
|
|
of the DITA-OT plug-in.</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/extension-points-by-plugin.html" title="The default plug-ins that ship with DITA Open Toolkit include a series of extension points that can be used to modify various aspects of toolkit processing.">Extension points by plug-in</a></div></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../extension-points/plugin-extension-points-pre-processing.html" title="You can use these extension points to run an Ant target before or after the pre-processing stage. If necessary, you can also run an Ant target before a specific pre-processing step — but this approach is not recommended.">Pre-processing extension points</a></li><li class="linklist"><a class="link" href="../extension-points/plugin-extension-points-support.html" title="You can use these extension points to define version and support information for a plug-in. Currently, DITA-OT does not do anything with this information, but it might do so in the future.">Version and support information</a></li><li class="linklist"><a class="link" href="../extension-points/plugin-extension-points-general.html" title="These extension points enable you to extend DITA-OT. You can add Ant targets or imports; add a Java library to the classpath parameter; add a new transformation type; extend a catalog file; add new diagnostic messages, and more.">General extension points</a></li></ul></div></nav></article></main></body></html> |