321 lines
17 KiB
HTML
321 lines
17 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>Index (DITA Open Toolkit 3.6.0)</title>
|
|
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
|
<script type="text/javascript" src="script.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="Index (DITA Open Toolkit 3.6.0)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="overview-summary.html">Overview</a></li>
|
|
<li>Package</li>
|
|
<li>Class</li>
|
|
<li><a href="overview-tree.html">Tree</a></li>
|
|
<li><a href="deprecated-list.html">Deprecated</a></li>
|
|
<li class="navBarCell1Rev">Index</li>
|
|
<li><a href="help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li>Prev</li>
|
|
<li>Next</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
|
|
<li><a href="index-all.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<div class="contentContainer"><a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:V">V</a> <a name="I:C">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">C</h2>
|
|
<dl>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#cleanOnFailure-boolean-">cleanOnFailure(boolean)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Clean temporary directory when process fails.</div>
|
|
</dd>
|
|
<dt><a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util"><span class="typeNameLink">Configuration</span></a> - Class in <a href="org/dita/dost/util/package-summary.html">org.dita.dost.util</a></dt>
|
|
<dd>
|
|
<div class="block">Global configuration object for static configurations.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#configuration">configuration</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
|
|
<dd>
|
|
<div class="block">Immutable configuration properties.</div>
|
|
</dd>
|
|
<dt><a href="org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util"><span class="typeNameLink">Configuration.Mode</span></a> - Enum in <a href="org/dita/dost/util/package-summary.html">org.dita.dost.util</a></dt>
|
|
<dd>
|
|
<div class="block">Processing mode</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#createDebugLog-boolean-">createDebugLog(boolean)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Write a debug log to temporary directory.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="I:D">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">D</h2>
|
|
<dl>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#DEBUG">DEBUG</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
|
|
<dd>
|
|
<div class="block">Debug mode to aid in development, not intended for end users.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#ditaFormat">ditaFormat</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception"><span class="typeNameLink">DITAOTException</span></a> - Exception in <a href="org/dita/dost/exception/package-summary.html">org.dita.dost.exception</a></dt>
|
|
<dd>
|
|
<div class="block">Exception class for DITAOT, used to handle exceptions in Java modules.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException--">DITAOTException()</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
|
|
<dd>
|
|
<div class="block">Constructs a new DITAOTException with <code>null</code>
|
|
as its detail message.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.String-">DITAOTException(String)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
|
|
<dd>
|
|
<div class="block">Constructs a new exception with the specified detail message.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.Throwable-">DITAOTException(Throwable)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
|
|
<dd>
|
|
<div class="block">Constructs a new exception with the specified detail cause.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.String-java.lang.Throwable-">DITAOTException(String, Throwable)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
|
|
<dd>
|
|
<div class="block">Constructs a new exception with the specified detail message and
|
|
cause.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-net.sf.saxon.trans.UncheckedXPathException-">DITAOTException(UncheckedXPathException)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
|
|
<dd>
|
|
<div class="block">Constructs a new exception with cause, using location information from a root <code>XPathException</code></div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.String-net.sf.saxon.trans.UncheckedXPathException-">DITAOTException(String, UncheckedXPathException)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
|
|
<dd>
|
|
<div class="block">Constructs a new exception with the specified detail message and
|
|
cause, using location information from a root <code>XPathException</code></div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-MessageBean-java.lang.Throwable-java.lang.String-">DITAOTException(MessageBean, Throwable, String)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
|
|
<dd>
|
|
<div class="block">Constructs a new exception with the detailed messagebean and
|
|
cause.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="I:N">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">N</h2>
|
|
<dl>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/ProcessorFactory.html#newInstance-java.io.File-">newInstance(File)</a></span> - Static method in class org.dita.dost.<a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost">ProcessorFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Obtain a new instance of a ProcessorFactory.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/ProcessorFactory.html#newProcessor-java.lang.String-">newProcessor(String)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost">ProcessorFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Create new Processor to run DITA-OT</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="I:O">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">O</h2>
|
|
<dl>
|
|
<dt><a href="org/dita/dost/package-summary.html">org.dita.dost</a> - package org.dita.dost</dt>
|
|
<dd> </dd>
|
|
<dt><a href="org/dita/dost/exception/package-summary.html">org.dita.dost.exception</a> - package org.dita.dost.exception</dt>
|
|
<dd> </dd>
|
|
<dt><a href="org/dita/dost/util/package-summary.html">org.dita.dost.util</a> - package org.dita.dost.util</dt>
|
|
<dd> </dd>
|
|
</dl>
|
|
<a name="I:P">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">P</h2>
|
|
<dl>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#parserFeatures">parserFeatures</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#parserMap">parserMap</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#pluginResourceDirs">pluginResourceDirs</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
|
|
<dd>
|
|
<div class="block">Map of plug-in resource directories.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#printTranstype">printTranstype</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
|
|
<dd>
|
|
<div class="block">List of print-oriented transtypes.</div>
|
|
</dd>
|
|
<dt><a href="org/dita/dost/Processor.html" title="class in org.dita.dost"><span class="typeNameLink">Processor</span></a> - Class in <a href="org/dita/dost/package-summary.html">org.dita.dost</a></dt>
|
|
<dd>
|
|
<div class="block">DITA-OT processer.</div>
|
|
</dd>
|
|
<dt><a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost"><span class="typeNameLink">ProcessorFactory</span></a> - Class in <a href="org/dita/dost/package-summary.html">org.dita.dost</a></dt>
|
|
<dd>
|
|
<div class="block">DITA-OT processer factory.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="I:R">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">R</h2>
|
|
<dl>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#run--">run()</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Run process</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="I:S">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">S</h2>
|
|
<dl>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/ProcessorFactory.html#setBaseTempDir-java.io.File-">setBaseTempDir(File)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost">ProcessorFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Set base directory for temporary directories.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setInput-java.io.File-">setInput(File)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Set input document.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setInput-java.net.URI-">setInput(URI)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Set input document.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setLogger-org.slf4j.Logger-">setLogger(Logger)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Set process logger</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setMode-org.dita.dost.util.Configuration.Mode-">setMode(Configuration.Mode)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Set error recovery mode.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setOutputDir-java.io.File-">setOutputDir(File)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Set output directory.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setOutputDir-java.net.URI-">setOutputDir(URI)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Set output directory.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setProperties-java.util.Map-">setProperties(Map<String, String>)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Set properties.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setProperty-java.lang.String-java.lang.String-">setProperty(String, String)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
|
|
<dd>
|
|
<div class="block">Set property.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="I:T">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">T</h2>
|
|
<dl>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#transtypes">transtypes</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
|
|
<dd>
|
|
<div class="block">List of transtypes.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="I:V">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">V</h2>
|
|
<dl>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.Mode.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum org.dita.dost.util.<a href="org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a></dt>
|
|
<dd>
|
|
<div class="block">Returns the enum constant of this type with the specified name.</div>
|
|
</dd>
|
|
<dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.Mode.html#values--">values()</a></span> - Static method in enum org.dita.dost.util.<a href="org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a></dt>
|
|
<dd>
|
|
<div class="block">Returns an array containing the constants of this enum type, in
|
|
the order they are declared.</div>
|
|
</dd>
|
|
</dl>
|
|
<a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:V">V</a> </div>
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="overview-summary.html">Overview</a></li>
|
|
<li>Package</li>
|
|
<li>Class</li>
|
|
<li><a href="overview-tree.html">Tree</a></li>
|
|
<li><a href="deprecated-list.html">Deprecated</a></li>
|
|
<li class="navBarCell1Rev">Index</li>
|
|
<li><a href="help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li>Prev</li>
|
|
<li>Next</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
|
|
<li><a href="index-all.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|