from code-server
This commit is contained in:
parent
eda5c02fe9
commit
5ef8bdba47
2652 changed files with 528235 additions and 0 deletions
27
dita-ot-3.6/docsrc/.prettierignore
Normal file
27
dita-ot-3.6/docsrc/.prettierignore
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# This file specifies files that Prettier should not format
|
||||
|
||||
# Mirror entries from .gitignore (don't format untracked files)
|
||||
|
||||
## Directories generated during builds
|
||||
build/
|
||||
logs/
|
||||
node_modules/
|
||||
out/
|
||||
temp/
|
||||
|
||||
## Autogenerated files created by the build process
|
||||
error-messages.xml
|
||||
extension-points/all-extension-points.dita
|
||||
extension-points/extension-points-in-*.dita
|
||||
parameters/all-parameters.dita
|
||||
parameters/parameters-*.dita
|
||||
platform.ditaval
|
||||
samples/properties/template.properties
|
||||
|
||||
# Prettier-specific ignores
|
||||
LICENSE*
|
||||
publishing.ditamap
|
||||
release-notes/changes.ditamap
|
||||
release-notes/history.dita
|
||||
release-notes/rel*.dita
|
||||
samples/plugins/
|
||||
38
dita-ot-3.6/docsrc/.prettierrc.json
Normal file
38
dita-ot-3.6/docsrc/.prettierrc.json
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
{
|
||||
"arrowParens": "avoid",
|
||||
"bracketSpacing": false,
|
||||
"endOfLine": "lf",
|
||||
"htmlWhitespaceSensitivity": "css",
|
||||
"jsxBracketSameLine": false,
|
||||
"printWidth": 120,
|
||||
"proseWrap": "preserve",
|
||||
"requirePragma": false,
|
||||
"semi": true,
|
||||
"singleQuote": true,
|
||||
"tabWidth": 2,
|
||||
"trailingComma": "all",
|
||||
"useTabs": false,
|
||||
"vueIndentScriptAndStyle": true,
|
||||
"xmlSelfClosingSpace": false,
|
||||
"xmlWhitespaceSensitivity": "strict",
|
||||
"overrides": [
|
||||
{
|
||||
"files": "external-links.ditamap",
|
||||
"options": {
|
||||
"printWidth": 80
|
||||
}
|
||||
},
|
||||
{
|
||||
"files": "source-files.ditamap",
|
||||
"options": {
|
||||
"printWidth": 200
|
||||
}
|
||||
},
|
||||
{
|
||||
"files": "*.json",
|
||||
"options": {
|
||||
"printWidth": 200
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
159
dita-ot-3.6/docsrc/build.gradle
Normal file
159
dita-ot-3.6/docsrc/build.gradle
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
plugins {
|
||||
id 'com.github.eerohele.dita-ot-gradle' version '0.6.0'
|
||||
id 'com.github.eerohele.saxon-gradle' version '0.7.0'
|
||||
}
|
||||
|
||||
import com.github.eerohele.DitaOtTask
|
||||
import com.github.eerohele.SaxonXsltTask
|
||||
|
||||
def getPropertyOrDefault(String name, def defaultValue) {
|
||||
hasProperty(name) ? findProperty(name) : defaultValue
|
||||
}
|
||||
|
||||
String ditaHome = getPropertyOrDefault('ditaHome', projectDir.getParent())
|
||||
String ditaHomeSrc = getPropertyOrDefault('ditaHomeSrc', ditaHome)
|
||||
String configDir = "${ditaHomeSrc}/config"
|
||||
String ditavalFile = "${projectDir}/platform.ditaval"
|
||||
Boolean toolkitBuild = file("${projectDir}/../lib/dost.jar").exists()
|
||||
String samplesDir = toolkitBuild ? "${ditaHome}/docsrc/samples" : "${projectDir}/samples"
|
||||
String outputDir = getPropertyOrDefault('outputDir', toolkitBuild ? "${ditaHome}/doc" : "${projectDir}/out")
|
||||
|
||||
String toURI(String path) {
|
||||
file(path).toURI().toString()
|
||||
}
|
||||
|
||||
ditaOt.dir ditaHome
|
||||
|
||||
task messages(type: SaxonXsltTask) {
|
||||
input "${configDir}/messages.xml"
|
||||
output "${projectDir}/topics/error-messages.xml"
|
||||
stylesheet "${projectDir}/resources/messages.xsl"
|
||||
}
|
||||
|
||||
task params(type: SaxonXsltTask) {
|
||||
input "${configDir}/plugins.xml"
|
||||
output "${projectDir}/parameters/all-parameters.dita"
|
||||
stylesheet "${projectDir}/resources/params.xsl"
|
||||
parameters('output-dir.url': toURI('parameters'))
|
||||
outputs.dir "${projectDir}/parameters"
|
||||
}
|
||||
|
||||
task extensionPoints(type: SaxonXsltTask) {
|
||||
input "${configDir}/plugins.xml"
|
||||
output "${projectDir}/extension-points/all-extension-points.dita"
|
||||
stylesheet "${projectDir}/resources/extension-points.xsl"
|
||||
parameters('output-dir.url': toURI('extension-points'))
|
||||
outputs.dir "${projectDir}/extension-points"
|
||||
}
|
||||
|
||||
task generatePlatformFilter {
|
||||
ant.condition(property: 'platform', value: 'windows') {
|
||||
os(family: 'windows')
|
||||
}
|
||||
|
||||
ant.condition(property: 'platform', value: 'mac' ) {
|
||||
os(family: 'mac')
|
||||
}
|
||||
|
||||
ant.condition(property: 'platform', value: 'unix' ) {
|
||||
os(family: 'unix')
|
||||
}
|
||||
|
||||
ant.echoxml(file: ditavalFile) {
|
||||
val {
|
||||
prop(action: 'include', att: 'platform', val: platform)
|
||||
prop(action: 'exclude', att: 'platform')
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
task generatePropertiesTemplate(type: SaxonXsltTask) {
|
||||
input "${configDir}/plugins.xml"
|
||||
output "${samplesDir}/properties/template.properties"
|
||||
stylesheet "${projectDir}/resources/properties-file.xsl"
|
||||
}
|
||||
|
||||
task autoGenerate(dependsOn: [messages, params, extensionPoints, generatePlatformFilter, generatePropertiesTemplate]) {
|
||||
description 'Run tasks that generate content from resource files and the build environment.'
|
||||
}
|
||||
|
||||
task pdf(type: DitaOtTask, dependsOn: autoGenerate) {
|
||||
input "${projectDir}/userguide-book.ditamap"
|
||||
output outputDir
|
||||
transtype 'pdf'
|
||||
filter "${projectDir}/resources/pdf.ditaval"
|
||||
|
||||
properties {
|
||||
property(file: "${projectDir}/samples/properties/docs-build-pdf.properties")
|
||||
}
|
||||
}
|
||||
|
||||
task html(type: DitaOtTask, dependsOn: autoGenerate) {
|
||||
input "${projectDir}/userguide.ditamap"
|
||||
output outputDir
|
||||
transtype 'html5'
|
||||
filter "${projectDir}/resources/html.ditaval"
|
||||
|
||||
properties {
|
||||
property(file: "${projectDir}/samples/properties/docs-build-html5.properties")
|
||||
}
|
||||
}
|
||||
|
||||
task htmlhelp(type: DitaOtTask, dependsOn: autoGenerate) {
|
||||
input "${projectDir}/userguide.ditamap"
|
||||
output outputDir
|
||||
transtype 'htmlhelp'
|
||||
filter ditavalFile
|
||||
|
||||
properties {
|
||||
property(file: "${projectDir}/samples/properties/docs-build-htmlhelp.properties")
|
||||
}
|
||||
|
||||
doLast {
|
||||
ant.move(todir: outputDir, failonerror: 'no') {
|
||||
fileset(dir: "${outputDir}/htmlhelp", includes: '*.chm')
|
||||
}
|
||||
|
||||
ant.delete(dir: "${outputDir}/htmlhelp")
|
||||
}
|
||||
}
|
||||
|
||||
task cleanUp {
|
||||
doLast {
|
||||
ant.delete(dir: outputDir)
|
||||
}
|
||||
}
|
||||
|
||||
def commit = new ByteArrayOutputStream()
|
||||
|
||||
task gitMetadata {
|
||||
doLast {
|
||||
exec {
|
||||
workingDir = projectDir
|
||||
commandLine 'git'
|
||||
args = ['rev-parse', 'HEAD']
|
||||
standardOutput = commit
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
task site(type: DitaOtTask) {
|
||||
dependsOn 'messages', 'params', 'extensionPoints', 'gitMetadata'
|
||||
|
||||
input file("${projectDir}/site.ditamap")
|
||||
output getPropertyOrDefault('outputDir', "${buildDir}/site")
|
||||
filter "${projectDir}/resources/site.ditaval"
|
||||
|
||||
transtype 'org.dita-ot.html'
|
||||
|
||||
properties {
|
||||
property(name: 'args.gen.task.lbl', value: 'YES')
|
||||
property(name: 'args.rellinks', value: 'noparent')
|
||||
property(name: 'commit', value: commit)
|
||||
}
|
||||
}
|
||||
|
||||
task all(dependsOn: [pdf, html, htmlhelp])
|
||||
task dist(dependsOn: [pdf, html])
|
||||
|
||||
defaultTasks 'dist'
|
||||
166
dita-ot-3.6/docsrc/extension-points/all-extension-points.dita
Normal file
166
dita-ot-3.6/docsrc/extension-points/all-extension-points.dita
Normal file
|
|
@ -0,0 +1,166 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="all-extension-points"><title id="title" outputclass="generated">All DITA-OT extension points</title><titlealts><navtitle>All extension points</navtitle></titlealts><shortdesc id="shortdesc">The pre-defined extension points can be used to add new functionality to DITA-OT. If
|
||||
your toolkit installation includes custom plug-ins that define additional extension points, you can add to this
|
||||
list by rebuilding the DITA-OT documentation.</shortdesc><refbody><section><dl><dlentry id="dita.conductor.target"><dt><parmname>dita.conductor.target</parmname><ph><indexterm><parmname>dita.conductor.target</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.target</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.conductor.target.desc" id="dita.conductor.target.desc"/></dlentry><dlentry id="dita.conductor.target.relative"><dt><parmname>dita.conductor.target.relative</parmname><ph><indexterm><parmname>dita.conductor.target.relative</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.target.relative</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.conductor.target.relative.desc" id="dita.conductor.target.relative.desc"/></dlentry><dlentry id="dita.conductor.plugin"><dt><parmname>dita.conductor.plugin</parmname><ph><indexterm><parmname>dita.conductor.plugin</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.plugin</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.conductor.plugin.desc" id="dita.conductor.plugin.desc"/></dlentry><dlentry id="ant.import"><dt><parmname>ant.import</parmname><ph><indexterm><parmname>ant.import</parmname></indexterm><indexterm>extension points<indexterm><parmname>ant.import</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/ant.import.desc" id="ant.import.desc"/></dlentry><dlentry id="depend.preprocess.chunk.pre"><dt><parmname>depend.preprocess.chunk.pre</parmname><ph><indexterm><parmname>depend.preprocess.chunk.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.chunk.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.chunk.pre.desc" id="depend.preprocess.chunk.pre.desc"/></dlentry><dlentry id="depend.preprocess.clean-temp.pre"><dt><parmname>depend.preprocess.clean-temp.pre</parmname><ph><indexterm><parmname>depend.preprocess.clean-temp.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.clean-temp.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.clean-temp.pre.desc" id="depend.preprocess.clean-temp.pre.desc"/></dlentry><dlentry id="depend.preprocess.coderef.pre"><dt><parmname>depend.preprocess.coderef.pre</parmname><ph><indexterm><parmname>depend.preprocess.coderef.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.coderef.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.coderef.pre.desc" id="depend.preprocess.coderef.pre.desc"/></dlentry><dlentry id="org.dita.pdf2.catalog.relative"><dt><parmname>org.dita.pdf2.catalog.relative</parmname><ph><indexterm><parmname>org.dita.pdf2.catalog.relative</parmname></indexterm><indexterm>extension points<indexterm><parmname>org.dita.pdf2.catalog.relative</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/org.dita.pdf2.catalog.relative.desc" id="org.dita.pdf2.catalog.relative.desc"/></dlentry><dlentry id="dita.xsl.conref"><dt><parmname>dita.xsl.conref</parmname><ph><indexterm><parmname>dita.xsl.conref</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.conref</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.xsl.conref.desc" id="dita.xsl.conref.desc"/></dlentry><dlentry id="dita.preprocess.conref.param"><dt><parmname>dita.preprocess.conref.param</parmname><ph><indexterm><parmname>dita.preprocess.conref.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.preprocess.conref.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.preprocess.conref.param.desc" id="dita.preprocess.conref.param.desc"/></dlentry><dlentry id="depend.preprocess.conref.pre"><dt><parmname>depend.preprocess.conref.pre</parmname><ph><indexterm><parmname>depend.preprocess.conref.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.conref.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.conref.pre.desc" id="depend.preprocess.conref.pre.desc"/></dlentry><dlentry id="depend.preprocess.conrefpush.pre"><dt><parmname>depend.preprocess.conrefpush.pre</parmname><ph><indexterm><parmname>depend.preprocess.conrefpush.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.conrefpush.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.conrefpush.pre.desc" id="depend.preprocess.conrefpush.pre.desc"/></dlentry><dlentry id="depend.preprocess.copy-html.pre"><dt><parmname>depend.preprocess.copy-html.pre</parmname><ph><indexterm><parmname>depend.preprocess.copy-html.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.copy-html.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.copy-html.pre.desc" id="depend.preprocess.copy-html.pre.desc"/></dlentry><dlentry id="depend.preprocess.copy-files.pre"><dt><parmname>depend.preprocess.copy-files.pre</parmname><ph><indexterm><parmname>depend.preprocess.copy-files.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.copy-files.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.copy-files.pre.desc" id="depend.preprocess.copy-files.pre.desc"/></dlentry><dlentry id="depend.preprocess.copy-flag.pre"><dt><parmname>depend.preprocess.copy-flag.pre</parmname><ph><indexterm><parmname>depend.preprocess.copy-flag.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.copy-flag.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.copy-flag.pre.desc" id="depend.preprocess.copy-flag.pre.desc"/></dlentry><dlentry id="depend.preprocess.copy-image.pre"><dt><parmname>depend.preprocess.copy-image.pre</parmname><ph><indexterm><parmname>depend.preprocess.copy-image.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.copy-image.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.copy-image.pre.desc" id="depend.preprocess.copy-image.pre.desc"/></dlentry><dlentry id="depend.preprocess.copy-subsidiary.pre"><dt><parmname>depend.preprocess.copy-subsidiary.pre</parmname><ph><indexterm><parmname>depend.preprocess.copy-subsidiary.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.copy-subsidiary.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.copy-subsidiary.pre.desc" id="depend.preprocess.copy-subsidiary.pre.desc"/></dlentry><dlentry id="dita.parser"><dt><parmname>dita.parser</parmname><ph><indexterm><parmname>dita.parser</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.parser</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.parser.desc" id="dita.parser.desc"/></dlentry><dlentry id="depend.preprocess.debug-filter.pre"><dt><parmname>depend.preprocess.debug-filter.pre</parmname><ph><indexterm><parmname>depend.preprocess.debug-filter.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.debug-filter.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.debug-filter.pre.desc" id="depend.preprocess.debug-filter.pre.desc"/></dlentry><dlentry id="dita.preprocess.debug-filter.param"><dt><parmname>dita.preprocess.debug-filter.param</parmname><ph><indexterm><parmname>dita.preprocess.debug-filter.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.preprocess.debug-filter.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.preprocess.debug-filter.param.desc" id="dita.preprocess.debug-filter.param.desc"/></dlentry><dlentry id="dita.preprocess.map-reader.param"><dt><parmname>dita.preprocess.map-reader.param</parmname><ph><indexterm><parmname>dita.preprocess.map-reader.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.preprocess.map-reader.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.preprocess.map-reader.param.desc" id="dita.preprocess.map-reader.param.desc"/></dlentry><dlentry id="dita.preprocess.topic-reader.param"><dt><parmname>dita.preprocess.topic-reader.param</parmname><ph><indexterm><parmname>dita.preprocess.topic-reader.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.preprocess.topic-reader.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.preprocess.topic-reader.param.desc" id="dita.preprocess.topic-reader.param.desc"/></dlentry><dlentry id="dita.xsl.messages"><dt><parmname>dita.xsl.messages</parmname><ph><indexterm><parmname>dita.xsl.messages</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.messages</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.xsl.messages.desc" id="dita.xsl.messages.desc"/></dlentry><dlentry id="dita.conductor.eclipse.toc.param"><dt><parmname>dita.conductor.eclipse.toc.param</parmname><ph><indexterm><parmname>dita.conductor.eclipse.toc.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.eclipse.toc.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.eclipsehelp"><codeph>org.dita.eclipsehelp</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.eclipsehelp/dita.conductor.eclipse.toc.param.desc" id="dita.conductor.eclipse.toc.param.desc"/></dlentry><dlentry id="dita.xsl.eclipse.toc"><dt><parmname>dita.xsl.eclipse.toc</parmname><ph><indexterm><parmname>dita.xsl.eclipse.toc</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.eclipse.toc</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.eclipsehelp"><codeph>org.dita.eclipsehelp</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.eclipsehelp/dita.xsl.eclipse.toc.desc" id="dita.xsl.eclipse.toc.desc"/></dlentry><dlentry id="dita.map.eclipse.index.pre"><dt><parmname>dita.map.eclipse.index.pre</parmname><ph><indexterm><parmname>dita.map.eclipse.index.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.map.eclipse.index.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.eclipsehelp"><codeph>org.dita.eclipsehelp</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.eclipsehelp/dita.map.eclipse.index.pre.desc" id="dita.map.eclipse.index.pre.desc"/></dlentry><dlentry id="dita.xsl.eclipse.plugin"><dt><parmname>dita.xsl.eclipse.plugin</parmname><ph><indexterm><parmname>dita.xsl.eclipse.plugin</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.eclipse.plugin</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.eclipsehelp"><codeph>org.dita.eclipsehelp</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.eclipsehelp/dita.xsl.eclipse.plugin.desc" id="dita.xsl.eclipse.plugin.desc"/></dlentry><dlentry id="dita.basedir-resource-directory"><dt><parmname>dita.basedir-resource-directory</parmname><ph><indexterm><parmname>dita.basedir-resource-directory</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.basedir-resource-directory</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.basedir-resource-directory.desc" id="dita.basedir-resource-directory.desc"/></dlentry><dlentry id="dita.conductor.pdf2.formatter.check"><dt><parmname>dita.conductor.pdf2.formatter.check</parmname><ph><indexterm><parmname>dita.conductor.pdf2.formatter.check</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.pdf2.formatter.check</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/dita.conductor.pdf2.formatter.check.desc" id="dita.conductor.pdf2.formatter.check.desc"/></dlentry><dlentry id="depend.org.dita.pdf2.format.post"><dt><parmname>depend.org.dita.pdf2.format.post</parmname><ph><indexterm><parmname>depend.org.dita.pdf2.format.post</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.org.dita.pdf2.format.post</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/depend.org.dita.pdf2.format.post.desc" id="depend.org.dita.pdf2.format.post.desc"/></dlentry><dlentry id="depend.org.dita.pdf2.format.pre"><dt><parmname>depend.org.dita.pdf2.format.pre</parmname><ph><indexterm><parmname>depend.org.dita.pdf2.format.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.org.dita.pdf2.format.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/depend.org.dita.pdf2.format.pre.desc" id="depend.org.dita.pdf2.format.pre.desc"/></dlentry><dlentry id="depend.org.dita.pdf2.format"><dt><parmname>depend.org.dita.pdf2.format</parmname><ph><indexterm><parmname>depend.org.dita.pdf2.format</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.org.dita.pdf2.format</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/depend.org.dita.pdf2.format.desc" id="depend.org.dita.pdf2.format.desc"/></dlentry><dlentry id="depend.preprocess.gen-list.pre"><dt><parmname>depend.preprocess.gen-list.pre</parmname><ph><indexterm><parmname>depend.preprocess.gen-list.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.gen-list.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.gen-list.pre.desc" id="depend.preprocess.gen-list.pre.desc"/></dlentry><dlentry id="dita.xsl.strings"><dt><parmname>dita.xsl.strings</parmname><ph><indexterm><parmname>dita.xsl.strings</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.strings</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.xsl.strings.desc" id="dita.xsl.strings.desc"/></dlentry><dlentry id="dita.xsl.htmlhelp.map2hhc"><dt><parmname>dita.xsl.htmlhelp.map2hhc</parmname><ph><indexterm><parmname>dita.xsl.htmlhelp.map2hhc</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.htmlhelp.map2hhc</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.htmlhelp"><codeph>org.dita.htmlhelp</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.htmlhelp/dita.xsl.htmlhelp.map2hhc.desc" id="dita.xsl.htmlhelp.map2hhc.desc"/></dlentry><dlentry id="dita.xsl.htmlhelp.map2hhp"><dt><parmname>dita.xsl.htmlhelp.map2hhp</parmname><ph><indexterm><parmname>dita.xsl.htmlhelp.map2hhp</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.htmlhelp.map2hhp</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.htmlhelp"><codeph>org.dita.htmlhelp</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.htmlhelp/dita.xsl.htmlhelp.map2hhp.desc" id="dita.xsl.htmlhelp.map2hhp.desc"/></dlentry><dlentry id="dita.conductor.html.param"><dt><parmname>dita.conductor.html.param</parmname><ph><indexterm><parmname>dita.conductor.html.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.html.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.xhtml"><codeph>org.dita.xhtml</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.xhtml/dita.conductor.html.param.desc" id="dita.conductor.html.param.desc"/></dlentry><dlentry id="dita.html.extensions"><dt><parmname>dita.html.extensions</parmname><ph><indexterm><parmname>dita.html.extensions</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.html.extensions</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.html.extensions.desc" id="dita.html.extensions.desc"/></dlentry><dlentry id="dita.xsl.html.cover"><dt><parmname>dita.xsl.html.cover</parmname><ph><indexterm><parmname>dita.xsl.html.cover</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.html.cover</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.xhtml"><codeph>org.dita.xhtml</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.xhtml/dita.xsl.html.cover.desc" id="dita.xsl.html.cover.desc"/></dlentry><dlentry id="dita.xsl.htmltoc"><dt><parmname>dita.xsl.htmltoc</parmname><ph><indexterm><parmname>dita.xsl.htmltoc</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.htmltoc</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.xhtml"><codeph>org.dita.xhtml</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.xhtml/dita.xsl.htmltoc.desc" id="dita.xsl.htmltoc.desc"/></dlentry><dlentry id="dita.xsl.xhtml"><dt><parmname>dita.xsl.xhtml</parmname><ph><indexterm><parmname>dita.xsl.xhtml</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.xhtml</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.xhtml"><codeph>org.dita.xhtml</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.xhtml/dita.xsl.xhtml.desc" id="dita.xsl.xhtml.desc"/></dlentry><dlentry id="dita.conductor.html5.toc.param"><dt><parmname>dita.conductor.html5.toc.param</parmname><ph><indexterm><parmname>dita.conductor.html5.toc.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.html5.toc.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.html5"><codeph>org.dita.html5</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.html5/dita.conductor.html5.toc.param.desc" id="dita.conductor.html5.toc.param.desc"/></dlentry><dlentry id="dita.conductor.xhtml.toc.param"><dt><parmname>dita.conductor.xhtml.toc.param</parmname><ph><indexterm><parmname>dita.conductor.xhtml.toc.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.xhtml.toc.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.xhtml"><codeph>org.dita.xhtml</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.xhtml/dita.conductor.xhtml.toc.param.desc" id="dita.conductor.xhtml.toc.param.desc"/></dlentry><dlentry id="dita.xsl.html5.cover"><dt><parmname>dita.xsl.html5.cover</parmname><ph><indexterm><parmname>dita.xsl.html5.cover</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.html5.cover</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.html5"><codeph>org.dita.html5</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.html5/dita.xsl.html5.cover.desc" id="dita.xsl.html5.cover.desc"/></dlentry><dlentry id="dita.xsl.html5.toc"><dt><parmname>dita.xsl.html5.toc</parmname><ph><indexterm><parmname>dita.xsl.html5.toc</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.html5.toc</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.html5"><codeph>org.dita.html5</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.html5/dita.xsl.html5.toc.desc" id="dita.xsl.html5.toc.desc"/></dlentry><dlentry id="dita.xsl.html5"><dt><parmname>dita.xsl.html5</parmname><ph><indexterm><parmname>dita.xsl.html5</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.html5</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.html5"><codeph>org.dita.html5</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.html5/dita.xsl.html5.desc" id="dita.xsl.html5.desc"/></dlentry><dlentry id="dita.conductor.html5.param"><dt><parmname>dita.conductor.html5.param</parmname><ph><indexterm><parmname>dita.conductor.html5.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.html5.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.html5"><codeph>org.dita.html5</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.html5/dita.conductor.html5.param.desc" id="dita.conductor.html5.param.desc"/></dlentry><dlentry id="dita.image.extensions"><dt><parmname>dita.image.extensions</parmname><ph><indexterm><parmname>dita.image.extensions</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.image.extensions</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.image.extensions.desc" id="dita.image.extensions.desc"/></dlentry><dlentry id="depend.org.dita.pdf2.index"><dt><parmname>depend.org.dita.pdf2.index</parmname><ph><indexterm><parmname>depend.org.dita.pdf2.index</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.org.dita.pdf2.index</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/depend.org.dita.pdf2.index.desc" id="depend.org.dita.pdf2.index.desc"/></dlentry><dlentry id="depend.org.dita.pdf2.init.pre"><dt><parmname>depend.org.dita.pdf2.init.pre</parmname><ph><indexterm><parmname>depend.org.dita.pdf2.init.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.org.dita.pdf2.init.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/depend.org.dita.pdf2.init.pre.desc" id="depend.org.dita.pdf2.init.pre.desc"/></dlentry><dlentry id="dita.conductor.lib.import"><dt><parmname>dita.conductor.lib.import</parmname><ph><indexterm><parmname>dita.conductor.lib.import</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.lib.import</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.conductor.lib.import.desc" id="dita.conductor.lib.import.desc"/></dlentry><dlentry id="depend.preprocess.keyref.pre"><dt><parmname>depend.preprocess.keyref.pre</parmname><ph><indexterm><parmname>depend.preprocess.keyref.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.keyref.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.keyref.pre.desc" id="depend.preprocess.keyref.pre.desc"/></dlentry><dlentry id="dita.xsl.maplink"><dt><parmname>dita.xsl.maplink</parmname><ph><indexterm><parmname>dita.xsl.maplink</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.maplink</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.xsl.maplink.desc" id="dita.xsl.maplink.desc"/></dlentry><dlentry id="depend.preprocess.maplink.pre"><dt><parmname>depend.preprocess.maplink.pre</parmname><ph><indexterm><parmname>depend.preprocess.maplink.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.maplink.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.maplink.pre.desc" id="depend.preprocess.maplink.pre.desc"/></dlentry><dlentry id="dita.preprocess.mappull.param"><dt><parmname>dita.preprocess.mappull.param</parmname><ph><indexterm><parmname>dita.preprocess.mappull.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.preprocess.mappull.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.preprocess.mappull.param.desc" id="dita.preprocess.mappull.param.desc"/></dlentry><dlentry id="dita.xsl.mappull"><dt><parmname>dita.xsl.mappull</parmname><ph><indexterm><parmname>dita.xsl.mappull</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.mappull</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.xsl.mappull.desc" id="dita.xsl.mappull.desc"/></dlentry><dlentry id="depend.preprocess.mappull.pre"><dt><parmname>depend.preprocess.mappull.pre</parmname><ph><indexterm><parmname>depend.preprocess.mappull.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.mappull.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.mappull.pre.desc" id="depend.preprocess.mappull.pre.desc"/></dlentry><dlentry id="dita.xsl.mapref"><dt><parmname>dita.xsl.mapref</parmname><ph><indexterm><parmname>dita.xsl.mapref</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.mapref</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.xsl.mapref.desc" id="dita.xsl.mapref.desc"/></dlentry><dlentry id="dita.preprocess.mapref.param"><dt><parmname>dita.preprocess.mapref.param</parmname><ph><indexterm><parmname>dita.preprocess.mapref.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.preprocess.mapref.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.preprocess.mapref.param.desc" id="dita.preprocess.mapref.param.desc"/></dlentry><dlentry id="depend.preprocess.mapref.pre"><dt><parmname>depend.preprocess.mapref.pre</parmname><ph><indexterm><parmname>depend.preprocess.mapref.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.mapref.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.mapref.pre.desc" id="depend.preprocess.mapref.pre.desc"/></dlentry><dlentry id="depend.preprocess.move-meta-entries.pre"><dt><parmname>depend.preprocess.move-meta-entries.pre</parmname><ph><indexterm><parmname>depend.preprocess.move-meta-entries.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.move-meta-entries.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.move-meta-entries.pre.desc" id="depend.preprocess.move-meta-entries.pre.desc"/></dlentry><dlentry id="dita.xsl.xslfo.i18n-postprocess"><dt><parmname>dita.xsl.xslfo.i18n-postprocess</parmname><ph><indexterm><parmname>dita.xsl.xslfo.i18n-postprocess</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.xslfo.i18n-postprocess</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/dita.xsl.xslfo.i18n-postprocess.desc" id="dita.xsl.xslfo.i18n-postprocess.desc"/></dlentry><dlentry id="dita.xsl.xslfo"><dt><parmname>dita.xsl.xslfo</parmname><ph><indexterm><parmname>dita.xsl.xslfo</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.xslfo</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/dita.xsl.xslfo.desc" id="dita.xsl.xslfo.desc"/></dlentry><dlentry id="dita.conductor.pdf2.param"><dt><parmname>dita.conductor.pdf2.param</parmname><ph><indexterm><parmname>dita.conductor.pdf2.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.pdf2.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/dita.conductor.pdf2.param.desc" id="dita.conductor.pdf2.param.desc"/></dlentry><dlentry id="org.dita.pdf2.xsl.topicmerge"><dt><parmname>org.dita.pdf2.xsl.topicmerge</parmname><ph><indexterm><parmname>org.dita.pdf2.xsl.topicmerge</parmname></indexterm><indexterm>extension points<indexterm><parmname>org.dita.pdf2.xsl.topicmerge</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.pdf2"><codeph>org.dita.pdf2</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.pdf2/org.dita.pdf2.xsl.topicmerge.desc" id="org.dita.pdf2.xsl.topicmerge.desc"/></dlentry><dlentry id="dita.catalog.plugin-info"><dt><parmname>dita.catalog.plugin-info</parmname><ph><indexterm><parmname>dita.catalog.plugin-info</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.catalog.plugin-info</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.catalog.plugin-info.desc" id="dita.catalog.plugin-info.desc"/></dlentry><dlentry id="package.support.email"><dt><parmname>package.support.email</parmname><ph><indexterm><parmname>package.support.email</parmname></indexterm><indexterm>extension points<indexterm><parmname>package.support.email</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/package.support.email.desc" id="package.support.email.desc"/></dlentry><dlentry id="package.support.name"><dt><parmname>package.support.name</parmname><ph><indexterm><parmname>package.support.name</parmname></indexterm><indexterm>extension points<indexterm><parmname>package.support.name</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/package.support.name.desc" id="package.support.name.desc"/></dlentry><dlentry id="package.version"><dt><parmname>package.version</parmname><ph><indexterm><parmname>package.version</parmname></indexterm><indexterm>extension points<indexterm><parmname>package.version</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/package.version.desc" id="package.version.desc"/></dlentry><dlentry id="depend.preprocess.post"><dt><parmname>depend.preprocess.post</parmname><ph><indexterm><parmname>depend.preprocess.post</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.post</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.post.desc" id="depend.preprocess.post.desc"/></dlentry><dlentry id="depend.preprocess.pre"><dt><parmname>depend.preprocess.pre</parmname><ph><indexterm><parmname>depend.preprocess.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.pre.desc" id="depend.preprocess.pre.desc"/></dlentry><dlentry id="dita.transtype.print"><dt><parmname>dita.transtype.print</parmname><ph><indexterm><parmname>dita.transtype.print</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.transtype.print</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.transtype.print.desc" id="dita.transtype.print.desc"/></dlentry><dlentry id="dita.resource.extensions"><dt><parmname>dita.resource.extensions</parmname><ph><indexterm><parmname>dita.resource.extensions</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.resource.extensions</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.resource.extensions.desc" id="dita.resource.extensions.desc"/></dlentry><dlentry id="dita.xsl.topicpull"><dt><parmname>dita.xsl.topicpull</parmname><ph><indexterm><parmname>dita.xsl.topicpull</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.topicpull</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.xsl.topicpull.desc" id="dita.xsl.topicpull.desc"/></dlentry><dlentry id="dita.preprocess.topicpull.param"><dt><parmname>dita.preprocess.topicpull.param</parmname><ph><indexterm><parmname>dita.preprocess.topicpull.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.preprocess.topicpull.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.preprocess.topicpull.param.desc" id="dita.preprocess.topicpull.param.desc"/></dlentry><dlentry id="depend.preprocess.topicpull.pre"><dt><parmname>depend.preprocess.topicpull.pre</parmname><ph><indexterm><parmname>depend.preprocess.topicpull.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.preprocess.topicpull.pre</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/depend.preprocess.topicpull.pre.desc" id="depend.preprocess.topicpull.pre.desc"/></dlentry><dlentry id="dita.conductor.transtype.check"><dt><parmname>dita.conductor.transtype.check</parmname><ph><indexterm><parmname>dita.conductor.transtype.check</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.transtype.check</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.conductor.transtype.check.desc" id="dita.conductor.transtype.check.desc"/></dlentry><dlentry id="dita.conductor.xhtml.param"><dt><parmname>dita.conductor.xhtml.param</parmname><ph><indexterm><parmname>dita.conductor.xhtml.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.xhtml.param</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.xhtml"><codeph>org.dita.xhtml</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.xhtml/dita.conductor.xhtml.param.desc" id="dita.conductor.xhtml.param.desc"/></dlentry><dlentry id="dita.specialization.catalog"><dt><parmname>dita.specialization.catalog</parmname><ph><indexterm><parmname>dita.specialization.catalog</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.specialization.catalog</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.specialization.catalog.desc" id="dita.specialization.catalog.desc"/></dlentry><dlentry id="dita.specialization.catalog.relative"><dt><parmname>dita.specialization.catalog.relative</parmname><ph><indexterm><parmname>dita.specialization.catalog.relative</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.specialization.catalog.relative</parmname></indexterm></indexterm></ph></dt><dd>Defined in plug-in
|
||||
<xref keyref="extension-points-in-org.dita.base"><codeph>org.dita.base</codeph></xref>.
|
||||
</dd><dd conkeyref="extension-points-in-org.dita.base/dita.specialization.catalog.relative.desc" id="dita.specialization.catalog.relative.desc"/></dlentry></dl></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!--This file is part of the DITA Open Toolkit project. See the accompanying LICENSE.md file for applicable licenses.-->
|
||||
<reference id="extension-points-by-plugin">
|
||||
<title>Extension points by plug-in</title>
|
||||
<titlealts>
|
||||
<navtitle>Plug-in extension points</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>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.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>plug-ins
|
||||
<indexterm>extension points</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<p>If your toolkit installation includes custom plug-ins that define additional extension points, you can add
|
||||
topics by rebuilding the DITA-OT documentation.</p>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
|
@ -0,0 +1,144 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="extension-points-details">
|
||||
<title>Extension points details</title>
|
||||
<shortdesc>This file provides additional details that are pushed to the generated topics to replace the navigation
|
||||
titles and short descriptions embedded in the plug-in source code. Descriptions for individual extension points are
|
||||
pushed from the manually authored topics as necessary.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<!-- This is a resource-only topic. Place index entries in the content below. -->
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
|
||||
<reference id="base">
|
||||
<title>All transformations</title>
|
||||
<titlealts>
|
||||
<navtitle
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/navtitle"
|
||||
>Common processing</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc conaction="pushreplace" conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/shortdesc">The
|
||||
<codeph>org.dita.base</codeph> plug-in provides common extension points that are available to extend processing
|
||||
in all transformations that DITA Open Toolkit supports. <ph>
|
||||
<indexterm><codeph>org.dita.base</codeph></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm>common</indexterm></indexterm>
|
||||
</ph>
|
||||
</shortdesc>
|
||||
<refbody/>
|
||||
</reference>
|
||||
|
||||
<reference id="xhtml">
|
||||
<title>HTML-based output formats</title>
|
||||
<titlealts>
|
||||
<navtitle>HTML-based output</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc conaction="pushreplace" conref="extension-points-in-org.dita.xhtml.dita#org.dita.xhtml-ext/shortdesc">The
|
||||
<codeph>org.dita.xhtml</codeph> plug-in provides shared extension points that can be used to modify processing
|
||||
in HTML-based transformation types such as Eclipse help, HTML Help, and XHTML. <ph>
|
||||
<indexterm><codeph>org.dita.xhtml</codeph></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm>HTML</indexterm></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm>HTML5</indexterm></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm>HTML Help</indexterm></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm>Eclipse Help</indexterm></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm>XHTML</indexterm></indexterm>
|
||||
<indexterm>HTML</indexterm>
|
||||
<indexterm>HTML5
|
||||
<indexterm>extension points</indexterm></indexterm>
|
||||
<indexterm>HTML Help</indexterm>
|
||||
<indexterm>Eclipse Help</indexterm>
|
||||
<indexterm>XHTML</indexterm>
|
||||
</ph>
|
||||
</shortdesc>
|
||||
<refbody/>
|
||||
</reference>
|
||||
|
||||
<reference id="html5">
|
||||
<title>HTML5 extension points </title>
|
||||
<titlealts>
|
||||
<navtitle>HTML5</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc conaction="pushreplace" conref="extension-points-in-org.dita.html5.dita#org.dita.html5-ext/shortdesc">In
|
||||
addition to the extension points provided by common processing and those shared by with other HTML-based
|
||||
transformations, the <codeph>org.dita.html5</codeph> plug-in provides extension points that are specific to the
|
||||
HTML5 transformation. <ph>
|
||||
<indexterm><codeph>org.dita.html5</codeph></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm><codeph>org.dita.html5</codeph></indexterm></indexterm>
|
||||
</ph>
|
||||
</shortdesc>
|
||||
<refbody/>
|
||||
</reference>
|
||||
|
||||
<reference id="eclipsehelp">
|
||||
<title>Eclipse Help</title>
|
||||
<titlealts>
|
||||
<navtitle>Eclipse Help (<codeph>org.dita.eclipsehelp</codeph>) </navtitle>
|
||||
</titlealts>
|
||||
<shortdesc
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.eclipsehelp.dita#org.dita.eclipsehelp-ext/shortdesc"
|
||||
>Certain extension points
|
||||
are specific to the Eclipse Help transformation. <ph>
|
||||
<indexterm><codeph>org.dita.eclipsehelp</codeph></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm><codeph>org.dita.eclipsehelp</codeph></indexterm></indexterm>
|
||||
<indexterm>Eclipse Help</indexterm>
|
||||
</ph>
|
||||
</shortdesc>
|
||||
<refbody/>
|
||||
</reference>
|
||||
|
||||
<reference id="htmlhelp">
|
||||
<title>HTML Help</title>
|
||||
<titlealts>
|
||||
<navtitle
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.htmlhelp.dita#org.dita.htmlhelp-ext/navtitle"
|
||||
>HTML Help</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.htmlhelp.dita#org.dita.htmlhelp-ext/shortdesc"
|
||||
>Certain extension points are
|
||||
specific to the HTML Help transformation. <ph>
|
||||
<indexterm><codeph>org.dita.htmlhelp</codeph></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm><codeph>org.dita.htmlhelp</codeph></indexterm></indexterm>
|
||||
<indexterm>HTML Help</indexterm>
|
||||
</ph>
|
||||
</shortdesc>
|
||||
<refbody/>
|
||||
</reference>
|
||||
|
||||
<reference id="pdf">
|
||||
<title>PDF</title>
|
||||
<titlealts>
|
||||
<navtitle>PDF (<codeph>org.dita.pdf2</codeph>) </navtitle>
|
||||
</titlealts>
|
||||
<shortdesc
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.pdf2.dita#org.dita.pdf2-ext/shortdesc"
|
||||
>Certain extension points are specific to the PDF transformation (formerly known as “PDF2”). <ph>
|
||||
<indexterm>PDF
|
||||
<indexterm><codeph>org.dita.pdf2</codeph></indexterm></indexterm>
|
||||
<indexterm><codeph>org.dita.pdf2</codeph></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm><codeph>org.dita.pdf2</codeph></indexterm></indexterm>
|
||||
</ph>
|
||||
</shortdesc>
|
||||
<refbody/>
|
||||
</reference>
|
||||
|
||||
|
||||
</reference>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.eclipsehelp-ext"><title outputclass="generated">Extension points in <codeph>org.dita.eclipsehelp</codeph></title><titlealts><navtitle id="navtitle">Eclipse Help</navtitle></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.eclipsehelp</codeph> plug-in provides extension points
|
||||
to modify Eclipse Help processing.</shortdesc><refbody><section><dl><dlentry id="dita.conductor.eclipse.toc.param"><dt><parmname>dita.conductor.eclipse.toc.param</parmname><ph><indexterm><parmname>dita.conductor.eclipse.toc.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.eclipse.toc.param</parmname></indexterm></indexterm></ph></dt><dd id="dita.conductor.eclipse.toc.param.desc">Eclipse Help TOC XSLT parameter</dd></dlentry><dlentry id="dita.map.eclipse.index.pre"><dt><parmname>dita.map.eclipse.index.pre</parmname><ph><indexterm><parmname>dita.map.eclipse.index.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.map.eclipse.index.pre</parmname></indexterm></indexterm></ph></dt><dd id="dita.map.eclipse.index.pre.desc">Eclipse index extraction pre-target</dd></dlentry><dlentry id="dita.xsl.eclipse.plugin"><dt><parmname>dita.xsl.eclipse.plugin</parmname><ph><indexterm><parmname>dita.xsl.eclipse.plugin</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.eclipse.plugin</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.eclipse.plugin.desc">Eclipse plugin XSLT import</dd></dlentry><dlentry id="dita.xsl.eclipse.toc"><dt><parmname>dita.xsl.eclipse.toc</parmname><ph><indexterm><parmname>dita.xsl.eclipse.toc</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.eclipse.toc</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.eclipse.toc.desc">Eclipse TOC XSLT import</dd></dlentry></dl></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.html5-ext"><title outputclass="generated">Extension points in <codeph>org.dita.html5</codeph></title><titlealts><navtitle id="navtitle">HTML5</navtitle></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.html5</codeph> plug-in provides extension points
|
||||
to modify HTML5 processing.</shortdesc><refbody><section><dl><dlentry id="dita.conductor.html5.param"><dt><parmname>dita.conductor.html5.param</parmname><ph><indexterm><parmname>dita.conductor.html5.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.html5.param</parmname></indexterm></indexterm></ph></dt><dd id="dita.conductor.html5.param.desc">HTML5 XSLT parameters</dd></dlentry><dlentry id="dita.conductor.html5.toc.param"><dt><parmname>dita.conductor.html5.toc.param</parmname><ph><indexterm><parmname>dita.conductor.html5.toc.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.html5.toc.param</parmname></indexterm></indexterm></ph></dt><dd id="dita.conductor.html5.toc.param.desc">HTML/XSLT XSLT parameter</dd></dlentry><dlentry id="dita.xsl.html5"><dt><parmname>dita.xsl.html5</parmname><ph><indexterm><parmname>dita.xsl.html5</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.html5</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.html5.desc">HTML5 XSLT import</dd></dlentry><dlentry id="dita.xsl.html5.cover"><dt><parmname>dita.xsl.html5.cover</parmname><ph><indexterm><parmname>dita.xsl.html5.cover</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.html5.cover</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.html5.cover.desc">HTML5 Cover XSLT import</dd></dlentry><dlentry id="dita.xsl.html5.toc"><dt><parmname>dita.xsl.html5.toc</parmname><ph><indexterm><parmname>dita.xsl.html5.toc</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.html5.toc</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.html5.toc.desc">HTML5 TOC XSLT import</dd></dlentry></dl></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.htmlhelp-ext"><title outputclass="generated">Extension points in <codeph>org.dita.htmlhelp</codeph></title><titlealts><navtitle id="navtitle">Microsoft Compiled HTML Help</navtitle></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.htmlhelp</codeph> plug-in provides extension points
|
||||
to modify Microsoft Compiled HTML Help processing.</shortdesc><refbody><section><dl><dlentry id="dita.xsl.htmlhelp.map2hhc"><dt><parmname>dita.xsl.htmlhelp.map2hhc</parmname><ph><indexterm><parmname>dita.xsl.htmlhelp.map2hhc</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.htmlhelp.map2hhc</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.htmlhelp.map2hhc.desc">HTML Help content XSLT import</dd></dlentry><dlentry id="dita.xsl.htmlhelp.map2hhp"><dt><parmname>dita.xsl.htmlhelp.map2hhp</parmname><ph><indexterm><parmname>dita.xsl.htmlhelp.map2hhp</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.htmlhelp.map2hhp</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.htmlhelp.map2hhp.desc">HTML Help project XSLT import</dd></dlentry></dl></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.index-ext"><title outputclass="generated">Extension points in <codeph>org.dita.index</codeph></title><titlealts><navtitle id="navtitle"/></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.index</codeph> plug-in provides extension points
|
||||
to modify processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.normalize-ext"><title outputclass="generated">Extension points in <codeph>org.dita.normalize</codeph></title><titlealts><navtitle id="navtitle">Normalized DITA</navtitle></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.normalize</codeph> plug-in provides extension points
|
||||
to modify Normalized DITA processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.pdf2.axf-ext"><title outputclass="generated">Extension points in <codeph>org.dita.pdf2.axf</codeph></title><titlealts><navtitle id="navtitle">PDF</navtitle></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.pdf2.axf</codeph> plug-in provides extension points
|
||||
to modify PDF processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.pdf2-ext"><title outputclass="generated">Extension points in <codeph>org.dita.pdf2</codeph></title><titlealts><navtitle id="navtitle">PDF</navtitle></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.pdf2</codeph> plug-in provides extension points
|
||||
to modify PDF processing.</shortdesc><refbody><section><dl><dlentry id="depend.org.dita.pdf2.format"><dt><parmname>depend.org.dita.pdf2.format</parmname><ph><indexterm><parmname>depend.org.dita.pdf2.format</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.org.dita.pdf2.format</parmname></indexterm></indexterm></ph></dt><dd id="depend.org.dita.pdf2.format.desc">Formatting target</dd></dlentry><dlentry id="depend.org.dita.pdf2.format.post"><dt><parmname>depend.org.dita.pdf2.format.post</parmname><ph><indexterm><parmname>depend.org.dita.pdf2.format.post</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.org.dita.pdf2.format.post</parmname></indexterm></indexterm></ph></dt><dd id="depend.org.dita.pdf2.format.post.desc">Formatting post-target</dd></dlentry><dlentry id="depend.org.dita.pdf2.format.pre"><dt><parmname>depend.org.dita.pdf2.format.pre</parmname><ph><indexterm><parmname>depend.org.dita.pdf2.format.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.org.dita.pdf2.format.pre</parmname></indexterm></indexterm></ph></dt><dd id="depend.org.dita.pdf2.format.pre.desc">Formatting pre-target</dd></dlentry><dlentry id="depend.org.dita.pdf2.index"><dt><parmname>depend.org.dita.pdf2.index</parmname><ph><indexterm><parmname>depend.org.dita.pdf2.index</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.org.dita.pdf2.index</parmname></indexterm></indexterm></ph></dt><dd id="depend.org.dita.pdf2.index.desc">Indexing target</dd></dlentry><dlentry id="depend.org.dita.pdf2.init.pre"><dt><parmname>depend.org.dita.pdf2.init.pre</parmname><ph><indexterm><parmname>depend.org.dita.pdf2.init.pre</parmname></indexterm><indexterm>extension points<indexterm><parmname>depend.org.dita.pdf2.init.pre</parmname></indexterm></indexterm></ph></dt><dd id="depend.org.dita.pdf2.init.pre.desc">Initialization pre-target</dd></dlentry><dlentry id="dita.conductor.pdf2.formatter.check"><dt><parmname>dita.conductor.pdf2.formatter.check</parmname><ph><indexterm><parmname>dita.conductor.pdf2.formatter.check</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.pdf2.formatter.check</parmname></indexterm></indexterm></ph></dt><dd id="dita.conductor.pdf2.formatter.check.desc">Formatter check</dd></dlentry><dlentry id="dita.conductor.pdf2.param"><dt><parmname>dita.conductor.pdf2.param</parmname><ph><indexterm><parmname>dita.conductor.pdf2.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.pdf2.param</parmname></indexterm></indexterm></ph></dt><dd id="dita.conductor.pdf2.param.desc">PDF XSLT parameters</dd></dlentry><dlentry id="dita.xsl.xslfo"><dt><parmname>dita.xsl.xslfo</parmname><ph><indexterm><parmname>dita.xsl.xslfo</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.xslfo</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.xslfo.desc">PDF XSLT import</dd></dlentry><dlentry id="dita.xsl.xslfo.i18n-postprocess"><dt><parmname>dita.xsl.xslfo.i18n-postprocess</parmname><ph><indexterm><parmname>dita.xsl.xslfo.i18n-postprocess</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.xslfo.i18n-postprocess</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.xslfo.i18n-postprocess.desc">PDF I18N postprocess import</dd></dlentry><dlentry id="org.dita.pdf2.catalog.relative"><dt><parmname>org.dita.pdf2.catalog.relative</parmname><ph><indexterm><parmname>org.dita.pdf2.catalog.relative</parmname></indexterm><indexterm>extension points<indexterm><parmname>org.dita.pdf2.catalog.relative</parmname></indexterm></indexterm></ph></dt><dd id="org.dita.pdf2.catalog.relative.desc">Configuration XML catalog</dd></dlentry><dlentry id="org.dita.pdf2.xsl.topicmerge"><dt><parmname>org.dita.pdf2.xsl.topicmerge</parmname><ph><indexterm><parmname>org.dita.pdf2.xsl.topicmerge</parmname></indexterm><indexterm>extension points<indexterm><parmname>org.dita.pdf2.xsl.topicmerge</parmname></indexterm></indexterm></ph></dt><dd id="org.dita.pdf2.xsl.topicmerge.desc">PDF2 topic merge XSLT import</dd></dlentry></dl></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.pdf2.fop-ext"><title outputclass="generated">Extension points in <codeph>org.dita.pdf2.fop</codeph></title><titlealts><navtitle id="navtitle">PDF</navtitle></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.pdf2.fop</codeph> plug-in provides extension points
|
||||
to modify PDF processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.pdf2.xep-ext"><title outputclass="generated">Extension points in <codeph>org.dita.pdf2.xep</codeph></title><titlealts><navtitle id="navtitle">PDF</navtitle></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.pdf2.xep</codeph> plug-in provides extension points
|
||||
to modify PDF processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.specialization.dita11-ext"><title outputclass="generated">Extension points in <codeph>org.dita.specialization.dita11</codeph></title><titlealts><navtitle id="navtitle"/></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.specialization.dita11</codeph> plug-in provides extension points
|
||||
to modify processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.dita.xhtml-ext"><title outputclass="generated">Extension points in <codeph>org.dita.xhtml</codeph></title><titlealts><navtitle id="navtitle">HTML-based output</navtitle></titlealts><shortdesc id="shortdesc">The <codeph>org.dita.xhtml</codeph> plug-in provides extension points
|
||||
to modify HTML-based output processing.</shortdesc><refbody><section><dl><dlentry id="dita.conductor.html.param"><dt><parmname>dita.conductor.html.param</parmname><ph><indexterm><parmname>dita.conductor.html.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.html.param</parmname></indexterm></indexterm></ph></dt><dd id="dita.conductor.html.param.desc">HTML XSLT parameters</dd></dlentry><dlentry id="dita.conductor.xhtml.param"><dt><parmname>dita.conductor.xhtml.param</parmname><ph><indexterm><parmname>dita.conductor.xhtml.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.xhtml.param</parmname></indexterm></indexterm></ph></dt><dd id="dita.conductor.xhtml.param.desc">XHTML XSLT parameters</dd></dlentry><dlentry id="dita.conductor.xhtml.toc.param"><dt><parmname>dita.conductor.xhtml.toc.param</parmname><ph><indexterm><parmname>dita.conductor.xhtml.toc.param</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.conductor.xhtml.toc.param</parmname></indexterm></indexterm></ph></dt><dd id="dita.conductor.xhtml.toc.param.desc">HTML/XSLT XSLT parameter</dd></dlentry><dlentry id="dita.xsl.html.cover"><dt><parmname>dita.xsl.html.cover</parmname><ph><indexterm><parmname>dita.xsl.html.cover</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.html.cover</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.html.cover.desc">HTML/XHTML Cover XSLT import</dd></dlentry><dlentry id="dita.xsl.htmltoc"><dt><parmname>dita.xsl.htmltoc</parmname><ph><indexterm><parmname>dita.xsl.htmltoc</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.htmltoc</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.htmltoc.desc">HTML/XHTML TOC XSLT import</dd></dlentry><dlentry id="dita.xsl.xhtml"><dt><parmname>dita.xsl.xhtml</parmname><ph><indexterm><parmname>dita.xsl.xhtml</parmname></indexterm><indexterm>extension points<indexterm><parmname>dita.xsl.xhtml</parmname></indexterm></indexterm></ph></dt><dd id="dita.xsl.xhtml.desc">HTML/XHTML XSLT import</dd></dlentry></dl></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.lwdita-ext"><title outputclass="generated">Extension points in <codeph>org.lwdita</codeph></title><titlealts><navtitle id="navtitle">Markdown</navtitle></titlealts><shortdesc id="shortdesc">The <codeph>org.lwdita</codeph> plug-in provides extension points
|
||||
to modify Markdown processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.oasis-open.dita.techcomm.v2_0-ext"><title outputclass="generated">Extension points in <codeph>org.oasis-open.dita.techcomm.v2_0</codeph></title><titlealts><navtitle id="navtitle"/></titlealts><shortdesc id="shortdesc">The <codeph>org.oasis-open.dita.techcomm.v2_0</codeph> plug-in provides extension points
|
||||
to modify processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.oasis-open.dita.v1_2-ext"><title outputclass="generated">Extension points in <codeph>org.oasis-open.dita.v1_2</codeph></title><titlealts><navtitle id="navtitle"/></titlealts><shortdesc id="shortdesc">The <codeph>org.oasis-open.dita.v1_2</codeph> plug-in provides extension points
|
||||
to modify processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.oasis-open.dita.v1_3-ext"><title outputclass="generated">Extension points in <codeph>org.oasis-open.dita.v1_3</codeph></title><titlealts><navtitle id="navtitle"/></titlealts><shortdesc id="shortdesc">The <codeph>org.oasis-open.dita.v1_3</codeph> plug-in provides extension points
|
||||
to modify processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.oasis-open.dita.v2_0-ext"><title outputclass="generated">Extension points in <codeph>org.oasis-open.dita.v2_0</codeph></title><titlealts><navtitle id="navtitle"/></titlealts><shortdesc id="shortdesc">The <codeph>org.oasis-open.dita.v2_0</codeph> plug-in provides extension points
|
||||
to modify processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="org.oasis-open.xdita.v0_2_2-ext"><title outputclass="generated">Extension points in <codeph>org.oasis-open.xdita.v0_2_2</codeph></title><titlealts><navtitle id="navtitle"/></titlealts><shortdesc id="shortdesc">The <codeph>org.oasis-open.xdita.v0_2_2</codeph> plug-in provides extension points
|
||||
to modify processing.</shortdesc><refbody><section><dl/></section></refbody></reference>
|
||||
24
dita-ot-3.6/docsrc/extension-points/extension-points.ditamap
Normal file
24
dita-ot-3.6/docsrc/extension-points/extension-points.ditamap
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<map>
|
||||
<title>DITA-OT extension points</title>
|
||||
<topicref keyref="plugin-extension-points">
|
||||
<topicref keyref="all-extension-points"/>
|
||||
<topicref keyref="plugin-extension-points-general"/>
|
||||
<topicref keyref="plugin-extension-points-pre-processing"/>
|
||||
<topicref keyref="plugin-extension-points-xslt-import"/>
|
||||
<topicref keyref="plugin-extension-points-xslt-parameters"/>
|
||||
<topicref keyref="plugin-extension-points-support"/>
|
||||
<topicref keyref="extension-points-by-plugin">
|
||||
<!-- Include only topics for plug-ins that actually provide extension points. -->
|
||||
<topicref keyref="extension-points-in-org.dita.base"/>
|
||||
<topicref keyref="extension-points-in-org.dita.eclipsehelp"/>
|
||||
<topicref keyref="extension-points-in-org.dita.html5"/>
|
||||
<topicref keyref="extension-points-in-org.dita.htmlhelp"/>
|
||||
<topicref keyref="extension-points-in-org.dita.pdf2"/>
|
||||
<topicref keyref="extension-points-in-org.dita.xhtml"/>
|
||||
</topicref>
|
||||
<topicref keyref="extension-points-details" processing-role="resource-only" toc="no"/>
|
||||
</topicref>
|
||||
</map>
|
||||
|
|
@ -0,0 +1,119 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="plugin-general-extension-points">
|
||||
<title>General extension points</title>
|
||||
<shortdesc>These extension points enable you to extend DITA-OT. You can add Ant targets or imports; add a Java library
|
||||
to the <parmname>classpath</parmname> parameter; add a new transformation type; extend a catalog file; add new
|
||||
diagnostic messages, and more.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>deprecated features
|
||||
<indexterm><parmname>dita.conductor.target</parmname></indexterm></indexterm>
|
||||
<indexterm>deprecated features
|
||||
<indexterm><parmname>dita.specialization.catalog</parmname></indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<dl>
|
||||
<dlentry id="ant.import">
|
||||
<dt><parmname>ant.import</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/ant.import.desc"
|
||||
>Adds an Ant import to the main Ant build file.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.conductor.lib.import</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.conductor.lib.import.desc"
|
||||
>Adds a Java
|
||||
library to the DITA-OT classpath.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt importance="deprecated"><parmname>dita.conductor.target</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.conductor.target.desc"
|
||||
>Adds an Ant
|
||||
import to the main Ant build file.
|
||||
<p>
|
||||
<note type="attention">This extension point is deprecated; use <codeph>ant.import</codeph> instead.</note>
|
||||
</p>
|
||||
</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.conductor.target.relative</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.conductor.target.relative.desc"
|
||||
>Adds
|
||||
an Ant import to the main Ant build file.
|
||||
<p>
|
||||
<note type="tip">As of DITA-OT 3.0, the <codeph>ant.import</codeph> extension point can be used
|
||||
instead.</note>
|
||||
</p>
|
||||
</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.conductor.transtype.check</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.conductor.transtype.check.desc"
|
||||
>
|
||||
<p>Adds a new value to the list of valid transformation types.</p>
|
||||
<note type="tip">This extension point is still supported for backwards compatibility, but since DITA-OT 2.1,
|
||||
any new customizations should instead use the <xmlelement>transtype</xmlelement> element in the
|
||||
<xref keyref="plugin-configfile"/> to define a new transformation.</note>
|
||||
</dd>
|
||||
</dlentry>
|
||||
<dlentry importance="deprecated">
|
||||
<dt><parmname>dita.specialization.catalog</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.specialization.catalog.desc"
|
||||
>Adds the
|
||||
content of a catalog file to the main DITA-OT catalog file. <note type="attention">This extension point is
|
||||
deprecated; use <codeph>dita.specialization.catalog.relative</codeph> instead.</note></dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.specialization.catalog.relative</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.specialization.catalog.relative.desc"
|
||||
>Adds the content of a catalog file to the main DITA-OT catalog file.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.transtype.print</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.transtype.print.desc"
|
||||
>Defines a
|
||||
transformation as a print type.<draft-comment author="Kristen Eberlein" time="31 March 2013">What does this
|
||||
actually do? Does this interact with using the deprecated <xmlatt>print</xmlatt>
|
||||
attribute?</draft-comment></dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.messages</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.xsl.messages.desc"
|
||||
>Adds new diagnostic
|
||||
messages to DITA-OT.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>org.dita.pdf2.catalog.relative</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.pdf2.dita#org.dita.pdf2-ext/org.dita.pdf2.catalog.relative.desc"
|
||||
>Adds
|
||||
the content of a catalog file to the main catalog file for the PDF plug-in.</dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
|
@ -0,0 +1,183 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="plugin-extension-points-pre-processing">
|
||||
<title>Pre-processing extension points</title>
|
||||
<shortdesc>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.</shortdesc>
|
||||
<refbody>
|
||||
<section>
|
||||
<note conkeyref="conref-task/tip-extend-before-after-preprocessing"/>
|
||||
<dl>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.pre.desc"
|
||||
>Runs an Ant
|
||||
target before the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.post</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.post.desc"
|
||||
>Runs an Ant
|
||||
target after the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</section>
|
||||
<section>
|
||||
<title>Legacy pre-processing extensions</title>
|
||||
<p>The following extension points are available in the original <codeph>preprocess</codeph> pipeline that was used
|
||||
by default for all transformations prior to DITA-OT 3.0. These extensions are not available in the newer
|
||||
<xref keyref="map-first-preproc">map-first preprocessing</xref> pipeline (<codeph>preprocess2</codeph>), which
|
||||
is used in the PDF and HTML Help transformations as of DITA-OT 3.0.</p>
|
||||
<note conkeyref="conref-task/caution-extend-within-preprocessing"/>
|
||||
<dl>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.chunk.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.chunk.pre.desc"
|
||||
>Runs an
|
||||
Ant target before the <codeph>chunk</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.coderef.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.coderef.pre.desc"
|
||||
>Runs an
|
||||
Ant target before the <codeph>coderef</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.conref.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.conref.pre.desc"
|
||||
>Runs an
|
||||
Ant target before the <codeph>conref</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.conrefpush.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.conrefpush.pre.desc"
|
||||
>Runs
|
||||
an Ant target before the <codeph>conrefpush</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.clean-temp.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.clean-temp.pre.desc"
|
||||
>Runs
|
||||
an Ant target before the <codeph>clean-temp</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.copy-files.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.copy-files.pre.desc"
|
||||
>Runs
|
||||
an Ant target before the <codeph>copy-files</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.copy-flag.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.copy-flag.pre.desc"
|
||||
>Runs
|
||||
an Ant target before the <codeph>copy-flag</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.copy-html.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.copy-html.pre.desc"
|
||||
>Runs
|
||||
an Ant target before the <codeph>copy-html</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.copy-image.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.copy-image.pre.desc"
|
||||
>Runs
|
||||
an Ant target before the <codeph>copy-image</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.copy-subsidiary.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.copy-subsidiary.pre.desc"
|
||||
>Runs an Ant target before the <codeph>copy-subsidiary</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.debug-filter.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.debug-filter.pre.desc"
|
||||
>Runs an Ant target before the <codeph>debug-filter</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.gen-list.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.gen-list.pre.desc"
|
||||
>Runs
|
||||
an Ant target before the <codeph>gen-list</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.keyref.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.keyref.pre.desc"
|
||||
>Runs an
|
||||
Ant target before the <codeph>keyref</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.maplink.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.maplink.pre.desc"
|
||||
>Runs an
|
||||
Ant target before the <codeph>maplink</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.mappull.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.mappull.pre.desc"
|
||||
>Runs an
|
||||
Ant target before the <codeph>mappull</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.mapref.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.mapref.pre.desc"
|
||||
>Runs an
|
||||
Ant target before the <codeph>mapref</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.move-meta-entries.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.move-meta-entries.pre.desc"
|
||||
>Runs an Ant target before the <codeph>move-meta-entries</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>depend.preprocess.topicpull.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/depend.preprocess.topicpull.pre.desc"
|
||||
>Runs
|
||||
an Ant target before the <codeph>topicpull</codeph> step in the pre-processing stage.</dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="plugin-support">
|
||||
<title>Version and support information</title>
|
||||
<shortdesc>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.</shortdesc>
|
||||
<refbody>
|
||||
<section>
|
||||
<dl>
|
||||
<dlentry>
|
||||
<dt><parmname>package.support.name</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/package.support.name.desc"
|
||||
>Specifies the
|
||||
person who provides support for the DITA-OT plug-in.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>package.support.email</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#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>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>package.version</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/package.version.desc"
|
||||
>Specifies the version
|
||||
of the DITA-OT plug-in.</dd>
|
||||
<dd>
|
||||
<p>The value uses the following syntax:</p>
|
||||
<codeblock><varname>major</varname>.<varname>minor</varname>.<varname>micro</varname>.<varname
|
||||
>qualifier</varname></codeblock>
|
||||
<p>where:</p>
|
||||
<ul>
|
||||
<li><varname>major</varname> is a number and is required.</li>
|
||||
<li><varname>minor</varname> is a number and is optional.</li>
|
||||
<li><varname>micro</varname> is a number and is optional.</li>
|
||||
<li><varname>qualifier</varname> is optional and can be composed of numerals, uppercase or lower case
|
||||
letters, underscores, and hyphens.</li>
|
||||
</ul>
|
||||
<p>By default, the <parmname>package.version</parmname> value is set to <codeph>0.0.0</codeph>.</p>
|
||||
</dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</section>
|
||||
<example>
|
||||
<title>Example</title>
|
||||
<codeblock
|
||||
outputclass="language-xml normalize-space show-line-numbers show-whitespace"
|
||||
><plugin id="com.example.WithSupportInfo">
|
||||
<feature extension="package.support.name" value="Joe the Author"/>
|
||||
<feature extension="package.support.email" value="joe@example.com"/>
|
||||
<feature extension="package.version" value="1.2.3"/>
|
||||
</plugin></codeblock>
|
||||
</example>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
|
@ -0,0 +1,189 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="plugin-extension-points-xslt-import">
|
||||
<title>XSLT-import extension points</title>
|
||||
<shortdesc>You can use these extension points to override XSLT processing steps in pre-processing and certain
|
||||
transformation types. The value of the <xmlatt>file</xmlatt> attribute in the <xmlelement>feature</xmlelement>
|
||||
element specifies a relative path to an XSL file in the current plug-in. The plug-in installer adds a XSL import
|
||||
statement to the default DITA-OT code, so that the XSL override becomes part of the normal build.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><xmlelement>xref</xmlelement></indexterm>
|
||||
<indexterm><xmlatt>file</xmlatt></indexterm>
|
||||
<indexterm>XSLT
|
||||
<indexterm>extension points</indexterm></indexterm>
|
||||
<indexterm>extension points
|
||||
<indexterm>XSLT</indexterm></indexterm>
|
||||
<indexterm>preprocessing
|
||||
<indexterm>extension points, XSLT</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<title>Pre-processing</title>
|
||||
<p>You can use the following extension points to add XSLT processing to modules in the pre-processing
|
||||
pipeline:</p>
|
||||
<dl>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.conref</parmname></dt>
|
||||
<dd>Overrides the pre-processing step that resolves conref.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.maplink</parmname></dt>
|
||||
<dd>Overrides the <codeph>maplink</codeph> step in the pre-processing pipeline. This is the step that
|
||||
generates map-based links.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.mappull</parmname></dt>
|
||||
<dd>Overrides the <codeph>mappull</codeph> step in the pre-processing pipeline. This is the step that updates
|
||||
navigation titles in maps and causes attributes to cascade.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.mapref</parmname></dt>
|
||||
<dd>Overrides the <codeph>mapref</codeph> step in the pre-processing pipeline. This is the step that resolves
|
||||
references to other maps.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.topicpull</parmname></dt>
|
||||
<dd>Overrides the <codeph>topicpull</codeph> step in the pre-processing pipeline. This is the step that pulls
|
||||
text into <xmlelement>xref</xmlelement> elements, as well as performing other tasks.</dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</section>
|
||||
<section>
|
||||
<title>Transformations</title>
|
||||
<p>You can use the following extension points to add XSLT processing to modules in DITA-OT transformations:</p>
|
||||
<dl>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.map.eclipse.index.pre</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.eclipsehelp.dita#org.dita.eclipsehelp-ext/dita.map.eclipse.index.pre.desc"
|
||||
>Runs an Ant target before the Eclipse index extraction process.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.eclipse.plugin</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.eclipsehelp.dita#org.dita.eclipsehelp-ext/dita.xsl.eclipse.plugin.desc"
|
||||
>Overrides the default XSLT step that generates the <filepath>plugin.xml</filepath> file for Eclipse
|
||||
Help.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.eclipse.toc</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.eclipsehelp.dita#org.dita.eclipsehelp-ext/dita.xsl.eclipse.toc.desc"
|
||||
>Overrides the default XSLT step that generates the Eclipse Help table of contents (TOC).</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.html.cover</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.xhtml.dita#org.dita.xhtml-ext/dita.xsl.html.cover.desc"
|
||||
>Overrides the
|
||||
default HTML cover page generation process.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.htmltoc</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.xhtml.dita#org.dita.xhtml-ext/dita.xsl.htmltoc.desc"
|
||||
>Overrides the
|
||||
default XSLT step that generates the HTML table of contents (TOC).</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.html5</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.html5.dita#org.dita.html5-ext/dita.xsl.html5.desc"
|
||||
>Overrides the
|
||||
default HTML5 transformation. The referenced file is integrated directly into the XSLT step that generates
|
||||
HTML5.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.html5.cover</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.html5.dita#org.dita.html5-ext/dita.xsl.html5.cover.desc"
|
||||
>Overrides the
|
||||
default HTML5 cover page generation process.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.html5.toc</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.html5.dita#org.dita.html5-ext/dita.xsl.html5.toc.desc"
|
||||
>Overrides the
|
||||
default XSLT step that generates the HTML5 table of contents (TOC).</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.htmlhelp.map2hhc</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.htmlhelp.dita#org.dita.htmlhelp-ext/dita.xsl.htmlhelp.map2hhc.desc"
|
||||
>Overrides the default XSLT step that generates the HTML Help contents (<filepath>.hhc</filepath>)
|
||||
file.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.htmlhelp.map2hhp</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.htmlhelp.dita#org.dita.htmlhelp-ext/dita.xsl.htmlhelp.map2hhp.desc"
|
||||
>Overrides the default XSLT step that generates the HTML Help project (<filepath>.hhp</filepath>) file.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.xhtml</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.xhtml.dita#org.dita.xhtml-ext/dita.xsl.xhtml.desc"
|
||||
>Overrides the
|
||||
default HTML or XHTML transformation, including HTML Help and Eclipse Help. The referenced file is
|
||||
integrated directly into the XSLT step that generates XHTML.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.xsl.xslfo</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.pdf2.dita#org.dita.pdf2-ext/dita.xsl.xslfo.desc"
|
||||
>Overrides the default
|
||||
PDF transformation. The referenced XSL file is integrated directly into the XSLT step that generates the
|
||||
XSL-FO.</dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</section>
|
||||
<example>
|
||||
<title>Example</title>
|
||||
<p>The following two files represent a complete (albeit simple) plug-in that adds a company banner to the XHTML
|
||||
output. The <filepath>plugin.xml</filepath> file declares an XSLT file that extends the XHTML processing; the
|
||||
<filepath>xsl/header.xsl</filepath> file overrides the default header processing to provide a company
|
||||
banner.</p>
|
||||
<fig>
|
||||
<title>Contents of the <filepath>plugin.xml</filepath> file</title>
|
||||
<codeblock
|
||||
outputclass="language-xml normalize-space show-line-numbers show-whitespace"
|
||||
><?xml version="1.0" encoding="UTF-8"?>
|
||||
<plugin id="com.example.brandheader">
|
||||
<feature extension="dita.xsl.xhtml" file="xsl/header.xsl"/>
|
||||
</plugin></codeblock>
|
||||
</fig>
|
||||
<fig>
|
||||
<title>Contents of the <filepath>xsl/header.xsl</filepath> file</title>
|
||||
<codeblock
|
||||
outputclass="language-xml normalize-space show-line-numbers show-whitespace"
|
||||
><?xml version="1.0" encoding="UTF-8"?>
|
||||
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
|
||||
<xsl:template name="gen-user-header">
|
||||
<div>
|
||||
<img src="http://www.example.com/company_banner.jpg"
|
||||
alt="Example Company Banner"/>
|
||||
</div>
|
||||
</xsl:template>
|
||||
</xsl:stylesheet></codeblock>
|
||||
</fig>
|
||||
</example>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
|
@ -0,0 +1,129 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="plugin-extension-points-xslt-parameters">
|
||||
<title>XSLT-parameter extension points</title>
|
||||
<shortdesc>You can use these extension points to pass parameters into existing XSLT steps in both the pre-processing
|
||||
pipeline and DITA-OT transformation. The parameters generally will be available as global
|
||||
<xmlelement>xsl:param</xmlelement> values with XSLT overrides.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>XSLT
|
||||
<indexterm>parameters</indexterm></indexterm>
|
||||
<indexterm>preprocessing
|
||||
<indexterm>extension points, parameters</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<title>Pre-processing</title>
|
||||
<p>You can use the following extension points to pass parameters to modules in the pre-processing pipeline:</p>
|
||||
<dl>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.preprocess.conref.param</parmname></dt>
|
||||
<dd>Pass parameters to the <codeph>conref</codeph> module in the pre-processing pipeline</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.preprocess.mappull.param</parmname></dt>
|
||||
<dd>Pass parameters to the <codeph>mappull</codeph> module in the pre-processing pipeline</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.preprocess.mapref.param</parmname></dt>
|
||||
<dd>Pass parameters to the <codeph>mapref</codeph> module in the pre-processing pipeline</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.preprocess.topicpull.param</parmname></dt>
|
||||
<dd>Pass parameters to the <codeph>topicpull</codeph> module in the pre-processing pipeline</dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</section>
|
||||
<section>
|
||||
<title>Transformations</title>
|
||||
<p>You can use the following extension points to pass parameters to modules in DITA-OT transformations:</p>
|
||||
<dl>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.conductor.eclipse.toc.param</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.eclipsehelp.dita#org.dita.eclipsehelp-ext/dita.conductor.eclipse.toc.param.desc"
|
||||
>Pass parameters to the XSLT step that generates the Eclipse Help table of contents (TOC).</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.conductor.html.param</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.xhtml.dita#org.dita.xhtml-ext/dita.conductor.html.param.desc"
|
||||
>Pass
|
||||
parameters to the <?oxy_comment_start author="Roger"comment="Verify"?>HTML and<?oxy_comment_end?> HTML Help
|
||||
transformations.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.conductor.html5.param</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.html5.dita#org.dita.html5-ext/dita.conductor.html5.param.desc"
|
||||
>Pass
|
||||
parameters to the HTML5 transformation.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.conductor.html5.toc.param</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.html5.dita#org.dita.html5-ext/dita.conductor.html5.toc.param.desc"
|
||||
>Pass
|
||||
parameters to the XSLT step that generates the HTML5 table of contents (TOC).</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.conductor.pdf2.param</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.pdf2.dita#org.dita.pdf2-ext/dita.conductor.pdf2.param.desc"
|
||||
>Pass
|
||||
parameters to the PDF transformation.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.conductor.xhtml.param</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.xhtml.dita#org.dita.xhtml-ext/dita.conductor.xhtml.param.desc"
|
||||
>Pass
|
||||
parameters to the XHTML and Eclipse Help transformations.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><parmname>dita.conductor.xhtml.toc.param</parmname></dt>
|
||||
<dd
|
||||
conaction="pushreplace"
|
||||
conref="extension-points-in-org.dita.xhtml.dita#org.dita.xhtml-ext/dita.conductor.xhtml.toc.param.desc"
|
||||
>Pass
|
||||
parameters to the XSLT step that generates the XHTML table of contents (TOC).</dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</section>
|
||||
<example>
|
||||
<title>Example</title>
|
||||
<p>The following two files represent a complete (albeit simple) plug-in that passes the parameters defined in the
|
||||
<filepath>insertParameters.xml</filepath> file to the XHTML transformation process.</p>
|
||||
<fig>
|
||||
<title>Contents of the <filepath>plugin.xml</filepath> file</title>
|
||||
<codeblock
|
||||
outputclass="language-xml normalize-space show-line-numbers show-whitespace"
|
||||
><plugin id="com.example.newparam">
|
||||
<feature extension="dita.conductor.xhtml.param"
|
||||
file="insertParameters.xml"/>
|
||||
</plugin></codeblock>
|
||||
</fig>
|
||||
<fig>
|
||||
<title>Contents of the <filepath>insertParameters.xml</filepath></title>
|
||||
<codeblock
|
||||
outputclass="language-xml normalize-space show-line-numbers show-whitespace"
|
||||
><dummy xmlns:if="ant:if" xmlns:unless="ant:unless">
|
||||
<i><!-- Any Ant code allowed in xslt task is possible. Example: --></i>
|
||||
<param name="paramNameinXSLT" expression="${antProperty}"
|
||||
if:set="antProperty"/>
|
||||
</dummy></codeblock>
|
||||
</fig>
|
||||
</example>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="plugin-extension-points">
|
||||
<title>Extension point reference</title>
|
||||
<titlealts>
|
||||
<navtitle>Extension points</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>DITA Open Toolkit provides a series of extension points that can be used to integrate changes into the core
|
||||
code. Extension points are defined in the <filepath>plugin.xml</filepath> file for each plug-in. When plug-ins are
|
||||
installed, DITA-OT makes each extension visible to the rest of the toolkit.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>extension points
|
||||
<indexterm>overview</indexterm>
|
||||
<indexterm>plug-in</indexterm></indexterm>
|
||||
<indexterm>extension points
|
||||
<index-see-also>preprocessing</index-see-also></indexterm>
|
||||
<indexterm><filepath>plugin.xml</filepath></indexterm>
|
||||
<indexterm>topicmerge
|
||||
<index-see>org.dita.pdf2.xsl.topicmerge</index-see></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
</reference>
|
||||
2
dita-ot-3.6/docsrc/gradle.properties
Normal file
2
dita-ot-3.6/docsrc/gradle.properties
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
# Fix Java memory errors with Gradle 5.2
|
||||
org.gradle.jvmargs = -Xmx1024m
|
||||
BIN
dita-ot-3.6/docsrc/gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
BIN
dita-ot-3.6/docsrc/gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
Binary file not shown.
5
dita-ot-3.6/docsrc/gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
5
dita-ot-3.6/docsrc/gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
zipStorePath=wrapper/dists
|
||||
185
dita-ot-3.6/docsrc/gradlew
vendored
Executable file
185
dita-ot-3.6/docsrc/gradlew
vendored
Executable file
|
|
@ -0,0 +1,185 @@
|
|||
#!/usr/bin/env sh
|
||||
|
||||
#
|
||||
# Copyright 2015 the original author or authors.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# https://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#
|
||||
|
||||
##############################################################################
|
||||
##
|
||||
## Gradle start up script for UN*X
|
||||
##
|
||||
##############################################################################
|
||||
|
||||
# Attempt to set APP_HOME
|
||||
# Resolve links: $0 may be a link
|
||||
PRG="$0"
|
||||
# Need this for relative symlinks.
|
||||
while [ -h "$PRG" ] ; do
|
||||
ls=`ls -ld "$PRG"`
|
||||
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||
if expr "$link" : '/.*' > /dev/null; then
|
||||
PRG="$link"
|
||||
else
|
||||
PRG=`dirname "$PRG"`"/$link"
|
||||
fi
|
||||
done
|
||||
SAVED="`pwd`"
|
||||
cd "`dirname \"$PRG\"`/" >/dev/null
|
||||
APP_HOME="`pwd -P`"
|
||||
cd "$SAVED" >/dev/null
|
||||
|
||||
APP_NAME="Gradle"
|
||||
APP_BASE_NAME=`basename "$0"`
|
||||
|
||||
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||
MAX_FD="maximum"
|
||||
|
||||
warn () {
|
||||
echo "$*"
|
||||
}
|
||||
|
||||
die () {
|
||||
echo
|
||||
echo "$*"
|
||||
echo
|
||||
exit 1
|
||||
}
|
||||
|
||||
# OS specific support (must be 'true' or 'false').
|
||||
cygwin=false
|
||||
msys=false
|
||||
darwin=false
|
||||
nonstop=false
|
||||
case "`uname`" in
|
||||
CYGWIN* )
|
||||
cygwin=true
|
||||
;;
|
||||
Darwin* )
|
||||
darwin=true
|
||||
;;
|
||||
MINGW* )
|
||||
msys=true
|
||||
;;
|
||||
NONSTOP* )
|
||||
nonstop=true
|
||||
;;
|
||||
esac
|
||||
|
||||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||
|
||||
|
||||
# Determine the Java command to use to start the JVM.
|
||||
if [ -n "$JAVA_HOME" ] ; then
|
||||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||
# IBM's JDK on AIX uses strange locations for the executables
|
||||
JAVACMD="$JAVA_HOME/jre/sh/java"
|
||||
else
|
||||
JAVACMD="$JAVA_HOME/bin/java"
|
||||
fi
|
||||
if [ ! -x "$JAVACMD" ] ; then
|
||||
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||
|
||||
Please set the JAVA_HOME variable in your environment to match the
|
||||
location of your Java installation."
|
||||
fi
|
||||
else
|
||||
JAVACMD="java"
|
||||
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||
|
||||
Please set the JAVA_HOME variable in your environment to match the
|
||||
location of your Java installation."
|
||||
fi
|
||||
|
||||
# Increase the maximum file descriptors if we can.
|
||||
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
|
||||
MAX_FD_LIMIT=`ulimit -H -n`
|
||||
if [ $? -eq 0 ] ; then
|
||||
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
|
||||
MAX_FD="$MAX_FD_LIMIT"
|
||||
fi
|
||||
ulimit -n $MAX_FD
|
||||
if [ $? -ne 0 ] ; then
|
||||
warn "Could not set maximum file descriptor limit: $MAX_FD"
|
||||
fi
|
||||
else
|
||||
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
|
||||
fi
|
||||
fi
|
||||
|
||||
# For Darwin, add options to specify how the application appears in the dock
|
||||
if $darwin; then
|
||||
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
|
||||
fi
|
||||
|
||||
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
|
||||
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
|
||||
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
|
||||
|
||||
JAVACMD=`cygpath --unix "$JAVACMD"`
|
||||
|
||||
# We build the pattern for arguments to be converted via cygpath
|
||||
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
|
||||
SEP=""
|
||||
for dir in $ROOTDIRSRAW ; do
|
||||
ROOTDIRS="$ROOTDIRS$SEP$dir"
|
||||
SEP="|"
|
||||
done
|
||||
OURCYGPATTERN="(^($ROOTDIRS))"
|
||||
# Add a user-defined pattern to the cygpath arguments
|
||||
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
|
||||
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
|
||||
fi
|
||||
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||
i=0
|
||||
for arg in "$@" ; do
|
||||
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
|
||||
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
|
||||
|
||||
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
|
||||
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
|
||||
else
|
||||
eval `echo args$i`="\"$arg\""
|
||||
fi
|
||||
i=`expr $i + 1`
|
||||
done
|
||||
case $i in
|
||||
0) set -- ;;
|
||||
1) set -- "$args0" ;;
|
||||
2) set -- "$args0" "$args1" ;;
|
||||
3) set -- "$args0" "$args1" "$args2" ;;
|
||||
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
|
||||
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
|
||||
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
|
||||
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
|
||||
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
|
||||
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
|
||||
esac
|
||||
fi
|
||||
|
||||
# Escape application args
|
||||
save () {
|
||||
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
|
||||
echo " "
|
||||
}
|
||||
APP_ARGS=`save "$@"`
|
||||
|
||||
# Collect all arguments for the java command, following the shell quoting and substitution rules
|
||||
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
|
||||
|
||||
exec "$JAVACMD" "$@"
|
||||
89
dita-ot-3.6/docsrc/gradlew.bat
vendored
Normal file
89
dita-ot-3.6/docsrc/gradlew.bat
vendored
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
@rem
|
||||
@rem Copyright 2015 the original author or authors.
|
||||
@rem
|
||||
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||
@rem you may not use this file except in compliance with the License.
|
||||
@rem You may obtain a copy of the License at
|
||||
@rem
|
||||
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||
@rem
|
||||
@rem Unless required by applicable law or agreed to in writing, software
|
||||
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
@rem See the License for the specific language governing permissions and
|
||||
@rem limitations under the License.
|
||||
@rem
|
||||
|
||||
@if "%DEBUG%" == "" @echo off
|
||||
@rem ##########################################################################
|
||||
@rem
|
||||
@rem Gradle startup script for Windows
|
||||
@rem
|
||||
@rem ##########################################################################
|
||||
|
||||
@rem Set local scope for the variables with windows NT shell
|
||||
if "%OS%"=="Windows_NT" setlocal
|
||||
|
||||
set DIRNAME=%~dp0
|
||||
if "%DIRNAME%" == "" set DIRNAME=.
|
||||
set APP_BASE_NAME=%~n0
|
||||
set APP_HOME=%DIRNAME%
|
||||
|
||||
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||
|
||||
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
|
||||
|
||||
@rem Find java.exe
|
||||
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||
|
||||
set JAVA_EXE=java.exe
|
||||
%JAVA_EXE% -version >NUL 2>&1
|
||||
if "%ERRORLEVEL%" == "0" goto execute
|
||||
|
||||
echo.
|
||||
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||
echo.
|
||||
echo Please set the JAVA_HOME variable in your environment to match the
|
||||
echo location of your Java installation.
|
||||
|
||||
goto fail
|
||||
|
||||
:findJavaFromJavaHome
|
||||
set JAVA_HOME=%JAVA_HOME:"=%
|
||||
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||
|
||||
if exist "%JAVA_EXE%" goto execute
|
||||
|
||||
echo.
|
||||
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
|
||||
echo.
|
||||
echo Please set the JAVA_HOME variable in your environment to match the
|
||||
echo location of your Java installation.
|
||||
|
||||
goto fail
|
||||
|
||||
:execute
|
||||
@rem Setup the command line
|
||||
|
||||
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||
|
||||
|
||||
@rem Execute Gradle
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
|
||||
|
||||
:end
|
||||
@rem End local scope for the variables with windows NT shell
|
||||
if "%ERRORLEVEL%"=="0" goto mainEnd
|
||||
|
||||
:fail
|
||||
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||
rem the _cmd.exe /c_ return code!
|
||||
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
|
||||
exit /b 1
|
||||
|
||||
:mainEnd
|
||||
if "%OS%"=="Windows_NT" endlocal
|
||||
|
||||
:omega
|
||||
73
dita-ot-3.6/docsrc/index.dita
Normal file
73
dita-ot-3.6/docsrc/index.dita
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<topic id="dita-otprojecthome">
|
||||
<title>DITA Open Toolkit <keyword keyref="release"/></title>
|
||||
<shortdesc><term>DITA Open Toolkit</term>, or <term>DITA-OT</term> for short, is a set of Java-based, open-source
|
||||
tools that provide processing for content authored in the <term>Darwin Information Typing
|
||||
Architecture</term>.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>OASIS</indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<body>
|
||||
|
||||
<note>While the DITA standard is owned and developed by OASIS, the DITA Open Toolkit project is governed separately.
|
||||
DITA-OT is an independent, open-source implementation of the
|
||||
<xref keyref="dita13-spec">DITA standard</xref>.</note>
|
||||
|
||||
<section>
|
||||
<title>DITA-OT documentation</title>
|
||||
<p>The DITA Open Toolkit documentation provides information about installing, running, configuring and extending
|
||||
the toolkit.</p>
|
||||
<ul outputclass="list-group mb-5">
|
||||
<li outputclass="list-group-item list-group-item-action">See the
|
||||
<xref keyref="release-notes" outputclass="stretched-link"/> for information on the changes in the current
|
||||
release.</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="installing-client" outputclass="stretched-link"/> shows how to install the toolkit and run a
|
||||
build to verify the installation.</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="building-output" outputclass="stretched-link"/> explains the methods that can be used to
|
||||
transform DITA content to other formats, including the <cmdname>dita</cmdname> command, Ant, and the Java API,
|
||||
along with information on publishing DITA content from a containerized environment.</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="input-formats" outputclass="stretched-link"/> provides information on supported input formats,
|
||||
including standard DITA XML, Markdown and the Lightweight DITA formats (XDITA, MDITA and HDITA).</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="output-formats" outputclass="stretched-link">Output formats</xref> describes the core
|
||||
transformations that convert DITA to other formats.</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="parameters" outputclass="stretched-link"/> explains how to adjust the behavior of DITA Open
|
||||
Toolkit via <cmdname>dita</cmdname> command arguments and options, DITA-OT parameter settings, and
|
||||
configuration properties.</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="html-customization" outputclass="stretched-link"/> shows how to <ph
|
||||
conkeyref="html-customization/shortdesc-ph"
|
||||
/>.</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="pdf-customization" outputclass="stretched-link"/> explains how to <ph
|
||||
conkeyref="pdf-customization/shortdesc-ph"
|
||||
/>.</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="adding-plugins" outputclass="stretched-link"/> explains how to install, remove and discover new
|
||||
plug-ins.</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="custom-plugins" outputclass="stretched-link"/> provides information on extending DITA-OT with
|
||||
plug-ins of your own.</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="troubleshooting-overview" outputclass="stretched-link"/> contains information about resolving
|
||||
problems that you might encounter.</li>
|
||||
<li outputclass="list-group-item list-group-item-action">
|
||||
<xref keyref="reference" outputclass="stretched-link"/> topics provide additional information about the
|
||||
<xref keyref="architecture"/>,
|
||||
<xref keyref="dita-spec-support"/>, a
|
||||
<xref keyref="glossary"/> and other
|
||||
<xref keyref="dita-and-dita-ot-resources"/>.</li>
|
||||
</ul>
|
||||
</section>
|
||||
</body>
|
||||
</topic>
|
||||
967
dita-ot-3.6/docsrc/package-lock.json
generated
Normal file
967
dita-ot-3.6/docsrc/package-lock.json
generated
Normal file
|
|
@ -0,0 +1,967 @@
|
|||
{
|
||||
"name": "docs",
|
||||
"requires": true,
|
||||
"lockfileVersion": 1,
|
||||
"dependencies": {
|
||||
"@babel/code-frame": {
|
||||
"version": "7.10.4",
|
||||
"resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.10.4.tgz",
|
||||
"integrity": "sha512-vG6SvB6oYEhvgisZNFRmRCUkLz11c7rp+tbNTynGqc6mS1d5ATd/sGyV6W0KZZnXRKMTzZDRgQT3Ou9jhpAfUg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@babel/highlight": "^7.10.4"
|
||||
}
|
||||
},
|
||||
"@babel/helper-validator-identifier": {
|
||||
"version": "7.10.4",
|
||||
"resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.10.4.tgz",
|
||||
"integrity": "sha512-3U9y+43hz7ZM+rzG24Qe2mufW5KhvFg/NhnNph+i9mgCtdTCtMJuI1TMkrIUiK7Ix4PYlRF9I5dhqaLYA/ADXw==",
|
||||
"dev": true
|
||||
},
|
||||
"@babel/highlight": {
|
||||
"version": "7.10.4",
|
||||
"resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.10.4.tgz",
|
||||
"integrity": "sha512-i6rgnR/YgPEQzZZnbTHHuZdlE8qyoBNalD6F+q4vAFlcMEcqmkoG+mPqJYJCo63qPf74+Y1UZsl3l6f7/RIkmA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@babel/helper-validator-identifier": "^7.10.4",
|
||||
"chalk": "^2.0.0",
|
||||
"js-tokens": "^4.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"ansi-styles": {
|
||||
"version": "3.2.1",
|
||||
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
|
||||
"integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"color-convert": "^1.9.0"
|
||||
}
|
||||
},
|
||||
"chalk": {
|
||||
"version": "2.4.2",
|
||||
"resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz",
|
||||
"integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ansi-styles": "^3.2.1",
|
||||
"escape-string-regexp": "^1.0.5",
|
||||
"supports-color": "^5.3.0"
|
||||
}
|
||||
},
|
||||
"color-convert": {
|
||||
"version": "1.9.3",
|
||||
"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
|
||||
"integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"color-name": "1.1.3"
|
||||
}
|
||||
},
|
||||
"color-name": {
|
||||
"version": "1.1.3",
|
||||
"resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
|
||||
"integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=",
|
||||
"dev": true
|
||||
},
|
||||
"has-flag": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
|
||||
"integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=",
|
||||
"dev": true
|
||||
},
|
||||
"supports-color": {
|
||||
"version": "5.5.0",
|
||||
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
|
||||
"integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"has-flag": "^3.0.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"@prettier/plugin-xml": {
|
||||
"version": "0.12.0",
|
||||
"resolved": "https://registry.npmjs.org/@prettier/plugin-xml/-/plugin-xml-0.12.0.tgz",
|
||||
"integrity": "sha512-196oXlmim2SiqeG1jQO5aS/nChI85DvyfIQTBkOiVHHev2j15x4TVxOMGAWHkqdlD8pmCg/KmX8SfFIyT2L7tA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@xml-tools/parser": "^1.0.2",
|
||||
"prettier": ">=1.10"
|
||||
}
|
||||
},
|
||||
"@types/color-name": {
|
||||
"version": "1.1.1",
|
||||
"resolved": "https://registry.npmjs.org/@types/color-name/-/color-name-1.1.1.tgz",
|
||||
"integrity": "sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ==",
|
||||
"dev": true
|
||||
},
|
||||
"@types/parse-json": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/@types/parse-json/-/parse-json-4.0.0.tgz",
|
||||
"integrity": "sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA==",
|
||||
"dev": true
|
||||
},
|
||||
"@xml-tools/parser": {
|
||||
"version": "1.0.7",
|
||||
"resolved": "https://registry.npmjs.org/@xml-tools/parser/-/parser-1.0.7.tgz",
|
||||
"integrity": "sha512-mdjG4dWj4zaubxWAgr0YMNkZr182aHek5xrpDqgITNnGf+E8FhvAmCU95QiL9+pGjqK8Qfd+qnuer9f8KELRyQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"chevrotain": "7.0.1"
|
||||
}
|
||||
},
|
||||
"aggregate-error": {
|
||||
"version": "3.1.0",
|
||||
"resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz",
|
||||
"integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"clean-stack": "^2.0.0",
|
||||
"indent-string": "^4.0.0"
|
||||
}
|
||||
},
|
||||
"ansi-colors": {
|
||||
"version": "4.1.1",
|
||||
"resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz",
|
||||
"integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==",
|
||||
"dev": true
|
||||
},
|
||||
"ansi-escapes": {
|
||||
"version": "4.3.1",
|
||||
"resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.1.tgz",
|
||||
"integrity": "sha512-JWF7ocqNrp8u9oqpgV+wH5ftbt+cfvv+PTjOvKLT3AdYly/LmORARfEVT1iyjwN+4MqE5UmVKoAdIBqeoCHgLA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"type-fest": "^0.11.0"
|
||||
}
|
||||
},
|
||||
"ansi-regex": {
|
||||
"version": "5.0.0",
|
||||
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz",
|
||||
"integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==",
|
||||
"dev": true
|
||||
},
|
||||
"ansi-styles": {
|
||||
"version": "4.2.1",
|
||||
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz",
|
||||
"integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@types/color-name": "^1.1.1",
|
||||
"color-convert": "^2.0.1"
|
||||
}
|
||||
},
|
||||
"astral-regex": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz",
|
||||
"integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==",
|
||||
"dev": true
|
||||
},
|
||||
"braces": {
|
||||
"version": "3.0.2",
|
||||
"resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
|
||||
"integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"fill-range": "^7.0.1"
|
||||
}
|
||||
},
|
||||
"callsites": {
|
||||
"version": "3.1.0",
|
||||
"resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz",
|
||||
"integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==",
|
||||
"dev": true
|
||||
},
|
||||
"chalk": {
|
||||
"version": "4.1.0",
|
||||
"resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz",
|
||||
"integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ansi-styles": "^4.1.0",
|
||||
"supports-color": "^7.1.0"
|
||||
}
|
||||
},
|
||||
"chevrotain": {
|
||||
"version": "7.0.1",
|
||||
"resolved": "https://registry.npmjs.org/chevrotain/-/chevrotain-7.0.1.tgz",
|
||||
"integrity": "sha512-B/44jrdw5GAzy483LEeVSgXSX0qOYM8lUd3l5+yf6Vl6OQjEUCm2BUiYbHRCIK6xCEvCLAFe1kj8uyV6+zdaVw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"regexp-to-ast": "0.5.0"
|
||||
}
|
||||
},
|
||||
"ci-info": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/ci-info/-/ci-info-2.0.0.tgz",
|
||||
"integrity": "sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==",
|
||||
"dev": true
|
||||
},
|
||||
"clean-stack": {
|
||||
"version": "2.2.0",
|
||||
"resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz",
|
||||
"integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==",
|
||||
"dev": true
|
||||
},
|
||||
"cli-cursor": {
|
||||
"version": "3.1.0",
|
||||
"resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz",
|
||||
"integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"restore-cursor": "^3.1.0"
|
||||
}
|
||||
},
|
||||
"cli-truncate": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/cli-truncate/-/cli-truncate-2.1.0.tgz",
|
||||
"integrity": "sha512-n8fOixwDD6b/ObinzTrp1ZKFzbgvKZvuz/TvejnLn1aQfC6r52XEx85FmuC+3HI+JM7coBRXUvNqEU2PHVrHpg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"slice-ansi": "^3.0.0",
|
||||
"string-width": "^4.2.0"
|
||||
}
|
||||
},
|
||||
"color-convert": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
|
||||
"integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"color-name": "~1.1.4"
|
||||
}
|
||||
},
|
||||
"color-name": {
|
||||
"version": "1.1.4",
|
||||
"resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
|
||||
"integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
|
||||
"dev": true
|
||||
},
|
||||
"commander": {
|
||||
"version": "6.2.0",
|
||||
"resolved": "https://registry.npmjs.org/commander/-/commander-6.2.0.tgz",
|
||||
"integrity": "sha512-zP4jEKbe8SHzKJYQmq8Y9gYjtO/POJLgIdKgV7B9qNmABVFVc+ctqSX6iXh4mCpJfRBOabiZ2YKPg8ciDw6C+Q==",
|
||||
"dev": true
|
||||
},
|
||||
"compare-versions": {
|
||||
"version": "3.6.0",
|
||||
"resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-3.6.0.tgz",
|
||||
"integrity": "sha512-W6Af2Iw1z4CB7q4uU4hv646dW9GQuBM+YpC0UvUCWSD8w90SJjp+ujJuXaEMtAXBtSqGfMPuFOVn4/+FlaqfBA==",
|
||||
"dev": true
|
||||
},
|
||||
"cosmiconfig": {
|
||||
"version": "7.0.0",
|
||||
"resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-7.0.0.tgz",
|
||||
"integrity": "sha512-pondGvTuVYDk++upghXJabWzL6Kxu6f26ljFw64Swq9v6sQPUL3EUlVDV56diOjpCayKihL6hVe8exIACU4XcA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@types/parse-json": "^4.0.0",
|
||||
"import-fresh": "^3.2.1",
|
||||
"parse-json": "^5.0.0",
|
||||
"path-type": "^4.0.0",
|
||||
"yaml": "^1.10.0"
|
||||
}
|
||||
},
|
||||
"cross-spawn": {
|
||||
"version": "7.0.3",
|
||||
"resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
|
||||
"integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"path-key": "^3.1.0",
|
||||
"shebang-command": "^2.0.0",
|
||||
"which": "^2.0.1"
|
||||
}
|
||||
},
|
||||
"debug": {
|
||||
"version": "4.3.1",
|
||||
"resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz",
|
||||
"integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ms": "2.1.2"
|
||||
}
|
||||
},
|
||||
"dedent": {
|
||||
"version": "0.7.0",
|
||||
"resolved": "https://registry.npmjs.org/dedent/-/dedent-0.7.0.tgz",
|
||||
"integrity": "sha1-JJXduvbrh0q7Dhvp3yLS5aVEMmw=",
|
||||
"dev": true
|
||||
},
|
||||
"emoji-regex": {
|
||||
"version": "8.0.0",
|
||||
"resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
|
||||
"integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
|
||||
"dev": true
|
||||
},
|
||||
"end-of-stream": {
|
||||
"version": "1.4.4",
|
||||
"resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz",
|
||||
"integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"once": "^1.4.0"
|
||||
}
|
||||
},
|
||||
"enquirer": {
|
||||
"version": "2.3.6",
|
||||
"resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz",
|
||||
"integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ansi-colors": "^4.1.1"
|
||||
}
|
||||
},
|
||||
"error-ex": {
|
||||
"version": "1.3.2",
|
||||
"resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz",
|
||||
"integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"is-arrayish": "^0.2.1"
|
||||
}
|
||||
},
|
||||
"escape-string-regexp": {
|
||||
"version": "1.0.5",
|
||||
"resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
|
||||
"integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=",
|
||||
"dev": true
|
||||
},
|
||||
"execa": {
|
||||
"version": "4.1.0",
|
||||
"resolved": "https://registry.npmjs.org/execa/-/execa-4.1.0.tgz",
|
||||
"integrity": "sha512-j5W0//W7f8UxAn8hXVnwG8tLwdiUy4FJLcSupCg6maBYZDpyBvTApK7KyuI4bKj8KOh1r2YH+6ucuYtJv1bTZA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"cross-spawn": "^7.0.0",
|
||||
"get-stream": "^5.0.0",
|
||||
"human-signals": "^1.1.1",
|
||||
"is-stream": "^2.0.0",
|
||||
"merge-stream": "^2.0.0",
|
||||
"npm-run-path": "^4.0.0",
|
||||
"onetime": "^5.1.0",
|
||||
"signal-exit": "^3.0.2",
|
||||
"strip-final-newline": "^2.0.0"
|
||||
}
|
||||
},
|
||||
"figures": {
|
||||
"version": "3.2.0",
|
||||
"resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz",
|
||||
"integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"escape-string-regexp": "^1.0.5"
|
||||
}
|
||||
},
|
||||
"fill-range": {
|
||||
"version": "7.0.1",
|
||||
"resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
|
||||
"integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"to-regex-range": "^5.0.1"
|
||||
}
|
||||
},
|
||||
"find-up": {
|
||||
"version": "4.1.0",
|
||||
"resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz",
|
||||
"integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"locate-path": "^5.0.0",
|
||||
"path-exists": "^4.0.0"
|
||||
}
|
||||
},
|
||||
"find-versions": {
|
||||
"version": "3.2.0",
|
||||
"resolved": "https://registry.npmjs.org/find-versions/-/find-versions-3.2.0.tgz",
|
||||
"integrity": "sha512-P8WRou2S+oe222TOCHitLy8zj+SIsVJh52VP4lvXkaFVnOFFdoWv1H1Jjvel1aI6NCFOAaeAVm8qrI0odiLcww==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"semver-regex": "^2.0.0"
|
||||
}
|
||||
},
|
||||
"get-own-enumerable-property-symbols": {
|
||||
"version": "3.0.2",
|
||||
"resolved": "https://registry.npmjs.org/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz",
|
||||
"integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==",
|
||||
"dev": true
|
||||
},
|
||||
"get-stream": {
|
||||
"version": "5.2.0",
|
||||
"resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz",
|
||||
"integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"pump": "^3.0.0"
|
||||
}
|
||||
},
|
||||
"has-flag": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
|
||||
"integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
|
||||
"dev": true
|
||||
},
|
||||
"human-signals": {
|
||||
"version": "1.1.1",
|
||||
"resolved": "https://registry.npmjs.org/human-signals/-/human-signals-1.1.1.tgz",
|
||||
"integrity": "sha512-SEQu7vl8KjNL2eoGBLF3+wAjpsNfA9XMlXAYj/3EdaNfAlxKthD1xjEQfGOUhllCGGJVNY34bRr6lPINhNjyZw==",
|
||||
"dev": true
|
||||
},
|
||||
"husky": {
|
||||
"version": "4.3.6",
|
||||
"resolved": "https://registry.npmjs.org/husky/-/husky-4.3.6.tgz",
|
||||
"integrity": "sha512-o6UjVI8xtlWRL5395iWq9LKDyp/9TE7XMOTvIpEVzW638UcGxTmV5cfel6fsk/jbZSTlvfGVJf2svFtybcIZag==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"chalk": "^4.0.0",
|
||||
"ci-info": "^2.0.0",
|
||||
"compare-versions": "^3.6.0",
|
||||
"cosmiconfig": "^7.0.0",
|
||||
"find-versions": "^3.2.0",
|
||||
"opencollective-postinstall": "^2.0.2",
|
||||
"pkg-dir": "^4.2.0",
|
||||
"please-upgrade-node": "^3.2.0",
|
||||
"slash": "^3.0.0",
|
||||
"which-pm-runs": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"import-fresh": {
|
||||
"version": "3.2.1",
|
||||
"resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.2.1.tgz",
|
||||
"integrity": "sha512-6e1q1cnWP2RXD9/keSkxHScg508CdXqXWgWBaETNhyuBFz+kUZlKboh+ISK+bU++DmbHimVBrOz/zzPe0sZ3sQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"parent-module": "^1.0.0",
|
||||
"resolve-from": "^4.0.0"
|
||||
}
|
||||
},
|
||||
"indent-string": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz",
|
||||
"integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==",
|
||||
"dev": true
|
||||
},
|
||||
"is-arrayish": {
|
||||
"version": "0.2.1",
|
||||
"resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz",
|
||||
"integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=",
|
||||
"dev": true
|
||||
},
|
||||
"is-fullwidth-code-point": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
|
||||
"integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
|
||||
"dev": true
|
||||
},
|
||||
"is-number": {
|
||||
"version": "7.0.0",
|
||||
"resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
|
||||
"integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
|
||||
"dev": true
|
||||
},
|
||||
"is-obj": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz",
|
||||
"integrity": "sha1-PkcprB9f3gJc19g6iW2rn09n2w8=",
|
||||
"dev": true
|
||||
},
|
||||
"is-regexp": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz",
|
||||
"integrity": "sha1-/S2INUXEa6xaYz57mgnof6LLUGk=",
|
||||
"dev": true
|
||||
},
|
||||
"is-stream": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.0.tgz",
|
||||
"integrity": "sha512-XCoy+WlUr7d1+Z8GgSuXmpuUFC9fOhRXglJMx+dwLKTkL44Cjd4W1Z5P+BQZpr+cR93aGP4S/s7Ftw6Nd/kiEw==",
|
||||
"dev": true
|
||||
},
|
||||
"isexe": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
|
||||
"integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=",
|
||||
"dev": true
|
||||
},
|
||||
"js-tokens": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
|
||||
"integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==",
|
||||
"dev": true
|
||||
},
|
||||
"json-parse-even-better-errors": {
|
||||
"version": "2.3.1",
|
||||
"resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz",
|
||||
"integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==",
|
||||
"dev": true
|
||||
},
|
||||
"lines-and-columns": {
|
||||
"version": "1.1.6",
|
||||
"resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.1.6.tgz",
|
||||
"integrity": "sha1-HADHQ7QzzQpOgHWPe2SldEDZ/wA=",
|
||||
"dev": true
|
||||
},
|
||||
"lint-staged": {
|
||||
"version": "10.5.3",
|
||||
"resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-10.5.3.tgz",
|
||||
"integrity": "sha512-TanwFfuqUBLufxCc3RUtFEkFraSPNR3WzWcGF39R3f2J7S9+iF9W0KTVLfSy09lYGmZS5NDCxjNvhGMSJyFCWg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"chalk": "^4.1.0",
|
||||
"cli-truncate": "^2.1.0",
|
||||
"commander": "^6.2.0",
|
||||
"cosmiconfig": "^7.0.0",
|
||||
"debug": "^4.2.0",
|
||||
"dedent": "^0.7.0",
|
||||
"enquirer": "^2.3.6",
|
||||
"execa": "^4.1.0",
|
||||
"listr2": "^3.2.2",
|
||||
"log-symbols": "^4.0.0",
|
||||
"micromatch": "^4.0.2",
|
||||
"normalize-path": "^3.0.0",
|
||||
"please-upgrade-node": "^3.2.0",
|
||||
"string-argv": "0.3.1",
|
||||
"stringify-object": "^3.3.0"
|
||||
}
|
||||
},
|
||||
"listr2": {
|
||||
"version": "3.2.3",
|
||||
"resolved": "https://registry.npmjs.org/listr2/-/listr2-3.2.3.tgz",
|
||||
"integrity": "sha512-vUb80S2dSUi8YxXahO8/I/s29GqnOL8ozgHVLjfWQXa03BNEeS1TpBLjh2ruaqq5ufx46BRGvfymdBSuoXET5w==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"chalk": "^4.1.0",
|
||||
"cli-truncate": "^2.1.0",
|
||||
"figures": "^3.2.0",
|
||||
"indent-string": "^4.0.0",
|
||||
"log-update": "^4.0.0",
|
||||
"p-map": "^4.0.0",
|
||||
"rxjs": "^6.6.3",
|
||||
"through": "^2.3.8"
|
||||
}
|
||||
},
|
||||
"locate-path": {
|
||||
"version": "5.0.0",
|
||||
"resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz",
|
||||
"integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"p-locate": "^4.1.0"
|
||||
}
|
||||
},
|
||||
"log-symbols": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.0.0.tgz",
|
||||
"integrity": "sha512-FN8JBzLx6CzeMrB0tg6pqlGU1wCrXW+ZXGH481kfsBqer0hToTIiHdjH4Mq8xJUbvATujKCvaREGWpGUionraA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"chalk": "^4.0.0"
|
||||
}
|
||||
},
|
||||
"log-update": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/log-update/-/log-update-4.0.0.tgz",
|
||||
"integrity": "sha512-9fkkDevMefjg0mmzWFBW8YkFP91OrizzkW3diF7CpG+S2EYdy4+TVfGwz1zeF8x7hCx1ovSPTOE9Ngib74qqUg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ansi-escapes": "^4.3.0",
|
||||
"cli-cursor": "^3.1.0",
|
||||
"slice-ansi": "^4.0.0",
|
||||
"wrap-ansi": "^6.2.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"slice-ansi": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz",
|
||||
"integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ansi-styles": "^4.0.0",
|
||||
"astral-regex": "^2.0.0",
|
||||
"is-fullwidth-code-point": "^3.0.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"merge-stream": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz",
|
||||
"integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==",
|
||||
"dev": true
|
||||
},
|
||||
"micromatch": {
|
||||
"version": "4.0.2",
|
||||
"resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz",
|
||||
"integrity": "sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"braces": "^3.0.1",
|
||||
"picomatch": "^2.0.5"
|
||||
}
|
||||
},
|
||||
"mimic-fn": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz",
|
||||
"integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==",
|
||||
"dev": true
|
||||
},
|
||||
"ms": {
|
||||
"version": "2.1.2",
|
||||
"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
|
||||
"integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==",
|
||||
"dev": true
|
||||
},
|
||||
"normalize-path": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz",
|
||||
"integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==",
|
||||
"dev": true
|
||||
},
|
||||
"npm-run-path": {
|
||||
"version": "4.0.1",
|
||||
"resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz",
|
||||
"integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"path-key": "^3.0.0"
|
||||
}
|
||||
},
|
||||
"once": {
|
||||
"version": "1.4.0",
|
||||
"resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
|
||||
"integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"wrappy": "1"
|
||||
}
|
||||
},
|
||||
"onetime": {
|
||||
"version": "5.1.2",
|
||||
"resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz",
|
||||
"integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"mimic-fn": "^2.1.0"
|
||||
}
|
||||
},
|
||||
"opencollective-postinstall": {
|
||||
"version": "2.0.3",
|
||||
"resolved": "https://registry.npmjs.org/opencollective-postinstall/-/opencollective-postinstall-2.0.3.tgz",
|
||||
"integrity": "sha512-8AV/sCtuzUeTo8gQK5qDZzARrulB3egtLzFgteqB2tcT4Mw7B8Kt7JcDHmltjz6FOAHsvTevk70gZEbhM4ZS9Q==",
|
||||
"dev": true
|
||||
},
|
||||
"p-limit": {
|
||||
"version": "2.3.0",
|
||||
"resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz",
|
||||
"integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"p-try": "^2.0.0"
|
||||
}
|
||||
},
|
||||
"p-locate": {
|
||||
"version": "4.1.0",
|
||||
"resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz",
|
||||
"integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"p-limit": "^2.2.0"
|
||||
}
|
||||
},
|
||||
"p-map": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz",
|
||||
"integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"aggregate-error": "^3.0.0"
|
||||
}
|
||||
},
|
||||
"p-try": {
|
||||
"version": "2.2.0",
|
||||
"resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz",
|
||||
"integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==",
|
||||
"dev": true
|
||||
},
|
||||
"parent-module": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz",
|
||||
"integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"callsites": "^3.0.0"
|
||||
}
|
||||
},
|
||||
"parse-json": {
|
||||
"version": "5.1.0",
|
||||
"resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.1.0.tgz",
|
||||
"integrity": "sha512-+mi/lmVVNKFNVyLXV31ERiy2CY5E1/F6QtJFEzoChPRwwngMNXRDQ9GJ5WdE2Z2P4AujsOi0/+2qHID68KwfIQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@babel/code-frame": "^7.0.0",
|
||||
"error-ex": "^1.3.1",
|
||||
"json-parse-even-better-errors": "^2.3.0",
|
||||
"lines-and-columns": "^1.1.6"
|
||||
}
|
||||
},
|
||||
"path-exists": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz",
|
||||
"integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==",
|
||||
"dev": true
|
||||
},
|
||||
"path-key": {
|
||||
"version": "3.1.1",
|
||||
"resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
|
||||
"integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==",
|
||||
"dev": true
|
||||
},
|
||||
"path-type": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz",
|
||||
"integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==",
|
||||
"dev": true
|
||||
},
|
||||
"picomatch": {
|
||||
"version": "2.2.2",
|
||||
"resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.2.2.tgz",
|
||||
"integrity": "sha512-q0M/9eZHzmr0AulXyPwNfZjtwZ/RBZlbN3K3CErVrk50T2ASYI7Bye0EvekFY3IP1Nt2DHu0re+V2ZHIpMkuWg==",
|
||||
"dev": true
|
||||
},
|
||||
"pkg-dir": {
|
||||
"version": "4.2.0",
|
||||
"resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz",
|
||||
"integrity": "sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"find-up": "^4.0.0"
|
||||
}
|
||||
},
|
||||
"please-upgrade-node": {
|
||||
"version": "3.2.0",
|
||||
"resolved": "https://registry.npmjs.org/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz",
|
||||
"integrity": "sha512-gQR3WpIgNIKwBMVLkpMUeR3e1/E1y42bqDQZfql+kDeXd8COYfM8PQA4X6y7a8u9Ua9FHmsrrmirW2vHs45hWg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"semver-compare": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"prettier": {
|
||||
"version": "2.2.1",
|
||||
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.2.1.tgz",
|
||||
"integrity": "sha512-PqyhM2yCjg/oKkFPtTGUojv7gnZAoG80ttl45O6x2Ug/rMJw4wcc9k6aaf2hibP7BGVCCM33gZoGjyvt9mm16Q==",
|
||||
"dev": true
|
||||
},
|
||||
"pump": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz",
|
||||
"integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"end-of-stream": "^1.1.0",
|
||||
"once": "^1.3.1"
|
||||
}
|
||||
},
|
||||
"regexp-to-ast": {
|
||||
"version": "0.5.0",
|
||||
"resolved": "https://registry.npmjs.org/regexp-to-ast/-/regexp-to-ast-0.5.0.tgz",
|
||||
"integrity": "sha512-tlbJqcMHnPKI9zSrystikWKwHkBqu2a/Sgw01h3zFjvYrMxEDYHzzoMZnUrbIfpTFEsoRnnviOXNCzFiSc54Qw==",
|
||||
"dev": true
|
||||
},
|
||||
"resolve-from": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz",
|
||||
"integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==",
|
||||
"dev": true
|
||||
},
|
||||
"restore-cursor": {
|
||||
"version": "3.1.0",
|
||||
"resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz",
|
||||
"integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"onetime": "^5.1.0",
|
||||
"signal-exit": "^3.0.2"
|
||||
}
|
||||
},
|
||||
"rxjs": {
|
||||
"version": "6.6.3",
|
||||
"resolved": "https://registry.npmjs.org/rxjs/-/rxjs-6.6.3.tgz",
|
||||
"integrity": "sha512-trsQc+xYYXZ3urjOiJOuCOa5N3jAZ3eiSpQB5hIT8zGlL2QfnHLJ2r7GMkBGuIausdJN1OneaI6gQlsqNHHmZQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"tslib": "^1.9.0"
|
||||
}
|
||||
},
|
||||
"semver-compare": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/semver-compare/-/semver-compare-1.0.0.tgz",
|
||||
"integrity": "sha1-De4hahyUGrN+nvsXiPavxf9VN/w=",
|
||||
"dev": true
|
||||
},
|
||||
"semver-regex": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/semver-regex/-/semver-regex-2.0.0.tgz",
|
||||
"integrity": "sha512-mUdIBBvdn0PLOeP3TEkMH7HHeUP3GjsXCwKarjv/kGmUFOYg1VqEemKhoQpWMu6X2I8kHeuVdGibLGkVK+/5Qw==",
|
||||
"dev": true
|
||||
},
|
||||
"shebang-command": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
|
||||
"integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"shebang-regex": "^3.0.0"
|
||||
}
|
||||
},
|
||||
"shebang-regex": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz",
|
||||
"integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==",
|
||||
"dev": true
|
||||
},
|
||||
"signal-exit": {
|
||||
"version": "3.0.3",
|
||||
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.3.tgz",
|
||||
"integrity": "sha512-VUJ49FC8U1OxwZLxIbTTrDvLnf/6TDgxZcK8wxR8zs13xpx7xbG60ndBlhNrFi2EMuFRoeDoJO7wthSLq42EjA==",
|
||||
"dev": true
|
||||
},
|
||||
"slash": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz",
|
||||
"integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==",
|
||||
"dev": true
|
||||
},
|
||||
"slice-ansi": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-3.0.0.tgz",
|
||||
"integrity": "sha512-pSyv7bSTC7ig9Dcgbw9AuRNUb5k5V6oDudjZoMBSr13qpLBG7tB+zgCkARjq7xIUgdz5P1Qe8u+rSGdouOOIyQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ansi-styles": "^4.0.0",
|
||||
"astral-regex": "^2.0.0",
|
||||
"is-fullwidth-code-point": "^3.0.0"
|
||||
}
|
||||
},
|
||||
"string-argv": {
|
||||
"version": "0.3.1",
|
||||
"resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz",
|
||||
"integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==",
|
||||
"dev": true
|
||||
},
|
||||
"string-width": {
|
||||
"version": "4.2.0",
|
||||
"resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.0.tgz",
|
||||
"integrity": "sha512-zUz5JD+tgqtuDjMhwIg5uFVV3dtqZ9yQJlZVfq4I01/K5Paj5UHj7VyrQOJvzawSVlKpObApbfD0Ed6yJc+1eg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"emoji-regex": "^8.0.0",
|
||||
"is-fullwidth-code-point": "^3.0.0",
|
||||
"strip-ansi": "^6.0.0"
|
||||
}
|
||||
},
|
||||
"stringify-object": {
|
||||
"version": "3.3.0",
|
||||
"resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz",
|
||||
"integrity": "sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"get-own-enumerable-property-symbols": "^3.0.0",
|
||||
"is-obj": "^1.0.1",
|
||||
"is-regexp": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"strip-ansi": {
|
||||
"version": "6.0.0",
|
||||
"resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz",
|
||||
"integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ansi-regex": "^5.0.0"
|
||||
}
|
||||
},
|
||||
"strip-final-newline": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz",
|
||||
"integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==",
|
||||
"dev": true
|
||||
},
|
||||
"supports-color": {
|
||||
"version": "7.2.0",
|
||||
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
|
||||
"integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"has-flag": "^4.0.0"
|
||||
}
|
||||
},
|
||||
"through": {
|
||||
"version": "2.3.8",
|
||||
"resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz",
|
||||
"integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=",
|
||||
"dev": true
|
||||
},
|
||||
"to-regex-range": {
|
||||
"version": "5.0.1",
|
||||
"resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
|
||||
"integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"is-number": "^7.0.0"
|
||||
}
|
||||
},
|
||||
"tslib": {
|
||||
"version": "1.14.1",
|
||||
"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz",
|
||||
"integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==",
|
||||
"dev": true
|
||||
},
|
||||
"type-fest": {
|
||||
"version": "0.11.0",
|
||||
"resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.11.0.tgz",
|
||||
"integrity": "sha512-OdjXJxnCN1AvyLSzeKIgXTXxV+99ZuXl3Hpo9XpJAv9MBcHrrJOQ5kV7ypXOuQie+AmWG25hLbiKdwYTifzcfQ==",
|
||||
"dev": true
|
||||
},
|
||||
"which": {
|
||||
"version": "2.0.2",
|
||||
"resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
|
||||
"integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"isexe": "^2.0.0"
|
||||
}
|
||||
},
|
||||
"which-pm-runs": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/which-pm-runs/-/which-pm-runs-1.0.0.tgz",
|
||||
"integrity": "sha1-Zws6+8VS4LVd9rd4DKdGFfI60cs=",
|
||||
"dev": true
|
||||
},
|
||||
"wrap-ansi": {
|
||||
"version": "6.2.0",
|
||||
"resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz",
|
||||
"integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"ansi-styles": "^4.0.0",
|
||||
"string-width": "^4.1.0",
|
||||
"strip-ansi": "^6.0.0"
|
||||
}
|
||||
},
|
||||
"wrappy": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
|
||||
"integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=",
|
||||
"dev": true
|
||||
},
|
||||
"yaml": {
|
||||
"version": "1.10.0",
|
||||
"resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.0.tgz",
|
||||
"integrity": "sha512-yr2icI4glYaNG+KWONODapy2/jDdMSDnrONSjblABjD9B4Z5LgiircSt8m8sRZFNi08kG9Sm0uSHtEmP3zaEGg==",
|
||||
"dev": true
|
||||
}
|
||||
}
|
||||
}
|
||||
31
dita-ot-3.6/docsrc/package.json
Normal file
31
dita-ot-3.6/docsrc/package.json
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
{
|
||||
"name": "docs",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/dita-ot/docs"
|
||||
},
|
||||
"license": "Apache-2.0",
|
||||
"scripts": {
|
||||
"check": "prettier --check \"**/*.{css,dita*,json,md,scss,xml,yaml,yml}\"",
|
||||
"fmt": "npm run format",
|
||||
"format": "prettier --write \"**/*.{css,dita*,json,md,scss,xml,yaml,yml}\"",
|
||||
"prettier": "prettier --write \"**/*.{css,dita*,json,md,scss,xml,yaml,yml}\"",
|
||||
"test": "prettier --list-different \"**/*.{css,dita*,json,md,scss,xml,yaml,yml}\""
|
||||
},
|
||||
"husky": {
|
||||
"hooks": {
|
||||
"pre-commit": "lint-staged"
|
||||
}
|
||||
},
|
||||
"lint-staged": {
|
||||
"*.{css,dita*,json,md,scss,xml,yaml,yml}": [
|
||||
"prettier --write"
|
||||
]
|
||||
},
|
||||
"devDependencies": {
|
||||
"@prettier/plugin-xml": "0.12.0",
|
||||
"husky": "4.3.6",
|
||||
"lint-staged": "10.5.3",
|
||||
"prettier": "2.2.1"
|
||||
}
|
||||
}
|
||||
4
dita-ot-3.6/docsrc/parameters/all-parameters.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/all-parameters.dita
Normal file
File diff suppressed because one or more lines are too long
872
dita-ot-3.6/docsrc/parameters/ant-parameters-details.dita
Normal file
872
dita-ot-3.6/docsrc/parameters/ant-parameters-details.dita
Normal file
|
|
@ -0,0 +1,872 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="ant-parameters-details">
|
||||
<title>Ant parameter details</title>
|
||||
|
||||
<reference id="base">
|
||||
<title>All transformations</title>
|
||||
<titlealts>
|
||||
<navtitle>All transformations</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc conaction="pushreplace" conref="parameters-base.dita#base/shortdesc">Certain parameters apply to all
|
||||
transformations that DITA Open Toolkit supports.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<!-- This is a resource-only topic. Place index entries in the content below. -->
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<plentry id="args.draft">
|
||||
<pt>
|
||||
<parmname>args.draft</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/args.draft.desc"/>
|
||||
<pd conaction="pushafter" audience="xslt-customizer">Corresponds to the XSLT parameter
|
||||
<parmname>DRAFT</parmname> in most XSLT modules.<note type="tip">For PDF output, setting the
|
||||
<parmname>args.draft</parmname> parameter to <option>yes</option> causes the contents of the
|
||||
<xmlelement>titlealts</xmlelement> element to be rendered below the title.
|
||||
<indexterm><xmlelement>titlealts</xmlelement></indexterm>
|
||||
<indexterm>XSLT</indexterm>
|
||||
<indexterm>draft
|
||||
<indexterm>args.draft</indexterm>
|
||||
<indexterm>PDF</indexterm></indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>draft</indexterm></indexterm>
|
||||
<indexterm>parameters
|
||||
<indexterm>args.draft</indexterm></indexterm>
|
||||
</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.figurelink.style">
|
||||
<pt>
|
||||
<parmname>args.figurelink.style</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/args.figurelink.style.desc"/>
|
||||
<pd conaction="pushafter">Specifying <option>NUMBER</option> results in "Figure 5"; specifying
|
||||
<option>TITLE</option> results in the title of the figure. <ph audience="xslt-customizer">Corresponds to
|
||||
the XSLT parameter <parmname>FIGURELINK</parmname>.</ph><note rev="2.0">Support for PDF was added in
|
||||
DITA-OT 2.0. By default PDF uses the value <option>NUMTITLE</option>, which is not supported for other
|
||||
transformation types; this results in "Figure 5. Title".</note></pd>
|
||||
</plentry>
|
||||
<plentry id="args.filter">
|
||||
<pt>
|
||||
<parmname>args.filter</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-base.dita#base/args.filter.desc">
|
||||
<p>Specifies filter file(s) used to include, exclude, or flag content. Relative paths are resolved against
|
||||
the DITA-OT base directory (for backwards compatibility) and internally converted to absolute paths.</p>
|
||||
<note>
|
||||
<p>To specify multiple filter files, use the system path separator character to delimit individual file
|
||||
paths (semicolon ‘<codeph>;</codeph>’ on Windows, and colon ‘<codeph>:</codeph>’ on macOS and Linux)
|
||||
and wrap the value in quotes:</p>
|
||||
<p><codeph>--args.filter="filter1.ditaval;filter2.ditaval;filter3.ditaval"</codeph></p>
|
||||
<p>DITAVAL files are evaluated in the order specified, so conditions specified in the first file take
|
||||
precedence over matching conditions specified in later files, just as conditions at the start of a
|
||||
DITAVAL document take precedence over matching conditions later in the same document.</p>
|
||||
<indexterm>DITAVAL
|
||||
<indexterm><parmname>args.filter</parmname></indexterm></indexterm>
|
||||
<!-- https://github.com/dita-ot/dita-ot/issues/3319 -->
|
||||
<indexterm>DITAVAL
|
||||
<index-see-also>filters</index-see-also></indexterm>
|
||||
<indexterm>DITAVAL
|
||||
<index-see-also>profiling</index-see-also></indexterm>
|
||||
<indexterm>OS X
|
||||
<index-see>macOS</index-see></indexterm>
|
||||
<indexterm>macOS
|
||||
<indexterm>delimiter</indexterm></indexterm>
|
||||
<indexterm>Linux
|
||||
<indexterm>delimiter</indexterm></indexterm>
|
||||
<indexterm>Windows
|
||||
<indexterm>delimiter</indexterm></indexterm>
|
||||
</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.gen.task.lbl">
|
||||
<pt>
|
||||
<parmname>args.gen.task.lbl</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/args.gen.task.lbl.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<ph audience="xslt-customizer">Corresponds to the XSLT parameter
|
||||
<parmname>GENERATE-TASK-LABELS</parmname>.</ph></pd>
|
||||
</plentry>
|
||||
<plentry id="args.grammar.cache">
|
||||
<pt>
|
||||
<parmname>args.grammar.cache</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/args.grammar.cache.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<note>This option dramatically speeds up processing time. However, there is a known problem with using
|
||||
this feature for documents that use XML entities. If your build fails with parser errors about entity
|
||||
resolution, set this parameter to <option>no</option>.
|
||||
<indexterm>processing time</indexterm></note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.input">
|
||||
<pt>
|
||||
<parmname>args.input</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/args.input.desc"/>
|
||||
<pd conaction="pushafter">Typically this is a DITA map, however it also can be a DITA topic if you want to
|
||||
transform a single DITA file. The path can be absolute, relative to <parmname>args.input.dir</parmname>,
|
||||
or relative to the directory where your project’s Ant build script resides if
|
||||
<parmname>args.input.dir</parmname> is not defined. </pd>
|
||||
</plentry>
|
||||
<plentry id="args.rellinks">
|
||||
<pt><parmname>args.rellinks</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/args.rellinks.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<p>For PDF output, the default value is <option>nofamily</option>. For all other formats, the default
|
||||
value is <option>all</option>.
|
||||
<indexterm>args.rellinks</indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>related links</indexterm>
|
||||
<indexterm>args.rellinks</indexterm></indexterm>
|
||||
<indexterm>HTML5
|
||||
<indexterm>related links</indexterm>
|
||||
<indexterm>args.rellinks</indexterm></indexterm>
|
||||
</p></pd>
|
||||
</plentry>
|
||||
<plentry id="args.tablelink.style">
|
||||
<pt>
|
||||
<parmname>args.tablelink.style</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/args.tablelink.style.desc"/>
|
||||
<pd conaction="pushafter">Specifying <option>NUMBER</option> results in "Table 5"; specifying
|
||||
<option>TITLE</option> results in the title of the table. <ph audience="xslt-customizer">Corresponds to
|
||||
the XSLT parameter <parmname>TABLELINK</parmname>.</ph><note rev="2.0">Support for PDF was added in
|
||||
DITA-OT 2.0. By default PDF uses the value <option>NUMTITLE</option>, which is not supported for other
|
||||
transformation types; this results in "Table 5. Title".
|
||||
<indexterm>tables
|
||||
<indexterm>args.tablelink.style</indexterm></indexterm>
|
||||
</note></pd>
|
||||
</plentry>
|
||||
<plentry id="cleantemp">
|
||||
<pt>
|
||||
<parmname>clean.temp</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/clean.temp.desc"/>
|
||||
<pd conaction="pushafter"/>
|
||||
</plentry>
|
||||
<plentry id="default.language">
|
||||
<pt>
|
||||
<parmname>default.language</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-base.dita#base/default.language.desc">Specifies the language
|
||||
that is used if the input file does not have the <xmlatt>xml:lang</xmlatt> attribute set on the root
|
||||
element. By default, this is set to <option>en</option>. The allowed values are those that are defined in
|
||||
IETF BCP 47,
|
||||
<xref href="https://tools.ietf.org/html/bcp47" format="html" scope="external">Tags for Identifying
|
||||
Languages</xref>.
|
||||
<indexterm><xmlatt>xml:lang</xmlatt></indexterm>
|
||||
<indexterm>IETF BCP 47</indexterm>
|
||||
<indexterm>languages
|
||||
<indexterm>default</indexterm></indexterm>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="dita.temp.dir">
|
||||
<pt>
|
||||
<parmname>dita.temp.dir</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/dita.temp.dir.desc"/>
|
||||
<pd conaction="pushafter">The temporary directory is where DITA-OT writes temporary files that are generated
|
||||
during the transformation process.</pd>
|
||||
</plentry>
|
||||
<plentry id="dita.input.valfile" importance="deprecated">
|
||||
<pt>
|
||||
<parmname>dita.input.valfile</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/dita.input.valfile.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<note type="notice">Deprecated in favor of the <parmname>args.filter</parmname> parameter.</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="filter-stage">
|
||||
<pt>
|
||||
<parmname>filter-stage</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/filter-stage.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<note>Changing the filtering stage may produce different results for the same initial data set and
|
||||
filtering conditions.</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="force-unique">
|
||||
<pt>
|
||||
<parmname>force-unique</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/force-unique.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<p>Setting this to <option>true</option> ensures that unique output files are created for each instance of
|
||||
a resource when a map contains multiple references to a single topic.</p></pd>
|
||||
</plentry>
|
||||
<plentry id="generate-debug-attributes">
|
||||
<pt>
|
||||
<parmname>generate-debug-attributes</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/generate-debug-attributes.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<note>Disabling debugging attributes reduces the size of temporary files and thus reduces memory
|
||||
consumption. However, the log messages no longer have the source information available and thus the
|
||||
ability to debug problems might deteriorate.
|
||||
<indexterm>debugging
|
||||
<indexterm>generate-debug-attributes</indexterm></indexterm>
|
||||
<indexterm>memory</indexterm>
|
||||
</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="generate.copy.outer">
|
||||
<pt>
|
||||
<parmname>generate.copy.outer</parmname>
|
||||
<ph>
|
||||
<indexterm><parmname>generate.copy.outer</parmname></indexterm></ph>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/generate.copy.outer.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<p>See
|
||||
<xref keyref="generate-copy-outer"/> for more information.</p>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="onlytopic.in.map">
|
||||
<pt>
|
||||
<parmname>onlytopic.in.map</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/onlytopic.in.map.desc"/>
|
||||
<pd conaction="pushafter">If set to <option>true</option>, only files that are referenced directly from the
|
||||
map will generate output.</pd>
|
||||
</plentry>
|
||||
<plentry id="outer.control">
|
||||
<pt>
|
||||
<parmname>outer.control</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/outer.control.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<note type="warning" platform="windows">Microsoft HTML Help Compiler cannot produce HTML Help for
|
||||
documentation projects that use outer content. The content files must reside in or below the directory
|
||||
containing the master DITA map file, and the map file cannot specify ".." at the start of the
|
||||
<xmlatt>href</xmlatt> attributes for <xmlelement>topicref</xmlelement> elements.
|
||||
<indexterm><xmlelement>topicref</xmlelement></indexterm>
|
||||
<indexterm><xmlatt>href</xmlatt></indexterm>
|
||||
</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="output.dir">
|
||||
<pt>
|
||||
<parmname>output.dir</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/output.dir.desc"/>
|
||||
<pd conaction="pushafter">By default, the output is written to
|
||||
<filepath><varname>DITA-dir</varname>/out</filepath>.</pd>
|
||||
</plentry>
|
||||
<plentry id="result.rewrite-rule.class">
|
||||
<pt>
|
||||
<parmname>result.rewrite-rule.class</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/result.rewrite-rule.class.desc"/>
|
||||
<pd conaction="pushafter">The custom class should implement the
|
||||
<codeph>org.dita.dost.module.RewriteRule</codeph> interface.
|
||||
<indexterm><parmname>result.rewrite-rule.class</parmname></indexterm>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="result.rewrite-rule.xsl">
|
||||
<pt>
|
||||
<parmname>result.rewrite-rule.xsl</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/result.rewrite-rule.xsl.desc"/>
|
||||
<pd conaction="pushafter">See
|
||||
<xref keyref="plugin-rewrite-rules"/> for details.
|
||||
<indexterm><parmname>result.rewrite-rule.xsl</parmname></indexterm>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="root-chunk-override">
|
||||
<pt>
|
||||
<parmname>root-chunk-override</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/root-chunk-override.desc"/>
|
||||
<pd conaction="pushafter">Acceptable values include any value normally allowed on the <xmlatt>chunk</xmlatt>
|
||||
attribute. If the map does not have a <xmlatt>chunk</xmlatt> attribute, this value will be used; if the
|
||||
map already has a <xmlatt>chunk</xmlatt> attribute specified, this value will be used instead.
|
||||
<indexterm><xmlatt>chunk</xmlatt>
|
||||
<indexterm><parmname>root-chunk-override</parmname></indexterm></indexterm>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="store-type">
|
||||
<pt>
|
||||
<parmname>store-type</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/store-type.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<p>
|
||||
<ph conkeyref="migrating-to-3.6/io-bound"/> For more information, see
|
||||
<xref keyref="store-api"/>.</p>
|
||||
<note type="important">Custom plug-ins that expect to find certain files on disk in the temporary
|
||||
directory will not work with in-memory processing.</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="transtype">
|
||||
<pt>
|
||||
<parmname>transtype</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base.dita#base/transtype.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<p conkeyref="conref-task/transtypes"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
||||
<reference id="base-html">
|
||||
<title>HTML-based output parameters</title>
|
||||
<titlealts>
|
||||
<navtitle>HTML-based output</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc conaction="pushreplace" conref="parameters-base-html.dita#base-html/shortdesc">Certain parameters apply
|
||||
to all HTML-based transformation types: HTML5, XHTML, HTML Help, and Eclipse help. <ph>
|
||||
<indexterm>HTML5
|
||||
<indexterm>parameters</indexterm></indexterm>
|
||||
</ph>
|
||||
</shortdesc>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<plentry id="args.copycss">
|
||||
<pt><parmname>args.copycss</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.copycss.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.copycss.details">If an external process will copy your custom .css file to the output
|
||||
directory, leave this parameter unset (or set it to <option>no</option>). If DITA-OT should copy the
|
||||
file when generating output, set it to <option>yes</option>.</div></pd>
|
||||
</plentry>
|
||||
<plentry id="args.css">
|
||||
<pt><parmname>args.css</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.css.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.css.details">The value of this parameter should be only the file name. The absolute path to
|
||||
the parent directory should be specified with <parmname>args.cssroot</parmname>.</div></pd>
|
||||
</plentry>
|
||||
<plentry id="args.csspath">
|
||||
<pt>
|
||||
<parmname>args.csspath</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-base-html.dita#base-html/args.csspath.desc">
|
||||
<div id="args.csspath.desc">Specifies the <b>destination</b> directory to which .css files are copied
|
||||
(relative to the output directory).</div></pd>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.csspath.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.csspath.details">
|
||||
<p audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>CSSPATH</parmname>.</p>
|
||||
<p>DITA-OT will copy the file <b>to</b> this location.</p>
|
||||
<note type="tip">If <parmname>args.csspath</parmname> is not set, the custom CSS file (and the default
|
||||
CSS files) will be copied to the root level of the output folder. To copy CSS files to an output
|
||||
subfolder named <filepath>css</filepath>, set <parmname>args.csspath</parmname> to
|
||||
<option>css</option>.
|
||||
<indexterm>CSS
|
||||
<indexterm>copy to specific location</indexterm></indexterm>
|
||||
</note></div>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.cssroot">
|
||||
<pt>
|
||||
<parmname>args.cssroot</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-base-html.dita#base-html/args.cssroot.desc">
|
||||
<div id="args.cssroot.desc">Specifies the <b>source</b> directory that contains the custom .css
|
||||
file.</div></pd>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.cssroot.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.cssroot.details">
|
||||
<p>DITA-OT will copy the file <b>from</b> this location.</p>
|
||||
<note type="important">Enter the absolute path to the parent directory of the custom CSS file specified
|
||||
with <parmname>args.css</parmname>.</note>
|
||||
</div></pd>
|
||||
</plentry>
|
||||
<plentry id="args.dita.locale">
|
||||
<pt>
|
||||
<parmname>args.dita.locale</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.dita.locale.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<note>This parameter is not available for the XHTML transformation.</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.ftr">
|
||||
<pt>
|
||||
<parmname>args.ftr</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.ftr.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.ftr.details">
|
||||
<ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>FTR</parmname>.</ph>
|
||||
<note>The footer file should be specified using an absolute path and must contain valid XML. A common
|
||||
practice is to place all content into a <xmlelement>div</xmlelement> element. In HTML5 output, the
|
||||
footer file contents will be wrapped in an HTML5 <xmlelement>footer</xmlelement> element with the
|
||||
<xmlatt>role</xmlatt> attribute set to <option>contentinfo</option>.
|
||||
<indexterm><xmlelement>div</xmlelement>
|
||||
<indexterm>HTML footer</indexterm>
|
||||
<indexterm><parmname>args.ftr</parmname></indexterm></indexterm>
|
||||
<indexterm><xmlatt>role</xmlatt></indexterm>
|
||||
<indexterm>HTML5
|
||||
<indexterm>footers</indexterm></indexterm>
|
||||
</note>
|
||||
</div></pd>
|
||||
</plentry>
|
||||
<plentry id="args.gen.default.meta">
|
||||
<pt>
|
||||
<parmname>args.gen.default.meta</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.gen.default.meta.desc"/>
|
||||
<pd conaction="pushafter" audience="xslt-customizer">
|
||||
<div id="args.gen.default.meta.details">Corresponds to the XSLT parameter <parmname>genDefMeta</parmname>.
|
||||
</div>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.hdf">
|
||||
<pt><parmname>args.hdf</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hdf.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.hdf.details">
|
||||
<p>The contents of the header file will be inserted in the <xmlelement>head</xmlelement> element of the
|
||||
generated HTML files.</p>
|
||||
<note type="tip">The header file should be specified using an absolute path and must contain valid XML.
|
||||
If you need to insert more than one element into the HTML page head, wrap the content in a
|
||||
<xmlelement>div</xmlelement> element. The division wrapper in the header file will be discarded when
|
||||
generating HTML files, and the contents will be inserted into each page head.
|
||||
<indexterm><xmlelement>div</xmlelement>
|
||||
<indexterm>HTML <xmlelement>head</xmlelement></indexterm>
|
||||
<indexterm><parmname>args.hdf</parmname></indexterm></indexterm>
|
||||
</note></div></pd>
|
||||
</plentry>
|
||||
<plentry id="args.hdr">
|
||||
<pt>
|
||||
<parmname>args.hdr</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hdr.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.hdr.details">
|
||||
<ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>HDR</parmname>.</ph>
|
||||
<note>The header file should be specified using an absolute path and must contain valid XML. A common
|
||||
practice is to place all content into a <xmlelement>div</xmlelement> element. In HTML5 output, the
|
||||
contents of the header file will be wrapped in an HTML5 <xmlelement>header</xmlelement> element with
|
||||
the <xmlatt>role</xmlatt> attribute set to <option>banner</option>.
|
||||
<indexterm><xmlelement>div</xmlelement>
|
||||
<indexterm>HTML header</indexterm>
|
||||
<indexterm><parmname>args.hdr</parmname></indexterm></indexterm>
|
||||
<indexterm><xmlelement>header</xmlelement></indexterm>
|
||||
<indexterm><xmlatt>role</xmlatt></indexterm>
|
||||
<indexterm>HTML5
|
||||
<indexterm>headers</indexterm></indexterm>
|
||||
</note>
|
||||
</div></pd>
|
||||
</plentry>
|
||||
<plentry id="args.hide.parent.link" importance="deprecated">
|
||||
<pt>
|
||||
<parmname>args.hide.parent.link</parmname>
|
||||
<ph>
|
||||
<indexterm>deprecated features
|
||||
<indexterm><parmname>args.hide.parent.link</parmname></indexterm></indexterm></ph>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.hide.parent.link.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.hide.parent.link.details">
|
||||
<ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>NOPARENTLINK</parmname>.</ph>
|
||||
<note type="notice">This parameter is deprecated in favor of the <parmname>args.rellinks</parmname>
|
||||
parameter.</note>
|
||||
</div></pd>
|
||||
</plentry>
|
||||
<plentry id="args.outext">
|
||||
<pt>
|
||||
<parmname>args.outext</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.outext.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.outext.details">
|
||||
<ph audience="xslt-customizer">Corresponds to the XSLT parameter <parmname>OUTEXT</parmname>.</ph>
|
||||
</div></pd>
|
||||
</plentry>
|
||||
<plentry id="args.xhtml.classattr">
|
||||
<pt>
|
||||
<parmname>args.xhtml.classattr</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.xhtml.classattr.desc"/>
|
||||
<pd conaction="pushafter">For example, the <xmlelement>prereq</xmlelement> element (which is specialized
|
||||
from <xmlelement>section</xmlelement>) would generate <codeph>class="section prereq"</codeph>. <ph
|
||||
audience="xslt-customizer"
|
||||
>Corresponds to the XSLT parameter
|
||||
<parmname>PRESERVE-DITA-CLASS</parmname>.</ph><note>Beginning with DITA-OT release 1.5.2, the default
|
||||
value is <option>yes</option>. For release 1.5 and 1.5.1, the default value was <option
|
||||
>no</option>. </note>
|
||||
<indexterm><xmlelement>prereq</xmlelement></indexterm>
|
||||
<indexterm><xmlelement>section</xmlelement></indexterm>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.xsl">
|
||||
<pt>
|
||||
<parmname>args.xsl</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-base-html.dita#base-html/args.xsl.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div id="args.xsl.details">The parameter must specify a fully qualified file name.</div></pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
||||
<reference id="eclipsehelp">
|
||||
<title>Eclipse help</title>
|
||||
<titlealts>
|
||||
<navtitle>Eclipse help</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc conaction="pushreplace" conref="parameters-eclipsehelp.dita#eclipsehelp/shortdesc">Certain parameters are
|
||||
specific to the Eclipse help transformation.</shortdesc>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<plentry id="args.eclipsehelp.country">
|
||||
<pt>
|
||||
<parmname>args.eclipsehelp.country</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipsehelp.country.desc"/>
|
||||
<pd conaction="pushafter">For example, <option>us</option>, <option>ca</option>, and <option>gb</option>
|
||||
would clarify a value of <option>en</option> set for the <parmname>args.eclipsehelp.language</parmname>
|
||||
parameter. The content will be moved into the appropriate directory structure for an Eclipse
|
||||
fragment.<draft-comment author="Kristen James Eberlein" time="11 August 2012">What does "The content
|
||||
will be moved into the appropriate directory structure for an Eclipse fragment"
|
||||
mean?</draft-comment></pd>
|
||||
</plentry>
|
||||
<plentry id="args.eclipsehelp.language">
|
||||
<pt>
|
||||
<parmname>args.eclipsehelp.language</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipsehelp.language.desc"/>
|
||||
<pd conaction="pushafter">This parameter is a prerequisite for the
|
||||
<parmname>args.eclipsehelp.country</parmname> parameter. The content will be moved into the appropriate
|
||||
directory structure for an Eclipse fragment.</pd>
|
||||
</plentry>
|
||||
<plentry id="args.eclipse.provider">
|
||||
<pt>
|
||||
<parmname>args.eclipse.provider</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.provider.desc"/>
|
||||
<pd conaction="pushafter">The default value is <option>DITA</option>. <note type="tip">The toolkit ignores
|
||||
the value of this parameter when it processes an Eclipse map.</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.eclipse.version">
|
||||
<pt>
|
||||
<parmname>args.eclipse.version</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.version.desc"/>
|
||||
<pd conaction="pushafter">The default value is <option>0.0.0</option>.<note type="tip">The toolkit ignores
|
||||
the value of this parameter when it processes an Eclipse map.</note></pd>
|
||||
</plentry>
|
||||
<plentry id="args.eclipse.symbolic.name">
|
||||
<pt>
|
||||
<parmname>args.eclipse.symbolic.name</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-eclipsehelp.dita#eclipsehelp/args.eclipse.symbolic.name.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<!-- Specifies the symbolic name (aka plugin ID) in the output for an Eclipse Help project. -->The
|
||||
<xmlatt>id</xmlatt> value from the DITA map or the Eclipse map collection (Eclipse help specialization)
|
||||
is the symbolic name for the plugin in Eclipse. The default value is
|
||||
<option>org.sample.help.doc</option>.<note type="tip">The toolkit ignores the value of this parameter
|
||||
when it processes an Eclipse map.
|
||||
<indexterm><xmlatt>id</xmlatt>
|
||||
<indexterm><parmname>args.eclipse.symbolic.name</parmname></indexterm></indexterm>
|
||||
</note>
|
||||
<draft-comment author="Kristen James Eberlein" time="11 August 2012">I'm not clear what this means. Is the
|
||||
default value for the <parmname>args.eclipse.symbolic.name</parmname> parameter the value of the
|
||||
<xmlatt>id</xmlatt> attribute on the <xmlelement>map</xmlelement> or <xmlelement>plugin</xmlelement>
|
||||
element, if provided, and the <option>org.sample.help.doc</option> if there is not a value for the
|
||||
<xmlatt>id</xmlatt> attribute or the <parmname>args.eclipse.symbolic.name</parmname>
|
||||
parameter?</draft-comment>
|
||||
</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
||||
<reference id="htmlhelp">
|
||||
<title>HTML Help</title>
|
||||
<titlealts>
|
||||
<navtitle>HTML Help</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc conaction="pushreplace" conref="parameters-htmlhelp.dita#htmlhelp/shortdesc">Certain parameters are
|
||||
specific to the Microsoft Compiled HTML Help (.chm) transformation.</shortdesc>
|
||||
<refbody/>
|
||||
</reference>
|
||||
|
||||
<reference id="pdf">
|
||||
<title>PDF</title>
|
||||
<titlealts>
|
||||
<navtitle>PDF</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc conaction="pushreplace" conref="parameters-pdf.dita#pdf/shortdesc">Certain parameters are specific to the
|
||||
PDF transformation.</shortdesc>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<plentry id="args.xsl.pdf">
|
||||
<pt>
|
||||
<parmname>args.xsl.pdf</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-pdf.dita#pdf/args.xsl.pdf.desc"/>
|
||||
<pd conaction="pushafter">You must specify the fully qualified file name.</pd>
|
||||
</plentry>
|
||||
<plentry id="org.dita.index.skip">
|
||||
<pt>
|
||||
<parmname>org.dita.index.skip</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-pdf.dita#pdf/org.dita.index.skip.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<p>Up until DITA-OT 3.4, indexing code was provided in the PDF plug-in and only available for PDF output.
|
||||
In version 3.4 and above, indexing is provided by a separate plug-in to allow other transformations to
|
||||
access the results.</p>
|
||||
<p>If you have overridden PDF index processing via the <codeph>transform.topic2fo</codeph> target in the
|
||||
past, you can set the <parmname>org.dita.index.skip</parmname> property to <option>yes</option> and
|
||||
re-enable the <codeph>transform.topic2fo.index</codeph> target with <xmlelement>feature
|
||||
extension="depend.org.dita.pdf2.index" value="transform.topic2fo.index"/</xmlelement> in your plug-in
|
||||
configuration.</p>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="org.dita.pdf2.i18n.enabled">
|
||||
<pt><parmname>org.dita.pdf2.i18n.enabled</parmname></pt>
|
||||
<pd conaction="pushreplace" conref="parameters-pdf.dita#pdf/org.dita.pdf2.i18n.enabled.desc">
|
||||
<p>Enables internationalization (I18N) font processing to provide per-character font selection for FO
|
||||
renderers that do not support the <codeph>font-selection-strategy</codeph> property (such as Apache
|
||||
FOP).
|
||||
<indexterm>Apache FOP
|
||||
<indexterm>I18N</indexterm></indexterm>
|
||||
<indexterm>FOP
|
||||
<index-see>Apache FOP</index-see></indexterm>
|
||||
<indexterm>I18N
|
||||
<indexterm><parmname>org.dita.pdf2.i18n.enabled</parmname></indexterm></indexterm>
|
||||
<indexterm>fonts
|
||||
<indexterm>PDF</indexterm></indexterm>
|
||||
</p>
|
||||
<p>When this feature is enabled, DITA-OT uses a font mapping process that takes the content language into
|
||||
consideration. The mapping process uses configuration files for each language to define characters that
|
||||
should be rendered with certain logical fonts, and font mappings that associate each logical font to
|
||||
physical font files.</p>
|
||||
<p>The following values are allowed:</p>
|
||||
<ul>
|
||||
<li><option>true</option> (default) — Enables font mapping</li>
|
||||
<li><option>false</option> — Disables font mapping</li>
|
||||
</ul>
|
||||
<note type="tip">If you don’t use custom character mappings, turning off font mapping makes it easier to
|
||||
define custom fonts simply by changing font names in the XSL attributes files of your custom PDF
|
||||
plug-in. For details, see
|
||||
<xref keyref="jelovirt-on-pdf2-i18n"/>.</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="outputFile.base">
|
||||
<pt>
|
||||
<parmname>outputFile.base</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-pdf.dita#pdf/outputFile.base.desc"/>
|
||||
<pd conaction="pushafter">By default, the PDF file uses the base filename of the input
|
||||
<filepath>.ditamap</filepath> file.
|
||||
<indexterm>DITA maps
|
||||
<indexterm>PDF file name</indexterm></indexterm></pd>
|
||||
</plentry>
|
||||
<plentry id="pdf.formatter">
|
||||
<pt>
|
||||
<parmname>pdf.formatter</parmname>
|
||||
</pt>
|
||||
<pd>The client package comes with Apache FOP; other XSL processors must be separately installed.</pd>
|
||||
<!-- Added to inject index entries into the right location. -->
|
||||
<pd conaction="mark" conref="parameters-pdf.dita#pdf/pdf.formatter.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<indexterm>Apache FOP
|
||||
<indexterm><parmname>pdf.formatter</parmname></indexterm></indexterm>
|
||||
<indexterm>formatter</indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>formatter</indexterm></indexterm>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="publish.required.cleanup" importance="deprecated">
|
||||
<pt>
|
||||
<parmname>publish.required.cleanup</parmname>
|
||||
<ph>
|
||||
<indexterm>deprecated features
|
||||
<indexterm><parmname>publish.required.cleanup</parmname></indexterm></indexterm></ph>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-pdf.dita#pdf/publish.required.cleanup.desc"/>
|
||||
<pd conaction="pushafter">The default value is the value of the <parmname>args.draft</parmname> parameter.
|
||||
<ph audience="xslt-customizer">Corresponds to the XSLT parameter
|
||||
<parmname>publishRequiredCleanup</parmname>.</ph><note type="notice">This parameter is deprecated in
|
||||
favor of the <parmname>args.draft</parmname> parameter.</note></pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
||||
<reference id="xhtml">
|
||||
<title>XHTML</title>
|
||||
<shortdesc conaction="pushreplace" conref="parameters-xhtml.dita#xhtml/shortdesc">Certain parameters are specific to
|
||||
the XHTML transformation.</shortdesc>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<plentry id="args.xhtml.contenttarget">
|
||||
<pt>
|
||||
<parmname>args.xhtml.contenttarget</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-xhtml.dita#xhtml/args.xhtml.contenttarget.desc"/>
|
||||
<pd conaction="pushafter">The default value is <option>contentwin</option>. Change this value to use a
|
||||
different target name for the table of contents.
|
||||
<indexterm>table of contents
|
||||
<indexterm>XHTML</indexterm></indexterm>
|
||||
</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
|
||||
<reference id="html5">
|
||||
<title>HTML5 parameters</title>
|
||||
<titlealts>
|
||||
<navtitle>HTML5</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc conaction="pushreplace" conref="parameters-html5.dita#html5/shortdesc">The HTML5 transformation shares
|
||||
common parameters with other HTML-based transformations and provides additional parameters that are specific to
|
||||
HTML5 output. <ph>
|
||||
<indexterm>HTML5</indexterm></ph>
|
||||
</shortdesc>
|
||||
<refbody>
|
||||
<!-- args.html5.contenttarget is listed in generated topic, but does not appear in default HTML5 output files. -->
|
||||
<section>
|
||||
<!-- Re-use extended base-html parameter descriptions for #132 -->
|
||||
<parml>
|
||||
<plentry id="args.copycss">
|
||||
<pt><parmname>args.copycss</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.copycss.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.copycss.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.css">
|
||||
<pt><parmname>args.css</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.css.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.css.details"/></pd>
|
||||
</plentry>
|
||||
<!-- ↓ excerpt-csspath ↓ -->
|
||||
<plentry id="args.csspath">
|
||||
<pt>
|
||||
<parmname>args.csspath</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-html5.dita#html5/args.csspath.desc">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.csspath.desc"/>
|
||||
</pd>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.csspath.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.csspath.details"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
<!-- ↑ end-excerpt ↑ -->
|
||||
<plentry id="args.cssroot">
|
||||
<pt>
|
||||
<parmname>args.cssroot</parmname>
|
||||
</pt>
|
||||
<pd conaction="pushreplace" conref="parameters-html5.dita#html5/args.cssroot.desc">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.cssroot.desc"/></pd>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.cssroot.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.cssroot.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.ftr">
|
||||
<pt>
|
||||
<parmname>args.ftr</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.ftr.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.ftr.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.gen.default.meta">
|
||||
<pt>
|
||||
<parmname>args.gen.default.meta</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.gen.default.meta.desc"/>
|
||||
<pd conaction="pushafter" audience="xslt-customizer">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.gen.default.meta.details"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="args.hdf">
|
||||
<pt><parmname>args.hdf</parmname></pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.hdf.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.hdf.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.hdr">
|
||||
<pt>
|
||||
<parmname>args.hdr</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.hdr.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.hdr.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.hide.parent.link" importance="deprecated">
|
||||
<pt>
|
||||
<parmname>args.hide.parent.link</parmname>
|
||||
<ph>
|
||||
<indexterm>deprecated features
|
||||
<indexterm><parmname>args.hide.parent.link</parmname></indexterm></indexterm></ph>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.hide.parent.link.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.hide.parent.link.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.outext">
|
||||
<pt>
|
||||
<parmname>args.outext</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.outext.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.outext.details"/></pd>
|
||||
</plentry>
|
||||
<plentry id="args.xsl">
|
||||
<pt>
|
||||
<parmname>args.xsl</parmname>
|
||||
</pt>
|
||||
<pd conaction="mark" conref="parameters-html5.dita#html5/args.xsl.desc"/>
|
||||
<pd conaction="pushafter">
|
||||
<div conref="./ant-parameters-details.dita#base-html/args.xsl.details"/></pd>
|
||||
</plentry>
|
||||
<!-- End shared base-html parameter descriptions -->
|
||||
<plentry id="nav-toc">
|
||||
<pt><parmname>nav-toc</parmname></pt>
|
||||
<pd conaction="pushreplace" conref="parameters-html5.dita#html5/nav-toc.desc">
|
||||
<p>Specifies whether to generate a table of contents (ToC) in the HTML5 <xmlelement>nav</xmlelement>
|
||||
element of each page. The navigation can then be rendered in a sidebar or menu via CSS.
|
||||
<indexterm>HTML5
|
||||
<indexterm>nav-toc</indexterm></indexterm>
|
||||
</p>
|
||||
<p>The following values are supported:
|
||||
<ul>
|
||||
<li><option>none</option> (default) – No table of contents will be generated</li>
|
||||
<li><option>partial</option> – Include the current topic in the ToC along with its parents, siblings
|
||||
and children</li>
|
||||
<li><option>full</option> – Generate a complete ToC for the entire map</li>
|
||||
</ul>
|
||||
<indexterm>table of contents
|
||||
<indexterm>HTML5</indexterm></indexterm>
|
||||
<indexterm>table of contents
|
||||
<indexterm>nav-toc</indexterm></indexterm>
|
||||
</p>
|
||||
</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
</reference>
|
||||
163
dita-ot-3.6/docsrc/parameters/configuration-properties-file.dita
Normal file
163
dita-ot-3.6/docsrc/parameters/configuration-properties-file.dita
Normal file
|
|
@ -0,0 +1,163 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="configuration" xml:lang="en">
|
||||
<title>The <filepath>configuration.properties</filepath> file</title>
|
||||
<titlealts>
|
||||
<navtitle><filepath>configuration.properties</filepath></navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>The <filepath>configuration.properties</filepath> file controls certain common properties, as well as some
|
||||
properties that control PDF processing.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>configuration properties
|
||||
<indexterm>default.cascade</indexterm>
|
||||
<indexterm>org.dita.pdf2.i18n.enabled</indexterm>
|
||||
<indexterm>plugin.ignores</indexterm>
|
||||
<indexterm>plugin.order</indexterm>
|
||||
<indexterm>plugindirs</indexterm>
|
||||
<indexterm>temp-file-name-scheme</indexterm>
|
||||
<indexterm>cli.color</indexterm>
|
||||
<indexterm>registry</indexterm>
|
||||
<indexterm>default.coderef-charset</indexterm>
|
||||
</indexterm>
|
||||
<indexterm>files
|
||||
<indexterm>config/configuration.properties file</indexterm>
|
||||
</indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>configuration properties</indexterm>
|
||||
</indexterm>
|
||||
<indexterm><xmlatt>cascade</xmlatt></indexterm>
|
||||
<indexterm>macOS
|
||||
<indexterm>colored console output</indexterm></indexterm>
|
||||
<indexterm>Linux
|
||||
<indexterm>colored console output</indexterm></indexterm>
|
||||
<indexterm>Windows
|
||||
<indexterm>colored console output</indexterm></indexterm>
|
||||
<indexterm>command line
|
||||
<index-see-also>dita command</index-see-also></indexterm>
|
||||
<indexterm>terminal
|
||||
<index-see>command line</index-see></indexterm>
|
||||
<indexterm>grammar files
|
||||
<index-see-also>schema</index-see-also>
|
||||
<index-see-also>DTD</index-see-also></indexterm>
|
||||
<indexterm><cmdname>dita</cmdname> command
|
||||
<indexterm>colored console output</indexterm></indexterm>
|
||||
<indexterm>metadata
|
||||
<indexterm><xmlatt>cascade</xmlatt></indexterm></indexterm>
|
||||
<indexterm>DITA 1.3
|
||||
<indexterm><xmlatt>cascade</xmlatt></indexterm></indexterm>
|
||||
<indexterm>default.cascade</indexterm>
|
||||
<indexterm>org.dita.pdf2.i18n.enabled</indexterm>
|
||||
<indexterm>plugin.ignores</indexterm>
|
||||
<indexterm>plugin.order</indexterm>
|
||||
<indexterm>plugindirs</indexterm>
|
||||
<indexterm>temp-file-name-scheme</indexterm>
|
||||
<indexterm>cli.color</indexterm>
|
||||
<indexterm>registry</indexterm>
|
||||
<indexterm>default.coderef-charset</indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>temporary file names</indexterm></indexterm>
|
||||
<indexterm>temporary file names</indexterm>
|
||||
<indexterm>catalog
|
||||
<indexterm>import precedence</indexterm></indexterm>
|
||||
<indexterm>internationalization
|
||||
<index-see>I18N</index-see></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<p>The contents of the <filepath>config/configuration.properties</filepath> file are added to the DITA-OT
|
||||
configuration in the <codeph>dost-configuration.jar</codeph> file when the plug-in integration process runs. The
|
||||
following properties are typically set in this file:</p>
|
||||
<parml>
|
||||
<plentry id="default-cascade">
|
||||
<pt><parmname>default.cascade</parmname></pt>
|
||||
<pd>
|
||||
<p>Specifies the processing default value for the DITA 1.3 <xmlatt>cascade</xmlatt> attribute, which
|
||||
determines how map-level metadata attributes are applied to the children of elements where the attributes
|
||||
are specified. DITA-OT uses the <option>merge</option> value by default for backwards compatibility with
|
||||
DITA 1.2 and earlier.</p>
|
||||
<note type="warning" id="protected-config-props">This property can only be set in
|
||||
<filepath>configuration.properties</filepath> and should not be modified.</note></pd>
|
||||
</plentry>
|
||||
<plentry id="temp-file-name-scheme">
|
||||
<pt><parmname>temp-file-name-scheme</parmname></pt>
|
||||
<!-- org.dita.dost.module.GenMapAndTopicListModule$DefaultTempFileScheme -->
|
||||
<pd>
|
||||
<p>This setting specifies the name of the Java class that defines how the source URL of a topic is mapped to
|
||||
the URL of the temporary file name. The current default method uses a 1:1 mapping, though future
|
||||
implementations may use alternative approaches such as hashes or full absolute paths as file names.</p>
|
||||
<note conref="#configuration/protected-config-props"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="cli-color" rev="2.5">
|
||||
<pt><parmname>cli.color</parmname></pt>
|
||||
<pd>
|
||||
<p>Specifies whether the <cmdname>dita</cmdname> command prints colored output on the command line console.
|
||||
When set to <option>true</option>, error messages in <cmdname>dita</cmdname> command output will appear in
|
||||
red on terminals that support
|
||||
<xref href="https://en.wikipedia.org/wiki/ANSI_escape_code" format="html" scope="external">ANSI escape
|
||||
codes</xref>, such as on Linux or macOS. Set to <option>false</option> to disable the color. (Colored
|
||||
output is not supported on Windows consoles such as <cmdname>cmd.exe</cmdname> or PowerShell).</p>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry id="plugindirs">
|
||||
<pt><parmname>plugindirs</parmname></pt>
|
||||
<pd id="plugindirs.desc">
|
||||
<p>A semicolon-separated list of directory paths that DITA-OT searches for plug-ins to install; any relative
|
||||
paths are resolved against the DITA-OT base directory. Any immediate subdirectory that contains a
|
||||
<filepath>plugin.xml</filepath> file is installed.</p>
|
||||
<note type="tip">You can use this property to test custom plug-ins that are stored in other locations. For
|
||||
example, to install all of the sample plug-ins that are included in the DITA-OT documentation, append
|
||||
<filepath>;docsrc/samples/plugins</filepath> to the property value and run <cmdname>dita</cmdname>
|
||||
<parmname>--install</parmname>. You can maintain custom plug-ins in version-controlled repositories
|
||||
outside of the DITA-OT installation directory, and add the repository locations to the list of plug-in
|
||||
directories here to test your code.</note></pd>
|
||||
</plentry>
|
||||
<plentry id="plugin.ignores">
|
||||
<pt><parmname>plugin.ignores</parmname></pt>
|
||||
<pd id="plugin.ignores.desc">A semicolon-separated list of directory names to be ignored during plug-in
|
||||
installation; any relative paths are resolved against the DITA-OT base directory.</pd>
|
||||
</plentry>
|
||||
<plentry id="plugin-order">
|
||||
<pt><parmname>plugin.order</parmname></pt>
|
||||
<pd>Defines the order in which plug-ins are processed. In XML catalog files, the order of imports is
|
||||
significant. If multiple plug-ins define the same thing (differently), the first catalog entry “wins”.
|
||||
DITA-OT uses this property to define the order in which catalog entries are written. This mechanism is
|
||||
currently used to ensure that DITA 1.3 grammar files take precedence over their DITA 1.2 equivalents.</pd>
|
||||
</plentry>
|
||||
<plentry id="registry">
|
||||
<pt><parmname>registry</parmname></pt>
|
||||
<pd>Defines the list (and order) of plug-in repositories that are searched for available plug-ins during the
|
||||
installation process. In addition to the main plug-in registry at
|
||||
<xref keyref="site-plugin-registry"/>, you can create a registry of your own to store the custom plug-ins
|
||||
for your company or organization. To add a new entry, append the URL for your custom registry directory to
|
||||
the <codeph>registry</codeph> key value, separating each entry with a space. For more information, see
|
||||
<xref keyref="plugins-registry"/>.</pd>
|
||||
</plentry>
|
||||
<plentry conref="ant-parameters-details.dita#pdf/org.dita.pdf2.i18n.enabled">
|
||||
<pt/>
|
||||
<pd/>
|
||||
</plentry>
|
||||
<plentry id="charset">
|
||||
<pt><parmname>default.coderef-charset</parmname></pt>
|
||||
<pd>As of DITA-OT 3.3, the default character set for code references can be changed by specifying one of the
|
||||
character set values supported by the Java
|
||||
<xref
|
||||
format="html"
|
||||
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html"
|
||||
scope="external"
|
||||
>Charset</xref> class.</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
<related-links>
|
||||
<link keyref="dita13-spec-metadata-cascade"/>
|
||||
<link keyref="dita13-spec-metadata-cascade-example"/>
|
||||
<link keyref="jelovirt-on-pdf2-i18n"/>
|
||||
</related-links>
|
||||
</reference>
|
||||
49
dita-ot-3.6/docsrc/parameters/configuration-properties.dita
Normal file
49
dita-ot-3.6/docsrc/parameters/configuration-properties.dita
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="configuring-the-dita-ot">
|
||||
<title>Configuration properties</title>
|
||||
<shortdesc>DITA-OT uses <filepath>.properties</filepath> files and internal properties that store configuration
|
||||
settings for the toolkit and its plug-ins. Configuration properties are available to both Ant and Java processes,
|
||||
but unlike argument properties, they cannot be set at run time.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>command line
|
||||
<indexterm>properties</indexterm></indexterm>
|
||||
<indexterm>properties</indexterm>
|
||||
<indexterm>Ant
|
||||
<indexterm>properties</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>properties</indexterm></indexterm>
|
||||
<indexterm>Ant
|
||||
<indexterm>configuring</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>configuring</indexterm></indexterm>
|
||||
<indexterm>Ant
|
||||
<indexterm>precedence</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>precedence</indexterm></indexterm>
|
||||
<indexterm><filepath>local.properties file</filepath></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<p>When DITA-OT starts the Ant process, it looks for property values in the following order and locations:</p>
|
||||
<ol>
|
||||
<li>Any property passed to Ant from the command line with <parmname>-Dproperty</parmname> or
|
||||
<parmname>--property</parmname>=<option>value</option></li>
|
||||
<li>A custom property file passed with <parmname>--propertyfile</parmname></li>
|
||||
<li>A <filepath>local.properties</filepath> file in the root directory of the DITA-OT installation</li>
|
||||
<li>The <filepath>lib/org.dita.dost.platform/plugin.properties</filepath> file</li>
|
||||
<li>The <filepath>configuration.properties</filepath> file</li>
|
||||
</ol>
|
||||
<p>If a given property is set in multiple places, the first value “wins” and subsequent entries for the same
|
||||
property are ignored.</p>
|
||||
<p>You can use this mechanism to override DITA-OT default settings for your environment by passing parameters to
|
||||
the <cmdname>dita</cmdname> command with <parmname>--property</parmname>=<option>value</option>, or using
|
||||
entries in <filepath>.properties</filepath> files.</p>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
422
dita-ot-3.6/docsrc/parameters/dita-command-arguments.dita
Normal file
422
dita-ot-3.6/docsrc/parameters/dita-command-arguments.dita
Normal file
|
|
@ -0,0 +1,422 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="dita-command-properties" xml:lang="en">
|
||||
<title>Arguments and options for the <cmdname>dita</cmdname> command</title>
|
||||
<titlealts>
|
||||
<navtitle>DITA command arguments</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>The <cmdname>dita</cmdname> command takes mandatory arguments to process DITA content. Subcommands can be
|
||||
used to manage plug-ins, or print information about the current configuration. A series of options are available to
|
||||
modify the command behavior or specify additional configuration parameters.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>filters
|
||||
<indexterm><cmdname>dita</cmdname> command</indexterm></indexterm>
|
||||
<indexterm><cmdname>dita</cmdname> command
|
||||
<indexterm>arguments list</indexterm></indexterm>
|
||||
<indexterm>arguments
|
||||
<index-see-also><cmdname>dita</cmdname> command</index-see-also></indexterm>
|
||||
<indexterm>installing</indexterm>
|
||||
<indexterm>uninstalling</indexterm>
|
||||
<indexterm>artlbl
|
||||
<index-see>args.artlbl</index-see></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<title>Usage</title>
|
||||
<p>To convert content from one format to another, specify the file to transform and the desired output format. If
|
||||
necessary, you can set additional configuration parameters with options.</p>
|
||||
<syntaxdiagram>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>--input</kwd>
|
||||
<oper>=</oper>
|
||||
<var>file</var>
|
||||
<kwd>--format</kwd>
|
||||
<oper>=</oper>
|
||||
<var>name</var>
|
||||
<groupcomp importance="optional">
|
||||
<var>options</var>
|
||||
</groupcomp>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>--project</kwd>
|
||||
<oper>=</oper>
|
||||
<var>file</var>
|
||||
<groupcomp importance="optional">
|
||||
<var>options</var>
|
||||
</groupcomp>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
</syntaxdiagram>
|
||||
<note>Most <cmdname>dita</cmdname> command options support several syntax alternatives. All options can be
|
||||
specified with a GNU-style option keyword preceded by two hyphens. In many cases, Unix-style single-letter
|
||||
options (preceded by a single hyphen) are also available for brevity and backwards compatibility.</note>
|
||||
<p>The <cmdname>dita</cmdname> command also supports a series of subcommands that can be used to manage plug-ins,
|
||||
or print information about the current configuration or version.</p>
|
||||
<syntaxdiagram>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>deliverables</kwd>
|
||||
<var>file</var>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>install</kwd>
|
||||
<groupchoice importance="optional">
|
||||
<var>ID</var>
|
||||
<var>URL</var>
|
||||
<var>file</var>
|
||||
</groupchoice>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>plugins</kwd>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>transtypes</kwd>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>uninstall</kwd>
|
||||
<var>ID</var>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
<fragment>
|
||||
<groupseq>
|
||||
<kwd>dita</kwd>
|
||||
<kwd>version</kwd>
|
||||
</groupseq>
|
||||
</fragment>
|
||||
</syntaxdiagram>
|
||||
<note type="attention">Prior to DITA-OT 3.5, subcommands were specified with the double-hyphen option syntax,
|
||||
which is still supported for backwards compatibility. (For example, <cmdname>dita</cmdname>
|
||||
<parmname>--install</parmname> will still work.)</note>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Arguments</title>
|
||||
<indexterm><parmname>--input</parmname></indexterm>
|
||||
<indexterm><parmname>-i</parmname></indexterm>
|
||||
<indexterm><parmname>--format</parmname></indexterm>
|
||||
<indexterm><parmname>-f</parmname></indexterm>
|
||||
<p>Each transformation requires you to specify at least the file to transform and the desired output format.</p>
|
||||
<parml>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--input</parmname>=<varname>file</varname></pt>
|
||||
<pt>
|
||||
<parmname>-i</parmname>
|
||||
<varname>file</varname>
|
||||
</pt>
|
||||
<pd id="args.input.desc">Specifies the master file for your documentation project. This argument corresponds
|
||||
to the common parameter <parmname>args.input</parmname>. Typically this is a DITA map, however it also can
|
||||
be a DITA topic if you want to transform a single DITA file. The path can be absolute, relative to
|
||||
<parmname>args.input.dir</parmname>, or relative to the current directory if
|
||||
<parmname>args.input.dir</parmname> is not defined.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--format</parmname>=<varname>name</varname></pt>
|
||||
<pt>
|
||||
<parmname>-f</parmname>
|
||||
<varname>name</varname>
|
||||
</pt>
|
||||
<pd conkeyref="parameters-base/transtype.desc"/>
|
||||
<pd>This argument corresponds to the common parameter <parmname>transtype</parmname>.</pd>
|
||||
<pd>To list the formats that are currently available in your environment, use <cmdname>dita
|
||||
transtypes</cmdname>.</pd>
|
||||
<pd>
|
||||
<p conkeyref="conref-task/transtypes"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Subcommands</title>
|
||||
<indexterm><cmdname>deliverables</cmdname> subcommand</indexterm>
|
||||
<indexterm><cmdname>install</cmdname> subcommand</indexterm>
|
||||
<indexterm><parmname>--install</parmname>
|
||||
<index-see><cmdname>install</cmdname> subcommand</index-see></indexterm>
|
||||
<indexterm><cmdname>uninstall</cmdname> subcommand</indexterm>
|
||||
<indexterm><parmname>--uninstall</parmname>
|
||||
<index-see><cmdname>uninstall</cmdname> subcommand</index-see></indexterm>
|
||||
<indexterm><cmdname>plugins</cmdname> subcommand</indexterm>
|
||||
<indexterm><parmname>--plugins</parmname>
|
||||
<index-see><cmdname>plugins</cmdname> subcommand</index-see></indexterm>
|
||||
<indexterm><cmdname>transtypes</cmdname> subcommand</indexterm>
|
||||
<indexterm><parmname>--transtypes</parmname>
|
||||
<index-see><cmdname>transtypes</cmdname> subcommand</index-see></indexterm>
|
||||
<indexterm><parmname>--help</parmname></indexterm>
|
||||
<indexterm><parmname>-h</parmname></indexterm>
|
||||
<indexterm><cmdname>version</cmdname> subcommand</indexterm>
|
||||
<indexterm><parmname>--version</parmname>
|
||||
<index-see><cmdname>version</cmdname> subcommand</index-see></indexterm>
|
||||
<parml>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>deliverables</parmname>
|
||||
<varname>file</varname></pt>
|
||||
<pd>Show a list of the available deliverables in the specified project <varname>file</varname>.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>install</parmname>
|
||||
<varname>{ ID | URL | file }</varname></pt>
|
||||
<pt>
|
||||
<parmname>--install</parmname>=<varname>{ ID | URL | file }</varname></pt>
|
||||
<pd>Install a single plug-in <varname>ID </varname>from the registry at
|
||||
<xref keyref="site-plugin-registry"/> (or a local registry), from a remote <varname>URL</varname>, or a
|
||||
local ZIP <varname>file</varname>.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>install</parmname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>--install</parmname>
|
||||
</pt>
|
||||
<pd><ph conkeyref="conref-task/plugin-integrate-all"/></pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>uninstall</parmname>
|
||||
<varname>ID</varname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>--uninstall</parmname>=<varname>ID</varname>
|
||||
</pt>
|
||||
<pd>Remove the plug-in with the specified <varname>ID</varname>.</pd>
|
||||
<pd>For a list of the currently installed plug-in IDs, use <cmdname>dita plugins</cmdname>.</pd>
|
||||
<pd>
|
||||
<note conkeyref="conref-task/plugin-remove-subdir"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>plugins</parmname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>--plugins</parmname>
|
||||
</pt>
|
||||
<pd>Show a list of the currently installed plug-ins.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>transtypes</parmname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>--transtypes</parmname>
|
||||
</pt>
|
||||
<pd>Show a list of the available output formats (transformation types).</pd>
|
||||
<pd>The entries in this list may be passed as values to the <parmname>--format</parmname> argument.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>version</parmname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>--version</parmname>
|
||||
</pt>
|
||||
<pd>Print version information and exit.</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
<section>
|
||||
<title>Options</title>
|
||||
<indexterm><parmname>-o</parmname></indexterm>
|
||||
<indexterm><parmname>--output</parmname></indexterm>
|
||||
<indexterm><parmname>--filter</parmname></indexterm>
|
||||
<indexterm><parmname>--force</parmname></indexterm>
|
||||
<indexterm><parmname>--temp</parmname></indexterm>
|
||||
<indexterm><parmname>-t</parmname></indexterm>
|
||||
<indexterm><parmname>--verbose</parmname></indexterm>
|
||||
<indexterm><parmname>-v</parmname></indexterm>
|
||||
<indexterm><parmname>--debug</parmname></indexterm>
|
||||
<indexterm><parmname>-d</parmname></indexterm>
|
||||
<indexterm><parmname>--logfile</parmname></indexterm>
|
||||
<indexterm><parmname>-l</parmname></indexterm>
|
||||
<indexterm><parmname>--parameter</parmname></indexterm>
|
||||
<indexterm><parmname>-D</parmname></indexterm>
|
||||
<indexterm><parmname>--propertyfile</parmname></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>classes</indexterm></indexterm>
|
||||
<indexterm>debugging
|
||||
<indexterm><cmdname>dita</cmdname> command</indexterm></indexterm>
|
||||
<parml id="dita_build_options">
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--debug</parmname></pt>
|
||||
<pt>
|
||||
<parmname>-d</parmname>
|
||||
</pt>
|
||||
<pd>Debug logging prints considerably more additional information. The debug log includes all information from
|
||||
the verbose log, plus details on Java classes, additional Ant properties and overrides, preprocessing
|
||||
filters, parameters, and stages, and the complete build sequence. Debug logging requires additional
|
||||
resources and can slow down the build process, so it should only be enabled when further details are
|
||||
required to diagnose problems.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--output</parmname>=<varname>dir</varname></pt>
|
||||
<pt>
|
||||
<parmname>-o</parmname>
|
||||
<varname>dir</varname>
|
||||
</pt>
|
||||
<pd id="output.dir.desc">
|
||||
<p>Specifies the path of the output directory; the path can be absolute or relative to the current
|
||||
directory.</p>
|
||||
<p>This argument corresponds to the common parameter <parmname>output.dir</parmname>. By default, the output
|
||||
is written to the <filepath>out</filepath> subdirectory of the current directory.</p>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--filter</parmname>=<varname>files</varname>
|
||||
</pt>
|
||||
<pd>
|
||||
<!-- Based on ant-parameters-details.dita#args.filter but not identical. Relative paths & repeat differs -->
|
||||
<p>Specifies filter file(s) used to include, exclude, or flag content. Relative paths are resolved against
|
||||
the current directory and internally converted to absolute paths.</p>
|
||||
<note>
|
||||
<p>To specify multiple filter files, use the system path separator character to delimit individual file
|
||||
paths (semicolon ‘<codeph>;</codeph>’ on Windows, and colon ‘<codeph>:</codeph>’ on macOS and Linux) and
|
||||
wrap the value in quotes:</p>
|
||||
<p><codeph>--filter="filter1.ditaval;filter2.ditaval;filter3.ditaval"</codeph></p>
|
||||
<p>As of DITA-OT 3.6, the <parmname>--filter</parmname> option can also be passed multiple times:</p>
|
||||
<p><codeph>--filter=filter1.ditaval --filter=filter2.ditaval --filter=filter3.ditaval</codeph></p>
|
||||
<p>DITAVAL files are evaluated in the order specified, so conditions specified in the first file take
|
||||
precedence over matching conditions specified in later files, just as conditions at the start of a
|
||||
DITAVAL document take precedence over matching conditions later in the same document.</p>
|
||||
</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--force</parmname>
|
||||
</pt>
|
||||
<pd>Force-install an existing plug-in.</pd>
|
||||
<pd>Passed as an additional option to the installation subcommand: <cmdname>dita
|
||||
install</cmdname> <varname>plug-in-zip</varname> <parmname>--force</parmname></pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--help</parmname></pt>
|
||||
<pt>
|
||||
<parmname>-h</parmname>
|
||||
</pt>
|
||||
<pd>Print a list of available arguments, options, and subcommands.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--logfile</parmname>=<varname>file</varname></pt>
|
||||
<pt>
|
||||
<parmname>-l</parmname>
|
||||
<varname>file</varname>
|
||||
</pt>
|
||||
<pd>Write logging messages to a file.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--parameter</parmname>=<varname>value</varname></pt>
|
||||
<pt>
|
||||
<parmname>-D</parmname><varname>parameter</varname>=<varname>value</varname>
|
||||
</pt>
|
||||
<pd>Specify a value for a DITA-OT or Ant build parameter.</pd>
|
||||
<pd>The GNU-style <parmname>--parameter</parmname>=<varname>value</varname> form is only available for
|
||||
parameters that are configured in the plug-in configuration file; the Java-style <parmname>-D</parmname>
|
||||
form can also be used to specify additional non-configured parameters or set system properties.</pd>
|
||||
<pd>Parameters not implemented by the specified transformation type or referenced in a
|
||||
<filepath>.properties</filepath> file are ignored. <note conkeyref="conref-task/pass-input-dir"/>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--propertyfile</parmname>=<varname>file</varname>
|
||||
</pt>
|
||||
<pd>Use build parameters defined in the referenced <filepath>.properties</filepath> file.</pd>
|
||||
<pd>Build parameters specified on the command line override those set in the <filepath>.properties</filepath>
|
||||
file.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--repeat</parmname>=<varname>N</varname>
|
||||
</pt>
|
||||
<pd>Repeat the transformation <varname>N</varname> number of times.</pd>
|
||||
<pd>This option can be used by plug-in developers to measure performance. To run a conversion five times, for
|
||||
example, use <parmname>--repeat</parmname>=<option>5</option>. The duration of each execution will appear in
|
||||
the console when the final transformation is complete.
|
||||
<codeblock outputclass="syntax-bash multi-platform">$ <cmdname>dita</cmdname> <parmname
|
||||
>--input</parmname>=<filepath>docsrc/samples/sequence.ditamap</filepath> <parmname
|
||||
>--format</parmname>=<option>html5</option> <parmname>--repeat</parmname>=<option>5</option>
|
||||
1 11281ms
|
||||
2 4132ms
|
||||
3 3690ms
|
||||
4 4337ms
|
||||
5 3634ms</codeblock>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--resource</parmname>=<varname>file</varname>
|
||||
</pt>
|
||||
<pt>
|
||||
<parmname>-r</parmname>
|
||||
<varname>file</varname>
|
||||
</pt>
|
||||
<pd>Convert partial documentation sets by processing input with additional resources.</pd>
|
||||
<pd>For example, to process a single topic file with a map that contains key definitions, use a command like
|
||||
this:
|
||||
<codeblock outputclass="syntax-bash"><cmdname>dita</cmdname> <parmname>--input</parmname>=<filepath
|
||||
>topic.dita</filepath> <parmname>--resource</parmname>=<filepath>keys.ditamap</filepath> <parmname
|
||||
>--format</parmname>=<option>html5</option></codeblock>
|
||||
</pd>
|
||||
<pd>To convert a chapter map to HTML5 and insert related links from relationship tables in a separate map,
|
||||
use:
|
||||
<codeblock outputclass="syntax-bash"><cmdname>dita</cmdname> <parmname>--input</parmname>=<filepath
|
||||
>chapter.ditamap</filepath> <parmname>--resource</parmname>=<filepath
|
||||
>reltables.ditamap</filepath> <parmname>--format</parmname>=<option>html5</option></codeblock>
|
||||
</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--temp</parmname>=<varname>dir</varname></pt>
|
||||
<pt>
|
||||
<parmname>-t</parmname>
|
||||
<varname>dir</varname>
|
||||
</pt>
|
||||
<pd conkeyref="parameters-base/dita.temp.dir.desc"/>
|
||||
<pd>This argument corresponds to the common parameter <parmname>dita.temp.dir</parmname>.</pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt>
|
||||
<parmname>--verbose</parmname></pt>
|
||||
<pt>
|
||||
<parmname>-v</parmname>
|
||||
</pt>
|
||||
<pd>Verbose logging prints additional information to the console, including directory settings, effective
|
||||
values for Ant properties, input/output files, and informational messages to assist in troubleshooting.</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
83
dita-ot-3.6/docsrc/parameters/generate-copy-outer.dita
Normal file
83
dita-ot-3.6/docsrc/parameters/generate-copy-outer.dita
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="ID">
|
||||
<title>Handling content outside the map directory</title>
|
||||
<shortdesc>By default, DITA-OT assumes content is located in or beneath the directory containing the DITA map file.
|
||||
The <parmname>generate.copy.outer</parmname> parameter can be used to adjust how output is generated for content
|
||||
that is located outside the map directory.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><parmname>generate.copy.outer</parmname></indexterm>
|
||||
<indexterm>HTML
|
||||
<indexterm>files outside map directory</indexterm></indexterm>
|
||||
<indexterm>DITA maps
|
||||
<indexterm>relative file locations</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
|
||||
<conbody>
|
||||
<section>
|
||||
<title>Background</title>
|
||||
<p>This is an issue in the following situations:
|
||||
<ul>
|
||||
<li>The DITA map is in a directory that is a peer to directories that contain referenced objects.</li>
|
||||
<li>The DITA map is in a directory that is below the directories that contain the referenced objects.</li>
|
||||
</ul></p>
|
||||
<p>Let’s assume that the directory structure for the DITA content looks like the following:</p>
|
||||
<p><pre>images/
|
||||
fig.png
|
||||
maps/
|
||||
start.ditamap
|
||||
topics/
|
||||
topic.dita</pre></p>
|
||||
<p>The DITA map is in the <filepath>maps</filepath> directory, the topics are in the <filepath>topics</filepath>
|
||||
directory, and the images are in the <filepath>images</filepath> directory.</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Exclude content outside the map directory</title>
|
||||
<indexterm>index
|
||||
<index-see-also>entry file</index-see-also></indexterm>
|
||||
<indexterm>entry file
|
||||
<indexterm>broken links, reason for</indexterm></indexterm>
|
||||
<p>Let’s assume that you run the HTML5 transformation. By default, DITA-OT uses the
|
||||
<parmname>generate.copy.outer</parmname> parameter with a value of <option>1</option>, which means that no
|
||||
output is generated for content that is located outside the DITA map directory.</p>
|
||||
<p>You receive only the following output:</p>
|
||||
<p><pre>index.html
|
||||
commonltr.css
|
||||
commonrtl.css</pre></p>
|
||||
<p>The <filepath>index.html</filepath> file contains the navigation structure, but all the links are broken, since
|
||||
no HTML files were built for the topics.</p>
|
||||
<p>How do you fix this? By adjusting the parameter setting to shift the output directory.</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Shift the output directory to include all content</title>
|
||||
<p>To preserve the links to referenced topics and images and make it easier to copy the output directory, set the
|
||||
<parmname>generate.copy.outer</parmname> parameter to <option>3</option>.</p>
|
||||
<p>Now your output directory structure resembles the structure of the source directory:</p>
|
||||
<p><pre>images/
|
||||
fig.png
|
||||
maps/
|
||||
index.html
|
||||
topics/
|
||||
topic.html
|
||||
commonltr.css
|
||||
commonrtl.css</pre></p>
|
||||
<p>The <filepath>index.html</filepath> file is in the <filepath>maps</filepath> directory, the HTML files for the
|
||||
topics are in the <filepath>topics</filepath> directory, and the referenced images are in the
|
||||
<filepath>images</filepath> directory.</p>
|
||||
<note type="tip">If <parmname>args.csspath</parmname> is not set, the default CSS files (and any custom CSS files
|
||||
specified via <parmname>args.css</parmname>) will be copied to the root level of the output folder. To copy CSS
|
||||
files to an output subfolder named <filepath>css</filepath>, set <parmname>args.csspath</parmname> to
|
||||
<option>css</option>.
|
||||
<indexterm>CSS
|
||||
<indexterm>copy to specific location</indexterm></indexterm>
|
||||
</note>
|
||||
</section>
|
||||
</conbody>
|
||||
</concept>
|
||||
13
dita-ot-3.6/docsrc/parameters/index.dita
Normal file
13
dita-ot-3.6/docsrc/parameters/index.dita
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="ID">
|
||||
<title>DITA Open Toolkit parameters</title>
|
||||
<titlealts>
|
||||
<navtitle>Parameters</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>
|
||||
<ph id="ph_docs-pr-desc">You can adjust DITA Open Toolkit behavior via <cmdname>dita</cmdname> command arguments and
|
||||
options, DITA-OT parameter settings, and configuration properties.</ph>
|
||||
</shortdesc>
|
||||
</reference>
|
||||
57
dita-ot-3.6/docsrc/parameters/internal-ant-properties.dita
Normal file
57
dita-ot-3.6/docsrc/parameters/internal-ant-properties.dita
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="ant-properties">
|
||||
<title>Internal Ant properties</title>
|
||||
<shortdesc>Reference list of Ant properties used by DITA-OT internally.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><xmlatt>role</xmlatt></indexterm>
|
||||
<indexterm>args.rellinks</indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>related links</indexterm>
|
||||
<indexterm>args.rellinks</indexterm></indexterm>
|
||||
<indexterm>HTML5
|
||||
<indexterm>related links</indexterm>
|
||||
<indexterm>args.rellinks</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<plentry>
|
||||
<pt><codeph>include.rellinks</codeph></pt>
|
||||
<pd>A space-separated list of link roles to be output; the <codeph>#default</codeph> value token represents
|
||||
links without an explicit role (those for which no <xmlatt>role</xmlatt> attribute is defined). Defined by
|
||||
<codeph>args.rellinks</codeph>, but may be overridden directly. Valid roles include:
|
||||
<ul>
|
||||
<li>parent </li>
|
||||
<li>child </li>
|
||||
<li>sibling </li>
|
||||
<li>friend </li>
|
||||
<li>next </li>
|
||||
<li>previous </li>
|
||||
<li>cousin </li>
|
||||
<li>ancestor </li>
|
||||
<li>descendant </li>
|
||||
<li>sample </li>
|
||||
<li>external </li>
|
||||
<li>other</li>
|
||||
</ul></pd>
|
||||
</plentry>
|
||||
<plentry>
|
||||
<pt><codeph>temp.output.dir.name</codeph></pt>
|
||||
<pd>An internal property for use with custom transform types; this property can be used to place all output in
|
||||
an internal directory, so that a final step in the transform type can do some form of post-processing before
|
||||
the files are placed in the specified output directory.
|
||||
<p>For example, if a custom HTML5 transform sets the property to <codeph>zip_dir</codeph>, all output files
|
||||
(including HTML, images, and CSS) will be placed within the directory <filepath>zip_dir</filepath> in the
|
||||
temporary processing directory. A final step can then be used to add more files, zip the directory, and
|
||||
return that zip to the designated output directory.</p></pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
63
dita-ot-3.6/docsrc/parameters/local-properties-file.dita
Normal file
63
dita-ot-3.6/docsrc/parameters/local-properties-file.dita
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="local.properties">
|
||||
<title>The <filepath>local.properties</filepath> file</title>
|
||||
<titlealts>
|
||||
<navtitle><filepath>local.properties</filepath></navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>A <filepath>local.properties</filepath> file in the root directory of the DITA-OT installation can be used
|
||||
to override the default values of various DITA-OT parameters.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>files
|
||||
<indexterm>local.properties</indexterm></indexterm>
|
||||
<indexterm>local.properties file</indexterm>
|
||||
<indexterm>Windows</indexterm>
|
||||
<indexterm>RenderX
|
||||
<indexterm><filepath>local.properties</filepath></indexterm></indexterm>
|
||||
<indexterm>Antenna House
|
||||
<indexterm><filepath>local.properties</filepath></indexterm></indexterm>
|
||||
<indexterm>command line
|
||||
<indexterm><filepath>local.properties</filepath> file</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>local.properties file</indexterm></indexterm>
|
||||
<indexterm>PDF
|
||||
<indexterm>formatter</indexterm></indexterm>
|
||||
<indexterm>formatter
|
||||
<index-see-also>Apache FOP</index-see-also>
|
||||
<index-see-also>Antenna House</index-see-also>
|
||||
<index-see-also>RenderX</index-see-also></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<example>
|
||||
<p>For example, if you always use the same rendering engine to produce PDF output for all of your projects, you
|
||||
could create a <filepath>local.properties</filepath> file in the root directory of your DITA-OT installation to
|
||||
set the <parmname>pdf.formatter</parmname> parameter and additional options for the XSL processor:</p>
|
||||
<codeblock
|
||||
outputclass="language-properties normalize-space show-line-numbers show-whitespace"
|
||||
># Use RenderX XEP Engine for PDF output
|
||||
pdf.formatter = xep
|
||||
|
||||
# Specify the user configuration file for RenderX
|
||||
custom.xep.config = /path/to/custom.config</codeblock>
|
||||
<p>Backslash “\” characters in .properties files must be escaped with a second backslash as “\\”. If you use
|
||||
Antenna House Formatter on a Windows system, for example, you would set the path to the command using a
|
||||
properties file entry like this:</p>
|
||||
<codeblock
|
||||
outputclass="language-properties normalize-space show-line-numbers show-whitespace"
|
||||
># Use Antenna House Formatter for PDF output
|
||||
pdf.formatter = ah
|
||||
|
||||
# Specify the path to the Antenna House Formatter command
|
||||
axf.cmd=C:\\Program Files\\Antenna House\\AHFormatterV62</codeblock>
|
||||
</example>
|
||||
<section>
|
||||
<note>This file can only be used to set Ant property values that can be passed as argument parameters to the
|
||||
command line. The DITA-OT Java code does not read this file.</note>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
4
dita-ot-3.6/docsrc/parameters/parameters-base-html.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-base-html.dita
Normal file
File diff suppressed because one or more lines are too long
4
dita-ot-3.6/docsrc/parameters/parameters-base.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-base.dita
Normal file
File diff suppressed because one or more lines are too long
4
dita-ot-3.6/docsrc/parameters/parameters-dita.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-dita.dita
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="dita"><title outputclass="generated">Normalized DITA parameters</title><titlealts><navtitle>Normalized DITA</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="eclipsehelp"><title outputclass="generated">Eclipse Help parameters</title><titlealts><navtitle>Eclipse Help</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml><plentry id="args.eclipse.provider" props="eclipsehelp"><pt><parmname>args.eclipse.provider</parmname><ph><indexterm><parmname>args.eclipse.provider</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipse.provider</parmname></indexterm></indexterm></ph></pt><pd id="args.eclipse.provider.desc">Specifies the name of the person or organization that provides the Eclipse help.</pd></plentry><plentry id="args.eclipse.symbolic.name" props="eclipsehelp"><pt><parmname>args.eclipse.symbolic.name</parmname><ph><indexterm><parmname>args.eclipse.symbolic.name</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipse.symbolic.name</parmname></indexterm></indexterm></ph></pt><pd id="args.eclipse.symbolic.name.desc">Specifies the symbolic name (aka plugin ID) in the output for an Eclipse Help project.</pd></plentry><plentry id="args.eclipse.version" props="eclipsehelp"><pt><parmname>args.eclipse.version</parmname><ph><indexterm><parmname>args.eclipse.version</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipse.version</parmname></indexterm></indexterm></ph></pt><pd id="args.eclipse.version.desc">Specifies the version number to include in the output.</pd></plentry><plentry id="args.eclipsehelp.country" props="eclipsehelp"><pt><parmname>args.eclipsehelp.country</parmname><ph><indexterm><parmname>args.eclipsehelp.country</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipsehelp.country</parmname></indexterm></indexterm></ph></pt><pd id="args.eclipsehelp.country.desc">Specifies the region for the language that is specified by the args.</pd></plentry><plentry id="args.eclipsehelp.jar.name" props="eclipsehelp"><pt><parmname>args.eclipsehelp.jar.name</parmname><ph><indexterm><parmname>args.eclipsehelp.jar.name</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipsehelp.jar.name</parmname></indexterm></indexterm></ph></pt><pd id="args.eclipsehelp.jar.name.desc">Specifies that the output should be zipped and returned using this name.</pd></plentry><plentry id="args.eclipsehelp.language" props="eclipsehelp"><pt><parmname>args.eclipsehelp.language</parmname><ph><indexterm><parmname>args.eclipsehelp.language</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.eclipsehelp.language</parmname></indexterm></indexterm></ph></pt><pd id="args.eclipsehelp.language.desc">Specifies the base language for translated content, such as en for English.</pd></plentry></parml></section></refbody></reference>
|
||||
4
dita-ot-3.6/docsrc/parameters/parameters-html5.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-html5.dita
Normal file
File diff suppressed because one or more lines are too long
4
dita-ot-3.6/docsrc/parameters/parameters-htmlhelp.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-htmlhelp.dita
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="htmlhelp"><title outputclass="generated">Microsoft Compiled HTML Help parameters</title><titlealts><navtitle>Microsoft Compiled HTML Help</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml><plentry id="args.htmlhelp.includefile" props="htmlhelp"><pt><parmname>args.htmlhelp.includefile</parmname><ph><indexterm><parmname>args.htmlhelp.includefile</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.htmlhelp.includefile</parmname></indexterm></indexterm></ph></pt><pd id="args.htmlhelp.includefile.desc">Specifies the name of a file that you want included in the HTML Help.</pd></plentry></parml></section></refbody></reference>
|
||||
4
dita-ot-3.6/docsrc/parameters/parameters-markdown.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-markdown.dita
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="markdown"><title outputclass="generated">Markdown parameters</title><titlealts><navtitle>Markdown</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="markdown_gitbook"><title outputclass="generated">GitBook parameters</title><titlealts><navtitle>GitBook</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml/></section></refbody></reference>
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="markdown_github"><title outputclass="generated">GitHub-flavored Markdown parameters</title><titlealts><navtitle>GitHub-flavored Markdown</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml/></section></refbody></reference>
|
||||
84
dita-ot-3.6/docsrc/parameters/parameters-other.dita
Normal file
84
dita-ot-3.6/docsrc/parameters/parameters-other.dita
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
|
||||
<reference id="ant-parameters-other">
|
||||
<title>Other parameters</title>
|
||||
<titlealts>
|
||||
<navtitle>Other</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>These parameters enable you to reload style sheets that DITA-OT uses for specific pre-processing
|
||||
stages.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>XSLT
|
||||
<index-see-also>extension points</index-see-also>
|
||||
<index-see-also>preprocessing</index-see-also></indexterm>
|
||||
<indexterm>preprocessing
|
||||
<indexterm>XSLT</indexterm></indexterm>
|
||||
<indexterm>preprocessing
|
||||
<index-see-also>Java</index-see-also></indexterm>
|
||||
<indexterm>preprocessing
|
||||
<indexterm>extension points, parameters</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>out of memory</indexterm></indexterm>
|
||||
<indexterm>memory</indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<parml>
|
||||
<plentry>
|
||||
<pt id="dita.html5.reloadstylesheet">
|
||||
<parmname>dita.html5.reloadstylesheet</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet">
|
||||
<parmname>dita.preprocess.reloadstylesheet</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet.clean-map">
|
||||
<parmname>dita.preprocess.reloadstylesheet.clean-map</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet.conref">
|
||||
<parmname>dita.preprocess.reloadstylesheet.conref</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet.flag-module">
|
||||
<parmname>dita.preprocess.reloadstylesheet.lag-module</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet.mapref">
|
||||
<parmname>dita.preprocess.reloadstylesheet.mapref</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet.mappull">
|
||||
<parmname>dita.preprocess.reloadstylesheet.mappull</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet.maplink">
|
||||
<parmname>dita.preprocess.reloadstylesheet.maplink</parmname>
|
||||
</pt>
|
||||
<pt id="dita.preprocess.reloadstylesheet.topicpull">
|
||||
<parmname>dita.preprocess.reloadstylesheet.topicpull</parmname>
|
||||
</pt>
|
||||
<pt id="dita.xhtml.reloadstylesheet">
|
||||
<parmname>dita.xhtml.reloadstylesheet</parmname>
|
||||
</pt>
|
||||
<pd id="dita.preprocess.reloadstylesheet.desc">
|
||||
<p>Specifies whether DITA-OT reloads the XSL style sheets that are used for the transformation. The allowed
|
||||
values are <option>true</option> and <option>false</option>; the default value is
|
||||
<option>false</option>.</p>
|
||||
<p>During the pre-processing stage, DITA-OT processes one DITA topic at a time, using the same XSLT
|
||||
stylesheet for the entire process. These parameters control whether Ant will use the same
|
||||
<codeph>Transformer</codeph> object in Java, the object that handles the XSLT processing, for all
|
||||
topics, or create a separate <codeph>Transformer</codeph> for each topic.</p>
|
||||
<p>The default (<option>false</option>) option uses the same <codeph>Transformer</codeph>, which is a little
|
||||
faster, because it will not need to parse/compile the XSLT stylesheets and only needs to read the source
|
||||
trees with <codeph>document()</codeph> once. The downside is that it will not release the source trees
|
||||
from memory, so you can run out of memory.</p>
|
||||
<note type="tip">For large projects that generate Java out-of-memory errors during transformation, set the
|
||||
parameter to <option>true</option> to allow the XSLT processor to release memory. You may also need to
|
||||
increase the memory available to Java.</note>
|
||||
</pd>
|
||||
</plentry>
|
||||
</parml>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
4
dita-ot-3.6/docsrc/parameters/parameters-pdf.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-pdf.dita
Normal file
File diff suppressed because one or more lines are too long
4
dita-ot-3.6/docsrc/parameters/parameters-pdf2.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-pdf2.dita
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="pdf2"><title outputclass="generated">PDF2 parameters</title><titlealts><navtitle>PDF2</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml/></section></refbody></reference>
|
||||
4
dita-ot-3.6/docsrc/parameters/parameters-xhtml.dita
Normal file
4
dita-ot-3.6/docsrc/parameters/parameters-xhtml.dita
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><!-- Generated from plugin source, do not edit! -->
|
||||
<!DOCTYPE reference
|
||||
PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<reference id="xhtml"><title outputclass="generated">XHTML parameters</title><titlealts><navtitle>XHTML</navtitle></titlealts><shortdesc id="shortdesc"/><refbody><section><parml><plentry id="args.xhtml.contenttarget" props="xhtml"><pt><parmname>args.xhtml.contenttarget</parmname><ph><indexterm><parmname>args.xhtml.contenttarget</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.xhtml.contenttarget</parmname></indexterm></indexterm></ph></pt><pd id="args.xhtml.contenttarget.desc">Specifies the value of the @target attribute on the <base> element in the TOC file.</pd></plentry><plentry id="args.xhtml.toc" props="xhtml"><pt><parmname>args.xhtml.toc</parmname><ph><indexterm><parmname>args.xhtml.toc</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.xhtml.toc</parmname></indexterm></indexterm></ph></pt><pd id="args.xhtml.toc.desc">Specifies the base name of the TOC file.</pd></plentry><plentry id="args.xhtml.toc.class" props="xhtml"><pt><parmname>args.xhtml.toc.class</parmname><ph><indexterm><parmname>args.xhtml.toc.class</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.xhtml.toc.class</parmname></indexterm></indexterm></ph></pt><pd id="args.xhtml.toc.class.desc">Specifies the value of the @class attribute on the <body> element in the TOC file.</pd></plentry><plentry id="args.xhtml.toc.xsl" props="xhtml"><pt><parmname>args.xhtml.toc.xsl</parmname><ph><indexterm><parmname>args.xhtml.toc.xsl</parmname></indexterm><indexterm>parameters<indexterm><parmname>args.xhtml.toc.xsl</parmname></indexterm></indexterm></ph></pt><pd id="args.xhtml.toc.xsl.desc">Specifies a custom XSL file to be used for TOC generation.</pd></plentry></parml></section></refbody></reference>
|
||||
28
dita-ot-3.6/docsrc/parameters/parameters.ditamap
Normal file
28
dita-ot-3.6/docsrc/parameters/parameters.ditamap
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<map>
|
||||
<title>Parameter Reference</title>
|
||||
<topicref keyref="dita-command-arguments"/>
|
||||
<topicref keyref="parameters_intro" keys="dita-ot-params">
|
||||
<topicref keyref="parameters-base"/>
|
||||
<topicref keyref="parameters-pdf"/>
|
||||
<topicref keyref="parameters-base-html"/>
|
||||
<topicref keyref="parameters-html5"/>
|
||||
<topicref keyref="parameters-xhtml"/>
|
||||
<topicref keyref="parameters-htmlhelp" locktitle="yes" platform="windows">
|
||||
<topicmeta>
|
||||
<navtitle>HTML Help</navtitle>
|
||||
</topicmeta>
|
||||
</topicref>
|
||||
<topicref keyref="parameters-eclipsehelp"/>
|
||||
<topicref keyref="parameters-other"/>
|
||||
<topicref keyref="ant-parameters-details" keys="parameters-push" processing-role="resource-only" toc="no"/>
|
||||
</topicref>
|
||||
<topicref keyref="configuration-properties">
|
||||
<topicref keyref="local-properties-file"/>
|
||||
<topicref keyref="plugin-properties-file"/>
|
||||
<topicref keyref="configuration-properties-file"/>
|
||||
<topicref keyref="internal-ant-properties"/>
|
||||
</topicref>
|
||||
</map>
|
||||
37
dita-ot-3.6/docsrc/parameters/parameters_intro.dita
Normal file
37
dita-ot-3.6/docsrc/parameters/parameters_intro.dita
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="dita-ot-ant-properties">
|
||||
<title>DITA-OT parameters</title>
|
||||
|
||||
<shortdesc>Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based
|
||||
transformations. Some parameters apply only to specific transformation types. These parameters can be passed as
|
||||
options to the <cmdname>dita</cmdname> command using the <parmname>--parameter</parmname>=<varname>value</varname>
|
||||
syntax or included in build scripts as Ant properties.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><cmdname>dita</cmdname> command
|
||||
<indexterm>parameters</indexterm></indexterm>
|
||||
<indexterm>parameters</indexterm>
|
||||
<indexterm>transformations
|
||||
<indexterm>parameters</indexterm></indexterm>
|
||||
<indexterm>transformations
|
||||
<indexterm>HTML</indexterm></indexterm>
|
||||
<indexterm>Ant
|
||||
<indexterm>properties</indexterm>
|
||||
<indexterm>parameters</indexterm></indexterm>
|
||||
<indexterm>Ant
|
||||
<indexterm>build script</indexterm>
|
||||
<indexterm>script</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
|
||||
<refbody>
|
||||
<section>
|
||||
<p>If your toolkit installation includes custom plug-ins that define additional parameters, you can add entries to
|
||||
the following topics by rebuilding the DITA-OT documentation.</p>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
33
dita-ot-3.6/docsrc/parameters/plugin-properties-file.dita
Normal file
33
dita-ot-3.6/docsrc/parameters/plugin-properties-file.dita
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="lib-org.dita.dost.platform-plugin.properties">
|
||||
<title>The <filepath>plugin.properties</filepath> file</title>
|
||||
<titlealts>
|
||||
<navtitle><filepath>plugin.properties</filepath></navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>The <filepath>plugin.properties</filepath> file is used to store configuration properties that are set by
|
||||
the plug-in installation process.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>files
|
||||
<indexterm>plugin.properties</indexterm></indexterm>
|
||||
<indexterm>plugin.properties file</indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>plugin.properties</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<p>The file is located in the <filepath>lib/org.dita.dost.platform</filepath> directory of the DITA-OT
|
||||
installation and stores a cached version of the plug-in configuration used by the Java code.</p>
|
||||
<p>The contents of this file depend on the installed plug-ins. Each plug-in may contribute properties such as the
|
||||
path to the plug-in folder, supported extensions and print transformation types.</p>
|
||||
<note type="warning">The <filepath>plugin.properties</filepath> file is regenerated each time the plug-in
|
||||
integration process is run, so it should not be edited manually as these changes would be lost the next time a
|
||||
plug-in is installed or removed.</note>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
5
dita-ot-3.6/docsrc/platform.ditaval
Normal file
5
dita-ot-3.6/docsrc/platform.ditaval
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<val>
|
||||
<prop action="include" att="platform" val="unix" />
|
||||
<prop action="exclude" att="platform" />
|
||||
</val>
|
||||
27
dita-ot-3.6/docsrc/reference/architecture.dita
Normal file
27
dita-ot-3.6/docsrc/reference/architecture.dita
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="ditaotarch">
|
||||
<title>DITA Open Toolkit Architecture</title>
|
||||
<titlealts>
|
||||
<navtitle>DITA-OT architecture</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>DITA Open Toolkit is an open-source implementation of the OASIS specification for the Darwin Information
|
||||
Typing Architecture. The toolkit uses Ant, XSLT, and Java to transform DITA content (maps and topics) into different
|
||||
deliverable formats.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>authoring formats
|
||||
<indexterm>DITA</indexterm></indexterm>
|
||||
<indexterm>OASIS</indexterm>
|
||||
<indexterm>architecture</indexterm>
|
||||
<indexterm>Ant</indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>architecture</indexterm></indexterm>
|
||||
<indexterm>XSLT
|
||||
<indexterm>DITA-OT architecture</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
</concept>
|
||||
13
dita-ot-3.6/docsrc/reference/books.dita
Normal file
13
dita-ot-3.6/docsrc/reference/books.dita
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<?xml-model href="urn:oasis:names:tc:dita:rng:topic.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
|
||||
<?xml-model href="urn:oasis:names:tc:dita:rng:topic.rng" schematypens="http://purl.oclc.org/dsdl/schematron"?>
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<topic id="books">
|
||||
<title>Books</title>
|
||||
<shortdesc>Several DITA-related publications include information on configuring and customizing DITA Open Toolkit
|
||||
with detailed examples on creating custom plug-ins for PDF output.</shortdesc>
|
||||
<body>
|
||||
<section conkeyref="reusable-components/dita-for-print"/>
|
||||
<section conkeyref="reusable-components/dita-for-practitioners"/>
|
||||
</body>
|
||||
</topic>
|
||||
41
dita-ot-3.6/docsrc/reference/common-html-processing.dita
Normal file
41
dita-ot-3.6/docsrc/reference/common-html-processing.dita
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="common-html-processing">
|
||||
<title>Common HTML-based processing</title>
|
||||
<shortdesc>After the pre-processing operation runs, HTML-based builds each run a common series of Ant targets to
|
||||
generate HTML file. Navigation may be created before or after this set of common routines.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><xmlatt>chunk</xmlatt>
|
||||
<indexterm>HTML-based processing</indexterm></indexterm>
|
||||
<indexterm>DITAVAL
|
||||
<indexterm>HTML-based formats</indexterm></indexterm>
|
||||
<indexterm>HTML
|
||||
<indexterm>common processing</indexterm></indexterm>
|
||||
<indexterm>CSS
|
||||
<indexterm>HTML transforms</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<conbody>
|
||||
<p>After the pre-processing is completed, the following targets are run for all of the HTML-based builds:</p>
|
||||
<p>
|
||||
<ul>
|
||||
<li>If the <parmname>args.css</parmname> parameter is passed to the build to add a CSS file, the
|
||||
<codeph>copy-css</codeph> target copies the CSS file from its source location to the relative location in
|
||||
the output directory.</li>
|
||||
<li>If a DITAVAL file is used, the <codeph>copy-revflag</codeph> target copies the default start- and
|
||||
end-revision flags into the output directory.</li>
|
||||
<li>The DITA topics are converted to HTML files. Unless the <xmlatt>chunk</xmlatt> attribute was specified, each
|
||||
DITA topic in the temporary directory now corresponds to one HTML file. The
|
||||
<codeph>dita.inner.topics.xhtml</codeph> target is used to process documents that are in the map directory
|
||||
(or subdirectories of the map directory). The <codeph>dita.outer.topics.xhtml</codeph> target is used to
|
||||
process documents that are outside of the scope of the map, and thus might end up outside of the designated
|
||||
output directory. Various DITA-OT parameters control how documents processed by the
|
||||
<codeph>dita.outer.topics.xhtml</codeph> target are handled.</li>
|
||||
</ul>
|
||||
</p>
|
||||
</conbody>
|
||||
</concept>
|
||||
19
dita-ot-3.6/docsrc/reference/dita-spec-support.dita
Normal file
19
dita-ot-3.6/docsrc/reference/dita-spec-support.dita
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="dita-spec-support">
|
||||
<title>DITA specification support</title>
|
||||
<shortdesc>DITA Open Toolkit <keyword keyref="release"/> supports all versions of the OASIS DITA specification,
|
||||
including 1.0, 1.1, 1.2, and 1.3.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>authoring formats
|
||||
<indexterm>DITA</indexterm></indexterm>
|
||||
<indexterm>DITA 1.0</indexterm>
|
||||
<indexterm>DITA 1.1</indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<conbody/>
|
||||
</concept>
|
||||
61
dita-ot-3.6/docsrc/reference/dita-v1-2-support.dita
Normal file
61
dita-ot-3.6/docsrc/reference/dita-v1-2-support.dita
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="dita1.2specification">
|
||||
<title>DITA 1.2 support</title>
|
||||
<shortdesc>DITA Open Toolkit <keyword keyref="release"/> supports the DITA 1.2 specification. While 1.2 is no longer
|
||||
the latest version of DITA, the grammar files (DTD and XML Schema) are still included with DITA-OT and content
|
||||
explicitly created for 1.2 continues to work as intended.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><xmlelement>abbreviated-form</xmlelement></indexterm>
|
||||
<indexterm><xmlatt>keyref</xmlatt></indexterm>
|
||||
<indexterm><xmlatt>processing-role</xmlatt></indexterm>
|
||||
<indexterm><xmlatt>conref</xmlatt>
|
||||
<indexterm>support</indexterm></indexterm>
|
||||
<indexterm>filters
|
||||
<indexterm>subject scheme</indexterm></indexterm>
|
||||
<indexterm>DITA
|
||||
<indexterm>specializations</indexterm></indexterm>
|
||||
<indexterm>DTD</indexterm>
|
||||
<indexterm>schema
|
||||
<indexterm>DITA 1.2</indexterm></indexterm>
|
||||
<indexterm>grammar files</indexterm>
|
||||
<indexterm>DITA 1.2</indexterm>
|
||||
<indexterm>SCORM</indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<conbody>
|
||||
<p>Highlights of DITA 1.2 support in the toolkit include:
|
||||
<ul>
|
||||
<li>Processing support for all new elements and attributes</li>
|
||||
<li>Link redirection and text replacement using <xmlatt>keyref</xmlatt></li>
|
||||
<li>New <xmlatt>processing-role</xmlatt> attribute in maps to allow references to topics that will not produce
|
||||
output artifacts</li>
|
||||
<li>New content reference extensions, including the ability to reference a range of elements, to push content
|
||||
into another topic, and to use keys for resolving a <xmlatt>conref</xmlatt> attribute.</li>
|
||||
<li>The ability to filter content with controlled values and taxonomies using Subject Scheme Maps</li>
|
||||
<li>Processing support for both default versions of task (original, limited task, and the general task with
|
||||
fewer constraints on element order)</li>
|
||||
<li>Acronym and abbreviation support with the new <xmlelement>abbreviated-form</xmlelement> element</li>
|
||||
<li>New link grouping abilities available with headers in relationship tables</li>
|
||||
<li>OASIS Subcommittee specializations from the learning and machine industry domains (note that the core
|
||||
toolkit contains only basic processing support for these, but can be extended to produce related artifacts
|
||||
such as SCORM modules)</li>
|
||||
</ul></p>
|
||||
<p>To find detailed information about any of these features, see the specification documents at OASIS. The DITA
|
||||
Adoption Technical Committee has also produced several papers to describe individual new features. In general, the
|
||||
white papers are geared more towards DITA users and authors, while the specification is geared more towards tool
|
||||
implementors, though both may be useful for either audience. The DITA Adoption papers can be found from that
|
||||
committee’s main web page.</p>
|
||||
</conbody>
|
||||
<related-links>
|
||||
<link keyref="dita12-xhtml"/>
|
||||
<link keyref="dita12-pdf"/>
|
||||
<link keyref="dita12-source"/>
|
||||
<link keyref="dita-tc"/>
|
||||
<link keyref="dita-adoption-tc"/>
|
||||
</related-links>
|
||||
</concept>
|
||||
87
dita-ot-3.6/docsrc/reference/dita-v1-3-support.dita
Normal file
87
dita-ot-3.6/docsrc/reference/dita-v1-3-support.dita
Normal file
|
|
@ -0,0 +1,87 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="dita-13-spec-support">
|
||||
<title>DITA 1.3 support</title>
|
||||
<shortdesc><ph id="shortdesc-ph">DITA Open Toolkit <keyword keyref="release"/> provides processing support for the
|
||||
OASIS DITA 1.3 specification. Initial preview support for this specification was added in version 2.0 of the
|
||||
toolkit; version 2.2 extended this foundation to support key scopes and branch filtering along with additional
|
||||
DITA 1.3 features.</ph></shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><xmlelement>ditavalref</xmlelement></indexterm>
|
||||
<indexterm><xmlelement>xmlelement</xmlelement></indexterm>
|
||||
<indexterm><xmlelement>xmlatt</xmlelement></indexterm>
|
||||
<indexterm><xmlelement>line-through</xmlelement></indexterm>
|
||||
<indexterm><xmlelement>overline</xmlelement></indexterm>
|
||||
<indexterm><xmlelement>object</xmlelement></indexterm>
|
||||
<indexterm><xmlelement>div</xmlelement>
|
||||
<indexterm>support</indexterm></indexterm>
|
||||
<indexterm><xmlatt>keyscope</xmlatt></indexterm>
|
||||
<indexterm><xmlatt>deliveryTarget</xmlatt></indexterm>
|
||||
<indexterm><xmlatt>orient</xmlatt></indexterm>
|
||||
<indexterm><xmlatt>keyref</xmlatt></indexterm>
|
||||
<indexterm><xmlatt>cascade</xmlatt></indexterm>
|
||||
<indexterm>profiling</indexterm>
|
||||
<indexterm>filters
|
||||
<indexterm>support</indexterm></indexterm>
|
||||
<indexterm>branch filters</indexterm>
|
||||
<indexterm>DTD</indexterm>
|
||||
<indexterm>schema
|
||||
<indexterm>DITA 1.3</indexterm></indexterm>
|
||||
<indexterm>grammar files</indexterm>
|
||||
<indexterm>DITA 1.3
|
||||
<indexterm>specification support</indexterm></indexterm>
|
||||
<indexterm>catalog
|
||||
<indexterm>grammar file resolution</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
|
||||
<conbody>
|
||||
<p id="p">Because DITA 1.3 is fully backwards compatible with previous DITA DTDs and schemas, DITA-OT provides the
|
||||
1.3 materials as the default grammar files for processing. The XML Catalog resolution maps any references for
|
||||
unversioned DITA document types to the 1.3 versions. All processing ordinarily dependent on the 1.0, 1.1, or 1.2
|
||||
definitions continues to work as usual, and any documents that make use of the newer DITA 1.3 elements or
|
||||
attributes will be supported with specific new processing.</p>
|
||||
<section>
|
||||
<title>Major features of DITA 1.3</title>
|
||||
<p>The following DITA 1.3 features are supported in DITA Open Toolkit.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<xref keyref="dita13-spec-keyscopes">Scoped keys</xref> supported using DITA 1.3 <xmlatt>keyscope</xmlatt>
|
||||
attribute</li>
|
||||
<li>
|
||||
<xref keyref="dita13-spec-branch-filter">Branch filtering</xref> using <xmlelement>ditavalref</xmlelement>
|
||||
elements in a map</li>
|
||||
<li>Support formatting based on new XML Mention elements, such as adding angle brackets around elements tagged
|
||||
with <xmlelement>xmlelement</xmlelement> and adding <codeph>@</codeph> before attributes tagged with
|
||||
<xmlelement>xmlatt</xmlelement></li>
|
||||
<li>New highlighting elements <xmlelement>line-through</xmlelement> and <xmlelement>overline</xmlelement></li>
|
||||
<li>Support for profiling based on <xmlatt>deliveryTarget</xmlatt> attribute</li>
|
||||
<li>Support for the new <xmlatt>orient</xmlatt> attribute for rotating tables</li>
|
||||
<li>Profile (filter or flag) based on
|
||||
<xref keyref="dita13-spec-profile-groups">groups within profiling attributes</xref></li>
|
||||
<li><xmlatt>keyref</xmlatt> and related key referencing attributes supported on
|
||||
<xmlelement>object</xmlelement></li>
|
||||
<li>New in-topic link syntax using <codeph>.</codeph> in place of the topic ID: <codeph>#./figure</codeph></li>
|
||||
<li>Support for additional new elements, such as the <xmlelement>div</xmlelement> element for grouping</li>
|
||||
<li>Support <xmlatt>cascade</xmlatt> attribute in maps (processing defaults to the value <codeph>merge</codeph>,
|
||||
which is the
|
||||
<xref keyref="dita13-spec-metadata-cascade-example">default cascade operation</xref> described by the DITA
|
||||
specification)</li>
|
||||
</ul>
|
||||
<note>For the latest status information on DITA 1.3-related features and fixes, see the
|
||||
<xref keyref="dita13-issues"/> in the GitHub issues tracker.</note>
|
||||
</section>
|
||||
</conbody>
|
||||
|
||||
<related-links>
|
||||
<link keyref="dita13-spec-all-inclusive"/>
|
||||
<link keyref="dita13-spec-all-inclusive-pdf"/>
|
||||
<link keyref="dita13-spec-source"/>
|
||||
<link keyref="dita-tc"/>
|
||||
<link keyref="dita-adoption-tc"/>
|
||||
</related-links>
|
||||
</concept>
|
||||
108
dita-ot-3.6/docsrc/reference/dita-v2-0-support.dita
Normal file
108
dita-ot-3.6/docsrc/reference/dita-v2-0-support.dita
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="ID">
|
||||
<title>DITA 2.0 preview support</title>
|
||||
|
||||
<titlealts>
|
||||
<navtitle>DITA 2.0 preview</navtitle>
|
||||
</titlealts>
|
||||
|
||||
<shortdesc>DITA Open Toolkit <keyword keyref="release"/> provides a preview of features for the upcoming OASIS DITA
|
||||
2.0 specification. This preliminary processing support is provided on the basis of the latest DRAFT versions of the
|
||||
DITA 2.0 DTD and RELAX NG grammar files from OASIS (as of October 2020).</shortdesc>
|
||||
|
||||
<conbody>
|
||||
<p id="grammar-files">DITA documents that reference the draft grammar files can be parsed, and where features
|
||||
overlap with DITA 1.3, those features will work as expected.</p>
|
||||
<section>
|
||||
<title>DITA-OT 3.5</title>
|
||||
<p>DITA-OT 3.5 provided an initial preview of DITA 2.0 features.</p>
|
||||
<ul>
|
||||
<li id="3453">
|
||||
<p>
|
||||
<ph id="include">The new <xmlelement>include</xmlelement> element can be used to reference text or XML
|
||||
content from other files. In addition to the processing mandated by the specification, DITA-OT also
|
||||
supports the character set definition and line range extraction options previously provided for
|
||||
<xmlelement>coderef</xmlelement> elements (see
|
||||
<xref keyref="extended-functionality"/>).</ph>
|
||||
</p>
|
||||
</li>
|
||||
<li id="3462">
|
||||
<p>
|
||||
<ph id="specializations">The new <xmlatt>specializations</xmlatt> attribute, which replaces the DITA 1.x
|
||||
<xmlatt>domains</xmlatt> attribute, can now be used as an alternative method of declaring specialized
|
||||
attributes.</ph>
|
||||
</p>
|
||||
</li>
|
||||
<li id="3463">
|
||||
<p>
|
||||
<ph id="outputclass">The <xmlatt>outputclass</xmlatt> attribute can now be specified as a flagging behavior
|
||||
in DITAVAL files. This allows you to flag an element with a CSS class keyword that will be added to the
|
||||
<xmlatt>class</xmlatt> attribute value in the generated HTML. Output classes allow you to pick up
|
||||
pre-defined styles from existing web frameworks, and are more easily overridden with custom CSS files than
|
||||
the inline <xmlatt>style</xmlatt> attributes generated by DITA 1.x flagging options such as
|
||||
<xmlatt>color</xmlatt> and <xmlatt>backcolor</xmlatt>.</ph>
|
||||
</p>
|
||||
</li>
|
||||
<li id="3464">
|
||||
<p>
|
||||
<ph id="simple-table-titles">Titles can now be specified on simple tables, and
|
||||
<xmlelement>simpletable</xmlelement> entries now support row and column spanning attributes.</ph>
|
||||
</p>
|
||||
</li>
|
||||
<li id="3483">
|
||||
<p>
|
||||
<ph id="topic-based-classes">Where DITA 1.x defined conflicting <xmlatt>class</xmlatt> values for
|
||||
<xmlelement>linktext</xmlelement>, <xmlelement>shortdesc</xmlelement>, and
|
||||
<xmlelement>searchtitle</xmlelement> in maps and topics, the new draft of DITA 2.0 uses the topic-based
|
||||
<xmlatt>class</xmlatt> value in all cases. Processing is updated to recognize the updated value when
|
||||
these elements are used in maps.</ph>
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section>
|
||||
<title>DITA-OT 3.6</title>
|
||||
<p>DITA-OT 3.6 adds support for additional DITA 2.0 features.</p>
|
||||
<ul id="added-in-3.6">
|
||||
<!-- Added in DITA-OT 3.6 -->
|
||||
<li>Where earlier DITA versions relied on the <xmlelement>object</xmlelement> to embed media in DITA source
|
||||
files, DITA 2.0 provides new <xmlelement>audio</xmlelement> and <xmlelement>video</xmlelement> elements that
|
||||
correspond to their HTML5 equivalents.</li>
|
||||
<li>For HTML5 compatibility, the new emphasis domain adds support for the <xmlelement>strong</xmlelement> and
|
||||
<xmlelement>em</xmlelement> elements in addition to the existing <xmlelement>b</xmlelement> and
|
||||
<xmlelement>i</xmlelement> elements in the highlighting domain.</li>
|
||||
<li>The troubleshooting domain has been updated with additional constructs that can be used to provide detailed
|
||||
diagnostic information.</li>
|
||||
<li>Several obsolete elements and attributes have been removed from DITA 2.0, including:
|
||||
<ul>
|
||||
<li><xmlelement>boolean</xmlelement></li>
|
||||
<li><xmlelement>data-about</xmlelement></li>
|
||||
<li><xmlelement>indextermref</xmlelement></li>
|
||||
<li><xmlatt>alt</xmlatt> on <xmlelement>image</xmlelement></li>
|
||||
<li><xmlatt>navtitle</xmlatt> on <xmlelement>topicref</xmlelement></li>
|
||||
<li><xmlatt>query</xmlatt> on <xmlelement>topicref</xmlelement></li>
|
||||
<li><xmlatt>refcols</xmlatt> on <xmlelement>simpletable</xmlelement></li>
|
||||
<li><xmlatt>xtrc</xmlatt></li>
|
||||
<li><xmlatt>xtrf</xmlatt></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<note id="more-to-come">Other new or revised features proposed for DITA 2.0 are not yet supported. Additional
|
||||
features will be implemented in future versions of DITA-OT as the specification evolves.</note>
|
||||
<note type="tip">For the latest status information on DITA 2.0-related features and fixes, see the
|
||||
<xref keyref="dita20-issues"/> in the GitHub issues tracker.</note>
|
||||
</section>
|
||||
</conbody>
|
||||
|
||||
<related-links>
|
||||
<!--
|
||||
<link keyref="dita13-spec-all-inclusive"/>
|
||||
<link keyref="dita13-spec-all-inclusive-pdf"/>
|
||||
<link keyref="dita13-spec-source"/>
|
||||
-->
|
||||
<link keyref="dita-tc"/>
|
||||
|
||||
</related-links>
|
||||
</concept>
|
||||
132
dita-ot-3.6/docsrc/reference/docs-dita-features.dita
Normal file
132
dita-ot-3.6/docsrc/reference/docs-dita-features.dita
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="ID">
|
||||
<title>DITA features in the documentation</title>
|
||||
<titlealts>
|
||||
<navtitle>DITA features in docs</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>DITA Open Toolkit uses various recent DITA features in the project documentation.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><xmlatt>audience</xmlatt></indexterm>
|
||||
<indexterm><xmlatt>orient</xmlatt></indexterm>
|
||||
<indexterm>profiling</indexterm>
|
||||
<indexterm>branch filters</indexterm>
|
||||
<indexterm>Antenna House
|
||||
<indexterm>DITA XML mention domain</indexterm></indexterm>
|
||||
<indexterm>DITA 1.3
|
||||
<indexterm>XML mention domain</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<conbody>
|
||||
<p>The
|
||||
<xref href="https://github.com/dita-ot/docs" format="html" scope="external">source files</xref> for the DITA-OT
|
||||
documentation include examples of the following DITA features (among others):</p>
|
||||
<ul>
|
||||
<li>subjectScheme classification for controlling available attributes</li>
|
||||
<li>profiling and branch filtering (novice/expert content)</li>
|
||||
<li>extending topics with conref push</li>
|
||||
<li>keys and key references</li>
|
||||
<li>XML mention domain</li>
|
||||
</ul>
|
||||
|
||||
<section>
|
||||
<title>Subject schemes </title>
|
||||
<p>Various topics, sections and elements in the docs are profiled by audience:</p>
|
||||
<p><codeblock outputclass="language-xml normalize-space show-line-numbers show-whitespace"><coderef
|
||||
href="../resources/conref-task.dita#token=excerpt-variables,end-excerpt"
|
||||
/></codeblock></p>
|
||||
<p>An “audience” subject scheme controls the values that are available for the <xmlatt>audience</xmlatt>
|
||||
attribute:</p>
|
||||
<p><codeblock outputclass="language-xml normalize-space show-line-numbers show-whitespace"><coderef
|
||||
href="../resources/subjectscheme.ditamap#token=excerpt-audience,end-excerpt"
|
||||
/></codeblock></p>
|
||||
<p>A dedicated subject scheme map defines several series of permissible values for <xmlatt>outputclass</xmlatt>
|
||||
attributes, which apply styling to elements on the project website, enable
|
||||
<xref keyref="extended-functionality">extended codeblock processing</xref> such as whitespace visualization and
|
||||
line numbering in PDF output, or trigger
|
||||
<xref keyref="html5-code-highlighting"/> via
|
||||
<xref keyref="prismjs"/>.</p>
|
||||
<p><codeblock outputclass="language-xml normalize-space show-line-numbers show-whitespace"><coderef
|
||||
href="../resources/subjectscheme.ditamap#token=excerpt-outputclass,excerpt-audience"
|
||||
/></codeblock></p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Branch filtering: re-using profiled content</title>
|
||||
</section>
|
||||
<section>
|
||||
<p><cite>Installing DITA-OT</cite> pulls a subset of the build description from <cite>using the
|
||||
<cmdname>dita</cmdname> command</cite>, filtered to display only content deemed suitable for novice users
|
||||
under
|
||||
<xref keyref="first-build-using-dita-command"/>:</p>
|
||||
<p><codeblock outputclass="language-xml normalize-space show-line-numbers show-whitespace"><coderef
|
||||
href="../topics/installing.ditamap#token=branch-filter,end-filtering"
|
||||
/></codeblock></p>
|
||||
<p>The same content appears later in
|
||||
<xref keyref="build-using-dita-command"/> with additional information on arguments, options and examples.</p>
|
||||
<p><codeblock outputclass="language-xml normalize-space show-line-numbers show-whitespace"><coderef
|
||||
href="../topics/publishing.ditamap#token=branch-filter,end-filtering"
|
||||
/></codeblock></p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Conref push</title>
|
||||
</section>
|
||||
<section>
|
||||
<p>The docs build uses the conref push mechanism (with the <codeph>pushreplace</codeph>, <codeph>mark</codeph>,
|
||||
and <codeph>pushafter</codeph>
|
||||
<xref keyref="dita13-spec-conaction">conactions</xref>) to extend the parameter descriptions embedded in the
|
||||
default plug-ins:</p>
|
||||
<p><codeblock outputclass="language-xml normalize-space show-line-numbers show-whitespace"><coderef
|
||||
href="../parameters/ant-parameters-details.dita#token=excerpt-csspath,end-excerpt"
|
||||
/></codeblock></p>
|
||||
<p>The pushed content appears in the output after the default description. (See
|
||||
<xref keyref="parameters-base-html"/>.)</p>
|
||||
<note type="tip">You could also use the same mechanism to extend the documentation with custom information that
|
||||
applies only to your company’s toolkit distribution.</note>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Keys and key references</title>
|
||||
</section>
|
||||
<section>
|
||||
<p>The <codeph>key-definitions.ditamap</codeph> defines keys for version references, re-usable links, etc.</p>
|
||||
<p>This key definition defines the maintenance release version:</p>
|
||||
<p><codeblock outputclass="language-xml normalize-space"><coderef
|
||||
href="../resources/key-definitions.ditamap#token=excerpt-version,end-excerpt"
|
||||
/></codeblock></p>
|
||||
<p>In topics, the keyword is used in place of hard-coded version references:</p>
|
||||
<codeblock
|
||||
outputclass="language-xml"
|
||||
><title>DITA Open Toolkit <keyword keyref="maintenance-version"/> Release Notes</title></codeblock>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>XML mention domain</title>
|
||||
</section>
|
||||
<section>
|
||||
<p>The docs use the
|
||||
<xref
|
||||
format="html"
|
||||
href="http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/langRef/containers/xml-mention-domain.html#xml-mention-domain"
|
||||
scope="external"
|
||||
>XML mention domain</xref> to mark up XML elements and attributes:</p>
|
||||
<codeblock outputclass="language-xml"><li id="1777">
|
||||
DITA 1.3: Initial support has been added for the <xmlatt>orient</xmlatt>
|
||||
attribute on <xmlelement>table</xmlelement> elements. These changes allow
|
||||
Antenna House Formatter to render tables in landscape mode when the
|
||||
<xmlatt>orient</xmlatt> attribute is set to <option>land</option>. […]
|
||||
</li></codeblock>
|
||||
<p>When the toolkit generates output for the sample above:</p>
|
||||
<ul>
|
||||
<li>the XML element name is wrapped in angle brackets as <xmlelement>table</xmlelement>
|
||||
</li>
|
||||
<li>the attribute name is prefixed with an “at” sign as <xmlatt>orient</xmlatt></li>
|
||||
</ul>
|
||||
</section>
|
||||
</conbody>
|
||||
</concept>
|
||||
75
dita-ot-3.6/docsrc/reference/eclipsehelp-processing.dita
Normal file
75
dita-ot-3.6/docsrc/reference/eclipsehelp-processing.dita
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="xhtmleclipse">
|
||||
<title>Eclipse help processing</title>
|
||||
<shortdesc>The <option>eclipsehelp</option> transformation generates XHTML-based output and files that are needed to
|
||||
create an Eclipse Help system plug-in. Once the normal XHTML process has run, the <codeph>dita.map.eclipse</codeph>
|
||||
target is used to create a set of control files and navigation files.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>HTML
|
||||
<indexterm>Eclipse Help</indexterm></indexterm>
|
||||
<indexterm>dita.map.eclipse</indexterm>
|
||||
<indexterm>Eclipse Help</indexterm>
|
||||
<indexterm>targets
|
||||
<indexterm>Eclipse Help</indexterm></indexterm>
|
||||
<indexterm>index
|
||||
<indexterm>Eclipse Help</indexterm></indexterm>
|
||||
<indexterm>table of contents
|
||||
<indexterm>Eclipse Help</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<conbody>
|
||||
<section>
|
||||
<p>Eclipse uses multiple files to control the plug-in behavior. Some of these control files are generated by the
|
||||
build, while others might be created manually. The following Ant targets control the Eclipse help
|
||||
processing:</p>
|
||||
<p>
|
||||
<dl>
|
||||
<dlentry>
|
||||
<dt><codeph>dita.map.eclipse.init</codeph></dt>
|
||||
<dd>Sets up various default properties</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><codeph>dita.map.eclipse.toc</codeph></dt>
|
||||
<dd>Creates the XML file that defines an Eclipse table of contents</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><codeph>dita.map.eclipse.index</codeph></dt>
|
||||
<dd>Creates the sorted XML file that defines an Eclipse index</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><codeph>dita.map.eclipse.plugin</codeph></dt>
|
||||
<dd>Creates the <filepath>plugin.xml</filepath> file that controls the behavior of an Eclipse plug-in</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><codeph>dita.map.eclipse.plugin.properties</codeph></dt>
|
||||
<dd>Creates a Java properties file that sets properties for the plug-in, such as name and version
|
||||
information</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><codeph>dita.map.eclipse.manifest.file</codeph></dt>
|
||||
<dd>Creates a <filepath>MANIFEST.MF</filepath> file that contains additional information used by
|
||||
Eclipse</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><codeph>copy-plugin-files</codeph></dt>
|
||||
<dd>Checks for the presence of certain control files in the source directory, and copies those found to the
|
||||
output directory</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><codeph>dita.map.eclipse.fragment.language.init</codeph></dt>
|
||||
<dd>Works in conjunction with the <codeph>dita.map.eclipse.fragment.language.country.init</codeph> and
|
||||
<codeph>dita.map.eclipse.fragment.error</codeph> targets to control Eclipse fragment files, which are
|
||||
used for versions of a plug-in created for a new language or locale</dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</p>
|
||||
<p>Several of the targets listed above have matching templates for processing content that is located outside of
|
||||
the scope of the map directory, such as <codeph>dita.out.map.eclipse.toc</codeph>.</p>
|
||||
</section>
|
||||
</conbody>
|
||||
</concept>
|
||||
174
dita-ot-3.6/docsrc/reference/extended-functionality.dita
Normal file
174
dita-ot-3.6/docsrc/reference/extended-functionality.dita
Normal file
|
|
@ -0,0 +1,174 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="code-reference">
|
||||
|
||||
<title>Extended codeblock processing</title>
|
||||
|
||||
<titlealts>
|
||||
<navtitle>Codeblock extensions</navtitle>
|
||||
</titlealts>
|
||||
|
||||
<shortdesc>DITA-OT provides additional processing support beyond that which is mandated by the DITA specification.
|
||||
These extensions can be used to define character encodings or line ranges for code references, normalize
|
||||
indendation, add line numbers or display whitespace characters in code blocks.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><xmlelement>coderef</xmlelement></indexterm>
|
||||
<indexterm><xmlelement>codeblock</xmlelement></indexterm>
|
||||
<indexterm><xmlatt>format</xmlatt></indexterm>
|
||||
<indexterm><xmlatt>outputclass</xmlatt></indexterm>
|
||||
<indexterm>encoding</indexterm>
|
||||
<indexterm><msgnum>DOTJ052E</msgnum></indexterm>
|
||||
<indexterm>character set</indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
|
||||
<refbody>
|
||||
<section id="coderef-charset">
|
||||
<title>Character set definition</title>
|
||||
<p>For <xmlelement>coderef</xmlelement> elements, DITA-OT supports defining the code reference target file
|
||||
encoding using the <xmlatt>format</xmlatt> attribute. The supported format is:</p>
|
||||
<codeblock>format (";" space* "charset=" charset)?</codeblock>
|
||||
<p>If a character set is not defined, the system default character set will be used. If the character set is not
|
||||
recognized or supported, the <msgnum>DOTJ052E</msgnum> error is thrown and the system default character set is
|
||||
used as a fallback.</p>
|
||||
<codeblock outputclass="language-xml"><coderef href="unicode.txt" format="txt; charset=UTF-8"/></codeblock>
|
||||
<p>As of DITA-OT 3.3, the default character set for code references can be changed by adding the
|
||||
<parmname>default.coderef-charset</parmname> key to the
|
||||
<xref keyref="configuration-properties-file">configuration.properties</xref> file:</p>
|
||||
<codeblock outputclass="language-properties">default.coderef-charset = ISO-8859-1</codeblock>
|
||||
<p>The character set values are those supported by the Java
|
||||
<xref
|
||||
format="html"
|
||||
href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html"
|
||||
scope="external"
|
||||
>Charset</xref> class.</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Line range extraction</title>
|
||||
<p>Code references can be limited to extract only a specified line range by defining the
|
||||
<codeph>line-range</codeph> pointer in the URI fragment. The format is:</p>
|
||||
<codeblock>uri ("#line-range(" start ("," end)? ")" )?</codeblock>
|
||||
<p>Start and end line numbers start from 1 and are inclusive. If the end range is omitted, the range ends on the
|
||||
last line of the file.</p>
|
||||
</section>
|
||||
<example>
|
||||
<codeblock
|
||||
outputclass="language-xml"
|
||||
><coderef href="Parser.scala#line-range(5,10)" format="scala"/></codeblock>
|
||||
<p>Only lines from 5 to 10 will be included in the output.</p>
|
||||
</example>
|
||||
<section>
|
||||
<title>RFC 5147</title>
|
||||
<indexterm>RFC 5147</indexterm>
|
||||
<p>DITA-OT also supports the line position and range syntax from
|
||||
<xref keyref="rfc5147"/>. The format for line range is:</p>
|
||||
<codeblock>uri ("#line=" start? "," end? )?</codeblock>
|
||||
<p>Start and end line numbers start from 0 and are inclusive and exclusive, respectively. If the start range is
|
||||
omitted, the range starts from the first line; if the end range is omitted, the range ends on the last line of
|
||||
the file. The format for line position is:</p>
|
||||
<codeblock>uri ("#line=" position )?</codeblock>
|
||||
<p>The position line number starts from 0.</p>
|
||||
</section>
|
||||
<example>
|
||||
<codeblock outputclass="language-xml"><coderef href="Parser.scala#line=4,10" format="scala"/></codeblock>
|
||||
<p>Only lines from 5 to 10 will be included in the output.</p>
|
||||
</example>
|
||||
<section>
|
||||
<title>Line range by content</title>
|
||||
<p>Instead of specifying line numbers, you can also select lines to include in the code reference by specifying
|
||||
keywords (or “<term>tokens</term>”) that appear in the referenced file.</p>
|
||||
<div id="coderef-by-content">
|
||||
<p>DITA-OT supports the <codeph>token</codeph> pointer in the URI fragment to extract a line range based on the
|
||||
file content. The format for referencing a range of lines by content is:</p>
|
||||
<codeblock>uri ("#token=" start? ("," end)? )?</codeblock>
|
||||
<p>Lines identified using start and end tokens are exclusive: the lines that contain the start token and end
|
||||
token will be not be included. If the start token is omitted, the range starts from the first line in the
|
||||
file; if the end token is omitted, the range ends on the last line of the file. </p>
|
||||
</div>
|
||||
</section>
|
||||
<example>
|
||||
<p>Given a Haskell source file named <filepath>fact.hs</filepath> with the following content,</p>
|
||||
<codeblock outputclass="language-haskell normalize-space show-line-numbers show-whitespace"><coderef
|
||||
href="../resources/fact.hs"
|
||||
/></codeblock>
|
||||
<p>a range of lines can be referenced as:</p>
|
||||
<codeblock outputclass="language-xml"><coderef href="fact.hs#token=START-FACT,END-FACT"/></codeblock>
|
||||
<p>to include the range of lines that follows the <codeph>START-FACT</codeph> token on Line 1, up to (but not
|
||||
including) the line that contains the <codeph>END-FACT</codeph> token (Line 5). The resulting
|
||||
<xmlelement>codeblock</xmlelement> would contain lines 2–4:</p>
|
||||
<codeblock outputclass="language-haskell"><coderef
|
||||
href="../resources/fact.hs#token=START-FACT,END-FACT"
|
||||
/></codeblock>
|
||||
<note type="tip" id="coderef-by-content-tip">This approach can be used to reference code samples that are
|
||||
frequently edited. In these cases, referencing line ranges by line number can be error-prone, as the target line
|
||||
range for the reference may shift if preceding lines are added or removed. Specifying ranges by line content
|
||||
makes references more robust, as long as the <codeph>token</codeph> keywords are preserved when the referenced
|
||||
resource is modified.</note></example>
|
||||
<refbodydiv id="normalize-codeblock-whitespace">
|
||||
<section>
|
||||
<title>Whitespace normalization</title>
|
||||
<indexterm>whitespace handling</indexterm>
|
||||
<p>DITA-OT can adjust the leading whitespace in code blocks to remove excess indentation and keep lines short.
|
||||
Given an XML snippet in a codeblock with lines that all begin with spaces (indicated here as dots “·”),</p>
|
||||
</section>
|
||||
<example>
|
||||
<p><codeblock outputclass="language-xml">··<subjectdef keys="audience">
|
||||
····<subjectdef keys="novice"/>
|
||||
····<subjectdef keys="expert"/>
|
||||
··</subjectdef></codeblock></p>
|
||||
<p>DITA-OT can remove the leading whitespace that is common to all lines in the code block. To trim the excess
|
||||
space, set the <xmlatt>outputclass</xmlatt> attribute on the <xmlelement>codeblock</xmlelement> element to
|
||||
include the <codeph>normalize-space</codeph> keyword.</p>
|
||||
<p>In this case, two spaces (“··”) would be removed from the beginning of each line, shifting content to the
|
||||
left by two characters, while preserving the indentation of lines that contain additional whitespace (beyond
|
||||
the common indent):</p>
|
||||
<p><codeblock outputclass="language-xml"><subjectdef keys="audience">
|
||||
··<subjectdef keys="novice"/>
|
||||
··<subjectdef keys="expert"/>
|
||||
</subjectdef></codeblock></p>
|
||||
</example>
|
||||
</refbodydiv>
|
||||
<refbodydiv id="visualize-codeblock-whitespace">
|
||||
<section>
|
||||
<title>Whitespace visualization (PDF)</title>
|
||||
<p>DITA-OT can be set to display the whitespace characters in code blocks to visualize indentation in PDF
|
||||
output.</p>
|
||||
<p>To enable this feature, set the <xmlatt>outputclass</xmlatt> attribute on the
|
||||
<xmlelement>codeblock</xmlelement> element to include the <codeph>show-whitespace</codeph> keyword.</p>
|
||||
<p>When PDF output is generated, space characters in the code will be replaced with a middle dot or “interpunct”
|
||||
character ( <codeph>·</codeph> ); tab characters are replaced with a rightwards arrow and three spaces
|
||||
( <codeph>→ </codeph> ).</p>
|
||||
</section>
|
||||
<example deliveryTarget="pdf">
|
||||
<fig>
|
||||
<title>Sample Java code with visible whitespace characters <i>(PDF only)</i></title>
|
||||
<codeblock outputclass="language-java show-whitespace"> for i in 0..10 {
|
||||
println(i)
|
||||
}</codeblock>
|
||||
</fig>
|
||||
</example>
|
||||
</refbodydiv>
|
||||
<refbodydiv id="codeblock-line-numbers">
|
||||
<section>
|
||||
<title>Line numbering (PDF)</title>
|
||||
<indexterm>line numbering</indexterm>
|
||||
<p>DITA-OT can be set to add line numbers to code blocks to make it easier to distinguish specific lines.</p>
|
||||
<p>To enable this feature, set the <xmlatt>outputclass</xmlatt> attribute on the
|
||||
<xmlelement>codeblock</xmlelement> element to include the <codeph>show-line-numbers</codeph> keyword.</p>
|
||||
</section>
|
||||
<example deliveryTarget="pdf">
|
||||
<fig>
|
||||
<title>Sample Java code with line numbers and visible whitespace characters <i>(PDF only)</i></title>
|
||||
<codeblock outputclass="language-java show-line-numbers show-whitespace"> for i in 0..10 {
|
||||
println(i)
|
||||
}</codeblock>
|
||||
</fig>
|
||||
</example>
|
||||
</refbodydiv>
|
||||
</refbody>
|
||||
</reference>
|
||||
207
dita-ot-3.6/docsrc/reference/flagging-migration.dita
Normal file
207
dita-ot-3.6/docsrc/reference/flagging-migration.dita
Normal file
|
|
@ -0,0 +1,207 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="flagging-migration" rev="1.7">
|
||||
<title>XHTML migration for flagging updates in DITA-OT 1.7</title>
|
||||
<titlealts>
|
||||
<navtitle>Flagging updates</navtitle>
|
||||
</titlealts>
|
||||
<shortdesc>This topic is primarily of interest to developers with XHTML transform overrides written prior to DITA-OT
|
||||
1.7. Due to significant changes in the flagging process with the 1.7 release, some changes may be needed to make
|
||||
overrides work properly with DITAVAL-based flagging. The new design is significantly simpler than the old design; in
|
||||
many cases, migration will consist of deleting old code that is no longer needed.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm><xmlelement>ul</xmlelement></indexterm>
|
||||
<indexterm>deprecated features
|
||||
<indexterm><codeph>mode="elementname-fmt"</codeph></indexterm></indexterm>
|
||||
<indexterm>deprecated features
|
||||
<indexterm><codeph>DITAVAL templates</codeph></indexterm></indexterm>
|
||||
<indexterm>DITAVAL
|
||||
<indexterm>template changes in 1.7</indexterm></indexterm>
|
||||
<indexterm>CSS
|
||||
<indexterm>gen-style</indexterm></indexterm>
|
||||
<indexterm>flagging</indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<refbody>
|
||||
<section>
|
||||
<title>Which XHTML overrides need to migrate?</title>
|
||||
<p>If your override does not contain any code related to DITAVAL flagging, then there is nothing to migrate.</p>
|
||||
<p>If your builds do not make use of DITAVAL-based flagging, but call the deprecated flagging templates, then you
|
||||
should override but there is little urgency. You will not see any difference in the output, but those templates
|
||||
will be removed in a future release.</p>
|
||||
<p>If you do make use of DITAVAL-based flagging, try using your override with 1.7. Check the elements you
|
||||
override:
|
||||
<ol>
|
||||
<li>In some cases flags may be doubled. This will be the case if you call routines such as
|
||||
<codeph>"start-flagit"</codeph>.</li>
|
||||
<li>In some cases flags may be removed. This will be the case if you call shortcut routines such as
|
||||
<codeph>"revtext"</codeph> or <codeph>"revblock"</codeph>.</li>
|
||||
<li>In other cases, flags may still appear properly, in which case migration is less urgent.</li>
|
||||
</ol></p>
|
||||
<p>For any override that needs migration, please see the instructions that follow.</p></section>
|
||||
<section>
|
||||
<title>Deprecated templates in DITA-OT 1.7</title>
|
||||
<p>All of the old DITAVAL based templates are deprecated in DITA-OT 1.7. If your overrides include any of the
|
||||
following templates, they should be migrated for the new release; in many cases the templates below will not
|
||||
have any effect on your output, but all instances should be migrated.</p>
|
||||
<ul>
|
||||
<li>The <codeph>"gen-style"</codeph> template used to add CSS styling</li>
|
||||
<li>The <codeph>"start-flagit"</codeph> and <codeph>"end-flagit"</codeph> templates used to generate image flags
|
||||
based on property attributes like @audience</li>
|
||||
<li>The <codeph>"start-revflag"</codeph> and <codeph>"end-revflag"</codeph> templates, used to generate images
|
||||
for active revisions</li>
|
||||
<li>Shortcut templates that group these templates into a single call, such as:
|
||||
<ul>
|
||||
<li><codeph>"start-flags-and-rev"</codeph> and <codeph>"end-flags-and-rev"</codeph>, used to combine flags
|
||||
and revisions into one call</li>
|
||||
<li><codeph>"revblock"</codeph> and <codeph>"revtext"</codeph>, both used to output start revisions, element
|
||||
content, and end revisions</li>
|
||||
<li>The modes <codeph>"outputContentsWithFlags"</codeph> and
|
||||
<codeph>"outputContentsWithFlagsAndStyle"</codeph>, both used to combine processing for
|
||||
property/revision flags with content processing</li>
|
||||
</ul></li>
|
||||
<li>All other templates that make use of the <codeph>$flagrules</codeph> variable, which is no longer used in
|
||||
any of the DITA-OT 1.7 code</li>
|
||||
<li>All templates within <filepath>flag.xsl</filepath> that were called from the templates listed above</li>
|
||||
<li>Element processing handled with mode="elementname-fmt", such as <codeph>mode="ul-fmt"</codeph> for
|
||||
processing unordered lists and <codeph>mode="section-fmt"</codeph> for sections.</li>
|
||||
</ul></section>
|
||||
<section>
|
||||
<title>What replaces the templates?</title>
|
||||
<p>The new flagging design described in the preprocess design section now adds literal copies of relevant DITAVAL
|
||||
elements, along with CSS based flagging information, into the relevant section of the topic. This allows most
|
||||
flags to be processed in document order; in addition, there is never a need to read the DITAVAL, interpret CSS,
|
||||
or evaluate flagging logic. The <filepath>htmlflag.xsl</filepath> file contains a few rules to match and process
|
||||
the start/end flags; in most cases, all code to explicitly process flags can be deleted.</p>
|
||||
<p>For example, the common logic for most element rules before DITA-OT 1.7 could be boiled down to the following:
|
||||
<ol>
|
||||
<li>Match element </li>
|
||||
<li>Create <codeph>"flagrules"</codeph> variable by reading DITAVAL for active flags </li>
|
||||
<li>Output start tag such as <codeph><div></codeph> or <codeph><span></codeph>
|
||||
</li>
|
||||
<li>Call <codeph>"commonattributes"</codeph> and ID processing </li>
|
||||
<li>Call <codeph>"gen-style"</codeph> with <codeph>$flagrules</codeph>, to create DITAVAL based CSS </li>
|
||||
<li>Call <codeph>"start-flagit"</codeph> with <codeph>$flagrules</codeph>, to create start flag images </li>
|
||||
<li>Call <codeph>"start-revflag"</codeph> with <codeph
|
||||
>$flagrules</codeph>, to create start revision images </li>
|
||||
<li>Output contents </li>
|
||||
<li>Call <codeph>"end-revflag"</codeph> with <codeph>$flagrules</codeph>, to create end revision images </li>
|
||||
<li>Call <codeph>"end-flagit"</codeph> with <codeph>$flagrules</codeph>, to create end flag images </li>
|
||||
<li>Output end tag such as <codeph></div></codeph> or <codeph></span></codeph></li>
|
||||
</ol>
|
||||
</p>
|
||||
<p>In DITA-OT 1.7, style and images are typically handled with XSLT fallthrough processing. This removes virtually
|
||||
all special flag coding from element rules, because flags are already part of the document and processed in
|
||||
document order. </p>
|
||||
<p>The sample above is reduced to:
|
||||
<ol>
|
||||
<li>Match element </li>
|
||||
<li>Output start tag such as <codeph><div></codeph> or <codeph><span></codeph>
|
||||
</li>
|
||||
<li>Call <codeph>"commonattributes"</codeph> and ID processing </li>
|
||||
<li>Output contents </li>
|
||||
<li>Output end tag such as <codeph></div></codeph> or <codeph></span></codeph></li>
|
||||
</ol>
|
||||
</p>
|
||||
</section>
|
||||
<section>
|
||||
<title>Migrating <codeph>"gen-style"</codeph> named template</title>
|
||||
<p>Calls to the <codeph>"gen-style"</codeph> template should be deleted. There is no need to replace this call for
|
||||
most elements.</p>
|
||||
<p>The <codeph>"gen-style"</codeph> template was designed to read a DITAVAL file, find active style-based flagging
|
||||
(such as colored or bold text), and add it to the generated @style attribute in HTML.</p>
|
||||
<p>With DITA-OT 1.7, the style is calculated in the pre-process flagging module. The result is created as
|
||||
@outputclass on a <codeph><ditaval-startprop></codeph> sub-element. The <codeph>"commonattributes"</codeph>
|
||||
template now includes a line to process that value; the result is that for every element that calls
|
||||
<codeph>"commonattributes"</codeph>, DITAVAL style will be processed when needed. Because virtually every
|
||||
element includes a call to this common template, there is little chance that your override needs to explicitly
|
||||
process the style. The new line in <codeph>"commonattributes"</codeph> that handles the style is:
|
||||
<codeblock
|
||||
outputclass="language-xml"
|
||||
><xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-startprop ')]/@outputclass" mode="add-ditaval-style"/></codeblock></p></section>
|
||||
<section>
|
||||
<title>Migrating <codeph>"start-flagit"</codeph>, <codeph>"start-revflag"</codeph>, <codeph>"end-flagit"</codeph>,
|
||||
and <codeph>"end-flagit"</codeph> named templates</title>
|
||||
<p>Calls to these templates fall into two general groups.</p>
|
||||
<p>If the flow of your element rule is to create a start tag like <codeph><div></codeph>,
|
||||
<codeph>"start-flagit"</codeph>/<codeph>"start-revflag"</codeph>, process contents,
|
||||
<codeph>"end-revflag"</codeph>/<codeph>"end-flagit"</codeph>, end tag - you just need to delete the calls to
|
||||
these templates. Flags will be generated simply by processing the element contents in document order.</p>
|
||||
<p>If the flow of your element rule processes flags outside of the normal document-order. There are generally two
|
||||
reasons this is done. The first case is for elements like <codeph><ol></codeph>, where flags must appear
|
||||
before the <codeph><ol></codeph> in order to create valid XHTML. The second is for elements like
|
||||
<codeph><section></codeph>, where start flags are created, followed by the title or some generated text,
|
||||
element contents, and finally end flags. In either of these cases, support for processing flags in document
|
||||
order is disabled, so they must be explicitly processed out-of-line.</p>
|
||||
<p>This is done with the following two lines (one for start flag/revision, one for end flag/revision):</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Create starting flag and revision images:</p>
|
||||
<codeblock
|
||||
outputclass="language-xml"
|
||||
><xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-startprop ')]" mode="out-of-line"/></codeblock></li>
|
||||
<li>
|
||||
<p>Create ending flag and revision images:</p>
|
||||
<codeblock
|
||||
outputclass="language-xml"
|
||||
><xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-endprop ')]" mode="out-of-line"/></codeblock></li>
|
||||
</ul>
|
||||
<p>For example, the following lines are used in DITA-OT 1.7 to process the <xmlelement>ul</xmlelement> element
|
||||
(replacing the 29 lines used in DITA-OT
|
||||
1.6):<codeblock
|
||||
outputclass="language-xml normalize-space show-line-numbers show-whitespace"
|
||||
><xsl:template match="*[contains(@class,' topic/ul ')]">
|
||||
<b><xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-startprop ')]" mode="out-of-line"/></b>
|
||||
<xsl:call-template name="setaname"/>
|
||||
<ul>
|
||||
<xsl:call-template name="commonattributes"/>
|
||||
<xsl:apply-templates select="@compact"/>
|
||||
<xsl:call-template name="setid"/>
|
||||
<xsl:apply-templates/>
|
||||
</ul>
|
||||
<b><xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-endprop ')]" mode="out-of-line"/></b>
|
||||
<xsl:value-of select="$newline"/>
|
||||
</xsl:template></codeblock></p></section>
|
||||
<section>
|
||||
<title>Migrating <codeph>"start-flags-and-rev"</codeph> and <codeph>"end-flags-and-rev"</codeph></title>
|
||||
<ul>
|
||||
<li><codeph>"start-flags-and-rev"</codeph> is equivalent to calling <codeph>"start-flagit"</codeph> followed by
|
||||
<codeph>"start-revflag"</codeph>; it should be migrated as in the previous section.</li>
|
||||
<li><codeph>"end-flags-and-rev"</codeph> is equivalent to calling <codeph>"end-revflag"</codeph> followed by
|
||||
<codeph>"end-flagit"</codeph>; it should be migrated as in the previous section.</li>
|
||||
</ul></section>
|
||||
<section>
|
||||
<title>Migrating <codeph>"revblock"</codeph> and <codeph>"revtext"</codeph></title>
|
||||
<p>Calls to these two templates can be replaced with a simple call to
|
||||
<codeph><xsl:apply-templates/></codeph>.</p></section>
|
||||
<section>
|
||||
<title>Migrating modes <codeph>"outputContentsWithFlags"</codeph> and
|
||||
<codeph>"outputContentsWithFlagsAndStyle"</codeph></title>
|
||||
<p>Processing an element with either of these modes can be replaced with a simple call to
|
||||
<codeph><xsl:apply-templates/></codeph>.</p></section>
|
||||
<section>
|
||||
<title>Migrating <codeph>mode="elementname-fmt"</codeph></title>
|
||||
<p>Prior to DITA-OT 1.7, many elements were processed with the following
|
||||
logic:<pre>Match element
|
||||
Set variable to determine if revisions are active and $DRAFT is on
|
||||
If active
|
||||
create division with rev style
|
||||
process element with mode="elementname-fmt"
|
||||
end division
|
||||
Else
|
||||
process element with mode="elementname-fmt"
|
||||
|
||||
Match element with mode="elementname-fmt"
|
||||
Process as needed</pre></p>
|
||||
<p>Beginning with DITA-OT 1.7, styling from revisions is handled automatically with the
|
||||
<codeph>"commonattributes"</codeph> template. This means there is no need for the extra testing, or the
|
||||
indirection to <codeph>mode="elementname-fmt"</codeph>. These templates are deprecated, and element processing
|
||||
will move into the main element rule. Overrides that include this indirection may remove it; overrides should
|
||||
also be sure to match the default rule, rather than matching with
|
||||
<codeph>mode="elementname-fmt"</codeph>.</p></section>
|
||||
</refbody>
|
||||
</reference>
|
||||
7
dita-ot-3.6/docsrc/reference/gloss-argument.dita
Normal file
7
dita-ot-3.6/docsrc/reference/gloss-argument.dita
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-argument">
|
||||
<glossterm>argument</glossterm>
|
||||
<glossdef>Required parameter passed to the Ant process or <cmdname>dita</cmdname> command.</glossdef>
|
||||
</glossentry>
|
||||
28
dita-ot-3.6/docsrc/reference/gloss-dita-open-toolkit.dita
Normal file
28
dita-ot-3.6/docsrc/reference/gloss-dita-open-toolkit.dita
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-dita-open-toolkit">
|
||||
<glossterm>DITA Open Toolkit</glossterm>
|
||||
<glossdef>The open-source publishing engine for content authored in the Darwin Information Typing
|
||||
Architecture.</glossdef>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>DOST</indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<glossBody>
|
||||
<glossPartOfSpeech value="proper-noun"/>
|
||||
<glossAlt>
|
||||
<glossAbbreviation>DITA-OT</glossAbbreviation>
|
||||
<glossUsage>Treat as a proper noun; do not precede with <i>the</i> definite article.</glossUsage>
|
||||
</glossAlt>
|
||||
<glossAlt>
|
||||
<glossAcronym>DOST</glossAcronym>
|
||||
<glossStatus value="deprecated"/>
|
||||
<glossUsage>Deprecated acronym for “<b>D</b>ITA <b>O</b>pen <i><b>S</b>ource</i>
|
||||
<b>T</b>oolkit”. Use <term>DITA-OT</term> instead.</glossUsage>
|
||||
</glossAlt>
|
||||
</glossBody>
|
||||
</glossentry>
|
||||
10
dita-ot-3.6/docsrc/reference/gloss-extension-point.dita
Normal file
10
dita-ot-3.6/docsrc/reference/gloss-extension-point.dita
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-extension-point">
|
||||
<glossterm>extension point</glossterm>
|
||||
<glossdef>Pre-defined interface that can be added to a plug-in to allow other plug-ins to extend or customize portions
|
||||
of its functionality. An extendable feature is defined by declaring an <xmlelement>extension-point</xmlelement>
|
||||
element in the <filepath>plugin.xml</filepath> file. Other plug-ins can then override the default behavior by
|
||||
defining custom code that runs when this extension point is called.</glossdef>
|
||||
</glossentry>
|
||||
7
dita-ot-3.6/docsrc/reference/gloss-option.dita
Normal file
7
dita-ot-3.6/docsrc/reference/gloss-option.dita
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-option">
|
||||
<glossterm>option</glossterm>
|
||||
<glossdef>Discretionary parameter passed to the Ant process or <cmdname>dita</cmdname> command.</glossdef>
|
||||
</glossentry>
|
||||
7
dita-ot-3.6/docsrc/reference/gloss-output-format.dita
Normal file
7
dita-ot-3.6/docsrc/reference/gloss-output-format.dita
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-output-format">
|
||||
<glossterm>output format</glossterm>
|
||||
<glossdef>Deliverable file or set of files containing all of the transformed content.</glossdef>
|
||||
</glossentry>
|
||||
7
dita-ot-3.6/docsrc/reference/gloss-parameter.dita
Normal file
7
dita-ot-3.6/docsrc/reference/gloss-parameter.dita
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-parameter">
|
||||
<glossterm>parameter</glossterm>
|
||||
<glossdef>Command-line argument or option passed to the Ant process or <cmdname>dita</cmdname> command.</glossdef>
|
||||
</glossentry>
|
||||
7
dita-ot-3.6/docsrc/reference/gloss-plug-in.dita
Normal file
7
dita-ot-3.6/docsrc/reference/gloss-plug-in.dita
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-plug-in">
|
||||
<glossterm>plug-in</glossterm>
|
||||
<glossdef>Group of related files that change the default behavior of DITA-OT in some way.</glossdef>
|
||||
</glossentry>
|
||||
8
dita-ot-3.6/docsrc/reference/gloss-processor.dita
Normal file
8
dita-ot-3.6/docsrc/reference/gloss-processor.dita
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-processor">
|
||||
<glossterm>processor</glossterm>
|
||||
<glossdef>Software that performs a series of operations to transform DITA content from one format to
|
||||
another.</glossdef>
|
||||
</glossentry>
|
||||
7
dita-ot-3.6/docsrc/reference/gloss-property.dita
Normal file
7
dita-ot-3.6/docsrc/reference/gloss-property.dita
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-property">
|
||||
<glossterm>property</glossterm>
|
||||
<glossdef>Ant-specific argument or option.</glossdef>
|
||||
</glossentry>
|
||||
10
dita-ot-3.6/docsrc/reference/gloss-template-plugin.dita
Normal file
10
dita-ot-3.6/docsrc/reference/gloss-template-plugin.dita
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-template-plugin">
|
||||
<glossterm>template</glossterm>
|
||||
<glossdef>Optional <xmlelement>template</xmlelement> elements can be added to <filepath>plugin.xml</filepath> files to
|
||||
define XML or XSL files that integrate DITA-OT extensions. Template files are often named with a
|
||||
<filepath>_template</filepath> suffix, and may be used to create custom extensions, group targets, and more.
|
||||
Anything contained in the plug-in’s template files is integrated when the plug-in is installed.</glossdef>
|
||||
</glossentry>
|
||||
7
dita-ot-3.6/docsrc/reference/gloss-template-xslt.dita
Normal file
7
dita-ot-3.6/docsrc/reference/gloss-template-xslt.dita
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-template-xslt">
|
||||
<glossterm>XSL template</glossterm>
|
||||
<glossdef>Set of rules in an XSL stylesheet that are applied to nodes that match specific XML structures.</glossdef>
|
||||
</glossentry>
|
||||
16
dita-ot-3.6/docsrc/reference/gloss-transformation-type.dita
Normal file
16
dita-ot-3.6/docsrc/reference/gloss-transformation-type.dita
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-transformation-type">
|
||||
<glossterm>transformation type</glossterm>
|
||||
<glossdef>Component of a plug-in that defines an output format.</glossdef>
|
||||
<glossBody>
|
||||
<glossAlt>
|
||||
<glossAbbreviation>transtype</glossAbbreviation>
|
||||
<glossUsage>Abbreviated form of <term>transformation type</term>. Use only to refer to the
|
||||
<parmname>transtype</parmname> parameter of the <cmdname>dita</cmdname> command, or to the
|
||||
<xmlelement>transtype</xmlelement> element in a <filepath>plugin.xml</filepath> file that defines the output
|
||||
format.</glossUsage>
|
||||
</glossAlt>
|
||||
</glossBody>
|
||||
</glossentry>
|
||||
7
dita-ot-3.6/docsrc/reference/gloss-transtype.dita
Normal file
7
dita-ot-3.6/docsrc/reference/gloss-transtype.dita
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-transtype">
|
||||
<glossterm>transtype</glossterm>
|
||||
<glossdef>Specific element of <filepath>plugin.xml</filepath>.</glossdef>
|
||||
</glossentry>
|
||||
8
dita-ot-3.6/docsrc/reference/gloss-variable.dita
Normal file
8
dita-ot-3.6/docsrc/reference/gloss-variable.dita
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<glossentry id="gloss-variable">
|
||||
<glossterm>variable</glossterm>
|
||||
<glossdef>Language-specific piece of generated text, most often defined in the files in
|
||||
<filepath>org.dita.base\xsl\common</filepath>.</glossdef>
|
||||
</glossentry>
|
||||
7
dita-ot-3.6/docsrc/reference/glossary.dita
Normal file
7
dita-ot-3.6/docsrc/reference/glossary.dita
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="glossary">
|
||||
<title>Glossary</title>
|
||||
<shortdesc>Certain terms have particular meaning in the context of the DITA Open Toolkit project.</shortdesc>
|
||||
</concept>
|
||||
21
dita-ot-3.6/docsrc/reference/glossary.ditamap
Normal file
21
dita-ot-3.6/docsrc/reference/glossary.ditamap
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<map>
|
||||
<title>Glossary entries</title>
|
||||
<topicref keyref="glossary" chunk="to-content">
|
||||
<glossref href="gloss-argument.dita" keys="gloss-argument" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-dita-open-toolkit.dita" keys="gloss-dita-open-toolkit" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-extension-point.dita" keys="gloss-extension-point" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-option.dita" keys="gloss-option" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-output-format.dita" keys="gloss-output-format" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-parameter.dita" keys="gloss-parameter" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-plug-in.dita" keys="gloss-plug-in" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-processor.dita" keys="gloss-processor" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-property.dita" keys="gloss-property" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-template-plugin.dita" keys="gloss-template-plugin" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-transformation-type.dita" keys="gloss-transformation-type" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-variable.dita" keys="gloss-variable" print="yes" toc="yes"/>
|
||||
<glossref href="gloss-template-xslt.dita" keys="gloss-template-xslt" print="yes" toc="yes"/>
|
||||
</topicref>
|
||||
</map>
|
||||
24
dita-ot-3.6/docsrc/reference/html-based-processing.dita
Normal file
24
dita-ot-3.6/docsrc/reference/html-based-processing.dita
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="xhtmlwithnavigation">
|
||||
<title>HTML-based processing modules</title>
|
||||
<shortdesc>DITA-OT ships with several varieties of HTML output, each of which follows roughly the same path through
|
||||
the processing pipeline. All HTML-based transformations begin with the same call to the pre-processing module, after
|
||||
which they generate HTML files and then branch to create the transformation-specific navigation files.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>HTML
|
||||
<indexterm>various output types</indexterm></indexterm>
|
||||
<indexterm>pipelines
|
||||
<indexterm>HTML</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<conbody>
|
||||
<section>
|
||||
<draft-comment author="Kristen Eberlein" time="29 March 2013">Does the content in this section pertain to the
|
||||
<codeph>dita.map.xhtml</codeph> target?</draft-comment></section>
|
||||
</conbody>
|
||||
</concept>
|
||||
31
dita-ot-3.6/docsrc/reference/html5-processing.dita
Normal file
31
dita-ot-3.6/docsrc/reference/html5-processing.dita
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="ID">
|
||||
<title>HTML5 processing</title>
|
||||
<shortdesc>After the HTML5 files are generated, the <option>html5</option> transformation generates a table of
|
||||
contents (ToC) file called <filepath>index.html</filepath>, which can be loaded as a cover page or rendered in a
|
||||
navigation sidebar or menu via CSS.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>HTML
|
||||
<indexterm>HTML5</indexterm></indexterm>
|
||||
<indexterm>HTML5
|
||||
<indexterm>CSS</indexterm>
|
||||
<indexterm>nav-toc</indexterm></indexterm>
|
||||
<indexterm>targets
|
||||
<indexterm>HTML5</indexterm></indexterm>
|
||||
<indexterm>nav-toc</indexterm>
|
||||
<indexterm>CSS
|
||||
<indexterm>HTML5</indexterm></indexterm>
|
||||
<indexterm>entry file
|
||||
<indexterm>HTML5</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<conbody>
|
||||
<p>As of DITA-OT 2.2, the <parmname>nav-toc</parmname> parameter can be used in HTML5 transformations to embed
|
||||
navigation directly in topics using native HTML5 elements without JavaScript or framesets.</p>
|
||||
</conbody>
|
||||
</concept>
|
||||
45
dita-ot-3.6/docsrc/reference/htmlhelp-processing.dita
Normal file
45
dita-ot-3.6/docsrc/reference/htmlhelp-processing.dita
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="xhtmlchm">
|
||||
<title>HTML Help processing</title>
|
||||
<shortdesc>The <option>htmlhelp</option> transformation creates HTML Help control files. If the build runs on a system
|
||||
that has the HTML Help compiler installed, the control files are compiled into a CHM file.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>HTML
|
||||
<indexterm>CHM</indexterm></indexterm>
|
||||
<indexterm>dita.map.htmlhelp</indexterm>
|
||||
<indexterm>targets
|
||||
<indexterm>HTML Help</indexterm></indexterm>
|
||||
<indexterm><filepath>.hhp</filepath></indexterm>
|
||||
<indexterm><filepath>.hhc</filepath></indexterm>
|
||||
<indexterm><filepath>.hhk</filepath></indexterm>
|
||||
<indexterm>HTML Help</indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<conbody>
|
||||
<section>
|
||||
<p>Once the pre-processing and XHTML processes are completed, most of the HTML Help processing is handled by the
|
||||
following targets:</p>
|
||||
<dl>
|
||||
<dlentry>
|
||||
<dt><codeph>dita.map.htmlhelp</codeph></dt>
|
||||
<dd>Create the HHP, HHC, and HHK files. The HHK file is sorted based on the language of the map.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><codeph>dita.htmlhelp.convertlang</codeph></dt>
|
||||
<dd>Ensures that the content can be processed correctly by the compiler, and that the appropriate code pages
|
||||
and languages are used.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt><codeph>compile.HTML.Help</codeph></dt>
|
||||
<dd>Attempts to detect the HTML Help compiler. If the compiler is found, the full project is compiled into a
|
||||
single CHM file.</dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</section>
|
||||
</conbody>
|
||||
</concept>
|
||||
BIN
dita-ot-3.6/docsrc/reference/images/processing-flow.graffle
Normal file
BIN
dita-ot-3.6/docsrc/reference/images/processing-flow.graffle
Normal file
Binary file not shown.
1
dita-ot-3.6/docsrc/reference/images/processing-flow.svg
Normal file
1
dita-ot-3.6/docsrc/reference/images/processing-flow.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 18 KiB |
|
|
@ -0,0 +1,124 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<reference id="implementation-dependent-features">
|
||||
|
||||
<title>Implementation-dependent features</title>
|
||||
|
||||
<shortdesc>For certain features, the DITA specification allows conforming processors to choose between different
|
||||
implementation alternatives. In these cases, there may be differences in behavior when DITA content is handled by
|
||||
different processors. DITA-OT supports implementation-specific features by applying one or more of the permissible
|
||||
processing approaches.</shortdesc>
|
||||
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords> </keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
|
||||
<refbody>
|
||||
<section id="section_jla_oqn_qc">
|
||||
<title>Chunking</title>
|
||||
<indexterm><xmlatt>chunk</xmlatt>
|
||||
<indexterm>supported methods</indexterm></indexterm>
|
||||
<indexterm><xmlatt>chunk</xmlatt>
|
||||
<indexterm>error recovery</indexterm></indexterm>
|
||||
<p>DITA content can be divided or merged into new output documents in different ways, depending on the value of
|
||||
the <xmlatt>chunk</xmlatt> attribute.</p>
|
||||
<p>DITA-OT supports the following chunking methods:</p>
|
||||
<ul>
|
||||
<li>select-topic</li>
|
||||
<li>select-document</li>
|
||||
<li>select-branch</li>
|
||||
<li>by-topic</li>
|
||||
<li>by-document</li>
|
||||
<li>to-content</li>
|
||||
<li>to-navigation.</li>
|
||||
</ul>
|
||||
<p>When no chunk attribute values are given, no chunking is performed.</p>
|
||||
<note>For HTML-based transformation types, this is effectively equivalent to select-document and by-document
|
||||
defaults.</note>
|
||||
<p>Error recovery:</p>
|
||||
<ul>
|
||||
<li>When two tokens from the same category are used, no error or warning is thrown.<draft-comment>This violates
|
||||
DITA 1.2 spec.</draft-comment></li>
|
||||
<li>When an unrecognized chunking method is used, no error or warning is thrown.</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="section_zaa_bgs_qc">
|
||||
<title>Filtering</title>
|
||||
<indexterm><xmlelement>revprop</xmlelement></indexterm>
|
||||
<indexterm><xmlatt>val</xmlatt></indexterm>
|
||||
<indexterm>filters
|
||||
<indexterm>duplicate conditions</indexterm></indexterm>
|
||||
<p>Error recovery:</p>
|
||||
<ul>
|
||||
<li>When there are multiple <xmlelement>revprop</xmlelement> elements with the same <xmlatt>val</xmlatt>
|
||||
attribute, no error or warning is thrown</li>
|
||||
<li>When multiple prop elements define a duplicate attribute and value combination, attribute default, or
|
||||
fall-back behavior, the <msgnum>DOTJ007W</msgnum> warning is thrown.</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="section_kjq_egs_qc">
|
||||
<title>Debugging attributes</title>
|
||||
<indexterm>debugging
|
||||
<indexterm>attributes</indexterm>
|
||||
<indexterm>xtrf</indexterm>
|
||||
<indexterm>xtrc</indexterm></indexterm>
|
||||
<indexterm>xtrf</indexterm>
|
||||
<indexterm>xtrc</indexterm>
|
||||
<p>The debug attributes are populated as follows:</p>
|
||||
<dl>
|
||||
<dlentry>
|
||||
<dt>xtrf</dt>
|
||||
<dd>The XML trace filename is used to store the absolute system path of the original source document.</dd>
|
||||
</dlentry>
|
||||
<dlentry>
|
||||
<dt>xtrc</dt>
|
||||
<dd>The XML trace counter stores an element counter with the following format:
|
||||
<codeblock>element-name ":" integer-counter ";" line-number ":" column-number</codeblock></dd>
|
||||
</dlentry>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="section_dco_qgs_qc">
|
||||
<title>Image scaling</title>
|
||||
<indexterm>images
|
||||
<indexterm>scaling</indexterm></indexterm>
|
||||
<p>If both height and width attributes are given, the image is scaled non-uniformly.</p>
|
||||
<p>If the scale attribute is not an unsigned integer, no error or warning is thrown during preprocessing.</p>
|
||||
</section>
|
||||
<section>
|
||||
<title>Map processing</title>
|
||||
<indexterm><xmlelement>topicref</xmlelement></indexterm>
|
||||
<indexterm>map processing</indexterm>
|
||||
<p>When a <xmlelement>topicref</xmlelement> element that references a map contains child
|
||||
<xmlelement>topicref</xmlelement> elements, the <msgnum>DOTX068W</msgnum> error is thrown and the child
|
||||
<xmlelement>topicref</xmlelement> elements are ignored. </p>
|
||||
</section>
|
||||
<section id="section_h3h_jsx_1h">
|
||||
<title>Link processing</title>
|
||||
<indexterm><xmlatt>href</xmlatt></indexterm>
|
||||
<indexterm>link processing</indexterm>
|
||||
<p>When the value of a hyperlink reference in the <xmlatt>href</xmlatt> attribute is not a valid URI reference,
|
||||
the <msgnum>DOTJ054E</msgnum> error is thrown. Depending on the
|
||||
<xref href="../parameters/parameters-base.dita#base/processing-mode">processing-mode</xref> setting, error
|
||||
recovery may be attempted.</p>
|
||||
</section>
|
||||
<section>
|
||||
<title>Copy-to processing</title>
|
||||
<indexterm><xmlelement>shortdesc</xmlelement></indexterm>
|
||||
<indexterm><xmlatt>copy-to</xmlatt></indexterm>
|
||||
<p>When the <xmlatt>copy-to</xmlatt> attribute is specified on a <xmlelement>topicref</xmlelement>, the content of
|
||||
the <xmlelement>shortdesc</xmlelement> element is not used to override the short description of the topic.</p>
|
||||
</section>
|
||||
<section>
|
||||
<title>Coderef processing</title>
|
||||
<indexterm><xmlelement>coderef</xmlelement></indexterm>
|
||||
<indexterm>encoding</indexterm>
|
||||
<p>When <xmlelement>coderef</xmlelement> elements are used within code blocks to reference external files with
|
||||
literal code samples, the system default character set is used as the target file encoding unless a different
|
||||
character set is explicitly defined via the mechanisms described under
|
||||
<xref href="extended-functionality.dita#code-reference/coderef-charset"/>.</p>
|
||||
</section>
|
||||
</refbody>
|
||||
</reference>
|
||||
8
dita-ot-3.6/docsrc/reference/index.dita
Normal file
8
dita-ot-3.6/docsrc/reference/index.dita
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="reference">
|
||||
<title>Reference</title>
|
||||
<shortdesc>The <cite>Reference</cite> topics provide more advanced information about the DITA-OT architecture, OASIS
|
||||
specification support, and licensing.</shortdesc>
|
||||
</concept>
|
||||
76
dita-ot-3.6/docsrc/reference/java-api.dita
Normal file
76
dita-ot-3.6/docsrc/reference/java-api.dita
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
||||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
|
||||
<concept id="API">
|
||||
<title>Using the Java API</title>
|
||||
<shortdesc>DITA Open Toolkit includes a Java Application Programming Interface to allow developers to embed the
|
||||
toolkit more easily into other Java programs.</shortdesc>
|
||||
<prolog>
|
||||
<metadata>
|
||||
<keywords>
|
||||
<indexterm>Java
|
||||
<indexterm>API</indexterm></indexterm>
|
||||
<indexterm>API</indexterm>
|
||||
<indexterm><cmdname>dita</cmdname> command
|
||||
<indexterm>classpath</indexterm></indexterm>
|
||||
<indexterm>Java
|
||||
<indexterm>classpath</indexterm></indexterm>
|
||||
<indexterm>classpath
|
||||
<indexterm>Java</indexterm>
|
||||
<indexterm><cmdname>dita</cmdname> command</indexterm></indexterm>
|
||||
</keywords>
|
||||
</metadata>
|
||||
</prolog>
|
||||
<conbody>
|
||||
<p>When using the API, programmers don’t need to know or care that DITA-OT uses Ant, they can just use Java. </p>
|
||||
<note>When running DITA-OT via the <cmdname>dita</cmdname> command, an <codeph>ant</codeph> shell script handles the
|
||||
classpath setup, but when using the API the classpath should be set up as part of the normal classpath
|
||||
configuration for the Java application.</note>
|
||||
<example>
|
||||
<title>Example usage</title>
|
||||
<codeblock
|
||||
outputclass="language-java normalize-space show-line-numbers show-whitespace"
|
||||
>// Create a reusable processor factory with DITA-OT base directory
|
||||
ProcessorFactory pf = ProcessorFactory.newInstance(ditaDir);
|
||||
// and set the temporary directory
|
||||
pf.setBaseTempDir(tempDir);
|
||||
|
||||
// Create a processor using the factory and configure the processor
|
||||
Processor p = pf.newProcessor("html5")
|
||||
.setInput(mapFile)
|
||||
.setOutputDir(outDir)
|
||||
.setProperty("nav-toc", "partial");
|
||||
|
||||
// Run conversion
|
||||
p.run();</codeblock>
|
||||
</example>
|
||||
<section>
|
||||
<indexterm>debugging
|
||||
<indexterm>logging</indexterm></indexterm>
|
||||
<p>By default, running DITA-OT via the API will write a debug log to the temporary directory. A custom SLF4J
|
||||
logger can also be used to access the log via the Simple Logging Facade for Java.</p>
|
||||
<p>The processor cleans the temporary directory by default, but this can be disabled to simplify debugging in
|
||||
cases where the processor failed.</p>
|
||||
<note type="tip">See the <cite>DITA-OT Java API documentation</cite> in the <filepath>doc/api/</filepath> folder
|
||||
of the DITA-OT distribution package for information on the packages, classes, interfaces and methods provided by
|
||||
the Java API.</note>
|
||||
</section>
|
||||
<section>
|
||||
<title>Downloading DITA-OT from Maven Central</title>
|
||||
<indexterm>Maven Central</indexterm>
|
||||
<p>As of version 2.5, the DITA Open Toolkit base library (<filepath>dost.jar</filepath>) is available via the
|
||||
Maven 2 Central Repository. You can use this mechanism to download the main JAR file and include it in the build
|
||||
for other Java projects.</p>
|
||||
<p>To locate the latest version,
|
||||
<xref
|
||||
href="https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.dita-ot%22"
|
||||
format="html"
|
||||
scope="external"
|
||||
>search for the <codeph>org.dita-ot</codeph> group ID</xref>.</p>
|
||||
<note type="important">The <filepath>dost.jar</filepath> file provides only the DITA Open Toolkit base library. It
|
||||
does <b>not</b> contain the full DITA-OT distribution and cannot be used to run DITA-OT by itself. You will need
|
||||
to ensure that your build installs the other files and directories required for the toolkit along with the
|
||||
dependencies for your project.</note>
|
||||
</section>
|
||||
</conbody>
|
||||
</concept>
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue