apb/code-srv-test
apb/code-srv-test
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions

from code-server

Browse source
This commit is contained in:
Andy Bunce 2021-03-23 22:38:58 +00:00
parent eda5c02fe9
commit 5ef8bdba47
2652 changed files with 528235 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
3.6.zip Normal file
View file

Binary file not shown.

201
dita-ot-3.6/LICENSE Normal file
View file

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
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
http://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.

4553
dita-ot-3.6/NOTICES.txt Normal file
View file

File diff suppressed because it is too large Load diff

336
dita-ot-3.6/bin/ant Executable file
View file

@ -0,0 +1,336 @@
#! /bin/sh
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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
#
# http://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.
# Extract launch and ant arguments, (see details below).
ant_exec_args=
no_config=false
use_jikes_default=false
ant_exec_debug=false
show_help=false
for arg in "$@" ; do
if [ "$arg" = "--noconfig" ] ; then
no_config=true
elif [ "$arg" = "--usejikes" ] ; then
use_jikes_default=true
elif [ "$arg" = "--execdebug" ] ; then
ant_exec_debug=true
elif [ my"$arg" = my"--h" -o my"$arg" = my"--help" ] ; then
show_help=true
ant_exec_args="$ant_exec_args -h"
else
if [ my"$arg" = my"-h" -o my"$arg" = my"-help" ] ; then
show_help=true
fi
ant_exec_args="$ant_exec_args \"$arg\""
fi
done
# Source/default ant configuration
if $no_config ; then
rpm_mode=false
usejikes=$use_jikes_default
else
# load system-wide ant configuration (ONLY if ANT_HOME has NOT been set)
if [ -z "$ANT_HOME" -o "$ANT_HOME" = "/usr/share/ant" ]; then
if [ -f "/etc/ant.conf" ] ; then
. /etc/ant.conf
fi
fi
# load user ant configuration
if [ -f "$HOME/.ant/ant.conf" ] ; then
. $HOME/.ant/ant.conf
fi
if [ -f "$HOME/.antrc" ] ; then
. "$HOME/.antrc"
fi
# provide default configuration values
if [ -z "$rpm_mode" ] ; then
rpm_mode=false
fi
if [ -z "$usejikes" ] ; then
usejikes=$use_jikes_default
fi
fi
# Setup Java environment in rpm mode
if $rpm_mode ; then
if [ -f /usr/share/java-utils/java-functions ] ; then
. /usr/share/java-utils/java-functions
set_jvm
set_javacmd
fi
fi
# OS specific support. $var _must_ be set to either true or false.
cygwin=false;
darwin=false;
mingw=false;
case "`uname`" in
CYGWIN*) cygwin=true ;;
Darwin*) darwin=true
if [ -z "$JAVA_HOME" ] ; then
if [ -x '/usr/libexec/java_home' ] ; then
JAVA_HOME=`/usr/libexec/java_home`
elif [ -d "/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home" ]; then
JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home
fi
fi
;;
MINGW*) mingw=true ;;
esac
if [ -z "$ANT_HOME" -o ! -d "$ANT_HOME" ] ; then
## resolve links - $0 may be a link to ant's home
PRG="$0"
progname=`basename "$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
ANT_HOME=`dirname "$PRG"`/..
# make it fully qualified
ANT_HOME=`cd "$ANT_HOME" > /dev/null && pwd`
fi
# For Cygwin and Mingw, ensure paths are in UNIX format before
# anything is touched
if $cygwin ; then
[ -n "$ANT_HOME" ] &&
ANT_HOME=`cygpath --unix "$ANT_HOME"`
[ -n "$JAVA_HOME" ] &&
JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
fi
if $mingw ; then
[ -n "$ANT_HOME" ] &&
ANT_HOME="`(cd "$ANT_HOME"; pwd)`"
[ -n "$JAVA_HOME" ] &&
JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
fi
# set ANT_LIB location
ANT_LIB="${ANT_HOME}/lib"
if [ -z "$JAVACMD" ] ; then
if [ -n "$JAVA_HOME" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
JAVACMD="$JAVA_HOME/jre/sh/java"
elif [ -x "$JAVA_HOME/jre/bin/java" ] ; then
JAVACMD="$JAVA_HOME/jre/bin/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
else
JAVACMD=`which java 2> /dev/null `
if [ -z "$JAVACMD" ] ; then
JAVACMD=java
fi
fi
fi
if [ ! -x "$JAVACMD" ] ; then
echo "Error: JAVA_HOME is not defined correctly."
echo " We cannot execute $JAVACMD"
exit 1
fi
# Build local classpath using just the launcher in non-rpm mode or
# use the Jpackage helper in rpm mode with basic and default jars
# specified in the ant.conf configuration. Because the launcher is
# used, libraries linked in ANT_HOME/lib will also be included, but this
# is discouraged as it is not java-version safe. A user should
# request optional jars and their dependencies via the OPT_JAR_LIST
# variable
if $rpm_mode && [ -x /usr/bin/build-classpath ] ; then
LOCALCLASSPATH="$(/usr/bin/build-classpath ant ant-launcher jaxp_parser_impl xml-commons-apis)"
# If no optional jars have been specified then build the default list
if [ -z "$OPT_JAR_LIST" ] ; then
for file in /etc/ant.d/*; do
if [ -f "$file" ]; then
case "$file" in
*~) ;;
*#*) ;;
*.rpmsave) ;;
*.rpmnew) ;;
*)
for dep in `cat "$file"`; do
OPT_JAR_LIST="$OPT_JAR_LIST${OPT_JAR_LIST:+ }$dep"
done
esac
fi
done
fi
# If the user requested to try to add some other jars to the classpath
if [ -n "$OPT_JAR_LIST" ] ; then
_OPTCLASSPATH="$(/usr/bin/build-classpath $OPT_JAR_LIST 2> /dev/null)"
if [ -n "$_OPTCLASSPATH" ] ; then
LOCALCLASSPATH="$LOCALCLASSPATH:$_OPTCLASSPATH"
fi
fi
# Explicitly add javac path to classpath, assume JAVA_HOME set
# properly in rpm mode
if [ -f "$JAVA_HOME/lib/tools.jar" ] ; then
LOCALCLASSPATH="$LOCALCLASSPATH:$JAVA_HOME/lib/tools.jar"
fi
if [ -f "$JAVA_HOME/lib/classes.zip" ] ; then
LOCALCLASSPATH="$LOCALCLASSPATH:$JAVA_HOME/lib/classes.zip"
fi
# if CLASSPATH_OVERRIDE env var is set, LOCALCLASSPATH will be
# user CLASSPATH first and ant-found jars after.
# In that case, the user CLASSPATH will override ant-found jars
#
# if CLASSPATH_OVERRIDE is not set, we'll have the normal behaviour
# with ant-found jars first and user CLASSPATH after
if [ -n "$CLASSPATH" ] ; then
# merge local and specified classpath
if [ -z "$LOCALCLASSPATH" ] ; then
LOCALCLASSPATH="$CLASSPATH"
elif [ -n "$CLASSPATH_OVERRIDE" ] ; then
LOCALCLASSPATH="$CLASSPATH:$LOCALCLASSPATH"
else
LOCALCLASSPATH="$LOCALCLASSPATH:$CLASSPATH"
fi
# remove class path from launcher -cp option
CLASSPATH=""
fi
else
# not using rpm_mode; use launcher to determine classpaths
if [ -z "$LOCALCLASSPATH" ] ; then
LOCALCLASSPATH=$ANT_LIB/ant-launcher.jar
else
LOCALCLASSPATH=$ANT_LIB/ant-launcher.jar:$LOCALCLASSPATH
fi
fi
if [ -n "$JAVA_HOME" ] ; then
# OSX hack to make Ant work with jikes
if $darwin ; then
OSXHACK="${JAVA_HOME}/../Classes"
if [ -d "${OSXHACK}" ] ; then
for i in "${OSXHACK}"/*.jar
do
JIKESPATH="$JIKESPATH:$i"
done
fi
fi
fi
# Allow Jikes support (off by default)
if $usejikes; then
ANT_OPTS="$ANT_OPTS -Dbuild.compiler=jikes"
fi
# For Cygwin, switch paths to appropriate format before running java
# For PATHs convert to unix format first, then to windows format to ensure
# both formats are supported. Probably this will fail on directories with ;
# in the name in the path. Let's assume that paths containing ; are more
# rare than windows style paths on cygwin.
if $cygwin; then
if [ "$OS" = "Windows_NT" ] && cygpath -m .>/dev/null 2>/dev/null ; then
format=mixed
else
format=windows
fi
[ -n "$ANT_HOME" ] && ANT_HOME=`cygpath --$format "$ANT_HOME"`
ANT_LIB=`cygpath --$format "$ANT_LIB"`
[ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --$format "$JAVA_HOME"`
LCP_TEMP=`cygpath --path --unix "$LOCALCLASSPATH"`
LOCALCLASSPATH=`cygpath --path --$format "$LCP_TEMP"`
if [ -n "$CLASSPATH" ] ; then
CP_TEMP=`cygpath --path --unix "$CLASSPATH"`
CLASSPATH=`cygpath --path --$format "$CP_TEMP"`
fi
CYGHOME=`cygpath --$format "$HOME"`
fi
# Show script help if requested
if $show_help ; then
echo $0 '[script options] [options] [target [target2 [target3] ..]]'
echo 'Script Options:'
echo ' --help, --h print this message and ant help'
echo ' --noconfig suppress sourcing of /etc/ant.conf,'
echo ' $HOME/.ant/ant.conf, and $HOME/.antrc'
echo ' configuration files'
echo ' --usejikes enable use of jikes by default, unless'
echo ' set explicitly in configuration files'
echo ' --execdebug print ant exec line generated by this'
echo ' launch script'
echo ' '
fi
# add a second backslash to variables terminated by a backslash under cygwin
if $cygwin; then
case "$ANT_HOME" in
*\\ )
ANT_HOME="$ANT_HOME\\"
;;
esac
case "$CYGHOME" in
*\\ )
CYGHOME="$CYGHOME\\"
;;
esac
case "$JIKESPATH" in
*\\ )
JIKESPATH="$JIKESPATH\\"
;;
esac
case "$LOCALCLASSPATH" in
*\\ )
LOCALCLASSPATH="$LOCALCLASSPATH\\"
;;
esac
case "$CLASSPATH" in
*\\ )
CLASSPATH="$CLASSPATH\\"
;;
esac
fi
# Execute ant using eval/exec to preserve spaces in paths,
# java options, and ant args
ant_sys_opts=
if [ -n "$CYGHOME" ]; then
if [ -n "$JIKESPATH" ]; then
ant_sys_opts="-Djikes.class.path=\"$JIKESPATH\" -Dcygwin.user.home=\"$CYGHOME\""
else
ant_sys_opts="-Dcygwin.user.home=\"$CYGHOME\""
fi
else
if [ -n "$JIKESPATH" ]; then
ant_sys_opts="-Djikes.class.path=\"$JIKESPATH\""
fi
fi
ant_exec_command="exec \"$JAVACMD\" $ANT_OPTS -classpath \"$LOCALCLASSPATH\" -Dant.home=\"$ANT_HOME\" -Dant.library.dir=\"$ANT_LIB\" $ant_sys_opts org.apache.tools.ant.launch.Launcher $ANT_ARGS -cp \"$CLASSPATH\""
if $ant_exec_debug ; then
echo $ant_exec_command $ant_exec_args
fi
eval $ant_exec_command "$ant_exec_args"

218
dita-ot-3.6/bin/ant.bat Executable file
View file

@ -0,0 +1,218 @@
@echo off
REM Licensed to the Apache Software Foundation (ASF) under one or more
REM contributor license agreements. See the NOTICE file distributed with
REM this work for additional information regarding copyright ownership.
REM The ASF licenses this file to You under the Apache License, Version 2.0
REM (the "License"); you may not use this file except in compliance with
REM the License. You may obtain a copy of the License at
REM
REM http://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 This is an inordinately troublesome piece of code, particularly because it
REM tries to work on both Win9x and WinNT-based systems. If we could abandon '9x
REM support, things would be much easier, but sadly, it is not yet time.
REM Be cautious about editing this, and only add WinNT specific stuff in code that
REM only runs on WinNT.
if "%HOME%"=="" goto homeDrivePathPre
if exist "%HOME%\antrc_pre.bat" call "%HOME%\antrc_pre.bat"
:homeDrivePathPre
if "%HOMEDRIVE%%HOMEPATH%"=="" goto userProfilePre
if "%HOMEDRIVE%%HOMEPATH%"=="%HOME%" goto userProfilePre
if exist "%HOMEDRIVE%%HOMEPATH%\antrc_pre.bat" call "%HOMEDRIVE%%HOMEPATH%\antrc_pre.bat"
:userProfilePre
if "%USERPROFILE%"=="" goto alpha
if "%USERPROFILE%"=="%HOME%" goto alpha
if "%USERPROFILE%"=="%HOMEDRIVE%%HOMEPATH%" goto alpha
if exist "%USERPROFILE%\antrc_pre.bat" call "%USERPROFILE%\antrc_pre.bat"
:alpha
if "%OS%"=="Windows_NT" @setlocal
if "%OS%"=="WINNT" @setlocal
if "%ANT_HOME%"=="" goto setDefaultAntHome
:stripAntHome
if not _%ANT_HOME:~-1%==_\ goto checkClasspath
set ANT_HOME=%ANT_HOME:~0,-1%
goto stripAntHome
:setDefaultAntHome
rem %~dp0 is expanded pathname of the current script under NT
set ANT_HOME=%~dp0..
:checkClasspath
set _USE_CLASSPATH=yes
rem CLASSPATH must not be used if it is equal to ""
if "%CLASSPATH%"=="""" set _USE_CLASSPATH=no
if "%CLASSPATH%"=="" set _USE_CLASSPATH=no
rem Slurp the command line arguments. This loop allows for an unlimited number
rem of arguments (up to the command line limit, anyway).
set ANT_CMD_LINE_ARGS=
:setupArgs
if ""%1""=="""" goto doneStart
if ""%1""==""-noclasspath"" goto clearclasspath
set ANT_CMD_LINE_ARGS=%ANT_CMD_LINE_ARGS% %1
shift
goto setupArgs
rem here is there is a -noclasspath in the options
:clearclasspath
set _USE_CLASSPATH=no
shift
goto setupArgs
rem This label provides a place for the argument list loop to break out
rem and for NT handling to skip to.
:doneStart
if "%_USE_CLASSPATH%"=="no" goto findAntHome
:stripClasspath
if not _%CLASSPATH:~-1%==_\ goto findAntHome
set CLASSPATH=%CLASSPATH:~0,-1%
goto stripClasspath
:findAntHome
rem find ANT_HOME if it does not exist due to either an invalid value passed
rem by the user or the %0 problem on Windows 9x
if exist "%ANT_HOME%\lib\ant.jar" goto checkJava
rem check for ant in Program Files
if not exist "%ProgramFiles%\ant" goto checkSystemDrive
set ANT_HOME=%ProgramFiles%\ant
goto checkJava
:checkSystemDrive
rem check for ant in root directory of system drive
if not exist %SystemDrive%\ant\lib\ant.jar goto checkCDrive
set ANT_HOME=%SystemDrive%\ant
goto checkJava
:checkCDrive
rem check for ant in C:\ant for Win9X users
if not exist C:\ant\lib\ant.jar goto noAntHome
set ANT_HOME=C:\ant
goto checkJava
:noAntHome
echo ANT_HOME is set incorrectly or ant could not be located. Please set ANT_HOME.
goto end
:checkJava
set _JAVACMD=%JAVACMD%
if "%JAVA_HOME%" == "" goto noJavaHome
if not exist "%JAVA_HOME%\bin\java.exe" goto noJavaHome
if "%_JAVACMD%" == "" set _JAVACMD=%JAVA_HOME%\bin\java.exe
goto checkJikes
:noJavaHome
if "%_JAVACMD%" == "" set _JAVACMD=java.exe
:checkJikes
if not "%JIKESPATH%"=="" goto runAntWithJikes
:runAnt
if "%_USE_CLASSPATH%"=="no" goto runAntNoClasspath
:runAntWithClasspath
"%_JAVACMD%" %ANT_OPTS% -classpath "%ANT_HOME%\lib\ant-launcher.jar" "-Dant.home=%ANT_HOME%" org.apache.tools.ant.launch.Launcher %ANT_ARGS% -cp "%CLASSPATH%" %ANT_CMD_LINE_ARGS%
rem Check the error code of the Ant build
if not "%OS%"=="Windows_NT" goto onError
set ANT_ERROR=%ERRORLEVEL%
goto end
:runAntNoClasspath
"%_JAVACMD%" %ANT_OPTS% -classpath "%ANT_HOME%\lib\ant-launcher.jar" "-Dant.home=%ANT_HOME%" org.apache.tools.ant.launch.Launcher %ANT_ARGS% %ANT_CMD_LINE_ARGS%
rem Check the error code of the Ant build
if not "%OS%"=="Windows_NT" goto onError
set ANT_ERROR=%ERRORLEVEL%
goto end
:runAntWithJikes
if not _%JIKESPATH:~-1%==_\ goto checkJikesAndClasspath
set JIKESPATH=%JIKESPATH:~0,-1%
goto runAntWithJikes
:checkJikesAndClasspath
if "%_USE_CLASSPATH%"=="no" goto runAntWithJikesNoClasspath
:runAntWithJikesAndClasspath
"%_JAVACMD%" %ANT_OPTS% -classpath "%ANT_HOME%\lib\ant-launcher.jar" "-Dant.home=%ANT_HOME%" "-Djikes.class.path=%JIKESPATH%" org.apache.tools.ant.launch.Launcher %ANT_ARGS% -cp "%CLASSPATH%" %ANT_CMD_LINE_ARGS%
rem Check the error code of the Ant build
if not "%OS%"=="Windows_NT" goto onError
set ANT_ERROR=%ERRORLEVEL%
goto end
:runAntWithJikesNoClasspath
"%_JAVACMD%" %ANT_OPTS% -classpath "%ANT_HOME%\lib\ant-launcher.jar" "-Dant.home=%ANT_HOME%" "-Djikes.class.path=%JIKESPATH%" org.apache.tools.ant.launch.Launcher %ANT_ARGS% %ANT_CMD_LINE_ARGS%
rem Check the error code of the Ant build
if not "%OS%"=="Windows_NT" goto onError
set ANT_ERROR=%ERRORLEVEL%
goto end
:onError
rem Windows 9x way of checking the error code. It matches via brute force.
for %%i in (1 10 100) do set err%%i=
for %%i in (0 1 2) do if errorlevel %%i00 set err100=%%i
if %err100%==2 goto onError200
if %err100%==0 set err100=
for %%i in (0 1 2 3 4 5 6 7 8 9) do if errorlevel %err100%%%i0 set err10=%%i
if "%err100%"=="" if %err10%==0 set err10=
:onError1
for %%i in (0 1 2 3 4 5 6 7 8 9) do if errorlevel %err100%%err10%%%i set err1=%%i
goto onErrorEnd
:onError200
for %%i in (0 1 2 3 4 5) do if errorlevel 2%%i0 set err10=%%i
if err10==5 for %%i in (0 1 2 3 4 5) do if errorlevel 25%%i set err1=%%i
if not err10==5 goto onError1
:onErrorEnd
set ANT_ERROR=%err100%%err10%%err1%
for %%i in (1 10 100) do set err%%i=
:end
rem bug ID 32069: resetting an undefined env variable changes the errorlevel.
if not "%_JAVACMD%"=="" set _JAVACMD=
if not "%_ANT_CMD_LINE_ARGS%"=="" set ANT_CMD_LINE_ARGS=
if "%ANT_ERROR%"=="0" goto mainEnd
goto omega
:mainEnd
rem If there were no errors, we run the post script.
if "%OS%"=="Windows_NT" @endlocal
if "%OS%"=="WINNT" @endlocal
if "%HOME%"=="" goto homeDrivePathPost
if exist "%HOME%\antrc_post.bat" call "%HOME%\antrc_post.bat"
:homeDrivePathPost
if "%HOMEDRIVE%%HOMEPATH%"=="" goto userProfilePost
if "%HOMEDRIVE%%HOMEPATH%"=="%HOME%" goto userProfilePost
if exist "%HOMEDRIVE%%HOMEPATH%\antrc_post.bat" call "%HOMEDRIVE%%HOMEPATH%\antrc_post.bat"
:userProfilePost
if "%USERPROFILE%"=="" goto omega
if "%USERPROFILE%"=="%HOME%" goto omega
if "%USERPROFILE%"=="%HOMEDRIVE%%HOMEPATH%" goto omega
if exist "%USERPROFILE%\antrc_post.bat" call "%USERPROFILE%\antrc_post.bat"
:omega
exit /b %ANT_ERROR%

179
dita-ot-3.6/bin/dita Executable file
View file

@ -0,0 +1,179 @@
#! /bin/sh
# This file is part of the DITA Open Toolkit project.
# See the accompanying LICENSE file for applicable license.
# Derived from Apache Ant command line tool.
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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
#
# http://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.
# Extract launch and ant arguments, (see details below).
ant_exec_args=
for arg in "$@" ; do
if [ my"$arg" = my"--h" -o my"$arg" = my"--help" ] ; then
ant_exec_args="$ant_exec_args -h"
else
ant_exec_args="$ant_exec_args \"$arg\""
fi
done
# OS specific support. $var _must_ be set to either true or false.
cygwin=false;
darwin=false;
mingw=false;
case "`uname`" in
CYGWIN*) cygwin=true ;;
Darwin*) darwin=true
if [ -z "$JAVA_HOME" ] ; then
JAVA_HOME=`/usr/libexec/java_home`
fi
;;
MINGW*) mingw=true ;;
esac
if [ -z "$DITA_HOME" -o ! -d "$DITA_HOME" ] ; then
## resolve links - $0 may be a link to ant's home
PRG="$0"
progname=`basename "$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
DITA_HOME=`dirname "$PRG"`/..
# make it fully qualified
DITA_HOME=`cd "$DITA_HOME" > /dev/null && pwd`
fi
# Set environment variables
. "$DITA_HOME/config/env.sh"
# Add build script to arguments
ant_exec_args="$ant_exec_args \"-buildfile\" \"$DITA_HOME/build.xml\" \"-main\" \"org.dita.dost.invoker.Main\""
# For Cygwin and Mingw, ensure paths are in UNIX format before
# anything is touched
if $cygwin ; then
[ -n "$DITA_HOME" ] &&
DITA_HOME=`cygpath --unix "$DITA_HOME"`
[ -n "$JAVA_HOME" ] &&
JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
fi
if $mingw ; then
[ -n "$DITA_HOME" ] &&
DITA_HOME="`(cd "$DITA_HOME"; pwd)`"
[ -n "$JAVA_HOME" ] &&
JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
fi
# set ANT_LIB location
ANT_LIB="${DITA_HOME}/lib"
ANT_CONFIG="${DITA_HOME}/config"
if [ -z "$JAVACMD" ] ; then
if [ -n "$JAVA_HOME" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
JAVACMD="$JAVA_HOME/jre/sh/java"
elif [ -x "$JAVA_HOME/jre/bin/java" ] ; then
JAVACMD="$JAVA_HOME/jre/bin/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
else
JAVACMD=`which java 2> /dev/null `
if [ -z "$JAVACMD" ] ; then
JAVACMD=java
fi
fi
fi
if [ ! -x "$JAVACMD" ] ; then
echo "Error: JAVA_HOME is not defined correctly."
echo " We cannot execute $JAVACMD"
exit 1
fi
# use launcher to determine classpaths
if [ -z "$LOCALCLASSPATH" ] ; then
LOCALCLASSPATH=$ANT_LIB/ant-launcher.jar:$ANT_CONFIG
else
LOCALCLASSPATH=$ANT_LIB/ant-launcher.jar:$ANT_CONFIG:$LOCALCLASSPATH
fi
# For Cygwin, switch paths to appropriate format before running java
# For PATHs convert to unix format first, then to windows format to ensure
# both formats are supported. Probably this will fail on directories with ;
# in the name in the path. Let's assume that paths containing ; are more
# rare than windows style paths on cygwin.
if $cygwin; then
if [ "$OS" = "Windows_NT" ] && cygpath -m .>/dev/null 2>/dev/null ; then
format=mixed
else
format=windows
fi
[ -n "$DITA_HOME" ] && DITA_HOME=`cygpath --$format "$DITA_HOME"`
ANT_LIB=`cygpath --$format "$ANT_LIB"`
[ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --$format "$JAVA_HOME"`
LCP_TEMP=`cygpath --path --unix "$LOCALCLASSPATH"`
LOCALCLASSPATH=`cygpath --path --$format "$LCP_TEMP"`
if [ -n "$CLASSPATH" ] ; then
CP_TEMP=`cygpath --path --unix "$CLASSPATH"`
CLASSPATH=`cygpath --path --$format "$CP_TEMP"`
fi
CYGHOME=`cygpath --$format "$HOME"`
fi
# add a second backslash to variables terminated by a backslash under cygwin
if $cygwin; then
case "$DITA_HOME" in
*\\ )
DITA_HOME="$DITA_HOME\\"
;;
esac
case "$CYGHOME" in
*\\ )
CYGHOME="$CYGHOME\\"
;;
esac
case "$LOCALCLASSPATH" in
*\\ )
LOCALCLASSPATH="$LOCALCLASSPATH\\"
;;
esac
case "$CLASSPATH" in
*\\ )
CLASSPATH="$CLASSPATH\\"
;;
esac
fi
# Execute ant using eval/exec to preserve spaces in paths,
# java options, and ant args
ant_sys_opts=
if [ -n "$CYGHOME" ]; then
ant_sys_opts="-Dcygwin.user.home=\"$CYGHOME\""
fi
ant_exec_command="exec \"$JAVACMD\" $ANT_OPTS -Djava.awt.headless=true -classpath \"$LOCALCLASSPATH\" -Dant.home=\"$DITA_HOME\" -Ddita.dir=\"$DITA_HOME\" -Dant.library.dir=\"$ANT_LIB\" $ant_sys_opts org.apache.tools.ant.launch.Launcher $ANT_ARGS -cp \"$CLASSPATH\""
eval $ant_exec_command "$ant_exec_args"

102
dita-ot-3.6/bin/dita.bat Executable file
View file

@ -0,0 +1,102 @@
@echo off
REM This file is part of the DITA Open Toolkit project.
REM See the accompanying LICENSE file for applicable license.
REM Derived from Apache Ant command line tool.
REM Licensed to the Apache Software Foundation (ASF) under one or more
REM contributor license agreements. See the NOTICE file distributed with
REM this work for additional information regarding copyright ownership.
REM The ASF licenses this file to You under the Apache License, Version 2.0
REM (the "License"); you may not use this file except in compliance with
REM the License. You may obtain a copy of the License at
REM
REM http://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.
if "%OS%"=="Windows_NT" @setlocal
if "%OS%"=="WINNT" @setlocal
if "%DITA_HOME%"=="" goto setDefaultDitaHome
:setDefaultDitaHome
rem %~dp0 is expanded pathname of the current script under NT
set DITA_HOME=%~dp0..
rem Slurp the command line arguments. This loop allows for an unlimited number
rem of arguments (up to the command line limit, anyway).
set DITA_CMD_LINE_ARGS=
:setupArgs
if ""%1""=="""" goto doneStart
set DITA_CMD_LINE_ARGS=%DITA_CMD_LINE_ARGS% %1
shift
goto setupArgs
rem This label provides a place for the argument list loop to break out
rem and for NT handling to skip to.
:doneStart
:checkJava
rem Set environment variables
call "%DITA_HOME%\config\env.bat"
set _JAVACMD=%JAVACMD%
if "%JAVA_HOME%" == "" goto noJavaHome
if not exist "%JAVA_HOME%\bin\java.exe" goto noJavaHome
if "%_JAVACMD%" == "" set _JAVACMD=%JAVA_HOME%\bin\java.exe
:noJavaHome
if "%_JAVACMD%" == "" set _JAVACMD=java.exe
:runAnt
"%_JAVACMD%" %ANT_OPTS% -Djava.awt.headless=true -classpath "%DITA_HOME%\lib\ant-launcher.jar;%DITA_HOME%\config" "-Dant.home=%DITA_HOME%" "-Ddita.dir=%DITA_HOME%" org.apache.tools.ant.launch.Launcher %ANT_ARGS% -cp "%CLASSPATH%" %DITA_CMD_LINE_ARGS% -buildfile "%DITA_HOME%\build.xml" -main "org.dita.dost.invoker.Main"
rem Check the error code of the Ant build
if not "%OS%"=="Windows_NT" goto onError
set ANT_ERROR=%ERRORLEVEL%
goto end
:onError
rem Windows 9x way of checking the error code. It matches via brute force.
for %%i in (1 10 100) do set err%%i=
for %%i in (0 1 2) do if errorlevel %%i00 set err100=%%i
if %err100%==2 goto onError200
if %err100%==0 set err100=
for %%i in (0 1 2 3 4 5 6 7 8 9) do if errorlevel %err100%%%i0 set err10=%%i
if "%err100%"=="" if %err10%==0 set err10=
:onError1
for %%i in (0 1 2 3 4 5 6 7 8 9) do if errorlevel %err100%%err10%%%i set err1=%%i
goto onErrorEnd
:onError200
for %%i in (0 1 2 3 4 5) do if errorlevel 2%%i0 set err10=%%i
if err10==5 for %%i in (0 1 2 3 4 5) do if errorlevel 25%%i set err1=%%i
if not err10==5 goto onError1
:onErrorEnd
set ANT_ERROR=%err100%%err10%%err1%
for %%i in (1 10 100) do set err%%i=
:end
rem bug ID 32069: resetting an undefined env variable changes the errorlevel.
if not "%_JAVACMD%"=="" set _JAVACMD=
if not "%_DITA_CMD_LINE_ARGS%"=="" set DITA_CMD_LINE_ARGS=
if "%ANT_ERROR%"=="0" goto mainEnd
goto omega
:mainEnd
rem If there were no errors, we run the post script.
if "%OS%"=="Windows_NT" @endlocal
if "%OS%"=="WINNT" @endlocal
:omega
exit /b %ANT_ERROR%

23
dita-ot-3.6/build.xml Normal file
View file

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the DITA Open Toolkit project.
Copyright 2006 IBM Corporation
See the accompanying LICENSE file for applicable license.
-->
<project name="DOST" default="init">
<!-- Initialize DITA-OT base directory -->
<dirname property="ant.file.DOST.dir" file="${ant.file.DOST}" />
<property name="dita.dir" location="${ant.file.DOST.dir}"/>
<!-- XXX Is this ever used? -->
<property name="dita.dir" location="${basedir}"/>
<property file="${dita.dir}/local.properties"/>
<import>
<fileset file="${dita.dir}/plugins/org.dita.base/build.xml"/>
</import>
</project>

14
dita-ot-3.6/catalog-dita.xml Normal file
View file

@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the DITA Open Toolkit project.
Copyright 2019 Jarno Elovirta
See the accompanying LICENSE file for applicable license.
-->
<!-- Deprecated since 3.3: legacy support for catalog file in the root directory -->
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
<nextCatalog catalog="plugins/org.dita.base/catalog-dita.xml"/>
</catalog>

10
dita-ot-3.6/config/CatalogManager.properties Normal file
View file

@ -0,0 +1,10 @@
# This file is part of the DITA Open Toolkit project.
#
# Copyright 2006 IBM Corporation
#
# See the accompanying LICENSE file for applicable license.
catalogs=
relative-catalogs=no
prefer=public
static-catalog=yes
verbosity=0

20
dita-ot-3.6/config/configuration.properties Normal file
View file

@ -0,0 +1,20 @@
# This file is part of the DITA Open Toolkit project.
#
# Copyright 2011 Jarno Elovirta
#
# See the accompanying LICENSE file for applicable license.
#DITA-OT configuration properties
default.cascade = merge
temp-file-name-scheme = org.dita.dost.module.reader.DefaultTempFileScheme
#filter-attributes =
#flag-attributes =
cli.color = true
# Integration
plugindirs = plugins;demo
plugin.ignores =
plugin.order = org.dita.base org.oasis-open.dita.v1_3 org.oasis-open.dita.v1_2
registry = https://plugins.dita-ot.org/
# PDF2 defaults
org.dita.pdf2.i18n.enabled = true

44
dita-ot-3.6/config/env.bat Executable file
View file

@ -0,0 +1,44 @@
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.eclipsehelp\lib\eclipsehelp.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.htmlhelp\lib\htmlhelp.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.index\lib\index.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2\lib\fo.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.axf\lib\axf.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.fop\lib\batik-all-1.13.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.fop\lib\fontbox-2.0.21.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.fop\lib\fop-2.5.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.fop\lib\fop-pdf-images-2.5.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.fop\lib\jcl-over-slf4j-1.7.30.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.fop\lib\xml-apis-ext-1.3.04.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.fop\lib\pdfbox-2.0.21.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.fop\lib\slf4j-api-1.7.30.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.fop\lib\xmlgraphics-commons-2.4.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.dita.pdf2.xep\lib\xep.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\org.lwdita-2.4.0.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\htmlparser-1.4.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-profile-pegdown-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-abbreviation-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-anchorlink-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-aside-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-autolink-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-definition-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-html-parser-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-escaped-character-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-footnotes-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-jira-converter-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-youtrack-converter-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-gfm-strikethrough-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-gfm-tables-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-gfm-tasklist-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-jekyll-front-matter-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-jekyll-tag-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-ins-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-superscript-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-tables-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-toc-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-typographic-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-wikilink-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-ext-yaml-front-matter-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-formatter-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\flexmark-util-0.50.18.jar"
set "CLASSPATH=%CLASSPATH%;%DITA_HOME%\plugins\org.lwdita\lib\autolink-0.6.0.jar"

45
dita-ot-3.6/config/env.sh Executable file
View file

@ -0,0 +1,45 @@
#!/bin/sh
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.eclipsehelp/lib/eclipsehelp.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.htmlhelp/lib/htmlhelp.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.index/lib/index.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2/lib/fo.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.axf/lib/axf.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.fop/lib/batik-all-1.13.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.fop/lib/fontbox-2.0.21.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.fop/lib/fop-2.5.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.fop/lib/fop-pdf-images-2.5.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.fop/lib/jcl-over-slf4j-1.7.30.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.fop/lib/xml-apis-ext-1.3.04.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.fop/lib/pdfbox-2.0.21.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.fop/lib/slf4j-api-1.7.30.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.fop/lib/xmlgraphics-commons-2.4.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.dita.pdf2.xep/lib/xep.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/org.lwdita-2.4.0.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/htmlparser-1.4.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-profile-pegdown-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-abbreviation-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-anchorlink-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-aside-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-autolink-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-definition-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-html-parser-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-escaped-character-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-footnotes-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-jira-converter-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-youtrack-converter-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-gfm-strikethrough-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-gfm-tables-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-gfm-tasklist-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-jekyll-front-matter-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-jekyll-tag-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-ins-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-superscript-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-tables-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-toc-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-typographic-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-wikilink-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-ext-yaml-front-matter-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-formatter-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/flexmark-util-0.50.18.jar"
CLASSPATH="$CLASSPATH:$DITA_HOME/plugins/org.lwdita/lib/autolink-0.6.0.jar"

15
dita-ot-3.6/config/log4j.properties Normal file
View file

@ -0,0 +1,15 @@
# This file is part of the DITA Open Toolkit project.
#
# Copyright 2010 IBM Corporation
#
# See the accompanying LICENSE file for applicable license.
log4j.rootLogger=INFO, CONSOLE
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
#log4j.appender.CONSOLE.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x -%m%n
log4j.appender.CONSOLE.layout.ConversionPattern=[%p] %m%n
log4j.logger.org.apache.fop.fonts.truetype.TTFFile=WARN
log4j.logger.org.apache.fop.apps.FOUserAgent=ERROR
log4j.logger.org.apache.fop.complexscripts.fonts.GlyphCoverageTable=WARN
log4j.logger.org.apache.fop.apps.FopFactoryConfigurator=WARN

19
dita-ot-3.6/config/logback.xml Normal file
View file

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>[%level] %msg%n</pattern>
<!--pattern>
%d{HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n
</pattern-->
</encoder>
</appender>
<logger name="FOP" level="INFO"/>
<logger name="org.apache.fop" level="INFO"/>
<logger name="org.apache.fop.apps.FopConfParser" level="WARN"/>
<logger name="org.apache.xmlgraphics" level="INFO"/>
<logger name="org.apache.http" level="INFO"/>
<root level="DEBUG">
<appender-ref ref="STDOUT" />
</root>
</configuration>

941
dita-ot-3.6/config/messages.xml Normal file
View file

@ -0,0 +1,941 @@
<?xml version="1.0" encoding="UTF-8"?><!--
This file is part of the DITA Open Toolkit project.
Copyright 2005, 2006 IBM Corporation
See the accompanying LICENSE file for applicable license.
--><messages xmlns:dita="http://dita-ot.sourceforge.net">
<!-- Start of Ant Messages -->
<message id="DOTA001F" type="FATAL">
<reason>"%1" is not a recognized transformation type.</reason>
<response>Supported transformation types are dita, eclipsehelp, html5, htmlhelp, markdown, markdown_gitbook, markdown_github, pdf, pdf2, xhtml.</response>
</message>
<message id="DOTA002F" type="FATAL">
<reason>Input file is not specified, or is specified using the wrong parameter.</reason>
<response/>
</message>
<message id="DOTA069F" type="FATAL">
<reason>Input file '%1' cannot be located or read.</reason>
<response>Ensure that file was specified properly and that you have permission to access it.</response>
</message>
<message id="DOTA003F" type="FATAL">
<reason>Cannot find the user specified XSLT stylesheet '%1'.</reason>
<response/>
</message>
<message id="DOTA004F" type="FATAL">
<reason>Invalid DITA topic extension '%1'.</reason>
<response>Supported values are '.dita' and '.xml'.</response>
</message>
<message id="DOTA011W" type="WARN">
<reason>Argument "%1" is deprecated.</reason>
<response>This argument is no longer supported in the toolkit.</response>
</message>
<message id="DOTA012W" type="WARN">
<reason>Argument "%1" is deprecated.</reason>
<response>Please use the argument "%2" instead.</response>
</message>
<message id="DOTA013F" type="FATAL">
<reason>Cannot find the specified DITAVAL '%1'.</reason>
<response/>
</message>
<message id="DOTA014W" type="WARN">
<reason>Attribute @%1 is deprecated.</reason>
<response>Use attribute @%2 instead.</response>
</message>
<!-- Start of Java Messages -->
<!-- DOTJ005F appears to indicate an internal programming error, failed to create
a new module in ModuleFactory.java. This message should be updated
to indicate it is an internal programming error and should be reported to the
toolkit development team. -->&gt;
<message id="DOTJ005F" type="FATAL">
<reason>Failed to create new instance for '%1'.</reason>
<response>Please ensure that '%1' exists and that you have permission to access it.</response>
</message>
<message id="DOTJ007I" type="INFO">
<reason>Duplicate condition in filter file for rule '%1'.</reason>
<response>The first encountered condition will be used.</response>
</message>
<message id="DOTJ007W" type="WARN">
<reason>Duplicate condition in filter file for rule '%1'.</reason>
<response>The first encountered condition will be used.</response>
</message>
<message id="DOTJ007E" type="ERROR">
<reason>Duplicate condition in filter file for rule '%1'.</reason>
<response>The first encountered condition will be used.</response>
</message>
<!-- Would like to improve / shorten DOTJ009E but not sure how to modify. -->
<message id="DOTJ009E" type="ERROR">
<reason>Cannot overwrite file '%1' with file '%2'. The modified result may not be consumed by the following steps in the transform pipeline.</reason>
<response>Check to see whether the file is locked by some other application during the transformation process.</response>
</message>
<message id="DOTJ012F" type="FATAL">
<reason>Failed to parse the input file '%1'.</reason>
<response/>
</message>
<message id="DOTJ013E" type="ERROR">
<reason>Failed to parse the referenced file '%1'.</reason>
<response/>
</message>
<message id="DOTJ014W" type="WARN">
<reason>Found an indexterm element with no content.</reason>
<response>Setting the term to ***.</response>
</message>
<message id="DOTJ018I" type="INFO">
<reason>Log file '%1' was generated successfully in directory '%2'.</reason>
<response>Any messages from the transformation process are available in the log file; additional details about each message are available in the DITA-OT documentation.</response>
</message>
<message id="DOTJ020W" type="WARN">
<reason>At least one plug-in in '%1' is required by plug-in '%2'. Plug-in '%2' cannot be loaded.</reason>
<response>Check and see whether all prerequisite plug-ins are installed in toolkit.</response>
</message>
<!-- Message DOTJ021W deprecated in 3.4, replaced with DOTJ021E -->
<message id="DOTJ021W" type="WARN">
<reason>File '%1' will not generate output since it is invalid or all of its content has been filtered out by the ditaval file.</reason>
<response>Please check the file '%1' and the ditaval file to see if this is the intended result.</response>
</message>
<message id="DOTJ021E" type="ERROR">
<reason>File '%1' will not generate output because because all content has been filtered out by DITAVAL "exclude" conditions, or because the file is not valid DITA.</reason>
<response/>
</message>
<message id="DOTJ022F" type="FATAL">
<reason>Failed to parse the input file '%1' because all of its content has been filtered out.</reason>
<response>This will happen if the input file has filter conditions on the root element, and a ditaval excludes all content based on those conditions.</response>
</message>
<message id="DOTJ023E" type="ERROR">
<reason>Failed to get the specified image file '%1', so it will not be included with your output.</reason>
<response/>
</message>
<message id="DOTJ025E" type="ERROR">
<reason>The input to the "topic merge" transform process could not be found.</reason>
<response>Correct any earlier transform errors and try the build again, or see the DITA-OT documentation for additional causes.</response>
</message>
<message id="DOTJ026E" type="ERROR">
<reason>The "topic merge" did not generate any output.</reason>
<response>Correct any earlier transform errors and try the build again, or see the DITA-OT documentation for additional causes.</response>
</message>
<message id="DOTJ028E" type="ERROR">
<reason>No format attribute was found on a reference to file '%1', which does not appear to be a DITA file.</reason>
<response>If this is not a DITA file, set the format attribute to an appropriate value, otherwise set the format attribute to "dita".</response>
</message>
<!-- Deprecated since 3.5 -->
<message id="DOTJ029I" type="INFO">
<reason>No 'domains' attribute was found for element '&lt;%1&gt;'.</reason>
<response>This generally indicates that your DTD or Schema was not developed properly according to the DITA specification.</response>
</message>
<message id="DOTJ030I" type="INFO">
<reason>No 'class' attribute for was found for element '&lt;%1&gt;'.</reason>
<response>The element will be processed as an unknown or non-DITA element.</response>
</message>
<message id="DOTJ031I" type="INFO">
<reason>No specified rule for '%1' was found in the ditaval file. This value will use the default action, or a parent prop action if specified.</reason>
<response>To remove this message, you can specify a rule for '%1' in the ditaval file.</response>
</message>
<!-- 2012-06-12: Still need to reproduce and edit this message -->
<message id="DOTJ033E" type="ERROR">
<reason>No valid content is found in topicref '%1' during chunk processing.</reason>
<response>Please specify an existing and valid topic for the topicref.</response>
</message>
<!-- 2012-06-12: Still need to reproduce and edit this message -->
<message id="DOTJ034F" type="FATAL">
<reason>Failed to parse the input file '%1' (the content of the file is not valid).</reason>
<response>If the input file '%1' does not have a DOCTYPE declaration, please make sure that all class attributes are present in the file.</response>
</message>
<!-- 2012-06-12: Still need to edit this message -->
<message id="DOTJ035F" type="FATAL">
<reason>The file "%1" is outside the scope of the input dita/map directory.</reason>
<response>If you want to lower the severity level, please use the Ant parameter 'outer.control', and set the value to "warn" or "quiet". Otherwise, move the referenced file "%1" into the input dita/map directory.</response>
</message>
<message id="DOTJ036W" type="WARN">
<reason>The file "%1" is outside the scope of the input dita/map directory.</reason>
<response/>
</message>
<!-- 2012-06-12: Still need to edit this message -->
<message id="DOTJ037W" type="WARN">
<reason>The XML schema and DTD validation function of the parser is turned off.</reason>
<response>Please make sure the input is normalized DITA with class attributes included, otherwise it will not be processed correctly.</response>
</message>
<message id="DOTJ038E" type="ERROR">
<reason>The tag "%1" is specialized from unrecognized metadata.</reason>
<response>Please make sure that tag "%1" is specialized from an existing metadata tag in the core DITA vocabulary.</response>
</message>
<message id="DOTJ039E" type="ERROR">
<reason>There is no target specified for conref push action "pushafter".</reason>
<response>Please add &lt;elementname conref="pushtarget" conaction="mark"&gt; before current element.</response>
</message>
<message id="DOTJ040E" type="ERROR">
<reason>An element uses the attribute conaction="replace", but a conref attribute is not found in the expected location.</reason>
<response/>
</message>
<!-- Note, the following message comes from the Java conref-push module, XSL based message later catches regular conref (DOTX014E and DOTX015)-->
<message id="DOTJ041E" type="ERROR">
<reason>The attribute conref="%1" uses invalid syntax.</reason>
<response>The value should contain '#' followed by a topic or map ID, optionally followed by '/elemID' for a sub-topic element.</response>
</message>
<message id="DOTJ042E" type="ERROR">
<reason>Two elements both use conref push to replace the target "%1".</reason>
<response>Please delete one of the duplicate "replace" actions.</response>
</message>
<message id="DOTJ043W" type="WARN">
<reason>The conref push function is trying to replace an element that does not exist (element "%1" in file "%2").</reason>
<response/>
</message>
<!-- 2012-06-12: Still need to reproduce and edit this message -->
<message id="DOTJ044W" type="WARN">
<reason>There is a redundant conref action "pushbefore".</reason>
<response>Please make sure that "mark" and "pushbefore" occur in pairs.</response>
</message>
<message id="DOTJ045I" type="INFO">
<reason>The key "%1" is defined more than once in the same map file.</reason>
<response/>
</message>
<message id="DOTJ046E" type="ERROR">
<reason>Conkeyref="%1" can not be resolved because it does not contain a key or the key is not defined.</reason>
<response>The build will use the conref attribute for fallback, if one exists.</response>
</message>
<message id="DOTJ047I" type="INFO">
<reason>Unable to find key definition for key reference "%1" in root scope.</reason>
<response>The href attribute may be used as fallback if it exists</response>
</message>
<message id="DOTJ048I" type="INFO">
<reason>Unable to find key definition for key reference "%1" in scope "%2".</reason>
<response>The href attribute may be used as fallback if it exists</response>
</message>
<message id="DOTJ049W" type="WARN">
<reason>The attribute value %1="%3" on element "%2" does not comply with the specified subject scheme.</reason>
<response>According to the subject scheme map, the following values are valid for the %1 attribute: %4</response>
</message>
<message id="DOTJ050W" type="WARN">
<reason>Found an &lt;index-see&gt; or &lt;index-see-also&gt; reference to the term '%1', but that term is not defined in the index.</reason>
<response/>
</message>
<!-- Long term, would like to split this into two messages. One for file not found, another for file outside the scope of the map. -->
<message id="DOTJ051E" type="ERROR">
<reason>Unable to load target for coderef "%1".</reason>
<response/>
</message>
<message id="DOTJ052E" type="ERROR">
<reason>Code reference charset "%1" not supported.</reason>
<response>See the DITA-OT documentation for supported charset values on the format attribute.</response>
</message>
<!-- Obsolete since 2.3 -->
<message id="DOTJ053W" type="WARN">
<reason>Input file '%1' is not valid DITA file name.</reason>
<response>Please check '%1' to see if it is correct. The extensions ".dita" or ".xml" are supported for DITA topics.</response>
</message>
<message id="DOTJ054E" type="ERROR">
<reason>Unable to parse invalid %1 attribute value "%2"</reason>
<response/>
</message>
<message id="DOTJ055E" type="ERROR">
<reason>Invalid key name "%1".</reason>
<response/>
</message>
<message id="DOTJ056E" type="ERROR">
<reason>Invalid xml:lang "%1".</reason>
<response/>
</message>
<message id="DOTJ057E" type="ERROR">
<reason>The id attribute value "%1" is not unique within the topic that contains it.</reason>
<response/>
</message>
<message id="DOTJ058E" type="ERROR">
<reason>Both %1 and %2 attributes defined.</reason>
<response>A single element may not contain both generalized and specialized values for the same attribute.</response>
</message>
<message id="DOTJ059E" type="ERROR">
<reason>Invalid key scope name "%1".</reason>
<response/>
</message>
<message id="DOTJ060W" type="WARN">
<reason>Key "%1" was used in conkeyref but is not bound to a DITA topic or map.</reason>
<response>Cannot resolve conkeyref value "%2" as a valid conref reference.</response>
</message>
<message id="DOTJ061E" type="ERROR">
<reason>Topic reference target is a DITA map but format attribute has not been set.</reason>
<response>Set format attribute value to "ditamap".</response>
</message>
<message id="DOTJ062E" type="ERROR">
<reason>Invalid %1 attribute value "%2".</reason>
<response/>
</message>
<message id="DOTJ063E" type="ERROR">
<reason>The cols attribute is "%1" but number of colspec elements was %2.</reason>
<response/>
</message>
<message id="DOTJ064W" type="WARN">
<reason>Chunk attribute uses both "to-content" and "by-topic" that conflict with each other.</reason>
<response>Ignoring "by-topic" token.</response>
</message>
<message id="DOTJ065I" type="INFO">
<reason>Branch filter generated topic %1 used more than once.</reason>
<response>Renaming %1 to %2.</response>
</message>
<message id="DOTJ066E" type="ERROR">
<reason>No id attribute on topic type element %1.</reason>
<response>Using generated id %2.</response>
</message>
<message id="DOTJ067E" type="ERROR">
<reason>No id attribute on topic type element %1.</reason>
<response/>
</message>
<message id="DOTJ068E" type="ERROR">
<reason>Conref action "mark" without conref target.</reason>
<response/>
</message>
<message id="DOTJ069E" type="ERROR">
<reason>Circular key definition %1.</reason>
<response/>
</message>
<message id="DOTJ070I" type="INFO">
<reason>Invalid 'class' attribute '%1' for was found for element '&lt;%2&gt;'.</reason>
<response>The element will be processed as an unknown or non-DITA element.</response>
</message>
<message id="DOTJ071E" type="ERROR">
<reason>Cannot find the specified DITAVAL '%1'.</reason>
<response/>
</message>
<message id="DOTJ072E" type="ERROR">
<reason>Email link without correct 'format' attribute.</reason>
<response>Using 'format' attribute value 'email'.</response>
</message>
<message id="DOTJ073E" type="ERROR">
<reason>Email link without correct 'scope' attribute.</reason>
<response>Using 'scope' attribute value 'external'.</response>
</message>
<message id="DOTJ074W" type="WARN">
<reason>Rev attribute cannot be used with prop filter.</reason>
<response/>
</message>
<message id="DOTJ075W" type="WARN">
<reason>Absolute link '%1' without correct 'scope' attribute.</reason>
<response>Using 'scope' attribute value 'external'.</response>
</message>
<message id="DOTJ076W" type="WARN">
<reason>Absolute link '%1' without correct 'scope' attribute.</reason>
<response/>
</message>
<message id="DOTJ077F" type="FATAL">
<reason>Invalid action attribute '%1' on DITAVAL property.</reason>
<response/>
</message>
<message id="DOTJ078F" type="FATAL">
<reason>Input file '%1' could not be loaded.</reason>
<response>Ensure that grammar files for this document type are referenced and installed properly.</response>
</message>
<message id="DOTJ079E" type="ERROR">
<reason>File '%1' could not be loaded.</reason>
<response>Ensure that grammar files for this document type are referenced and installed properly.</response>
</message>
<message id="DOTJ080W" type="WARN">
<reason>Integrator configuration '%1' has been deprecated.</reason>
<response>Use plugin configuration '%1' instead.</response>
</message>
<message id="DOTJ081W" type="WARN">
<reason>Ignoring empty conref attribute conref="".</reason>
<response/>
</message>
<message id="DOTJ082E" type="ERROR">
<reason>Processing table cell failed.</reason>
<response/>
</message>
<message id="DOTJ083E" type="ERROR">
<reason>The resource referenced as %1 is capitalized differently on disk</reason>
<response/>
</message>
<!-- End of Java Messages -->
<!-- Start of XSL Messages -->
<message id="DOTX001W" type="WARN">
<reason>No string named '%1' was found for language '%2'. Using the default language '%3'.</reason>
<response>Add a mapping between default language and desired language for the string '%1'.</response>
</message>
<message id="DOTX002W" type="WARN">
<reason>The title element or attribute in the ditamap is required for Eclipse output.</reason>
<response/>
</message>
<message id="DOTX003I" type="INFO">
<reason>The anchorref attribute should either reference another dita map or an Eclipse XML TOC file. The value '%1' does not appear to reference either.</reason>
<response/>
</message>
<message id="DOTX004I" type="INFO">
<reason>Found a navref element that does not reference anything.</reason>
<response>The navref element should either reference another dita map or an Eclipse XML file.</response>
</message>
<message id="DOTX005E" type="ERROR">
<reason>Unable to find navigation title for reference to '%1'.</reason>
<response>The build will use '%1' as the title in the Eclipse Table of Contents.</response>
</message>
<message id="DOTX006E" type="ERROR">
<reason>Unknown file extension in href="%1".</reason>
<response>References to non-DITA resources should set the format attribute to match the resource (for example, 'txt', 'pdf', or 'html').</response>
</message>
<message id="DOTX007I" type="INFO">
<reason>Only DITA topics, HTML files, and images may be included in your compiled CHM file. The reference to "%1" will be ignored.</reason>
<response>To remove this message, you can set the toc="no" or processing-role="resource-only" attribute on your topicref.</response>
</message>
<!-- As of 20012-06-13, DOTX008W is only called for HTML Help and map2htmtoc -->
<message id="DOTX008W" type="WARN">
<reason>File '%1' cannot be loaded, and no navigation title is specified for the table of contents.</reason>
<response/>
</message>
<!-- DOTX008E uses the XSLT prefix DOTX, but generated only from Java code. -->
<message id="DOTX008E" type="ERROR">
<reason>File '%1' does not exist or cannot be loaded.</reason>
<response/>
</message>
<!-- As of 20012-06-13, 009W is only called for HTML Help and map2htmtoc -->
<message id="DOTX009W" type="WARN">
<reason>Could not retrieve a title from '%1'. Using '%2' instead.</reason>
<response/>
</message>
<message id="DOTX010E" type="ERROR">
<reason>Unable to find target for conref="%1".</reason>
<response/>
</message>
<message id="DOTX011W" type="WARN">
<reason>There is more than one possible target for the reference conref="%1". Only the first will be used.</reason>
<response>Remove the duplicate id in the referenced file.</response>
</message>
<!-- This message can no longer appear, though the template for producing it remains in conrefImpl.xsl.
Support for mismatched domains was added in release 1.5 or earlier. -->
<message id="DOTX012W" type="WARN">
<reason>When you conref another topic or an item in another topic, the domains attribute of the target topic must be equal to or a subset of the current topic's domains attribute.</reason>
<response>Put your target under an appropriate domain. You can see the messages guide for more help.</response>
</message>
<message id="DOTX013E" type="ERROR">
<reason>A element with attribute conref="%1" indirectly includes itself, which results in an infinite loop.</reason>
<response/>
</message>
<message id="DOTX014E" type="ERROR">
<reason>The attribute conref="%1" uses invalid syntax.</reason>
<response>Conref references to a map element should contain '#' followed by an ID, such as mymap.ditamap#mytopicrefid.</response>
</message>
<message id="DOTX015E" type="ERROR">
<reason>The attribute conref="%1" uses invalid syntax.</reason>
<response>The value should contain '#' followed by a topic or map ID, optionally followed by '/elemID' for a sub-topic element.</response>
</message>
<message id="DOTX016W" type="WARN">
<reason>A reference to "%2" appears to reference a DITA document, but the format attribute has inherited a value of "%1". The document will not be processed as DITA.</reason>
<response/>
</message>
<!-- Should likely be "warning" instead of "error", as related toolkit problems were fixed in very early releases.
Now this serves only to catch likely problems with the source content. Keeping as "error" to avoid meaningless churn. -->
<message id="DOTX017E" type="ERROR">
<reason>Found a link or cross reference with an empty href attribute (href="").</reason>
<response>Remove the empty href attribute or provide a value.</response>
</message>
<!-- 018 currently not used, commented out due to SF bug 1771123 -->
<message id="DOTX018I" type="INFO">
<reason>The type attribute on a topicref was set to '%1', but the topicref references a more specific '%2' topic. Note that the type attribute cascades in maps, so the value '%1' may come from an ancestor topicref.</reason>
<response/>
</message>
<message id="DOTX019W" type="WARN">
<reason>The type attribute on a topicref was set to '%1', but the topicref references a '%2' topic. This may cause your links to sort incorrectly in the output. Note that the type attribute cascades in maps, so the value '%1' may come from an ancestor topicref.</reason>
<response/>
</message>
<message id="DOTX020E" type="ERROR">
<reason>Missing navtitle attribute or element for peer topic "%1".</reason>
<response>References must provide a local navigation title when the target is not a local DITA resource.</response>
</message>
<message id="DOTX021E" type="ERROR">
<reason>Missing navtitle attribute or element for non-DITA resource "%1".</reason>
<response>References must provide a local navigation title when the target is not a local DITA resource.</response>
</message>
<message id="DOTX022W" type="WARN">
<reason>Unable to retrieve navtitle from target: '%1'. Using linktext (specified in topicmeta) as the navigation title.</reason>
<response/>
</message>
<message id="DOTX023W" type="WARN">
<reason>Unable to retrieve navtitle from target: '%1'.</reason>
<response/>
</message>
<message id="DOTX024E" type="ERROR">
<reason>Missing linktext and navtitle for peer topic "%1".</reason>
<response>References must provide a local navigation title when the target is not a local DITA resource.</response>
</message>
<message id="DOTX025E" type="ERROR">
<reason>Missing linktext and navtitle for non-DITA resource "%1".</reason>
<response>References must provide a local navigation title when the target is not a local DITA resource.</response>
</message>
<message id="DOTX026W" type="WARN">
<reason>Unable to retrieve linktext from target: '%1'. Using navigation title as fallback.</reason>
<response/>
</message>
<message id="DOTX027W" type="WARN">
<reason>Unable to retrieve linktext from target: '%1'.</reason>
<response/>
</message>
<message id="DOTX028E" type="ERROR">
<reason>Link or cross reference must contain a valid href or keyref attribute; no link target is specified.</reason>
<response/>
</message>
<message id="DOTX029I" type="INFO">
<reason>The type attribute on a %1 element was set to %3, but the reference is to a more specific %4 %2. This may cause your links to sort incorrectly in the output.</reason>
<response/>
</message>
<message id="DOTX030W" type="WARN">
<reason>The type attribute on a %1 element was set to %3, but the reference is to a %4 %2. This may cause your links to sort incorrectly in the output.</reason>
<response/>
</message>
<message id="DOTX031E" type="ERROR">
<reason>The file %1 is not available to resolve link information.</reason>
<response/>
</message>
<message id="DOTX032E" type="ERROR">
<reason>Unable to retrieve link text from target: '%1'.</reason>
<response>If the target is not accessible at build time, or does not have a title, provide the link text inside the reference.</response>
</message>
<message id="DOTX033E" type="ERROR">
<reason>Unable to generate link text for a cross reference to a list item: '%1'</reason>
<response/>
</message>
<message id="DOTX034E" type="ERROR">
<reason>Unable to generate link text for a cross reference to an undered list item: '%1'</reason>
<response/>
</message>
<message id="DOTX035E" type="ERROR">
<reason>Unable to generate the correct number for a cross reference to a footnote: '%1'</reason>
<response/>
</message>
<message id="DOTX036E" type="ERROR">
<reason>Unable to generate link text for a cross reference to a dlentry (the dlentry or term could not be found): '%1'</reason>
<response/>
</message>
<message id="DOTX037W" type="WARN">
<reason>No title found for this document; using "***" in XHTML title bar.</reason>
<response/>
</message>
<message id="DOTX038I" type="INFO">
<reason>The longdescref attribute on tag '%1' will be ignored. Accessibility for object elements needs to be handled another way.</reason>
<response/>
</message>
<message id="DOTX039W" type="WARN">
<reason>Required cleanup area found.</reason>
<response>To remove this message and hide the content, build your content without using the DRAFT parameter.</response>
</message>
<message id="DOTX040I" type="INFO">
<reason>Draft comment area found.</reason>
<response>To remove this message and hide the comments, build your content without using the DRAFT parameter.</response>
</message>
<message id="DOTX041W" type="WARN">
<reason>Found more than one title element in a %1 element. Using the first one for the %1's title.</reason>
<response/>
</message>
<message id="DOTX042I" type="INFO">
<reason>DITAVAL based flagging is not currently supported for inline phrases in XHTML; ignoring flag value on '%1' attribute.</reason>
<response/>
</message>
<message id="DOTX043I" type="INFO">
<reason>The link to '%1' may appear more than once in '%2'.</reason>
<response/>
</message>
<message id="DOTX044E" type="ERROR">
<reason>The area element in an image map does not specify a link target.</reason>
<response>Please add an xref element with a link target to the area element.</response>
</message>
<message id="DOTX045W" type="WARN">
<reason>The area element in an image map should specify link text for greater accessibility.</reason>
<response>Link text should be specified directly when the target is not a local DITA resource.</response>
</message>
<message id="DOTX046W" type="WARN">
<reason>Area shape should be: default, rect, circle, poly, or blank (no value). The value '%1' is not recognized.</reason>
<response/>
</message>
<message id="DOTX047W" type="WARN">
<reason>Area coordinates are blank. Coordinate points for the shape need to be specified.</reason>
<response/>
</message>
<message id="DOTX049I" type="INFO">
<reason>References to non-dita files will be ignored by the PDF, ODT, and RTF output transforms.</reason>
<response/>
</message>
<message id="DOTX050W" type="WARN">
<reason>Default id "org.sample.help.doc" is used for Eclipse plug-in.</reason>
<response>If you want to use your own plug-in id, please specify it using the id attribute on your map.</response>
</message>
<message id="DOTX052W" type="WARN">
<reason>No string named '%1' was found when creating generated text; using the value '%1' in your output file.</reason>
<response/>
</message>
<message id="DOTX053E" type="ERROR">
<reason>A element that references another map indirectly includes itself, which results in an infinite loop. The original map reference is to '%1'.</reason>
<response/>
</message>
<message id="DOTX054W" type="WARN">
<reason>Conflict text style is applied on the current element based on DITAVAL flagging rules.</reason>
<response>Please check ditaval and dita source to make sure there is no style conflict on the element which needs to be flagged.</response>
</message>
<message id="DOTX055W" type="WARN">
<reason>Customized stylesheet uses deprecated template "flagit". Conditional processing is no longer supported using this template.</reason>
<response>Please update your stylesheet to use template "start-flagit" instead of deprecated template "flagit".</response>
</message>
<message id="DOTX056W" type="WARN">
<reason>The file '%1' is not available to resolve link information.</reason>
<response/>
</message>
<message id="DOTX057W" type="WARN">
<reason>The link or cross reference target '%1' cannot be found, which may cause errors creating links or cross references in your output file.</reason>
<response/>
</message>
<message id="DOTX058W" type="WARN">
<reason>No glossary entry was found associated with key '%1' on %2 element. The build will try to determine the best display text and hover text for terms and abbreviations.</reason>
<response/>
</message>
<message id="DOTX060W" type="WARN">
<reason>Key '%1' was used in an abbreviated-form element, but the key is not associated with a glossary entry.</reason>
<response>Abbreviated-form should ONLY be used to reference to a glossary entry.</response>
</message>
<message id="DOTX061W" type="WARN">
<reason>ID '%1' was used in topicref tag but did not reference a topic element. The href attribute on a topicref element should only reference topic level elements.</reason>
<response/>
</message>
<message id="DOTX062I" type="INFO">
<reason>It appears that this document uses constraints, but the conref processor cannot validate that the target of a conref is valid.</reason>
<response>To enable constraint checking, please upgrade to an XSLT 2.0 processor.</response>
</message>
<message id="DOTX063W" type="WARN">
<reason>The dita document '%1' is linked to from your content, but is not referenced by a topicref tag in the ditamap file.</reason>
<response>Include the topic in your map to avoid a broken link.</response>
</message>
<message id="DOTX064W" type="WARN">
<reason>The copy-to attribute [copy-to="%1"] uses the name of a file that already exists, so this attribute is ignored.</reason>
<response/>
</message>
<message id="DOTX065W" type="WARN">
<reason>Two unique source files each specify copy-to="%2", which results in a collision. The value associated with href="%1" is ignored.</reason>
<response/>
</message>
<message id="DOTX066W" type="WARN">
<reason>Template "%1" is deprecated.</reason>
<response>Remove references to this template from your custom XSLT or plug-ins.</response>
</message>
<message id="DOTX067E" type="ERROR">
<reason>No string named '%1' was found for language '%2'.</reason>
<response>Add a mapping for the string '%1'.</response>
</message>
<message id="DOTX068W" type="WARN">
<reason>A topicref element that references a map contains child topicref elements.</reason>
<response>Child topicref elements are ignored.</response>
</message>
<message id="DOTX069W" type="WARN">
<reason>Template mode "%1" is deprecated.</reason>
<response>Remove references to this template mode from your custom XSLT or plug-ins.</response>
</message>
<message id="DOTX070W" type="WARN">
<reason>Target "%1" is deprecated.</reason>
<response>Remove references to this target from your custom Ant files.</response>
</message>
<message id="DOTX071W" type="WARN">
<reason>Parameter "%1" on template "%2" is deprecated.</reason>
<response>Use parameter "%3" instead.</response>
</message>
<message id="DOTX071E" type="ERROR">
<reason>Conref range: Unable to find conref range end element with ID "%1".</reason>
<response/>
</message>
<message id="DOTX072I" type="INFO">
<reason>Ignoring navtitle within topicgroup.</reason>
<response/>
</message>
<message id="DOTX073I" type="INFO">
<reason>Removing broken link to "%1".</reason>
<response/>
</message>
<message id="DOTX074W" type="WARN">
<reason>No formatting defined for unknown class attribute value "%1".</reason>
<response/>
</message>
<message id="DOTX075W" type="WARN">
<reason>A content reference in a constrained document type is pulling content from an unconstrained document type. The reference will resolve, but may result in content that violates one of the document constraints in "%1".</reason>
<response/>
</message>
<message id="DOTX076E" type="ERROR">
<reason>A content reference in a constrained document type cannot be resolved because it would violate one of the document constraints "%1".</reason>
<response>The current constrained document may only reuse content from documents with equivalent constraints.</response>
</message>
<!-- End of XSL Messages -->
<!-- Add any messages defined by plugins. -->
<message xmlns:dita="http://dita-ot.sourceforge.net" id="DOTA006W" type="WARN">
<reason>Absolute paths on the local file system are not supported for the CSSPATH parameter.</reason>
<response>Please use a relative path or full URI instead.</response>
</message>
<message id="DOTA007E" type="ERROR">
<reason>Cannot find the running-footer file "%1".</reason>
<response>Please double check the value to ensure it is specified correctly.</response>
</message>
<message id="DOTA008E" type="ERROR">
<reason>Cannot find the running-header file "%1".</reason>
<response>Please double check the value to ensure it is specified correctly.</response>
</message>
<message id="DOTA009E" type="ERROR">
<reason>Cannot find the specified heading file "%1".</reason>
<response>Please double check the value to ensure it is specified correctly.</response>
</message>
<message id="DOTA069W" type="WARN">
<reason>Target "%1" is deprecated.</reason>
<response>Remove references to this target from your custom XSLT or plug-ins.</response>
</message>
<message id="DOTX048I" type="INFO">
<reason>In order to include peer or external topic '%1' in your help file, you may need to recompile the CHM file after making the file available.</reason>
<response/>
</message>
<message id="INDX001I" type="INFO">
<reason>Index entry '%1' will be sorted under the "Special characters" heading.</reason>
<response/>
</message>
<message id="INDX002E" type="ERROR">
<reason>The PDF indexing process could not find the proper sort location for '%1', so the term has been dropped from the index.</reason>
<response/>
</message>
<message id="INDX003E" type="ERROR">
<reason>The build failed due to problems encountered when sorting the PDF index.</reason>
<response/>
</message>
<message id="DOTA066F" type="FATAL">
<reason>Cannot find the user specified XSLT stylesheet '%1'.</reason>
<response/>
</message>
<message id="PDFJ001E" type="ERROR">
<reason>The PDF indexing process could not find the proper sort location for '%1', so the term has been dropped from the index.</reason>
<response/>
</message>
<message id="PDFJ002E" type="ERROR">
<reason>The build failed due to problems encountered when sorting the PDF index.</reason>
<response>Please address any messages located earlier in the log.</response>
</message>
<message id="PDFJ003I" type="INFO">
<reason>Index entry '%1' will be sorted under the "Special characters" heading.</reason>
<response/>
</message>
<message id="XEPJ001W" type="WARN">
<reason>%1</reason>
<response/>
</message>
<message id="XEPJ002E" type="ERROR">
<reason>%1</reason>
<response/>
</message>
<message id="XEPJ003E" type="ERROR">
<reason>%1</reason>
<response/>
</message>
<message id="DOTA067W" type="WARN">
<reason>Ignoring index-see '%1' inside parent index entry '%2' because the parent indexterm contains indexterm children.</reason>
<response/>
</message>
<message id="DOTA068W" type="WARN">
<reason>Ignoring index-see-also '%1' inside parent index entry '%2' because the parent indexterm contains indexterm children.</reason>
<response/>
</message>
<message id="PDFX001W" type="WARN">
<reason>There is an index term specified with start="%1", but there is no matching end for this term.</reason>
<response>Add an index term in a valid location with end="%1".</response>
</message>
<message id="PDFX002W" type="WARN">
<reason>There are multiple index terms specified with start="%1", but there is only one term to end this range, or the ranges for this term overlap.</reason>
<response>Ensure that each term with this start value has a matching end value, and that the specified ranges for this value do not overlap</response>
</message>
<message id="PDFX003W" type="WARN">
<reason>There are multiple index entries found to close the index range for "%1".</reason>
<response>Ensure that any index term with start="%1" has only one matching end term with end="%1".</response>
</message>
<message id="PDFX004F" type="ERROR">
<reason>A topic reference was found with href="".</reason>
<response>Please specify a target or remove the href attribute.</response>
</message>
<message id="PDFX005F" type="ERROR">
<reason>The topic reference href="%1" could not be found.</reason>
<response>Please correct the reference, or set the scope or format attribute if the target is not a local DITA topic.</response>
</message>
<message id="PDFX007W" type="WARN">
<reason>Found an index term with end="%1", but no starting term was found for this entry.</reason>
<response/>
</message>
<message id="PDFX008W" type="WARN">
<reason>Font definition not found for the logical name or alias '%1'.</reason>
<response/>
</message>
<message id="PDFX009E" type="ERROR">
<reason>Attribute set reflection cannot handle XSLT element %1.</reason>
<response/>
</message>
<message id="PDFX011E" type="ERROR">
<reason>The index term '%2' uses both an index-see element and %1 element.</reason>
<response>Convert the index-see element to index-see-also.</response>
</message>
<message id="PDFX012E" type="ERROR">
<reason>Found a table row with more entries than allowed.</reason>
<response/>
</message>
<message id="PDFX013F" type="FATAL">
<reason>The PDF file '%1' could not be generated.</reason>
<response/>
</message>
</messages>

185
dita-ot-3.6/config/messages_en_US.properties Normal file
View file

@ -0,0 +1,185 @@
#Sat Dec 19 14:42:20 UTC 2020
PDFX008W=Font definition not found for the logical name or alias ''{0}''.
DOTX064W=The copy-to attribute [copy-to\="{0}"] uses the name of a file that already exists, so this attribute is ignored.
DOTX025E=Missing linktext and navtitle for non-DITA resource "{0}". References must provide a local navigation title when the target is not a local DITA resource.
PDFX012E=Found a table row with more entries than allowed.
DOTX005E=Unable to find navigation title for reference to ''{0}''. The build will use ''{0}'' as the title in the Eclipse Table of Contents.
DOTA014W=Attribute @{0} is deprecated. Use attribute @{1} instead.
DOTJ043W=The conref push function is trying to replace an element that does not exist (element "{0}" in file "{1}").
DOTJ083E=The resource referenced as {0} is capitalized differently on disk
DOTX044E=The area element in an image map does not specify a link target. Please add an xref element with a link target to the area element.
PDFX007W=Found an index term with end\="{0}", but no starting term was found for this entry.
DOTJ063E=The cols attribute is "{0}" but number of colspec elements was {1}.
DOTA069W=Target "{0}" is deprecated. Remove references to this target from your custom XSLT or plug-ins.
DOTJ079E=File ''{0}'' could not be loaded. Ensure that grammar files for this document type are referenced and installed properly.
DOTX063W=The dita document ''{0}'' is linked to from your content, but is not referenced by a topicref tag in the ditamap file. Include the topic in your map to avoid a broken link.
DOTX024E=Missing linktext and navtitle for peer topic "{0}". References must provide a local navigation title when the target is not a local DITA resource.
PDFX011E=The index term ''{1}'' uses both an index-see element and {0} element. Convert the index-see element to index-see-also.
DOTX004I=Found a navref element that does not reference anything. The navref element should either reference another dita map or an Eclipse XML file.
DOTJ059E=Invalid key scope name "{0}".
DOTJ023E=Failed to get the specified image file ''{0}'', so it will not be included with your output.
DOTJ039E=There is no target specified for conref push action "pushafter". Please add <elementname conref\="pushtarget" conaction\="mark"> before current element.
DOTX023W=Unable to retrieve navtitle from target\: ''{0}''.
DOTX039W=Required cleanup area found. To remove this message and hide the content, build your content without using the DRAFT parameter.
DOTA069F=Input file ''{0}'' cannot be located or read. Ensure that file was specified properly and that you have permission to access it.
DOTX043I=The link to ''{0}'' may appear more than once in ''{1}''.
DOTJ082E=Processing table cell failed.
DOTX019W=The type attribute on a topicref was set to ''{0}'', but the topicref references a ''{1}'' topic. This may cause your links to sort incorrectly in the output. Note that the type attribute cascades in maps, so the value ''{0}'' may come from an ancestor topicref.
DOTJ062E=Invalid {0} attribute value "{1}".
DOTA013F=Cannot find the specified DITAVAL ''{0}''.
DOTJ078F=Input file ''{0}'' could not be loaded. Ensure that grammar files for this document type are referenced and installed properly.
DOTA068W=Ignoring index-see-also ''{0}'' inside parent index entry ''{1}'' because the parent indexterm contains indexterm children.
DOTJ081W=Ignoring empty conref attribute conref\="".
DOTX003I=The anchorref attribute should either reference another dita map or an Eclipse XML TOC file. The value ''{0}'' does not appear to reference either.
DOTJ042E=Two elements both use conref push to replace the target "{0}". Please delete one of the duplicate "replace" actions.
DOTJ058E=Both {0} and {1} attributes defined. A single element may not contain both generalized and specialized values for the same attribute.
DOTA009E=Cannot find the specified heading file "{0}". Please double check the value to ensure it is specified correctly.
DOTX058W=No glossary entry was found associated with key ''{0}'' on {1} element. The build will try to determine the best display text and hover text for terms and abbreviations.
DOTJ022F=Failed to parse the input file ''{0}'' because all of its content has been filtered out. This will happen if the input file has filter conditions on the root element, and a ditaval excludes all content based on those conditions.
DOTA012W=Argument "{0}" is deprecated. Please use the argument "{1}" instead.
DOTX022W=Unable to retrieve navtitle from target\: ''{0}''. Using linktext (specified in topicmeta) as the navigation title.
DOTX062I=It appears that this document uses constraints, but the conref processor cannot validate that the target of a conref is valid. To enable constraint checking, please upgrade to an XSLT 2.0 processor.
DOTJ038E=The tag "{0}" is specialized from unrecognized metadata. Please make sure that tag "{0}" is specialized from an existing metadata tag in the core DITA vocabulary.
DOTJ018I=Log file ''{0}'' was generated successfully in directory ''{1}''. Any messages from the transformation process are available in the log file; additional details about each message are available in the DITA-OT documentation.
DOTX002W=The title element or attribute in the ditamap is required for Eclipse output.
DOTX042I=DITAVAL based flagging is not currently supported for inline phrases in XHTML; ignoring flag value on ''{0}'' attribute.
DOTJ021W=File ''{0}'' will not generate output since it is invalid or all of its content has been filtered out by the ditaval file. Please check the file ''{0}'' and the ditaval file to see if this is the intended result.
DOTJ037W=The XML schema and DTD validation function of the parser is turned off. Please make sure the input is normalized DITA with class attributes included, otherwise it will not be processed correctly.
DOTJ061E=Topic reference target is a DITA map but format attribute has not been set. Set format attribute value to "ditamap".
DOTX038I=The longdescref attribute on tag ''{0}'' will be ignored. Accessibility for object elements needs to be handled another way.
DOTJ077F=Invalid action attribute ''{0}'' on DITAVAL property.
DOTA067W=Ignoring index-see ''{0}'' inside parent index entry ''{1}'' because the parent indexterm contains indexterm children.
DOTX061W=ID ''{0}'' was used in topicref tag but did not reference a topic element. The href attribute on a topicref element should only reference topic level elements.
DOTJ080W=Integrator configuration ''{0}'' has been deprecated. Use plugin configuration ''{0}'' instead.
DOTJ041E=The attribute conref\="{0}" uses invalid syntax. The value should contain ''\#'' followed by a topic or map ID, optionally followed by ''/elemID'' for a sub-topic element.
DOTX018I=The type attribute on a topicref was set to ''{0}'', but the topicref references a more specific ''{1}'' topic. Note that the type attribute cascades in maps, so the value ''{0}'' may come from an ancestor topicref.
XEPJ003E={0}
DOTX041W=Found more than one title element in a {0} element. Using the first one for the {0}''s title.
DOTJ057E=The id attribute value "{0}" is not unique within the topic that contains it.
DOTA008E=Cannot find the running-header file "{0}". Please double check the value to ensure it is specified correctly.
DOTX057W=The link or cross reference target ''{0}'' cannot be found, which may cause errors creating links or cross references in your output file.
DOTJ060W=Key "{0}" was used in conkeyref but is not bound to a DITA topic or map. Cannot resolve conkeyref value "{1}" as a valid conref reference.
PDFX005F=The topic reference href\="{0}" could not be found. Please correct the reference, or set the scope or format attribute if the target is not a local DITA topic.
DOTA011W=Argument "{0}" is deprecated. This argument is no longer supported in the toolkit.
DOTJ021E=File ''{0}'' will not generate output because because all content has been filtered out by DITAVAL "exclude" conditions, or because the file is not valid DITA.
DOTJ076W=Absolute link ''{0}'' without correct ''scope'' attribute.
DOTX037W=No title found for this document; using "***" in XHTML title bar.
DOTX001W=No string named ''{0}'' was found for language ''{1}''. Using the default language ''{2}''. Add a mapping between default language and desired language for the string ''{0}''.
DOTJ020W=At least one plug-in in ''{0}'' is required by plug-in ''{1}''. Plug-in ''{1}'' cannot be loaded. Check and see whether all prerequisite plug-ins are installed in toolkit.
DOTJ036W=The file "{0}" is outside the scope of the input dita/map directory.
DOTX060W=Key ''{0}'' was used in an abbreviated-form element, but the key is not associated with a glossary entry. Abbreviated-form should ONLY be used to reference to a glossary entry.
DOTX021E=Missing navtitle attribute or element for non-DITA resource "{0}". References must provide a local navigation title when the target is not a local DITA resource.
DOTJ040E=An element uses the attribute conaction\="replace", but a conref attribute is not found in the expected location.
XEPJ002E={0}
DOTJ056E=Invalid xml\:lang "{0}".
DOTA007E=Cannot find the running-footer file "{0}". Please double check the value to ensure it is specified correctly.
DOTX056W=The file ''{0}'' is not available to resolve link information.
DOTX017E=Found a link or cross reference with an empty href attribute (href\=""). Remove the empty href attribute or provide a value.
PDFX004F=A topic reference was found with href\="". Please specify a target or remove the href attribute.
DOTJ075W=Absolute link ''{0}'' without correct ''scope'' attribute. Using ''scope'' attribute value ''external''.
DOTA066F=Cannot find the user specified XSLT stylesheet ''{0}''.
XEPJ001W={0}
PDFJ003I=Index entry ''{0}'' will be sorted under the "Special characters" heading.
DOTX076E=A content reference in a constrained document type cannot be resolved because it would violate one of the document constraints "{0}". The current constrained document may only reuse content from documents with equivalent constraints.
DOTA006W=Absolute paths on the local file system are not supported for the CSSPATH parameter. Please use a relative path or full URI instead.
DOTX040I=Draft comment area found. To remove this message and hide the comments, build your content without using the DRAFT parameter.
DOTX016W=A reference to "{1}" appears to reference a DITA document, but the format attribute has inherited a value of "{0}". The document will not be processed as DITA.
PDFX003W=There are multiple index entries found to close the index range for "{0}". Ensure that any index term with start\="{0}" has only one matching end term with end\="{0}".
DOTX020E=Missing navtitle attribute or element for peer topic "{0}". References must provide a local navigation title when the target is not a local DITA resource.
DOTX075W=A content reference in a constrained document type is pulling content from an unconstrained document type. The reference will resolve, but may result in content that violates one of the document constraints in "{0}".
DOTX036E=Unable to generate link text for a cross reference to a dlentry (the dlentry or term could not be found)\: ''{0}''
DOTJ055E=Invalid key name "{0}".
DOTX055W=Customized stylesheet uses deprecated template "flagit". Conditional processing is no longer supported using this template. Please update your stylesheet to use template "start-flagit" instead of deprecated template "flagit".
DOTJ035F=The file "{0}" is outside the scope of the input dita/map directory. If you want to lower the severity level, please use the Ant parameter ''outer.control'', and set the value to "warn" or "quiet". Otherwise, move the referenced file "{0}" into the input dita/map directory.
DOTJ074W=Rev attribute cannot be used with prop filter.
PDFJ002E=The build failed due to problems encountered when sorting the PDF index. Please address any messages located earlier in the log.
PDFX002W=There are multiple index terms specified with start\="{0}", but there is only one term to end this range, or the ranges for this term overlap. Ensure that each term with this start value has a matching end value, and that the specified ranges for this value do not overlap
DOTX074W=No formatting defined for unknown class attribute value "{0}".
DOTX035E=Unable to generate the correct number for a cross reference to a footnote\: ''{0}''
DOTJ014W=Found an indexterm element with no content. Setting the term to ***.
DOTJ054E=Unable to parse invalid {0} attribute value "{1}"
DOTX054W=Conflict text style is applied on the current element based on DITAVAL flagging rules. Please check ditaval and dita source to make sure there is no style conflict on the element which needs to be flagged.
DOTX015E=The attribute conref\="{0}" uses invalid syntax. The value should contain ''\#'' followed by a topic or map ID, optionally followed by ''/elemID'' for a sub-topic element.
DOTJ034F=Failed to parse the input file ''{0}'' (the content of the file is not valid). If the input file ''{0}'' does not have a DOCTYPE declaration, please make sure that all class attributes are present in the file.
DOTJ053W=Input file ''{0}'' is not valid DITA file name. Please check ''{0}'' to see if it is correct. The extensions ".dita" or ".xml" are supported for DITA topics.
INDX003E=The build failed due to problems encountered when sorting the PDF index.
PDFJ001E=The PDF indexing process could not find the proper sort location for ''{0}'', so the term has been dropped from the index.
PDFX001W=There is an index term specified with start\="{0}", but there is no matching end for this term. Add an index term in a valid location with end\="{0}".
DOTJ049W=The attribute value {0}\="{2}" on element "{1}" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the {0} attribute\: {3}
DOTJ073E=Email link without correct ''scope'' attribute. Using ''scope'' attribute value ''external''.
DOTX034E=Unable to generate link text for a cross reference to an undered list item\: ''{0}''
DOTA004F=Invalid DITA topic extension ''{0}''. Supported values are ''.dita'' and ''.xml''.
DOTJ069E=Circular key definition {0}.
DOTX014E=The attribute conref\="{0}" uses invalid syntax. Conref references to a map element should contain ''\#'' followed by an ID, such as mymap.ditamap\#mytopicrefid.
DOTX069W=Template mode "{0}" is deprecated. Remove references to this template mode from your custom XSLT or plug-ins.
DOTJ033E=No valid content is found in topicref ''{0}'' during chunk processing. Please specify an existing and valid topic for the topicref.
DOTX073I=Removing broken link to "{0}".
DOTJ029I=No ''domains'' attribute was found for element ''<{0}>''. This generally indicates that your DTD or Schema was not developed properly according to the DITA specification.
DOTJ013E=Failed to parse the referenced file ''{0}''.
INDX002E=The PDF indexing process could not find the proper sort location for ''{0}'', so the term has been dropped from the index.
DOTX053E=A element that references another map indirectly includes itself, which results in an infinite loop. The original map reference is to ''{0}''.
DOTJ009E=Cannot overwrite file ''{0}'' with file ''{1}''. The modified result may not be consumed by the following steps in the transform pipeline. Check to see whether the file is locked by some other application during the transformation process.
DOTJ072E=Email link without correct ''format'' attribute. Using ''format'' attribute value ''email''.
DOTX009W=Could not retrieve a title from ''{0}''. Using ''{1}'' instead.
DOTX049I=References to non-dita files will be ignored by the PDF, ODT, and RTF output transforms.
DOTX033E=Unable to generate link text for a cross reference to a list item\: ''{0}''
DOTJ052E=Code reference charset "{0}" not supported. See the DITA-OT documentation for supported charset values on the format attribute.
DOTA003F=Cannot find the user specified XSLT stylesheet ''{0}''.
DOTX029I=The type attribute on a {0} element was set to {2}, but the reference is to a more specific {3} {1}. This may cause your links to sort incorrectly in the output.
DOTJ068E=Conref action "mark" without conref target.
DOTX052W=No string named ''{0}'' was found when creating generated text; using the value ''{0}'' in your output file.
DOTX013E=A element with attribute conref\="{0}" indirectly includes itself, which results in an infinite loop.
DOTX068W=A topicref element that references a map contains child topicref elements. Child topicref elements are ignored.
DOTJ048I=Unable to find key definition for key reference "{0}" in scope "{1}". The href attribute may be used as fallback if it exists
DOTX072I=Ignoring navtitle within topicgroup.
INDX001I=Index entry ''{0}'' will be sorted under the "Special characters" heading.
DOTJ012F=Failed to parse the input file ''{0}''.
DOTX012W=When you conref another topic or an item in another topic, the domains attribute of the target topic must be equal to or a subset of the current topic''s domains attribute. Put your target under an appropriate domain. You can see the messages guide for more help.
DOTJ028E=No format attribute was found on a reference to file ''{0}'', which does not appear to be a DITA file. If this is not a DITA file, set the format attribute to an appropriate value, otherwise set the format attribute to "dita".
DOTJ071E=Cannot find the specified DITAVAL ''{0}''.
DOTX048I=In order to include peer or external topic ''{0}'' in your help file, you may need to recompile the CHM file after making the file available.
DOTX008W=File ''{0}'' cannot be loaded, and no navigation title is specified for the table of contents.
DOTX071W=Parameter "{0}" on template "{1}" is deprecated. Use parameter "{2}" instead.
DOTX032E=Unable to retrieve link text from target\: ''{0}''. If the target is not accessible at build time, or does not have a title, provide the link text inside the reference.
DOTA002F=Input file is not specified, or is specified using the wrong parameter.
DOTJ051E=Unable to load target for coderef "{0}".
DOTJ067E=No id attribute on topic type element {0}.
DOTJ031I=No specified rule for ''{0}'' was found in the ditaval file. This value will use the default action, or a parent prop action if specified. To remove this message, you can specify a rule for ''{0}'' in the ditaval file.
DOTX028E=Link or cross reference must contain a valid href or keyref attribute; no link target is specified.
DOTJ007W=Duplicate condition in filter file for rule ''{0}''. The first encountered condition will be used.
DOTJ047I=Unable to find key definition for key reference "{0}" in root scope. The href attribute may be used as fallback if it exists
DOTX047W=Area coordinates are blank. Coordinate points for the shape need to be specified.
DOTX008E=File ''{0}'' does not exist or cannot be loaded.
DOTX071E=Conref range\: Unable to find conref range end element with ID "{0}".
DOTJ050W=Found an <index-see> or <index-see-also> reference to the term ''{0}'', but that term is not defined in the index.
DOTX011W=There is more than one possible target for the reference conref\="{0}". Only the first will be used. Remove the duplicate id in the referenced file.
DOTX027W=Unable to retrieve linktext from target\: ''{0}''.
DOTJ007I=Duplicate condition in filter file for rule ''{0}''. The first encountered condition will be used.
DOTJ070I=Invalid ''class'' attribute ''{0}'' for was found for element ''<{1}>''. The element will be processed as an unknown or non-DITA element.
DOTX067E=No string named ''{0}'' was found for language ''{1}''. Add a mapping for the string ''{0}''.
DOTJ007E=Duplicate condition in filter file for rule ''{0}''. The first encountered condition will be used.
DOTX070W=Target "{0}" is deprecated. Remove references to this target from your custom Ant files.
DOTX031E=The file {0} is not available to resolve link information.
DOTA001F="{0}" is not a recognized transformation type. Supported transformation types are dita, eclipsehelp, html5, htmlhelp, markdown, markdown_gitbook, markdown_github, pdf, pdf2, xhtml.
DOTX050W=Default id "org.sample.help.doc" is used for Eclipse plug-in. If you want to use your own plug-in id, please specify it using the id attribute on your map.
DOTJ066E=No id attribute on topic type element {0}. Using generated id {1}.
DOTJ030I=No ''class'' attribute for was found for element ''<{0}>''. The element will be processed as an unknown or non-DITA element.
DOTX066W=Template "{0}" is deprecated. Remove references to this template from your custom XSLT or plug-ins.
DOTX007I=Only DITA topics, HTML files, and images may be included in your compiled CHM file. The reference to "{0}" will be ignored. To remove this message, you can set the toc\="no" or processing-role\="resource-only" attribute on your topicref.
DOTX030W=The type attribute on a {0} element was set to {2}, but the reference is to a {3} {1}. This may cause your links to sort incorrectly in the output.
DOTJ046E=Conkeyref\="{0}" can not be resolved because it does not contain a key or the key is not defined. The build will use the conref attribute for fallback, if one exists.
DOTX046W=Area shape should be\: default, rect, circle, poly, or blank (no value). The value ''{0}'' is not recognized.
DOTJ026E=The "topic merge" did not generate any output. Correct any earlier transform errors and try the build again, or see the DITA-OT documentation for additional causes.
DOTX026W=Unable to retrieve linktext from target\: ''{0}''. Using navigation title as fallback.
DOTJ065I=Branch filter generated topic {0} used more than once. Renaming {0} to {1}.
DOTX010E=Unable to find target for conref\="{0}".
DOTX065W=Two unique source files each specify copy-to\="{1}", which results in a collision. The value associated with href\="{0}" is ignored.
DOTJ045I=The key "{0}" is defined more than once in the same map file.
PDFX013F=The PDF file ''{0}'' could not be generated.
DOTX045W=The area element in an image map should specify link text for greater accessibility. Link text should be specified directly when the target is not a local DITA resource.
DOTX006E=Unknown file extension in href\="{0}". References to non-DITA resources should set the format attribute to match the resource (for example, ''txt'', ''pdf'', or ''html'').
DOTJ064W=Chunk attribute uses both "to-content" and "by-topic" that conflict with each other. Ignoring "by-topic" token.
DOTJ025E=The input to the "topic merge" transform process could not be found. Correct any earlier transform errors and try the build again, or see the DITA-OT documentation for additional causes.
PDFX009E=Attribute set reflection cannot handle XSLT element {0}.
DOTJ005F=Failed to create new instance for ''{0}''. Please ensure that ''{0}'' exists and that you have permission to access it.
DOTJ044W=There is a redundant conref action "pushbefore". Please make sure that "mark" and "pushbefore" occur in pairs.

819
dita-ot-3.6/config/messages_template.xml Normal file
View file

@ -0,0 +1,819 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!--
This file is part of the DITA Open Toolkit project.
Copyright 2005, 2006 IBM Corporation
See the accompanying LICENSE file for applicable license.
-->
<messages xmlns:dita="http://dita-ot.sourceforge.net">
<!-- Start of Ant Messages -->
<message id="DOTA001F" type="FATAL">
<reason>"%1" is not a recognized transformation type.</reason>
<response>Supported transformation types are <dita:extension id="dita.conductor.transtype.check" behavior="org.dita.dost.platform.ListTranstypeAction" separator=", "/>.</response>
</message>
<message id="DOTA002F" type="FATAL">
<reason>Input file is not specified, or is specified using the wrong parameter.</reason>
<response></response>
</message>
<message id="DOTA069F" type="FATAL">
<reason>Input file '%1' cannot be located or read.</reason>
<response>Ensure that file was specified properly and that you have permission to access it.</response>
</message>
<message id="DOTA003F" type="FATAL">
<reason>Cannot find the user specified XSLT stylesheet '%1'.</reason>
<response></response>
</message>
<message id="DOTA004F" type="FATAL">
<reason>Invalid DITA topic extension '%1'.</reason>
<response>Supported values are '.dita' and '.xml'.</response>
</message>
<message id="DOTA011W" type="WARN">
<reason>Argument "%1" is deprecated.</reason>
<response>This argument is no longer supported in the toolkit.</response>
</message>
<message id="DOTA012W" type="WARN">
<reason>Argument "%1" is deprecated.</reason>
<response>Please use the argument "%2" instead.</response>
</message>
<message id="DOTA013F" type="FATAL">
<reason>Cannot find the specified DITAVAL '%1'.</reason>
<response></response>
</message>
<message id="DOTA014W" type="WARN">
<reason>Attribute @%1 is deprecated.</reason>
<response>Use attribute @%2 instead.</response>
</message>
<!-- Start of Java Messages -->
<!-- DOTJ005F appears to indicate an internal programming error, failed to create
a new module in ModuleFactory.java. This message should be updated
to indicate it is an internal programming error and should be reported to the
toolkit development team. -->>
<message id="DOTJ005F" type="FATAL">
<reason>Failed to create new instance for '%1'.</reason>
<response>Please ensure that '%1' exists and that you have permission to access it.</response>
</message>
<message id="DOTJ007I" type="INFO">
<reason>Duplicate condition in filter file for rule '%1'.</reason>
<response>The first encountered condition will be used.</response>
</message>
<message id="DOTJ007W" type="WARN">
<reason>Duplicate condition in filter file for rule '%1'.</reason>
<response>The first encountered condition will be used.</response>
</message>
<message id="DOTJ007E" type="ERROR">
<reason>Duplicate condition in filter file for rule '%1'.</reason>
<response>The first encountered condition will be used.</response>
</message>
<!-- Would like to improve / shorten DOTJ009E but not sure how to modify. -->
<message id="DOTJ009E" type="ERROR">
<reason>Cannot overwrite file '%1' with file '%2'. The modified result may not be consumed by the following steps in the transform pipeline.</reason>
<response>Check to see whether the file is locked by some other application during the transformation process.</response>
</message>
<message id="DOTJ012F" type="FATAL">
<reason>Failed to parse the input file '%1'.</reason>
<response></response>
</message>
<message id="DOTJ013E" type="ERROR">
<reason>Failed to parse the referenced file '%1'.</reason>
<response></response>
</message>
<message id="DOTJ014W" type="WARN">
<reason>Found an indexterm element with no content.</reason>
<response>Setting the term to ***.</response>
</message>
<message id="DOTJ018I" type="INFO">
<reason>Log file '%1' was generated successfully in directory '%2'.</reason>
<response>Any messages from the transformation process are available in the log file; additional details about each message are available in the DITA-OT documentation.</response>
</message>
<message id="DOTJ020W" type="WARN">
<reason>At least one plug-in in '%1' is required by plug-in '%2'. Plug-in '%2' cannot be loaded.</reason>
<response>Check and see whether all prerequisite plug-ins are installed in toolkit.</response>
</message>
<!-- Message DOTJ021W deprecated in 3.4, replaced with DOTJ021E -->
<message id="DOTJ021W" type="WARN">
<reason>File '%1' will not generate output since it is invalid or all of its content has been filtered out by the ditaval file.</reason>
<response>Please check the file '%1' and the ditaval file to see if this is the intended result.</response>
</message>
<message id="DOTJ021E" type="ERROR">
<reason>File '%1' will not generate output because because all content has been filtered out by DITAVAL "exclude" conditions, or because the file is not valid DITA.</reason>
<response></response>
</message>
<message id="DOTJ022F" type="FATAL">
<reason>Failed to parse the input file '%1' because all of its content has been filtered out.</reason>
<response>This will happen if the input file has filter conditions on the root element, and a ditaval excludes all content based on those conditions.</response>
</message>
<message id="DOTJ023E" type="ERROR">
<reason>Failed to get the specified image file '%1', so it will not be included with your output.</reason>
<response></response>
</message>
<message id="DOTJ025E" type="ERROR">
<reason>The input to the "topic merge" transform process could not be found.</reason>
<response>Correct any earlier transform errors and try the build again, or see the DITA-OT documentation for additional causes.</response>
</message>
<message id="DOTJ026E" type="ERROR">
<reason>The "topic merge" did not generate any output.</reason>
<response>Correct any earlier transform errors and try the build again, or see the DITA-OT documentation for additional causes.</response>
</message>
<message id="DOTJ028E" type="ERROR">
<reason>No format attribute was found on a reference to file '%1', which does not appear to be a DITA file.</reason>
<response>If this is not a DITA file, set the format attribute to an appropriate value, otherwise set the format attribute to "dita".</response>
</message>
<!-- Deprecated since 3.5 -->
<message id="DOTJ029I" type="INFO">
<reason>No 'domains' attribute was found for element '&lt;%1&gt;'.</reason>
<response>This generally indicates that your DTD or Schema was not developed properly according to the DITA specification.</response>
</message>
<message id="DOTJ030I" type="INFO">
<reason>No 'class' attribute for was found for element '&lt;%1&gt;'.</reason>
<response>The element will be processed as an unknown or non-DITA element.</response>
</message>
<message id="DOTJ031I" type="INFO">
<reason>No specified rule for '%1' was found in the ditaval file. This value will use the default action, or a parent prop action if specified.</reason>
<response>To remove this message, you can specify a rule for '%1' in the ditaval file.</response>
</message>
<!-- 2012-06-12: Still need to reproduce and edit this message -->
<message id="DOTJ033E" type="ERROR">
<reason>No valid content is found in topicref '%1' during chunk processing.</reason>
<response>Please specify an existing and valid topic for the topicref.</response>
</message>
<!-- 2012-06-12: Still need to reproduce and edit this message -->
<message id="DOTJ034F" type="FATAL">
<reason>Failed to parse the input file '%1' (the content of the file is not valid).</reason>
<response>If the input file '%1' does not have a DOCTYPE declaration, please make sure that all class attributes are present in the file.</response>
</message>
<!-- 2012-06-12: Still need to edit this message -->
<message id="DOTJ035F" type="FATAL">
<reason>The file "%1" is outside the scope of the input dita/map directory.</reason>
<response>If you want to lower the severity level, please use the Ant parameter 'outer.control', and set the value to "warn" or "quiet". Otherwise, move the referenced file "%1" into the input dita/map directory.</response>
</message>
<message id="DOTJ036W" type="WARN">
<reason>The file "%1" is outside the scope of the input dita/map directory.</reason>
<response></response>
</message>
<!-- 2012-06-12: Still need to edit this message -->
<message id="DOTJ037W" type="WARN">
<reason>The XML schema and DTD validation function of the parser is turned off.</reason>
<response>Please make sure the input is normalized DITA with class attributes included, otherwise it will not be processed correctly.</response>
</message>
<message id="DOTJ038E" type="ERROR">
<reason>The tag "%1" is specialized from unrecognized metadata.</reason>
<response>Please make sure that tag "%1" is specialized from an existing metadata tag in the core DITA vocabulary.</response>
</message>
<message id="DOTJ039E" type="ERROR">
<reason>There is no target specified for conref push action "pushafter".</reason>
<response>Please add &lt;elementname conref="pushtarget" conaction="mark"&gt; before current element.</response>
</message>
<message id="DOTJ040E" type="ERROR">
<reason>An element uses the attribute conaction="replace", but a conref attribute is not found in the expected location.</reason>
<response></response>
</message>
<!-- Note, the following message comes from the Java conref-push module, XSL based message later catches regular conref (DOTX014E and DOTX015)-->
<message id="DOTJ041E" type="ERROR">
<reason>The attribute conref="%1" uses invalid syntax.</reason>
<response>The value should contain '#' followed by a topic or map ID, optionally followed by '/elemID' for a sub-topic element.</response>
</message>
<message id="DOTJ042E" type="ERROR">
<reason>Two elements both use conref push to replace the target "%1".</reason>
<response>Please delete one of the duplicate "replace" actions.</response>
</message>
<message id="DOTJ043W" type="WARN">
<reason>The conref push function is trying to replace an element that does not exist (element "%1" in file "%2").</reason>
<response></response>
</message>
<!-- 2012-06-12: Still need to reproduce and edit this message -->
<message id="DOTJ044W" type="WARN">
<reason>There is a redundant conref action "pushbefore".</reason>
<response>Please make sure that "mark" and "pushbefore" occur in pairs.</response>
</message>
<message id="DOTJ045I" type="INFO">
<reason>The key "%1" is defined more than once in the same map file.</reason>
<response></response>
</message>
<message id="DOTJ046E" type="ERROR">
<reason>Conkeyref="%1" can not be resolved because it does not contain a key or the key is not defined.</reason>
<response>The build will use the conref attribute for fallback, if one exists.</response>
</message>
<message id="DOTJ047I" type="INFO">
<reason>Unable to find key definition for key reference "%1" in root scope.</reason>
<response>The href attribute may be used as fallback if it exists</response>
</message>
<message id="DOTJ048I" type="INFO">
<reason>Unable to find key definition for key reference "%1" in scope "%2".</reason>
<response>The href attribute may be used as fallback if it exists</response>
</message>
<message id="DOTJ049W" type="WARN">
<reason>The attribute value %1="%3" on element "%2" does not comply with the specified subject scheme.</reason>
<response>According to the subject scheme map, the following values are valid for the %1 attribute: %4</response>
</message>
<message id="DOTJ050W" type="WARN">
<reason>Found an &lt;index-see&gt; or &lt;index-see-also&gt; reference to the term '%1', but that term is not defined in the index.</reason>
<response></response>
</message>
<!-- Long term, would like to split this into two messages. One for file not found, another for file outside the scope of the map. -->
<message id="DOTJ051E" type="ERROR">
<reason>Unable to load target for coderef "%1".</reason>
<response></response>
</message>
<message id="DOTJ052E" type="ERROR">
<reason>Code reference charset "%1" not supported.</reason>
<response>See the DITA-OT documentation for supported charset values on the format attribute.</response>
</message>
<!-- Obsolete since 2.3 -->
<message id="DOTJ053W" type="WARN">
<reason>Input file '%1' is not valid DITA file name.</reason>
<response>Please check '%1' to see if it is correct. The extensions ".dita" or ".xml" are supported for DITA topics.</response>
</message>
<message id="DOTJ054E" type="ERROR">
<reason>Unable to parse invalid %1 attribute value "%2"</reason>
<response></response>
</message>
<message id="DOTJ055E" type="ERROR">
<reason>Invalid key name "%1".</reason>
<response></response>
</message>
<message id="DOTJ056E" type="ERROR">
<reason>Invalid xml:lang "%1".</reason>
<response></response>
</message>
<message id="DOTJ057E" type="ERROR">
<reason>The id attribute value "%1" is not unique within the topic that contains it.</reason>
<response></response>
</message>
<message id="DOTJ058E" type="ERROR">
<reason>Both %1 and %2 attributes defined.</reason>
<response>A single element may not contain both generalized and specialized values for the same attribute.</response>
</message>
<message id="DOTJ059E" type="ERROR">
<reason>Invalid key scope name "%1".</reason>
<response></response>
</message>
<message id="DOTJ060W" type="WARN">
<reason>Key "%1" was used in conkeyref but is not bound to a DITA topic or map.</reason>
<response>Cannot resolve conkeyref value "%2" as a valid conref reference.</response>
</message>
<message id="DOTJ061E" type="ERROR">
<reason>Topic reference target is a DITA map but format attribute has not been set.</reason>
<response>Set format attribute value to "ditamap".</response>
</message>
<message id="DOTJ062E" type="ERROR">
<reason>Invalid %1 attribute value "%2".</reason>
<response></response>
</message>
<message id="DOTJ063E" type="ERROR">
<reason>The cols attribute is "%1" but number of colspec elements was %2.</reason>
<response></response>
</message>
<message id="DOTJ064W" type="WARN">
<reason>Chunk attribute uses both "to-content" and "by-topic" that conflict with each other.</reason>
<response>Ignoring "by-topic" token.</response>
</message>
<message id="DOTJ065I" type="INFO">
<reason>Branch filter generated topic %1 used more than once.</reason>
<response>Renaming %1 to %2.</response>
</message>
<message id="DOTJ066E" type="ERROR">
<reason>No id attribute on topic type element %1.</reason>
<response>Using generated id %2.</response>
</message>
<message id="DOTJ067E" type="ERROR">
<reason>No id attribute on topic type element %1.</reason>
<response></response>
</message>
<message id="DOTJ068E" type="ERROR">
<reason>Conref action "mark" without conref target.</reason>
<response></response>
</message>
<message id="DOTJ069E" type="ERROR">
<reason>Circular key definition %1.</reason>
<response></response>
</message>
<message id="DOTJ070I" type="INFO">
<reason>Invalid 'class' attribute '%1' for was found for element '&lt;%2&gt;'.</reason>
<response>The element will be processed as an unknown or non-DITA element.</response>
</message>
<message id="DOTJ071E" type="ERROR">
<reason>Cannot find the specified DITAVAL '%1'.</reason>
<response></response>
</message>
<message id="DOTJ072E" type="ERROR">
<reason>Email link without correct 'format' attribute.</reason>
<response>Using 'format' attribute value 'email'.</response>
</message>
<message id="DOTJ073E" type="ERROR">
<reason>Email link without correct 'scope' attribute.</reason>
<response>Using 'scope' attribute value 'external'.</response>
</message>
<message id="DOTJ074W" type="WARN">
<reason>Rev attribute cannot be used with prop filter.</reason>
<response></response>
</message>
<message id="DOTJ075W" type="WARN">
<reason>Absolute link '%1' without correct 'scope' attribute.</reason>
<response>Using 'scope' attribute value 'external'.</response>
</message>
<message id="DOTJ076W" type="WARN">
<reason>Absolute link '%1' without correct 'scope' attribute.</reason>
<response></response>
</message>
<message id="DOTJ077F" type="FATAL">
<reason>Invalid action attribute '%1' on DITAVAL property.</reason>
<response></response>
</message>
<message id="DOTJ078F" type="FATAL">
<reason>Input file '%1' could not be loaded.</reason>
<response>Ensure that grammar files for this document type are referenced and installed properly.</response>
</message>
<message id="DOTJ079E" type="ERROR">
<reason>File '%1' could not be loaded.</reason>
<response>Ensure that grammar files for this document type are referenced and installed properly.</response>
</message>
<message id="DOTJ080W" type="WARN">
<reason>Integrator configuration '%1' has been deprecated.</reason>
<response>Use plugin configuration '%1' instead.</response>
</message>
<message id="DOTJ081W" type="WARN">
<reason>Ignoring empty conref attribute conref="".</reason>
<response></response>
</message>
<message id="DOTJ082E" type="ERROR">
<reason>Processing table cell failed.</reason>
<response></response>
</message>
<message id="DOTJ083E" type="ERROR">
<reason>The resource referenced as %1 is capitalized differently on disk</reason>
<response></response>
</message>
<!-- End of Java Messages -->
<!-- Start of XSL Messages -->
<message id="DOTX001W" type="WARN">
<reason>No string named '%1' was found for language '%2'. Using the default language '%3'.</reason>
<response>Add a mapping between default language and desired language for the string '%1'.</response>
</message>
<message id="DOTX002W" type="WARN">
<reason>The title element or attribute in the ditamap is required for Eclipse output.</reason>
<response></response>
</message>
<message id="DOTX003I" type="INFO">
<reason>The anchorref attribute should either reference another dita map or an Eclipse XML TOC file. The value '%1' does not appear to reference either.</reason>
<response></response>
</message>
<message id="DOTX004I" type="INFO">
<reason>Found a navref element that does not reference anything.</reason>
<response>The navref element should either reference another dita map or an Eclipse XML file.</response>
</message>
<message id="DOTX005E" type="ERROR">
<reason>Unable to find navigation title for reference to '%1'.</reason>
<response>The build will use '%1' as the title in the Eclipse Table of Contents.</response>
</message>
<message id="DOTX006E" type="ERROR">
<reason>Unknown file extension in href="%1".</reason>
<response>References to non-DITA resources should set the format attribute to match the resource (for example, 'txt', 'pdf', or 'html').</response>
</message>
<message id="DOTX007I" type="INFO">
<reason>Only DITA topics, HTML files, and images may be included in your compiled CHM file. The reference to "%1" will be ignored.</reason>
<response>To remove this message, you can set the toc="no" or processing-role="resource-only" attribute on your topicref.</response>
</message>
<!-- As of 20012-06-13, DOTX008W is only called for HTML Help and map2htmtoc -->
<message id="DOTX008W" type="WARN">
<reason>File '%1' cannot be loaded, and no navigation title is specified for the table of contents.</reason>
<response></response>
</message>
<!-- DOTX008E uses the XSLT prefix DOTX, but generated only from Java code. -->
<message id="DOTX008E" type="ERROR">
<reason>File '%1' does not exist or cannot be loaded.</reason>
<response></response>
</message>
<!-- As of 20012-06-13, 009W is only called for HTML Help and map2htmtoc -->
<message id="DOTX009W" type="WARN">
<reason>Could not retrieve a title from '%1'. Using '%2' instead.</reason>
<response></response>
</message>
<message id="DOTX010E" type="ERROR">
<reason>Unable to find target for conref="%1".</reason>
<response></response>
</message>
<message id="DOTX011W" type="WARN">
<reason>There is more than one possible target for the reference conref="%1". Only the first will be used.</reason>
<response>Remove the duplicate id in the referenced file.</response>
</message>
<!-- This message can no longer appear, though the template for producing it remains in conrefImpl.xsl.
Support for mismatched domains was added in release 1.5 or earlier. -->
<message id="DOTX012W" type="WARN">
<reason>When you conref another topic or an item in another topic, the domains attribute of the target topic must be equal to or a subset of the current topic's domains attribute.</reason>
<response>Put your target under an appropriate domain. You can see the messages guide for more help.</response>
</message>
<message id="DOTX013E" type="ERROR">
<reason>A element with attribute conref="%1" indirectly includes itself, which results in an infinite loop.</reason>
<response></response>
</message>
<message id="DOTX014E" type="ERROR">
<reason>The attribute conref="%1" uses invalid syntax.</reason>
<response>Conref references to a map element should contain '#' followed by an ID, such as mymap.ditamap#mytopicrefid.</response>
</message>
<message id="DOTX015E" type="ERROR">
<reason>The attribute conref="%1" uses invalid syntax.</reason>
<response>The value should contain '#' followed by a topic or map ID, optionally followed by '/elemID' for a sub-topic element.</response>
</message>
<message id="DOTX016W" type="WARN">
<reason>A reference to "%2" appears to reference a DITA document, but the format attribute has inherited a value of "%1". The document will not be processed as DITA.</reason>
<response></response>
</message>
<!-- Should likely be "warning" instead of "error", as related toolkit problems were fixed in very early releases.
Now this serves only to catch likely problems with the source content. Keeping as "error" to avoid meaningless churn. -->
<message id="DOTX017E" type="ERROR">
<reason>Found a link or cross reference with an empty href attribute (href="").</reason>
<response>Remove the empty href attribute or provide a value.</response>
</message>
<!-- 018 currently not used, commented out due to SF bug 1771123 -->
<message id="DOTX018I" type="INFO">
<reason>The type attribute on a topicref was set to '%1', but the topicref references a more specific '%2' topic. Note that the type attribute cascades in maps, so the value '%1' may come from an ancestor topicref.</reason>
<response></response>
</message>
<message id="DOTX019W" type="WARN">
<reason>The type attribute on a topicref was set to '%1', but the topicref references a '%2' topic. This may cause your links to sort incorrectly in the output. Note that the type attribute cascades in maps, so the value '%1' may come from an ancestor topicref.</reason>
<response></response>
</message>
<message id="DOTX020E" type="ERROR">
<reason>Missing navtitle attribute or element for peer topic "%1".</reason>
<response>References must provide a local navigation title when the target is not a local DITA resource.</response>
</message>
<message id="DOTX021E" type="ERROR">
<reason>Missing navtitle attribute or element for non-DITA resource "%1".</reason>
<response>References must provide a local navigation title when the target is not a local DITA resource.</response>
</message>
<message id="DOTX022W" type="WARN">
<reason>Unable to retrieve navtitle from target: '%1'. Using linktext (specified in topicmeta) as the navigation title.</reason>
<response></response>
</message>
<message id="DOTX023W" type="WARN">
<reason>Unable to retrieve navtitle from target: '%1'.</reason>
<response></response>
</message>
<message id="DOTX024E" type="ERROR">
<reason>Missing linktext and navtitle for peer topic "%1".</reason>
<response>References must provide a local navigation title when the target is not a local DITA resource.</response>
</message>
<message id="DOTX025E" type="ERROR">
<reason>Missing linktext and navtitle for non-DITA resource "%1".</reason>
<response>References must provide a local navigation title when the target is not a local DITA resource.</response>
</message>
<message id="DOTX026W" type="WARN">
<reason>Unable to retrieve linktext from target: '%1'. Using navigation title as fallback.</reason>
<response></response>
</message>
<message id="DOTX027W" type="WARN">
<reason>Unable to retrieve linktext from target: '%1'.</reason>
<response></response>
</message>
<message id="DOTX028E" type="ERROR">
<reason>Link or cross reference must contain a valid href or keyref attribute; no link target is specified.</reason>
<response></response>
</message>
<message id="DOTX029I" type="INFO">
<reason>The type attribute on a %1 element was set to %3, but the reference is to a more specific %4 %2. This may cause your links to sort incorrectly in the output.</reason>
<response></response>
</message>
<message id="DOTX030W" type="WARN">
<reason>The type attribute on a %1 element was set to %3, but the reference is to a %4 %2. This may cause your links to sort incorrectly in the output.</reason>
<response></response>
</message>
<message id="DOTX031E" type="ERROR">
<reason>The file %1 is not available to resolve link information.</reason>
<response></response>
</message>
<message id="DOTX032E" type="ERROR">
<reason>Unable to retrieve link text from target: '%1'.</reason>
<response>If the target is not accessible at build time, or does not have a title, provide the link text inside the reference.</response>
</message>
<message id="DOTX033E" type="ERROR">
<reason>Unable to generate link text for a cross reference to a list item: '%1'</reason>
<response></response>
</message>
<message id="DOTX034E" type="ERROR">
<reason>Unable to generate link text for a cross reference to an undered list item: '%1'</reason>
<response></response>
</message>
<message id="DOTX035E" type="ERROR">
<reason>Unable to generate the correct number for a cross reference to a footnote: '%1'</reason>
<response></response>
</message>
<message id="DOTX036E" type="ERROR">
<reason>Unable to generate link text for a cross reference to a dlentry (the dlentry or term could not be found): '%1'</reason>
<response></response>
</message>
<message id="DOTX037W" type="WARN">
<reason>No title found for this document; using "***" in XHTML title bar.</reason>
<response></response>
</message>
<message id="DOTX038I" type="INFO">
<reason>The longdescref attribute on tag '%1' will be ignored. Accessibility for object elements needs to be handled another way.</reason>
<response></response>
</message>
<message id="DOTX039W" type="WARN">
<reason>Required cleanup area found.</reason>
<response>To remove this message and hide the content, build your content without using the DRAFT parameter.</response>
</message>
<message id="DOTX040I" type="INFO">
<reason>Draft comment area found.</reason>
<response>To remove this message and hide the comments, build your content without using the DRAFT parameter.</response>
</message>
<message id="DOTX041W" type="WARN">
<reason>Found more than one title element in a %1 element. Using the first one for the %1's title.</reason>
<response></response>
</message>
<message id="DOTX042I" type="INFO">
<reason>DITAVAL based flagging is not currently supported for inline phrases in XHTML; ignoring flag value on '%1' attribute.</reason>
<response></response>
</message>
<message id="DOTX043I" type="INFO">
<reason>The link to '%1' may appear more than once in '%2'.</reason>
<response></response>
</message>
<message id="DOTX044E" type="ERROR">
<reason>The area element in an image map does not specify a link target.</reason>
<response>Please add an xref element with a link target to the area element.</response>
</message>
<message id="DOTX045W" type="WARN">
<reason>The area element in an image map should specify link text for greater accessibility.</reason>
<response>Link text should be specified directly when the target is not a local DITA resource.</response>
</message>
<message id="DOTX046W" type="WARN">
<reason>Area shape should be: default, rect, circle, poly, or blank (no value). The value '%1' is not recognized.</reason>
<response></response>
</message>
<message id="DOTX047W" type="WARN">
<reason>Area coordinates are blank. Coordinate points for the shape need to be specified.</reason>
<response></response>
</message>
<message id="DOTX049I" type="INFO">
<reason>References to non-dita files will be ignored by the PDF, ODT, and RTF output transforms.</reason>
<response></response>
</message>
<message id="DOTX050W" type="WARN">
<reason>Default id "org.sample.help.doc" is used for Eclipse plug-in.</reason>
<response>If you want to use your own plug-in id, please specify it using the id attribute on your map.</response>
</message>
<message id="DOTX052W" type="WARN">
<reason>No string named '%1' was found when creating generated text; using the value '%1' in your output file.</reason>
<response></response>
</message>
<message id="DOTX053E" type="ERROR">
<reason>A element that references another map indirectly includes itself, which results in an infinite loop. The original map reference is to '%1'.</reason>
<response></response>
</message>
<message id="DOTX054W" type="WARN">
<reason>Conflict text style is applied on the current element based on DITAVAL flagging rules.</reason>
<response>Please check ditaval and dita source to make sure there is no style conflict on the element which needs to be flagged.</response>
</message>
<message id="DOTX055W" type="WARN">
<reason>Customized stylesheet uses deprecated template "flagit". Conditional processing is no longer supported using this template.</reason>
<response>Please update your stylesheet to use template "start-flagit" instead of deprecated template "flagit".</response>
</message>
<message id="DOTX056W" type="WARN">
<reason>The file '%1' is not available to resolve link information.</reason>
<response></response>
</message>
<message id="DOTX057W" type="WARN">
<reason>The link or cross reference target '%1' cannot be found, which may cause errors creating links or cross references in your output file.</reason>
<response></response>
</message>
<message id="DOTX058W" type="WARN">
<reason>No glossary entry was found associated with key '%1' on %2 element. The build will try to determine the best display text and hover text for terms and abbreviations.</reason>
<response></response>
</message>
<message id="DOTX060W" type="WARN">
<reason>Key '%1' was used in an abbreviated-form element, but the key is not associated with a glossary entry.</reason>
<response>Abbreviated-form should ONLY be used to reference to a glossary entry.</response>
</message>
<message id="DOTX061W" type="WARN">
<reason>ID '%1' was used in topicref tag but did not reference a topic element. The href attribute on a topicref element should only reference topic level elements.</reason>
<response></response>
</message>
<message id="DOTX062I" type="INFO">
<reason>It appears that this document uses constraints, but the conref processor cannot validate that the target of a conref is valid.</reason>
<response>To enable constraint checking, please upgrade to an XSLT 2.0 processor.</response>
</message>
<message id="DOTX063W" type="WARN">
<reason>The dita document '%1' is linked to from your content, but is not referenced by a topicref tag in the ditamap file.</reason>
<response>Include the topic in your map to avoid a broken link.</response>
</message>
<message id="DOTX064W" type="WARN">
<reason>The copy-to attribute [copy-to="%1"] uses the name of a file that already exists, so this attribute is ignored.</reason>
<response></response>
</message>
<message id="DOTX065W" type="WARN">
<reason>Two unique source files each specify copy-to="%2", which results in a collision. The value associated with href="%1" is ignored.</reason>
<response></response>
</message>
<message id="DOTX066W" type="WARN">
<reason>Template "%1" is deprecated.</reason>
<response>Remove references to this template from your custom XSLT or plug-ins.</response>
</message>
<message id="DOTX067E" type="ERROR">
<reason>No string named '%1' was found for language '%2'.</reason>
<response>Add a mapping for the string '%1'.</response>
</message>
<message id="DOTX068W" type="WARN">
<reason>A topicref element that references a map contains child topicref elements.</reason>
<response>Child topicref elements are ignored.</response>
</message>
<message id="DOTX069W" type="WARN">
<reason>Template mode "%1" is deprecated.</reason>
<response>Remove references to this template mode from your custom XSLT or plug-ins.</response>
</message>
<message id="DOTX070W" type="WARN">
<reason>Target "%1" is deprecated.</reason>
<response>Remove references to this target from your custom Ant files.</response>
</message>
<message id="DOTX071W" type="WARN">
<reason>Parameter "%1" on template "%2" is deprecated.</reason>
<response>Use parameter "%3" instead.</response>
</message>
<message id="DOTX071E" type="ERROR">
<reason>Conref range: Unable to find conref range end element with ID "%1".</reason>
<response/>
</message>
<message id="DOTX072I" type="INFO">
<reason>Ignoring navtitle within topicgroup.</reason>
<response/>
</message>
<message id="DOTX073I" type="INFO">
<reason>Removing broken link to "%1".</reason>
<response/>
</message>
<message id="DOTX074W" type="WARN">
<reason>No formatting defined for unknown class attribute value "%1".</reason>
<response/>
</message>
<message id="DOTX075W" type="WARN">
<reason>A content reference in a constrained document type is pulling content from an unconstrained document type. The reference will resolve, but may result in content that violates one of the document constraints in "%1".</reason>
<response></response>
</message>
<message id="DOTX076E" type="ERROR">
<reason>A content reference in a constrained document type cannot be resolved because it would violate one of the document constraints "%1".</reason>
<response>The current constrained document may only reuse content from documents with equivalent constraints.</response>
</message>
<!-- End of XSL Messages -->
<!-- Add any messages defined by plugins. -->
<dita:extension xmlns:dita="http://dita-ot.sourceforge.net"
behavior="org.dita.dost.platform.InsertAction" id="dita.xsl.messages"/>
</messages>

29
dita-ot-3.6/config/org.dita.dost.platform/plugin.properties Normal file
View file

@ -0,0 +1,29 @@
#DITA-OT runtime configuration, do not edit manually
#Sat Dec 19 14:42:20 UTC 2020
print_transtypes=pdf;pdf2
parser.md=com.elovirta.dita.markdown.MarkdownReader
plugin.org.dita.html5.dir=plugins/org.dita.html5
parser.hdita=com.elovirta.dita.html.HDitaReader
plugin.org.dita.pdf2.dir=plugins/org.dita.pdf2
plugin.org.oasis-open.dita.v1_3.dir=plugins/org.oasis-open.dita.v1_3
plugin.org.dita.pdf2.fop.dir=plugins/org.dita.pdf2.fop
plugin.org.oasis-open.xdita.v0_2_2.dir=plugins/org.oasis-open.xdita.v0_2_2
supported_resource_extensions=.pdf;.swf
parser.mdita=com.elovirta.dita.markdown.MDitaReader
supported_html_extensions=.html;.htm
plugin.org.dita.pdf2.xep.dir=plugins/org.dita.pdf2.xep
parser.markdown=com.elovirta.dita.markdown.MarkdownReader
plugin.org.dita.xhtml.dir=plugins/org.dita.xhtml
supported_image_extensions=.gif;.svg;.bmp;.jpg;.tif;.eps;.jpeg;.png;.tiff
plugin.org.dita.base.dir=plugins/org.dita.base
plugin.org.oasis-open.dita.techcomm.v2_0.dir=plugins/org.oasis-open.dita.techcomm.v2_0
transtypes=xhtml;eclipsehelp;html5;htmlhelp;dita;pdf;pdf2;markdown;markdown_github;markdown_gitbook
plugin.org.dita.pdf2.axf.dir=plugins/org.dita.pdf2.axf
plugin.org.dita.index.dir=plugins/org.dita.index
plugin.org.lwdita.dir=plugins/org.lwdita
plugin.org.dita.eclipsehelp.dir=plugins/org.dita.eclipsehelp
plugin.org.oasis-open.dita.v1_2.dir=plugins/org.oasis-open.dita.v1_2
plugin.org.dita.specialization.dita11.dir=plugins/org.dita.specialization.dita11
plugin.org.dita.htmlhelp.dir=plugins/org.dita.htmlhelp
plugin.org.dita.normalize.dir=plugins/org.dita.normalize
plugin.org.oasis-open.dita.v2_0.dir=plugins/org.oasis-open.dita.v2_0

594
dita-ot-3.6/config/plugins.xml Normal file
View file

@ -0,0 +1,594 @@
<?xml version="1.0" encoding="UTF-8"?><plugins><plugin id="org.dita.htmlhelp" version="3.6.0" xml:base="../plugins/org.dita.htmlhelp/plugin.xml">
<!-- extension points -->
<extension-point id="dita.xsl.htmlhelp.map2hhp" name="HTML Help project XSLT import"/>
<extension-point id="dita.xsl.htmlhelp.map2hhc" name="HTML Help content XSLT import"/>
<!-- extensions -->
<transtype desc="Microsoft Compiled HTML Help" extends="base-html" name="htmlhelp">
<param desc="Specifies the name of a file that you want included in the HTML Help." name="args.htmlhelp.includefile" type="file"/>
</transtype>
<require plugin="org.dita.xhtml"/>
<feature extension="ant.import" file="build_dita2htmlhelp.xml"/>
<feature extension="dita.conductor.lib.import" file="lib/htmlhelp.jar"/>
<feature extension="dita.xsl.messages" file="resource/messages.xml"/>
<template file="xsl/map2hhc_template.xsl"/>
<template file="xsl/map2hhp_template.xsl"/>
<template file="build_dita2htmlhelp_template.xml"/>
</plugin><plugin id="org.dita.eclipsehelp" version="3.4.0" xml:base="../plugins/org.dita.eclipsehelp/plugin.xml">
<!-- extension points -->
<extension-point id="dita.xsl.eclipse.plugin" name="Eclipse plugin XSLT import"/>
<extension-point id="dita.map.eclipse.index.pre" name="Eclipse index extraction pre-target"/>
<extension-point id="dita.xsl.eclipse.toc" name="Eclipse TOC XSLT import"/>
<extension-point id="dita.conductor.eclipse.toc.param" name="Eclipse Help TOC XSLT parameter"/>
<!-- extensions -->
<transtype desc="Eclipse Help" extends="base-html" name="eclipsehelp">
<param desc="Specifies that the output should be zipped and returned using this name." name="args.eclipsehelp.jar.name" type="string"/>
<param desc="Specifies the region for the language that is specified by the args." name="args.eclipsehelp.country" type="string"/>
<param desc="Specifies the base language for translated content, such as en for English." name="args.eclipsehelp.language" type="string"/>
<param desc="Specifies the name of the person or organization that provides the Eclipse help." name="args.eclipse.provider" type="string">
<val default="true">DITA</val>
</param>
<param desc="Specifies the version number to include in the output." name="args.eclipse.version" type="string">
<val default="true">0.0.0</val>
</param>
<param desc="Specifies the symbolic name (aka plugin ID) in the output for an Eclipse Help project." name="args.eclipse.symbolic.name" type="string">
<val default="true">org.sample.help.doc</val>
</param>
</transtype>
<require plugin="org.dita.xhtml"/>
<feature extension="dita.conductor.lib.import" file="lib/eclipsehelp.jar"/>
<feature extension="ant.import" file="build_dita2eclipsehelp.xml"/>
<template file="build_dita2eclipsehelp_template.xml"/>
<template file="xsl/map2eclipse_template.xsl"/>
<template file="xsl/map2plugin_template.xsl"/>
</plugin><plugin id="org.dita.base" version="3.6.0" xml:base="../plugins/org.dita.base/plugin.xml">
<!-- base extension points -->
<extension-point id="package.version" name="Plug-in version"/>
<extension-point id="package.support.email" name="Plug-in support email"/>
<extension-point id="package.support.name" name="Plug-in support name"/>
<extension-point id="dita.conductor.plugin" name="Ant conductor plug-in information"/>
<extension-point id="dita.catalog.plugin-info" name="Plug-in XML catalog information"/>
<extension-point id="dita.image.extensions" name="Image file extension"/>
<extension-point id="dita.html.extensions" name="HTML file extension"/>
<extension-point id="dita.resource.extensions" name="Resource file extension"/>
<!-- deprecated -->
<extension-point id="dita.conductor.transtype.check" name="Transtype check"/>
<extension-point id="dita.transtype.print" name="Print transtype"/>
<extension-point id="dita.conductor.target" name="Ant conductor"/>
<extension-point id="dita.conductor.target.relative" name="Ant conductor"/>
<extension-point id="ant.import" name="Ant import"/>
<extension-point id="dita.specialization.catalog" name="XML catalog"/>
<extension-point id="dita.specialization.catalog.relative" name="XML catalog"/>
<extension-point id="dita.xsl.strings" name="Generated text"/>
<extension-point id="dita.conductor.lib.import" name="Java library import"/>
<extension-point id="dita.xsl.messages" name="Diagnostic messages"/>
<!-- legacy support -->
<extension-point id="dita.basedir-resource-directory" name="Flag to use basedir as resource directory"/>
<!-- preprocessing extension points -->
<extension-point id="depend.preprocess.pre" name="Preprocessing pre-target"/>
<extension-point id="depend.preprocess.clean-temp.pre" name="Clean temp pre-target"/>
<extension-point id="depend.preprocess.gen-list.pre" name="Generate list pre-target"/>
<extension-point id="depend.preprocess.debug-filter.pre" name="Debug and filter pre-target"/>
<extension-point id="depend.preprocess.conrefpush.pre" name="Content reference push pre-target"/>
<extension-point id="depend.preprocess.move-meta-entries.pre" name="Move meta entries pre-target"/>
<extension-point id="depend.preprocess.conref.pre" name="Content reference pre-target"/>
<extension-point id="depend.preprocess.coderef.pre" name="Code reference pre-target"/>
<extension-point id="depend.preprocess.mapref.pre" name="Map reference pre-target"/>
<extension-point id="depend.preprocess.keyref.pre" name="Key reference pre-target"/>
<extension-point id="depend.preprocess.mappull.pre" name="Map pull pre-target"/>
<extension-point id="depend.preprocess.chunk.pre" name="Chunking pre-target"/>
<extension-point id="depend.preprocess.maplink.pre" name="Map link pre-target"/>
<extension-point id="depend.preprocess.topicpull.pre" name="Topic pull pre-target"/>
<extension-point id="depend.preprocess.copy-files.pre" name="Copy files pre-target"/>
<extension-point id="depend.preprocess.copy-image.pre" name="Copy images pre-target"/>
<extension-point id="depend.preprocess.copy-html.pre" name="Copy HTML pre-target"/>
<extension-point id="depend.preprocess.copy-flag.pre" name="Copy flag pre-target"/>
<!-- Deprecated since 2.1 -->
<extension-point id="depend.preprocess.copy-subsidiary.pre" name="Copy subsidiary pre-target"/>
<extension-point id="depend.preprocess.post" name="Preprocessing post-target"/>
<extension-point id="dita.preprocess.debug-filter.param" name="Debug filter module parameters"/>
<extension-point id="dita.preprocess.map-reader.param" name="Debug filter module parameters"/>
<extension-point id="dita.preprocess.topic-reader.param" name="Debug filter module parameters"/>
<extension-point id="dita.preprocess.conref.param" name="Content reference XSLT parameters"/>
<extension-point id="dita.preprocess.mapref.param" name="Map reference XSLT parameters"/>
<extension-point id="dita.preprocess.mappull.param" name="Map pull XSLT parameters"/>
<!--extension-point id="dita.preprocess.maplink.param" name="Map link XSLT parameters"/-->
<extension-point id="dita.preprocess.topicpull.param" name="Topic pull XSLT parameters"/>
<extension-point id="dita.xsl.conref" name="Content reference XSLT import"/>
<extension-point id="dita.xsl.topicpull" name="Topic pull XSLT import"/>
<extension-point id="dita.xsl.mapref" name="Map reference XSLT import"/>
<extension-point id="dita.xsl.mappull" name="Map pull XSLT import"/>
<extension-point id="dita.xsl.maplink" name="Map link XSLT import"/>
<extension-point id="dita.parser" name="Custom DITA parser"/>
<!-- extensions -->
<transtype abstract="true" desc="Common" name="base">
<param desc="Specifies whether to generate headings for sections within task topics." name="args.gen.task.lbl" type="enum">
<val>YES</val>
<val>NO</val>
</param>
<param desc="Specifies which links to include in the output." name="args.rellinks" type="enum">
<val desc="No links are included.">none</val>
<val desc="All links are included.">all</val>
<val desc="Parent links are not included.">noparent</val>
<val desc="Parent, child, next, and previous links are not included.">nofamily</val>
</param>
<!-- Deprecated since 2.5 -->
<param deprecated="true" desc="Specifies whether debugging information is included in the log." name="args.debug" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies whether the content of &lt;draft-comment&gt; and &lt;required-cleanup&gt; elements is included in the output." name="args.draft" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies how cross references to figures are styled in output." name="args.figurelink.style" type="enum">
<val>NUMBER</val>
<val>TITLE</val>
<val>NUMTITLE</val>
</param>
<param desc="Specifies a filter file to be used to include, exclude, or flag content." name="args.filter" type="file"/>
<param desc="Specifies whether the grammar-caching feature of the XML parser is used." name="args.grammar.cache" type="enum">
<val default="true">yes</val>
<val>no</val>
</param>
<param desc="Specifies the master file for your documentation project." name="args.input" required="true" type="file"/>
<param desc="Specifies the base directory for your documentation project." name="args.input.dir" type="dir"/>
<param desc="Specifies resource files." name="args.resources" type="file"/>
<param desc="Specifies the name of the output file without file extension." name="args.output.base" type="string"/>
<param desc="Specifies how cross references to tables are styled." name="args.tablelink.style" type="enum">
<val>NUMBER</val>
<val>TITLE</val>
<val>NUMTITLE</val>
</param>
<param desc="Specifies whether to crawl only those topic links found in maps, or all discovered topic links." name="link-crawl" type="enum">
<val>map</val>
<val default="true">topic</val>
</param>
<param desc="Specifies whether DITA-OT deletes the files in the temporary directory after it finishes a build." name="clean.temp" type="enum">
<val default="true">yes</val>
<val>no</val>
</param>
<param desc="Specifies where DITA-OT is installed." name="dita.dir" type="dir"/>
<param desc="Specifies the location of the temporary directory." name="dita.temp.dir" type="dir"/>
<param deprecated="true" desc="Specifies a filter file to be used to include, exclude, or flag content." name="dita.input.valfile" type="file"/>
<param desc="Specifies whether filtering is done before all other processing, or after key and conref processing." name="filter-stage" type="enum">
<val default="true">early</val>
<val>late</val>
</param>
<param desc="Generate copy-to attributes to duplicate topicref elements." name="force-unique" type="enum">
<val>true</val>
<val default="true">false</val>
</param>
<param desc="Adjust how output is generated for content that is located outside the directory containing the DITA map." name="generate.copy.outer" type="enum">
<val default="true" desc="Do not generate output for content that is located outside the DITA map directory.">1</val>
<val desc="Shift the output directory so that it contains all output for the publication.">3</val>
</param>
<param desc="Specifies whether files that are linked to, or referenced with a @conref attribute, generate output." name="onlytopic.in.map" type="enum">
<val>true</val>
<val default="true">false</val>
</param>
<param desc="Specifies whether to warn or fail if content is located outside the directory containing the DITA map." name="outer.control" type="enum">
<val desc="Fail quickly if files are going to be generated or copied outside of the directory.">fail</val>
<val default="true" desc="Complete the operation if files will be generated or copied outside of the directory, but log a warning.">warn</val>
<val desc="Quietly finish without generating warnings or errors.">quiet</val>
</param>
<param desc="Specifies the name and location of the output directory." name="output.dir" type="dir"/>
<param desc="Override for map chunk attribute value." name="root-chunk-override" type="string"/>
<param desc="Specifies the output format (transformation type)." name="transtype" required="true" type="string"/>
<param desc="Specifies whether DITA-OT validates the content." name="validate" type="enum">
<val default="true">true</val>
<val>false</val>
</param>
<param desc="Specifies whether the @xtrf and @xtrc debugging attributes are generated in the temporary files." name="generate-debug-attributes" type="enum">
<val default="true" desc="Enables generation of debugging attributes">true</val>
<val desc="Disables generation of debugging attributes">false</val>
</param>
<param desc="Specifies how DITA-OT handles errors and error recovery." name="processing-mode" type="enum">
<val desc="When an error is encountered, DITA-OT stops processing">strict</val>
<val default="true" desc="When an error is encountered, DITA-OT attempts to recover from it">lax</val>
<val desc="When an error is encountered, DITA-OT continues processing but does not attempt error recovery">skip</val>
</param>
<param desc="Conserve memory at the expense of processing speed." name="conserve-memory" type="enum">
<val>true</val>
<val default="true">false</val>
</param>
<param desc="Specifies the default language for source documents." name="default.language" type="string"/>
<param desc="Remove broken related links." name="remove-broken-links" type="enum">
<val>true</val>
<val default="true">false</val>
</param>
<param desc="Specifies the name of the XSLT file used to rewrite filenames." name="result.rewrite-rule.xsl" type="string"/>
<param desc="Specifies the name of the Java class used to rewrite filenames." name="result.rewrite-rule.class" type="string"/>
<param desc="Temporary file store type." name="store-type" type="enum">
<val default="true">file</val>
<val>memory</val>
</param>
<param desc="Run processes in parallel when possible." name="parallel" type="enum">
<val>true</val>
<val default="true">false</val>
</param>
</transtype>
<feature extension="dita.image.extensions" value=".gif"/>
<feature extension="dita.image.extensions" value=".eps"/>
<feature extension="dita.image.extensions" value=".jpg"/>
<feature extension="dita.image.extensions" value=".jpeg"/>
<feature extension="dita.image.extensions" value=".png"/>
<feature extension="dita.image.extensions" value=".svg"/>
<feature extension="dita.image.extensions" value=".tif"/>
<feature extension="dita.image.extensions" value=".tiff"/>
<feature extension="dita.image.extensions" value=".bmp"/>
<feature extension="dita.html.extensions" value=".html"/>
<feature extension="dita.html.extensions" value=".htm"/>
<feature extension="dita.resource.extensions" value=".pdf"/>
<feature extension="dita.resource.extensions" value=".swf"/>
<feature extension="ant.import" file="build_init.xml"/>
<feature extension="ant.import" file="build_preprocess.xml"/>
<feature extension="ant.import" file="build_preprocess2.xml"/>
<feature extension="dita.xsl.strings" file="xsl/common/common-strings.xml"/>
<template file="catalog-dita_template.xml"/>
<template file="build_template.xml"/>
<template file="build_preprocess_template.xml"/>
<template file="build_preprocess2_template.xml"/>
<template file="../../config/messages_template.xml"/>
<template file="xsl/common/allstrings_template.xml"/>
<template file="xsl/common/strings_template.xml"/>
<template file="xsl/preprocess/maplink_template.xsl"/>
<template file="xsl/preprocess/mapref_template.xsl"/>
<template file="xsl/preprocess/mappull_template.xsl"/>
<template file="xsl/preprocess/conref_template.xsl"/>
<template file="xsl/preprocess/map-conref_template.xsl"/>
<template file="xsl/preprocess/topicpull_template.xsl"/>
</plugin><plugin id="org.dita.html5" version="3.6.0" xml:base="../plugins/org.dita.html5/plugin.xml">
<!-- extension points -->
<extension-point id="dita.xsl.html5" name="HTML5 XSLT import"/>
<extension-point id="dita.conductor.html5.param" name="HTML5 XSLT parameters"/>
<extension-point id="dita.conductor.html5.toc.param" name="HTML/XSLT XSLT parameter"/>
<extension-point id="dita.xsl.html5.toc" name="HTML5 TOC XSLT import"/>
<extension-point id="dita.xsl.html5.cover" name="HTML5 Cover XSLT import"/>
<!-- extensions -->
<transtype desc="HTML5" name="html5">
<param desc="Specifies whether to generate a label for each image; the label will contain the image file name." name="args.artlbl" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies whether to copy the custom .css file to the output directory." name="args.copycss" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies the name of a custom .css file." name="args.css" type="string"/>
<param desc="Specifies the location of a copied .css file relative to the output directory." name="args.csspath" type="string"/>
<param desc="Specifies the directory that contains the custom .css file." name="args.cssroot" type="string"/>
<param desc="Specifies the language locale file to use for sorting index entries." name="args.dita.locale" type="string"/>
<param desc="Specifies an XML file that contains content for a running footer." name="args.ftr" type="file"/>
<param desc="Generate metadata for parental control scanners, meta elements with name=&#34;security&#34; and name=&#34;Robots&#34;." name="args.gen.default.meta" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies an XML file that contains content to be placed in the document head." name="args.hdf" type="file"/>
<param desc="Specifies an XML file that contains content for a running header." name="args.hdr" type="file"/>
<param desc="Specifies whether to hide links to parent topics in the HTML5 output." name="args.hide.parent.link" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies whether to include the DITA class ancestry inside the HTML5 elements." name="args.html5.classattr" type="enum">
<val default="true">yes</val>
<val>no</val>
</param>
<param desc="Specifies the value of the @target attribute on the &lt;base&gt; element in the TOC file." name="args.html5.contenttarget" type="string">
<val default="true">contentwin</val>
</param>
<param desc="Generate TOC file from the DITA map." name="html5.toc.generate" type="enum">
<val default="true">yes</val>
<val>no</val>
</param>
<param desc="Specifies the base name of the TOC file." name="args.html5.toc" type="string">
<val default="true">index</val>
</param>
<param desc="Specifies the value of the @class attribute on the &lt;body&gt; element in the TOC file." name="args.html5.toc.class" type="string"/>
<param desc="Specifies a custom XSL file to be used for TOC generation." name="args.html5.toc.xsl" type="file"/>
<param desc="Specifies whether the content of &lt;indexterm&gt; elements are rendered in the output." name="args.indexshow" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies the file extension for HTML5 output." name="args.outext" type="string">
<val default="true">html</val>
</param>
<param desc="Specifies a custom XSL file to be used instead of the default XSL transformation." name="args.xsl" type="file"/>
<param desc="Specifies whether to generate a navigation TOC in topic pages." name="nav-toc" type="enum">
<val default="true" desc="No TOC">none</val>
<val desc="Partial TOC that shows the current topic">partial</val>
<val desc="Full TOC">full</val>
</param>
</transtype>
<feature extension="ant.import" file="build_dita2html5.xml"/>
<feature extension="dita.conductor.html5.param" file="params.xml"/>
<!--feature extension="dita.xsl.messages" file="resource/messages.xml"/-->
<template file="build_dita2html5_template.xml"/>
<template file="xsl/dita2html5Impl_template.xsl"/>
<template file="xsl/map2html5-coverImpl_template.xsl"/>
</plugin><plugin id="org.dita.pdf2.axf" version="3.6.0" xml:base="../plugins/org.dita.pdf2.axf/plugin.xml">
<require plugin="org.dita.pdf2"/>
<!-- extensions -->
<feature extension="depend.org.dita.pdf2.init.pre" value="transform.fo2pdf.ah.init"/>
<feature extension="depend.org.dita.pdf2.format" value="transform.fo2pdf.ah"/>
<feature extension="dita.conductor.lib.import" file="lib/axf.jar"/>
<transtype desc="PDF" name="pdf">
<param desc="Specifies the XSL processor." name="pdf.formatter" type="enum">
<val desc="Antenna House Formatter">ah</val>
</param>
<param desc="Specifies whether draft-comment and required-cleanup elements are included in the output." name="publish.required.cleanup" type="enum">
<val>yes</val>
<val>no</val>
</param>
<param desc="Specifies the user configuration file for Antenna House Formatter." name="axf.opt" type="file"/>
<param desc="Specifies the path to the Antenna House Formatter executable." name="axf.cmd" type="file"/>
</transtype>
<feature extension="ant.import" file="build_axf.xml"/>
<feature extension="dita.conductor.pdf2.formatter.check" value="ah"/>
<template file="xsl/fo/topic2fo_shell_axf_template.xsl"/>
</plugin><plugin id="org.oasis-open.dita.v1_3" version="1.3" xml:base="../plugins/org.oasis-open.dita.v1_3/plugin.xml">
<feature extension="dita.specialization.catalog.relative" file="catalog.xml"/>
</plugin><plugin id="org.dita.normalize" version="0.0.0" xml:base="../plugins/org.dita.normalize/plugin.xml">
<transtype desc="Normalized DITA" name="dita"/>
<feature extension="dita.conductor.target.relative" file="conductor.xml"/>
</plugin><plugin id="org.dita.index" version="1.0.0" xml:base="../plugins/org.dita.index/plugin.xml">
<feature extension="dita.conductor.lib.import" file="lib/index.jar"/>
<feature extension="dita.xsl.messages" file="messages.xml"/>
<feature extension="ant.import" file="build.xml"/>
<feature extension="depend.org.dita.pdf2.index" value="org.dita.index"/>
<transtype abstract="true" extends="pdf">
<param desc="Disable index processing." name="org.dita.index.skip" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
</transtype>
</plugin><plugin id="org.dita.pdf2" version="3.6.0" xml:base="../plugins/org.dita.pdf2/plugin.xml">
<!-- extension points -->
<extension-point id="dita.xsl.xslfo" name="PDF XSLT import"/>
<extension-point id="dita.xsl.xslfo.i18n-postprocess" name="PDF I18N postprocess import"/>
<extension-point id="org.dita.pdf2.xsl.topicmerge" name="PDF2 topic merge XSLT import"/>
<extension-point id="depend.org.dita.pdf2.init.pre" name="Initialization pre-target"/>
<extension-point id="depend.org.dita.pdf2.format.pre" name="Formatting pre-target"/>
<extension-point id="depend.org.dita.pdf2.format" name="Formatting target"/>
<extension-point id="depend.org.dita.pdf2.format.post" name="Formatting post-target"/>
<extension-point id="depend.org.dita.pdf2.index" name="Indexing target"/>
<extension-point id="org.dita.pdf2.catalog.relative" name="Configuration XML catalog"/>
<extension-point id="dita.conductor.pdf2.param" name="PDF XSLT parameters"/>
<extension-point id="dita.conductor.pdf2.formatter.check" name="Formatter check"/>
<!-- extensions -->
<feature extension="dita.conductor.lib.import" file="lib/fo.jar"/>
<transtype desc="PDF" name="pdf">
<param desc="Specifies the base file name of the generated PDF file." name="outputFile.base"/>
<param desc="Specifies whether to generate a label for each image; the label will contain the image file name." name="args.artlbl" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies if the frontmatter and backmatter content order is retained in bookmap." name="args.bookmap-order" type="enum">
<val>retain</val>
<val default="true">discard</val>
</param>
<param desc="Specifies whether PDF bookmarks are by default expanded or collapsed." name="args.bookmark.style" type="enum">
<val>EXPANDED</val>
<val>COLLAPSE</val>
</param>
<param desc="Specifies whether chapter level TOCs are generated." name="args.chapter.layout" type="enum">
<val default="true">MINITOC</val>
<val>BASIC</val>
</param>
<param desc="Specifies an XSL file that is used to override the default XSL transformation." name="args.xsl.pdf" type="file"/>
<param desc="Specifies the customization directory." name="customization.dir" type="dir"/>
<param desc="Specifies the XSL processor." name="pdf.formatter" type="enum"/>
<param desc="Specifies whether draft-comment and required-cleanup elements are included in the output." name="publish.required.cleanup" type="enum">
<val>yes</val>
<val>no</val>
</param>
<param desc="Enables I18N font processing." name="org.dita.pdf2.i18n.enabled" type="enum">
<val default="true" desc="Enables I18N processing">true</val>
<val desc="Disables I18N processing">false</val>
</param>
<param desc="Enables chunk attribute processing." name="org.dita.pdf2.chunk.enabled" type="enum">
<val desc="Enables chunk processing">true</val>
<val default="true" desc="Disables chunk processing">false</val>
</param>
<!-- Deprecated since 3.4 -->
<!-- Disable deprecated built-in indexing -->
<!--
<param name="pdf2.index.skip" desc="Disable built-in index processing." type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
-->
</transtype>
<transtype desc="PDF2" extends="pdf" name="pdf2"/>
<feature extension="dita.transtype.print" value="pdf"/>
<feature extension="dita.transtype.print" value="pdf2"/>
<feature extension="ant.import" file="build.xml"/>
<feature extension="dita.xsl.messages" file="resource/messages.xml"/>
<feature extension="dita.conductor.pdf2.formatter.check" value="ah"/>
<feature extension="dita.xsl.strings" file="cfg/common/vars/strings.xml"/>
<feature extension="dita.specialization.catalog.relative" file="cfg/catalog.xml"/>
<!-- Deprecated since 3.4 -->
<!-- Disable deprecated built-in indexing -->
<!--<feature extension="depend.org.dita.pdf2.index" value="transform.topic2fo.index"/>-->
<template file="build_template.xml"/>
<template file="cfg/catalog_template.xml"/>
<template file="xsl/fo/i18n-postprocess_template.xsl"/>
<template file="xsl/fo/topic2fo_shell_template.xsl"/>
<template file="xsl/common/topicmerge_template.xsl"/>
</plugin><plugin id="org.dita.specialization.dita11" version="1.1" xml:base="../plugins/org.dita.specialization.dita11/plugin.xml">
<feature extension="dita.specialization.catalog.relative" file="catalog.xml"/>
</plugin><plugin id="org.oasis-open.dita.techcomm.v2_0" version="0.0.0" xml:base="../plugins/org.oasis-open.dita.techcomm.v2_0/plugin.xml">
<feature extension="dita.specialization.catalog.relative" file="catalog.xml"/>
</plugin><plugin id="org.oasis-open.dita.v2_0" version="0.0.0" xml:base="../plugins/org.oasis-open.dita.v2_0/plugin.xml">
<feature extension="dita.specialization.catalog.relative" file="catalog.xml"/>
</plugin><plugin id="org.lwdita" version="0.0.0" xml:base="../plugins/org.lwdita/plugin.xml">
<!-- DITA to Markdown -->
<transtype desc="Markdown" name="markdown"/>
<transtype desc="GitHub-flavored Markdown" name="markdown_github"/>
<transtype desc="GitBook" name="markdown_gitbook"/>
<feature extension="dita.conductor.target.relative" file="conductor.xml"/>
<!-- common -->
<feature extension="dita.conductor.lib.import" file="lib/org.lwdita-2.4.0.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/htmlparser-1.4.jar"/>
<!-- Markdown to DITA -->
<template file="build-markdown_template.xml"/>
<template file="xsl/dita2markdown_template.xsl"/>
<!--template file="xsl/map2markdown-toc_template.xsl"/-->
<template file="xsl/map2markdown-cover_template.xsl"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-profile-pegdown-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-abbreviation-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-anchorlink-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-aside-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-autolink-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-definition-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-html-parser-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-escaped-character-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-footnotes-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-jira-converter-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-youtrack-converter-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-gfm-strikethrough-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-gfm-tables-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-gfm-tasklist-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-jekyll-front-matter-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-jekyll-tag-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-ins-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-superscript-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-tables-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-toc-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-typographic-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-wikilink-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-ext-yaml-front-matter-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-formatter-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/flexmark-util-0.50.18.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/autolink-0.6.0.jar"/>
<feature extension="dita.parser">
<parser class="com.elovirta.dita.markdown.MarkdownReader" format="markdown"/>
<parser class="com.elovirta.dita.markdown.MarkdownReader" format="md"/>
<parser class="com.elovirta.dita.markdown.MDitaReader" format="mdita"/>
</feature>
<!-- HTML to DITA -->
<template file="build-html_template.xml"/>
<feature extension="dita.parser">
<parser class="com.elovirta.dita.html.HDitaReader" format="hdita"/>
</feature>
</plugin><plugin id="org.oasis-open.dita.v1_2" version="1.2" xml:base="../plugins/org.oasis-open.dita.v1_2/plugin.xml">
<feature extension="dita.specialization.catalog.relative" file="catalog.xml"/>
</plugin><plugin id="org.dita.pdf2.xep" version="3.6.0" xml:base="../plugins/org.dita.pdf2.xep/plugin.xml">
<require plugin="org.dita.pdf2"/>
<!-- extensions -->
<feature extension="depend.org.dita.pdf2.init.pre" value="transform.fo2pdf.xep.init"/>
<feature extension="depend.org.dita.pdf2.format" value="transform.fo2pdf.xep"/>
<feature extension="dita.conductor.lib.import" file="lib/xep.jar"/>
<transtype desc="PDF" name="pdf">
<param desc="Specifies the XSL processor." name="pdf.formatter" type="enum">
<val desc="RenderX XEP Engine">xep</val>
</param>
<param desc="Specifies the user configuration file for RenderX." name="custom.xep.config" type="file"/>
<param desc="Specifies the amount of memory allocated to the RenderX process." name="maxJavaMemory"/>
</transtype>
<feature extension="ant.import" file="build_xep.xml"/>
<feature extension="dita.conductor.pdf2.formatter.check" value="xep"/>
<template file="xsl/fo/topic2fo_shell_xep_template.xsl"/>
</plugin><plugin id="org.dita.pdf2.fop" version="3.6.0" xml:base="../plugins/org.dita.pdf2.fop/plugin.xml">
<require plugin="org.dita.pdf2"/>
<!-- extensions -->
<feature extension="depend.org.dita.pdf2.init.pre" value="transform.fo2pdf.fop.init"/>
<feature extension="depend.org.dita.pdf2.format" value="transform.fo2pdf.fop"/>
<feature extension="dita.conductor.lib.import" file="lib/batik-all-1.13.jar"/>
<!-- <feature extension="dita.conductor.lib.import" file="lib/commons-logging-1.2.jar"/>-->
<feature extension="dita.conductor.lib.import" file="lib/fontbox-2.0.21.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/fop-2.5.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/fop-pdf-images-2.5.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/jcl-over-slf4j-1.7.30.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/xml-apis-ext-1.3.04.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/pdfbox-2.0.21.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/slf4j-api-1.7.30.jar"/>
<feature extension="dita.conductor.lib.import" file="lib/xmlgraphics-commons-2.4.jar"/>
<transtype desc="PDF" name="pdf">
<param desc="Specifies the XSL processor." name="pdf.formatter" type="enum">
<val default="true" desc="Apache FOP">fop</val>
</param>
<param desc="Specifies the user configuration file for FOP." name="args.fo.userconfig" type="file"/>
</transtype>
<feature extension="dita.conductor.pdf2.formatter.check" value="fop"/>
<feature extension="ant.import" file="build_fop.xml"/>
<template file="xsl/fo/topic2fo_shell_fop_template.xsl"/>
</plugin><plugin id="org.dita.xhtml" version="3.6.0" xml:base="../plugins/org.dita.xhtml/plugin.xml">
<!-- extension points -->
<extension-point id="dita.xsl.xhtml" name="HTML/XHTML XSLT import"/>
<extension-point id="dita.conductor.html.param" name="HTML XSLT parameters"/>
<extension-point id="dita.conductor.xhtml.param" name="XHTML XSLT parameters"/>
<extension-point id="dita.conductor.xhtml.toc.param" name="HTML/XSLT XSLT parameter"/>
<extension-point id="dita.xsl.htmltoc" name="HTML/XHTML TOC XSLT import"/>
<extension-point id="dita.xsl.html.cover" name="HTML/XHTML Cover XSLT import"/>
<!-- extensions -->
<transtype abstract="true" desc="HTML-based output" name="base-html">
<param desc="Specifies whether to generate a label for each image; the label will contain the image file name." name="args.artlbl" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies whether to copy the custom .css file to the output directory." name="args.copycss" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies the name of a custom .css file." name="args.css" type="string"/>
<param desc="Specifies the location of a copied .css file relative to the output directory." name="args.csspath" type="string"/>
<param desc="Specifies the directory that contains the custom .css file." name="args.cssroot" type="string"/>
<param desc="Specifies the language locale file to use for sorting index entries." name="args.dita.locale" type="string"/>
<param desc="Specifies an XML file that contains content for a running footer." name="args.ftr" type="file"/>
<param desc="Generate metadata for parental control scanners, meta elements with name=&#34;security&#34; and name=&#34;Robots&#34;." name="args.gen.default.meta" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies an XML file that contains content to be placed in the document head." name="args.hdf" type="file"/>
<param desc="Specifies an XML file that contains content for a running header." name="args.hdr" type="file"/>
<param desc="Specifies whether to hide links to parent topics in the HTML or XHTML output." name="args.hide.parent.link" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies whether the content of &lt;indexterm&gt; elements are rendered in the output." name="args.indexshow" type="enum">
<val>yes</val>
<val default="true">no</val>
</param>
<param desc="Specifies the file extension for HTML or XHTML output." name="args.outext" type="string">
<val default="true">html</val>
</param>
<param desc="Specifies whether to include the DITA class ancestry inside the XHTML elements." name="args.xhtml.classattr" type="enum">
<val default="true">yes</val>
<val>no</val>
</param>
<param desc="Specifies a custom XSL file to be used instead of the default XSL transformation." name="args.xsl" type="file"/>
</transtype>
<transtype desc="XHTML" extends="base-html" name="xhtml">
<param desc="Specifies the value of the @target attribute on the &lt;base&gt; element in the TOC file." name="args.xhtml.contenttarget" type="string">
<val default="true">contentwin</val>
</param>
<param desc="Specifies the base name of the TOC file." name="args.xhtml.toc" type="string">
<val default="true">index</val>
</param>
<param desc="Specifies the value of the @class attribute on the &lt;body&gt; element in the TOC file." name="args.xhtml.toc.class" type="string"/>
<param desc="Specifies a custom XSL file to be used for TOC generation." name="args.xhtml.toc.xsl" type="file"/>
</transtype>
<feature extension="ant.import" file="build_general.xml"/>
<feature extension="ant.import" file="build_dita2xhtml.xml"/>
<feature extension="dita.xsl.messages" file="resource/messages.xml"/>
<template file="build_general_template.xml"/>
<template file="build_dita2xhtml_template.xml"/>
<template file="xsl/dita2html-base_template.xsl"/>
<template file="xsl/map2htmltoc_template.xsl"/>
<template file="xsl/map2html-coverImpl_template.xsl"/>
</plugin><plugin id="org.oasis-open.xdita.v0_2_2" version="0.2.2" xml:base="../plugins/org.oasis-open.xdita.v0_2_2/plugin.xml">
<title>Lightweight DITA</title>
<!-- Include support name and email -->
<feature extension="package.support.name" value="OASIS Lightweight DITA subcommittee"/>
<feature extension="package.support.email" value="dita-lightweight-dita-chair@lists.oasis-open.org"/>
<!-- Provide a version (default is 1.0 if not specified) -->
<feature extension="package.version" value="1.0.4"/>
<!-- This references a catalog using the OASIS catalog format, to define
public IDs and system IDs for any DTD modules included in this plugin. -->
<feature extension="dita.specialization.catalog.relative" type="file" value="catalog-dita.xml"/>
</plugin></plugins>

22
dita-ot-3.6/doc/api/allclasses-frame.html Normal file
View file

@ -0,0 +1,22 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util" target="classFrame">Configuration</a></li>
<li><a href="org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util" target="classFrame">Configuration.Mode</a></li>
<li><a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception" target="classFrame">DITAOTException</a></li>
<li><a href="org/dita/dost/Processor.html" title="class in org.dita.dost" target="classFrame">Processor</a></li>
<li><a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost" target="classFrame">ProcessorFactory</a></li>
</ul>
</div>
</body>
</html>

22
dita-ot-3.6/doc/api/allclasses-noframe.html Normal file
View file

@ -0,0 +1,22 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></li>
<li><a href="org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a></li>
<li><a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></li>
<li><a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></li>
<li><a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost">ProcessorFactory</a></li>
</ul>
</div>
</body>
</html>

150
dita-ot-3.6/doc/api/constant-values.html Normal file
View file

@ -0,0 +1,150 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Constant Field Values (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Constant Field Values (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
<h2 title="Contents">Contents</h2>
<ul>
<li><a href="#org.dita">org.dita.*</a></li>
</ul>
</div>
<div class="constantValuesContainer"><a name="org.dita">
<!-- -->
</a>
<h2 title="org.dita">org.dita.*</h2>
<ul class="blockList">
<li class="blockList">
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
<caption><span>org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th scope="col">Constant Field</th>
<th class="colLast" scope="col">Value</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a name="org.dita.dost.util.Configuration.DEBUG">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;boolean</code></td>
<td><code><a href="org/dita/dost/util/Configuration.html#DEBUG">DEBUG</a></code></td>
<td class="colLast"><code>false</code></td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

121
dita-ot-3.6/doc/api/deprecated-list.html Normal file
View file

@ -0,0 +1,121 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Deprecated List (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Deprecated List (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li class="navBarCell1Rev">Deprecated</li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
<li><a href="deprecated-list.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Deprecated API" class="title">Deprecated API</h1>
<h2 title="Contents">Contents</h2>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li class="navBarCell1Rev">Deprecated</li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
<li><a href="deprecated-list.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

222
dita-ot-3.6/doc/api/help-doc.html Normal file
View file

@ -0,0 +1,222 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>API Help (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="API Help (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li class="navBarCell1Rev">Help</li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?help-doc.html" target="_top">Frames</a></li>
<li><a href="help-doc.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">How This API Document Is Organized</h1>
<div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<h2>Overview</h2>
<p>The <a href="overview-summary.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p>
</li>
<li class="blockList">
<h2>Package</h2>
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p>
<ul>
<li>Interfaces (italic)</li>
<li>Classes</li>
<li>Enums</li>
<li>Exceptions</li>
<li>Errors</li>
<li>Annotation Types</li>
</ul>
</li>
<li class="blockList">
<h2>Class/Interface</h2>
<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:</p>
<ul>
<li>Class inheritance diagram</li>
<li>Direct Subclasses</li>
<li>All Known Subinterfaces</li>
<li>All Known Implementing Classes</li>
<li>Class/interface declaration</li>
<li>Class/interface description</li>
</ul>
<ul>
<li>Nested Class Summary</li>
<li>Field Summary</li>
<li>Constructor Summary</li>
<li>Method Summary</li>
</ul>
<ul>
<li>Field Detail</li>
<li>Constructor Detail</li>
<li>Method Detail</li>
</ul>
<p>Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p>
</li>
<li class="blockList">
<h2>Annotation Type</h2>
<p>Each annotation type has its own separate page with the following sections:</p>
<ul>
<li>Annotation Type declaration</li>
<li>Annotation Type description</li>
<li>Required Element Summary</li>
<li>Optional Element Summary</li>
<li>Element Detail</li>
</ul>
</li>
<li class="blockList">
<h2>Enum</h2>
<p>Each enum has its own separate page with the following sections:</p>
<ul>
<li>Enum declaration</li>
<li>Enum description</li>
<li>Enum Constant Summary</li>
<li>Enum Constant Detail</li>
</ul>
</li>
<li class="blockList">
<h2>Tree (Class Hierarchy)</h2>
<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.</p>
<ul>
<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li>
<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li>
</ul>
</li>
<li class="blockList">
<h2>Deprecated API</h2>
<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p>
</li>
<li class="blockList">
<h2>Index</h2>
<p>The <a href="index-all.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p>
</li>
<li class="blockList">
<h2>Prev/Next</h2>
<p>These links take you to the next or previous class, interface, package, or related page.</p>
</li>
<li class="blockList">
<h2>Frames/No Frames</h2>
<p>These links show and hide the HTML frames. All pages are available with or without frames.</p>
</li>
<li class="blockList">
<h2>All Classes</h2>
<p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p>
</li>
<li class="blockList">
<h2>Serialized Form</h2>
<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.</p>
</li>
<li class="blockList">
<h2>Constant Field Values</h2>
<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
</li>
</ul>
<span class="emphasizedPhrase">This help file applies to API documentation generated using the standard doclet.</span></div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li class="navBarCell1Rev">Help</li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?help-doc.html" target="_top">Frames</a></li>
<li><a href="help-doc.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

321
dita-ot-3.6/doc/api/index-all.html Normal file
View file

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

75
dita-ot-3.6/doc/api/index.html Normal file
View file

@ -0,0 +1,75 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DITA Open Toolkit 3.6.0</title>
<script type="text/javascript">
tmpTargetPage = "" + window.location.search;
if (tmpTargetPage != "" && tmpTargetPage != "undefined")
tmpTargetPage = tmpTargetPage.substring(1);
if (tmpTargetPage.indexOf(":") != -1 || (tmpTargetPage != "" && !validURL(tmpTargetPage)))
tmpTargetPage = "undefined";
targetPage = tmpTargetPage;
function validURL(url) {
try {
url = decodeURIComponent(url);
}
catch (error) {
return false;
}
var pos = url.indexOf(".html");
if (pos == -1 || pos != url.length - 5)
return false;
var allowNumber = false;
var allowSep = false;
var seenDot = false;
for (var i = 0; i < url.length - 5; i++) {
var ch = url.charAt(i);
if ('a' <= ch && ch <= 'z' ||
'A' <= ch && ch <= 'Z' ||
ch == '$' ||
ch == '_' ||
ch.charCodeAt(0) > 127) {
allowNumber = true;
allowSep = true;
} else if ('0' <= ch && ch <= '9'
|| ch == '-') {
if (!allowNumber)
return false;
} else if (ch == '/' || ch == '.') {
if (!allowSep)
return false;
allowNumber = false;
allowSep = false;
if (ch == '.')
seenDot = true;
if (ch == '/' && seenDot)
return false;
} else {
return false;
}
}
return true;
}
function loadFrames() {
if (targetPage != "" && targetPage != "undefined")
top.classFrame.location = top.targetPage;
}
</script>
</head>
<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()">
<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()">
<frame src="overview-frame.html" name="packageListFrame" title="All Packages">
<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)">
</frameset>
<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes">
<noframes>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<h2>Frame Alert</h2>
<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p>
</noframes>
</frameset>
</html>

467
dita-ot-3.6/doc/api/org/dita/dost/Processor.html Normal file
View file

@ -0,0 +1,467 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Processor (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Processor (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/dita/dost/Processor.html" target="_top">Frames</a></li>
<li><a href="Processor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.dita.dost</div>
<h2 title="Class Processor" class="title">Class Processor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.dita.dost.Processor</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">Processor</span>
extends java.lang.Object</pre>
<div class="block">DITA-OT processer. Not thread-safe, but can be reused.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#cleanOnFailure-boolean-">cleanOnFailure</a></span>(boolean&nbsp;cleanOnFailure)</code>
<div class="block">Clean temporary directory when process fails.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#createDebugLog-boolean-">createDebugLog</a></span>(boolean&nbsp;createDebugLog)</code>
<div class="block">Write a debug log to temporary directory.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#run--">run</a></span>()</code>
<div class="block">Run process</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#setInput-java.io.File-">setInput</a></span>(java.io.File&nbsp;input)</code>
<div class="block">Set input document.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#setInput-java.net.URI-">setInput</a></span>(java.net.URI&nbsp;input)</code>
<div class="block">Set input document.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#setLogger-org.slf4j.Logger-">setLogger</a></span>(org.slf4j.Logger&nbsp;logger)</code>
<div class="block">Set process logger</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#setMode-org.dita.dost.util.Configuration.Mode-">setMode</a></span>(<a href="../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a>&nbsp;mode)</code>
<div class="block">Set error recovery mode.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#setOutputDir-java.io.File-">setOutputDir</a></span>(java.io.File&nbsp;output)</code>
<div class="block">Set output directory.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#setOutputDir-java.net.URI-">setOutputDir</a></span>(java.net.URI&nbsp;output)</code>
<div class="block">Set output directory.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#setProperties-java.util.Map-">setProperties</a></span>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;value)</code>
<div class="block">Set properties.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/Processor.html#setProperty-java.lang.String-java.lang.String-">setProperty</a></span>(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</code>
<div class="block">Set property.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setInput-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInput</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;setInput(java.io.File&nbsp;input)</pre>
<div class="block">Set input document.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - input document file</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Process object</dd>
</dl>
</li>
</ul>
<a name="setInput-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInput</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;setInput(java.net.URI&nbsp;input)</pre>
<div class="block">Set input document.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - absolute input document URI</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Process object</dd>
</dl>
</li>
</ul>
<a name="setOutputDir-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutputDir</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;setOutputDir(java.io.File&nbsp;output)</pre>
<div class="block">Set output directory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>output</code> - absolute output directory</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Process object</dd>
</dl>
</li>
</ul>
<a name="setOutputDir-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutputDir</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;setOutputDir(java.net.URI&nbsp;output)</pre>
<div class="block">Set output directory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>output</code> - absolute output directory URI</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Process object</dd>
</dl>
</li>
</ul>
<a name="setProperty-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;setProperty(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</pre>
<div class="block">Set property. Existing property mapping will be overridden.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - property name</dd>
<dd><code>value</code> - property value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Process object</dd>
</dl>
</li>
</ul>
<a name="setProperties-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperties</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;setProperties(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;value)</pre>
<div class="block">Set properties. Existing property mapping will be overridden.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - property mappings</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Process object</dd>
</dl>
</li>
</ul>
<a name="setLogger-org.slf4j.Logger-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLogger</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;setLogger(org.slf4j.Logger&nbsp;logger)</pre>
<div class="block">Set process logger</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>logger</code> - process logger</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Process object</dd>
</dl>
</li>
</ul>
<a name="cleanOnFailure-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanOnFailure</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;cleanOnFailure(boolean&nbsp;cleanOnFailure)</pre>
<div class="block">Clean temporary directory when process fails. By default temporary directory is always cleaned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cleanOnFailure</code> - clean on failure</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Process object</dd>
</dl>
</li>
</ul>
<a name="createDebugLog-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDebugLog</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;createDebugLog(boolean&nbsp;createDebugLog)</pre>
<div class="block">Write a debug log to temporary directory. The name of the debug log is temporary file with <code>.log</code> extension.
By default debug log is generated</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>createDebugLog</code> - create debug log</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Process object</dd>
</dl>
</li>
</ul>
<a name="setMode-org.dita.dost.util.Configuration.Mode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMode</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;setMode(<a href="../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a>&nbsp;mode)</pre>
<div class="block">Set error recovery mode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mode</code> - processing mode</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Process object</dd>
</dl>
</li>
</ul>
<a name="run--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;void&nbsp;run()
throws <a href="../../../org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></pre>
<div class="block">Run process</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></code> - if processing failed</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/dita/dost/Processor.html" target="_top">Frames</a></li>
<li><a href="Processor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

286
dita-ot-3.6/doc/api/org/dita/dost/ProcessorFactory.html Normal file
View file

@ -0,0 +1,286 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ProcessorFactory (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ProcessorFactory (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/dita/dost/ProcessorFactory.html" target="_top">Frames</a></li>
<li><a href="ProcessorFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.dita.dost</div>
<h2 title="Class ProcessorFactory" class="title">Class ProcessorFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.dita.dost.ProcessorFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">ProcessorFactory</span>
extends java.lang.Object</pre>
<div class="block">DITA-OT processer factory. Not thread-safe, but can be reused.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost">ProcessorFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/ProcessorFactory.html#newInstance-java.io.File-">newInstance</a></span>(java.io.File&nbsp;ditaDir)</code>
<div class="block">Obtain a new instance of a ProcessorFactory.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/ProcessorFactory.html#newProcessor-java.lang.String-">newProcessor</a></span>(java.lang.String&nbsp;transtype)</code>
<div class="block">Create new Processor to run DITA-OT</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/dita/dost/ProcessorFactory.html#setBaseTempDir-java.io.File-">setBaseTempDir</a></span>(java.io.File&nbsp;tmp)</code>
<div class="block">Set base directory for temporary directories.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newInstance-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newInstance</h4>
<pre>public static&nbsp;<a href="../../../org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost">ProcessorFactory</a>&nbsp;newInstance(java.io.File&nbsp;ditaDir)</pre>
<div class="block">Obtain a new instance of a ProcessorFactory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ditaDir</code> - absolute directory to DITA-OT installation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new ProcessorFactory instance</dd>
</dl>
</li>
</ul>
<a name="setBaseTempDir-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBaseTempDir</h4>
<pre>public&nbsp;void&nbsp;setBaseTempDir(java.io.File&nbsp;tmp)</pre>
<div class="block">Set base directory for temporary directories.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tmp</code> - absolute directory for temporary directories</dd>
</dl>
</li>
</ul>
<a name="newProcessor-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newProcessor</h4>
<pre>public&nbsp;<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a>&nbsp;newProcessor(java.lang.String&nbsp;transtype)</pre>
<div class="block">Create new Processor to run DITA-OT</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transtype</code> - transtype for the processor</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new Processor instance</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/dita/dost/ProcessorFactory.html" target="_top">Frames</a></li>
<li><a href="ProcessorFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

397
dita-ot-3.6/doc/api/org/dita/dost/exception/DITAOTException.html Normal file
View file

@ -0,0 +1,397 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DITAOTException (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DITAOTException (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/exception/DITAOTException.html" target="_top">Frames</a></li>
<li><a href="DITAOTException.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.dita.dost.exception</div>
<h2 title="Class DITAOTException" class="title">Class DITAOTException</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li>
<ul class="inheritance">
<li>org.dita.dost.exception.DITAOTException</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">DITAOTException</span>
extends java.lang.Exception</pre>
<div class="block">Exception class for DITAOT, used to handle exceptions in Java modules.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.dita.dost.exception.DITAOTException">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/exception/DITAOTException.html#DITAOTException--">DITAOTException</a></span>()</code>
<div class="block">Constructs a new DITAOTException with <code>null</code>
as its detail message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/exception/DITAOTException.html#DITAOTException-MessageBean-java.lang.Throwable-java.lang.String-">DITAOTException</a></span>(MessageBean&nbsp;msgBean,
java.lang.Throwable&nbsp;cause,
java.lang.String&nbsp;message)</code>
<div class="block">Constructs a new exception with the detailed messagebean and
cause.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.String-">DITAOTException</a></span>(java.lang.String&nbsp;message)</code>
<div class="block">Constructs a new exception with the specified detail message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.String-java.lang.Throwable-">DITAOTException</a></span>(java.lang.String&nbsp;message,
java.lang.Throwable&nbsp;cause)</code>
<div class="block">Constructs a new exception with the specified detail message and
cause.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.String-net.sf.saxon.trans.UncheckedXPathException-">DITAOTException</a></span>(java.lang.String&nbsp;message,
net.sf.saxon.trans.UncheckedXPathException&nbsp;cause)</code>
<div class="block">Constructs a new exception with the specified detail message and
cause, using location information from a root <code>XPathException</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.Throwable-">DITAOTException</a></span>(java.lang.Throwable&nbsp;cause)</code>
<div class="block">Constructs a new exception with the specified detail cause.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/exception/DITAOTException.html#DITAOTException-net.sf.saxon.trans.UncheckedXPathException-">DITAOTException</a></span>(net.sf.saxon.trans.UncheckedXPathException&nbsp;cause)</code>
<div class="block">Constructs a new exception with cause, using location information from a root <code>XPathException</code></div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DITAOTException--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DITAOTException</h4>
<pre>public&nbsp;DITAOTException()</pre>
<div class="block">Constructs a new DITAOTException with <code>null</code>
as its detail message.</div>
</li>
</ul>
<a name="DITAOTException-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DITAOTException</h4>
<pre>public&nbsp;DITAOTException(java.lang.String&nbsp;message)</pre>
<div class="block">Constructs a new exception with the specified detail message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the detail message</dd>
</dl>
</li>
</ul>
<a name="DITAOTException-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DITAOTException</h4>
<pre>public&nbsp;DITAOTException(java.lang.Throwable&nbsp;cause)</pre>
<div class="block">Constructs a new exception with the specified detail cause.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - the cause</dd>
</dl>
</li>
</ul>
<a name="DITAOTException-java.lang.String-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DITAOTException</h4>
<pre>public&nbsp;DITAOTException(java.lang.String&nbsp;message,
java.lang.Throwable&nbsp;cause)</pre>
<div class="block">Constructs a new exception with the specified detail message and
cause.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the detail message.</dd>
<dd><code>cause</code> - the cause</dd>
</dl>
</li>
</ul>
<a name="DITAOTException-net.sf.saxon.trans.UncheckedXPathException-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DITAOTException</h4>
<pre>public&nbsp;DITAOTException(net.sf.saxon.trans.UncheckedXPathException&nbsp;cause)</pre>
<div class="block">Constructs a new exception with cause, using location information from a root <code>XPathException</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - the cause</dd>
</dl>
</li>
</ul>
<a name="DITAOTException-java.lang.String-net.sf.saxon.trans.UncheckedXPathException-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DITAOTException</h4>
<pre>public&nbsp;DITAOTException(java.lang.String&nbsp;message,
net.sf.saxon.trans.UncheckedXPathException&nbsp;cause)</pre>
<div class="block">Constructs a new exception with the specified detail message and
cause, using location information from a root <code>XPathException</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the detail message.</dd>
<dd><code>cause</code> - the cause</dd>
</dl>
</li>
</ul>
<a name="DITAOTException-MessageBean-java.lang.Throwable-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DITAOTException</h4>
<pre>public&nbsp;DITAOTException(MessageBean&nbsp;msgBean,
java.lang.Throwable&nbsp;cause,
java.lang.String&nbsp;message)</pre>
<div class="block">Constructs a new exception with the detailed messagebean and
cause.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msgBean</code> - the bean contains detailed information for log statistic.</dd>
<dd><code>cause</code> - the cause</dd>
<dd><code>message</code> - the detail message.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/exception/DITAOTException.html" target="_top">Frames</a></li>
<li><a href="DITAOTException.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

19
dita-ot-3.6/doc/api/org/dita/dost/exception/package-frame.html Normal file
View file

@ -0,0 +1,19 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.dita.dost.exception (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<h1 class="bar"><a href="../../../../org/dita/dost/exception/package-summary.html" target="classFrame">org.dita.dost.exception</a></h1>
<div class="indexContainer">
<h2 title="Exceptions">Exceptions</h2>
<ul title="Exceptions">
<li><a href="DITAOTException.html" title="class in org.dita.dost.exception" target="classFrame">DITAOTException</a></li>
</ul>
</div>
</body>
</html>

141
dita-ot-3.6/doc/api/org/dita/dost/exception/package-summary.html Normal file
View file

@ -0,0 +1,141 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.dita.dost.exception (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.dita.dost.exception (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/dita/dost/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/dita/dost/util/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/exception/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.dita.dost.exception</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></td>
<td class="colLast">
<div class="block">Exception class for DITAOT, used to handle exceptions in Java modules.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/dita/dost/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/dita/dost/util/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/exception/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

142
dita-ot-3.6/doc/api/org/dita/dost/exception/package-tree.html Normal file
View file

@ -0,0 +1,142 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.dita.dost.exception Class Hierarchy (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.dita.dost.exception Class Hierarchy (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/dita/dost/package-tree.html">Prev</a></li>
<li><a href="../../../../org/dita/dost/util/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/exception/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Hierarchy For Package org.dita.dost.exception</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">java.lang.Throwable (implements java.io.Serializable)
<ul>
<li type="circle">java.lang.Exception
<ul>
<li type="circle">org.dita.dost.exception.<a href="../../../../org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception"><span class="typeNameLink">DITAOTException</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/dita/dost/package-tree.html">Prev</a></li>
<li><a href="../../../../org/dita/dost/util/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/exception/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

20
dita-ot-3.6/doc/api/org/dita/dost/package-frame.html Normal file
View file

@ -0,0 +1,20 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.dita.dost (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<h1 class="bar"><a href="../../../org/dita/dost/package-summary.html" target="classFrame">org.dita.dost</a></h1>
<div class="indexContainer">
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="Processor.html" title="class in org.dita.dost" target="classFrame">Processor</a></li>
<li><a href="ProcessorFactory.html" title="class in org.dita.dost" target="classFrame">ProcessorFactory</a></li>
</ul>
</div>
</body>
</html>

147
dita-ot-3.6/doc/api/org/dita/dost/package-summary.html Normal file
View file

@ -0,0 +1,147 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.dita.dost (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.dita.dost (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li><a href="../../../org/dita/dost/exception/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/dita/dost/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.dita.dost</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></td>
<td class="colLast">
<div class="block">DITA-OT processer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost">ProcessorFactory</a></td>
<td class="colLast">
<div class="block">DITA-OT processer factory.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li><a href="../../../org/dita/dost/exception/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/dita/dost/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

135
dita-ot-3.6/doc/api/org/dita/dost/package-tree.html Normal file
View file

@ -0,0 +1,135 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.dita.dost Class Hierarchy (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.dita.dost Class Hierarchy (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li><a href="../../../org/dita/dost/exception/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/dita/dost/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Hierarchy For Package org.dita.dost</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">org.dita.dost.<a href="../../../org/dita/dost/Processor.html" title="class in org.dita.dost"><span class="typeNameLink">Processor</span></a></li>
<li type="circle">org.dita.dost.<a href="../../../org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost"><span class="typeNameLink">ProcessorFactory</span></a></li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li><a href="../../../org/dita/dost/exception/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/dita/dost/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

364
dita-ot-3.6/doc/api/org/dita/dost/util/Configuration.Mode.html Normal file
View file

@ -0,0 +1,364 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Configuration.Mode (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Configuration.Mode (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/util/Configuration.Mode.html" target="_top">Frames</a></li>
<li><a href="Configuration.Mode.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.dita.dost.util</div>
<h2 title="Enum Configuration.Mode" class="title">Enum Configuration.Mode</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.dita.dost.util.Configuration.Mode</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a>&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dd>
</dl>
<hr>
<br>
<pre>public static enum <span class="typeNameLabel">Configuration.Mode</span>
extends java.lang.Enum&lt;<a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a>&gt;</pre>
<div class="block">Processing mode</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Enum Constant and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.Mode.html#LAX">LAX</a></span></code>
<div class="block">Processing continues after error with error recovery</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.Mode.html#SKIP">SKIP</a></span></code>
<div class="block">Processing continues after error and will not attempt error recovery</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.Mode.html#STRICT">STRICT</a></span></code>
<div class="block">Processing fails on error.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.Mode.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.Mode.html#values--">values</a></span>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a name="STRICT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STRICT</h4>
<pre>public static final&nbsp;<a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a> STRICT</pre>
<div class="block">Processing fails on error.</div>
</li>
</ul>
<a name="SKIP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SKIP</h4>
<pre>public static final&nbsp;<a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a> SKIP</pre>
<div class="block">Processing continues after error and will not attempt error recovery</div>
</li>
</ul>
<a name="LAX">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LAX</h4>
<pre>public static final&nbsp;<a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a> LAX</pre>
<div class="block">Processing continues after error with error recovery</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="values--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public static&nbsp;<a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (Configuration.Mode c : Configuration.Mode.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a name="valueOf-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/util/Configuration.Mode.html" target="_top">Frames</a></li>
<li><a href="Configuration.Mode.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

375
dita-ot-3.6/doc/api/org/dita/dost/util/Configuration.html Normal file
View file

@ -0,0 +1,375 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Configuration (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Configuration (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/util/Configuration.html" target="_top">Frames</a></li>
<li><a href="Configuration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.dita.dost.util</div>
<h2 title="Class Configuration" class="title">Class Configuration</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.dita.dost.util.Configuration</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">Configuration</span>
extends java.lang.Object</pre>
<div class="block">Global configuration object for static configurations.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.3</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a></span></code>
<div class="block">Processing mode</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.html#configuration">configuration</a></span></code>
<div class="block">Immutable configuration properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.html#DEBUG">DEBUG</a></span></code>
<div class="block">Debug mode to aid in development, not intended for end users.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.html#ditaFormat">ditaFormat</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Map&lt;java.lang.String,java.util.Map&lt;java.lang.String,java.lang.Boolean&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.html#parserFeatures">parserFeatures</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.html#parserMap">parserMap</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Map&lt;java.lang.String,java.io.File&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.html#pluginResourceDirs">pluginResourceDirs</a></span></code>
<div class="block">Map of plug-in resource directories.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.html#printTranstype">printTranstype</a></span></code>
<div class="block">List of print-oriented transtypes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/dita/dost/util/Configuration.html#transtypes">transtypes</a></span></code>
<div class="block">List of transtypes.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEBUG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEBUG</h4>
<pre>public static final&nbsp;boolean DEBUG</pre>
<div class="block">Debug mode to aid in development, not intended for end users.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.dita.dost.util.Configuration.DEBUG">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="configuration">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configuration</h4>
<pre>public static final&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt; configuration</pre>
<div class="block">Immutable configuration properties.
<p>If configuration file is not found e.g. during integration, the
configuration will be an empty.</p></div>
</li>
</ul>
<a name="printTranstype">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printTranstype</h4>
<pre>public static final&nbsp;java.util.List&lt;java.lang.String&gt; printTranstype</pre>
<div class="block">List of print-oriented transtypes.</div>
</li>
</ul>
<a name="transtypes">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transtypes</h4>
<pre>public static final&nbsp;java.util.List&lt;java.lang.String&gt; transtypes</pre>
<div class="block">List of transtypes.</div>
</li>
</ul>
<a name="pluginResourceDirs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pluginResourceDirs</h4>
<pre>public static final&nbsp;java.util.Map&lt;java.lang.String,java.io.File&gt; pluginResourceDirs</pre>
<div class="block">Map of plug-in resource directories.</div>
</li>
</ul>
<a name="parserMap">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parserMap</h4>
<pre>public static final&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt; parserMap</pre>
</li>
</ul>
<a name="parserFeatures">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parserFeatures</h4>
<pre>public static final&nbsp;java.util.Map&lt;java.lang.String,java.util.Map&lt;java.lang.String,java.lang.Boolean&gt;&gt; parserFeatures</pre>
</li>
</ul>
<a name="ditaFormat">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ditaFormat</h4>
<pre>public static final&nbsp;java.util.Set&lt;java.lang.String&gt; ditaFormat</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/util/Configuration.html" target="_top">Frames</a></li>
<li><a href="Configuration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

23
dita-ot-3.6/doc/api/org/dita/dost/util/package-frame.html Normal file
View file

@ -0,0 +1,23 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.dita.dost.util (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<h1 class="bar"><a href="../../../../org/dita/dost/util/package-summary.html" target="classFrame">org.dita.dost.util</a></h1>
<div class="indexContainer">
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="Configuration.html" title="class in org.dita.dost.util" target="classFrame">Configuration</a></li>
</ul>
<h2 title="Enums">Enums</h2>
<ul title="Enums">
<li><a href="Configuration.Mode.html" title="enum in org.dita.dost.util" target="classFrame">Configuration.Mode</a></li>
</ul>
</div>
</body>
</html>

158
dita-ot-3.6/doc/api/org/dita/dost/util/package-summary.html Normal file
View file

@ -0,0 +1,158 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.dita.dost.util (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.dita.dost.util (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/dita/dost/exception/package-summary.html">Prev&nbsp;Package</a></li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/util/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.dita.dost.util</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></td>
<td class="colLast">
<div class="block">Global configuration object for static configurations.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a></td>
<td class="colLast">
<div class="block">Processing mode</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/dita/dost/exception/package-summary.html">Prev&nbsp;Package</a></li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/util/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

146
dita-ot-3.6/doc/api/org/dita/dost/util/package-tree.html Normal file
View file

@ -0,0 +1,146 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.dita.dost.util Class Hierarchy (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.dita.dost.util Class Hierarchy (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/dita/dost/exception/package-tree.html">Prev</a></li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/util/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Hierarchy For Package org.dita.dost.util</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">org.dita.dost.util.<a href="../../../../org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util"><span class="typeNameLink">Configuration</span></a></li>
</ul>
</li>
</ul>
<h2 title="Enum Hierarchy">Enum Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
<ul>
<li type="circle">org.dita.dost.util.<a href="../../../../org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util"><span class="typeNameLink">Configuration.Mode</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/dita/dost/exception/package-tree.html">Prev</a></li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/dita/dost/util/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

22
dita-ot-3.6/doc/api/overview-frame.html Normal file
View file

@ -0,0 +1,22 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Overview List (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<div class="indexHeader"><span><a href="allclasses-frame.html" target="packageFrame">All&nbsp;Classes</a></span></div>
<div class="indexContainer">
<h2 title="Packages">Packages</h2>
<ul title="Packages">
<li><a href="org/dita/dost/package-frame.html" target="packageFrame">org.dita.dost</a></li>
<li><a href="org/dita/dost/exception/package-frame.html" target="packageFrame">org.dita.dost.exception</a></li>
<li><a href="org/dita/dost/util/package-frame.html" target="packageFrame">org.dita.dost.util</a></li>
</ul>
</div>
<p>&nbsp;</p>
</body>
</html>

143
dita-ot-3.6/doc/api/overview-summary.html Normal file
View file

@ -0,0 +1,143 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Overview (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Overview (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">DITA Open Toolkit 3.6.0</h1>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/dita/dost/package-summary.html">org.dita.dost</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/dita/dost/exception/package-summary.html">org.dita.dost.exception</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/dita/dost/util/package-summary.html">org.dita.dost.util</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

159
dita-ot-3.6/doc/api/overview-tree.html Normal file
View file

@ -0,0 +1,159 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Class Hierarchy (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Class Hierarchy (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-tree.html" target="_top">Frames</a></li>
<li><a href="overview-tree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Hierarchy For All Packages</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="org/dita/dost/package-tree.html">org.dita.dost</a>, </li>
<li><a href="org/dita/dost/exception/package-tree.html">org.dita.dost.exception</a>, </li>
<li><a href="org/dita/dost/util/package-tree.html">org.dita.dost.util</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util"><span class="typeNameLink">Configuration</span></a></li>
<li type="circle">org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost"><span class="typeNameLink">Processor</span></a></li>
<li type="circle">org.dita.dost.<a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost"><span class="typeNameLink">ProcessorFactory</span></a></li>
<li type="circle">java.lang.Throwable (implements java.io.Serializable)
<ul>
<li type="circle">java.lang.Exception
<ul>
<li type="circle">org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception"><span class="typeNameLink">DITAOTException</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 title="Enum Hierarchy">Enum Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
<ul>
<li type="circle">org.dita.dost.util.<a href="org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util"><span class="typeNameLink">Configuration.Mode</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-tree.html" target="_top">Frames</a></li>
<li><a href="overview-tree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

3
dita-ot-3.6/doc/api/package-list Normal file
View file

@ -0,0 +1,3 @@
org.dita.dost
org.dita.dost.exception
org.dita.dost.util

30
dita-ot-3.6/doc/api/script.js Normal file
View file

@ -0,0 +1,30 @@
function show(type)
{
count = 0;
for (var key in methods) {
var row = document.getElementById(key);
if ((methods[key] & type) != 0) {
row.style.display = '';
row.className = (count++ % 2) ? rowColor : altColor;
}
else
row.style.display = 'none';
}
updateTabs(type);
}
function updateTabs(type)
{
for (var value in tabs) {
var sNode = document.getElementById(tabs[value][0]);
var spanNode = sNode.firstChild;
if (value == type) {
sNode.className = activeTableTab;
spanNode.innerHTML = tabs[value][1];
}
else {
sNode.className = tableTab;
spanNode.innerHTML = "<a href=\"javascript:show("+ value + ");\">" + tabs[value][1] + "</a>";
}
}
}

155
dita-ot-3.6/doc/api/serialized-form.html Normal file
View file

@ -0,0 +1,155 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Serialized Form (DITA Open Toolkit 3.6.0)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Serialized Form (DITA Open Toolkit 3.6.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?serialized-form.html" target="_top">Frames</a></li>
<li><a href="serialized-form.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Serialized Form" class="title">Serialized Form</h1>
</div>
<div class="serializedFormContainer">
<ul class="blockList">
<li class="blockList">
<h2 title="Package">Package&nbsp;org.dita.dost.exception</h2>
<ul class="blockList">
<li class="blockList"><a name="org.dita.dost.exception.DITAOTException">
<!-- -->
</a>
<h3>Class <a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">org.dita.dost.exception.DITAOTException</a> extends java.lang.Exception implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>-7505646495801170017L</dd>
</dl>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>messageBean</h4>
<pre>MessageBean messageBean</pre>
<div class="block">message bean.</div>
</li>
<li class="blockListLast">
<h4>captured</h4>
<pre>boolean captured</pre>
<div class="block">capture flag.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?serialized-form.html" target="_top">Frames</a></li>
<li><a href="serialized-form.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

574
dita-ot-3.6/doc/api/stylesheet.css Normal file
View file

@ -0,0 +1,574 @@
/* Javadoc style sheet */
/*
Overall document style
*/
@import url('resources/fonts/dejavu.css');
body {
background-color:#ffffff;
color:#353833;
font-family:'DejaVu Sans', Arial, Helvetica, sans-serif;
font-size:14px;
margin:0;
}
a:link, a:visited {
text-decoration:none;
color:#4A6782;
}
a:hover, a:focus {
text-decoration:none;
color:#bb7a2a;
}
a:active {
text-decoration:none;
color:#4A6782;
}
a[name] {
color:#353833;
}
a[name]:hover {
text-decoration:none;
color:#353833;
}
pre {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
}
h1 {
font-size:20px;
}
h2 {
font-size:18px;
}
h3 {
font-size:16px;
font-style:italic;
}
h4 {
font-size:13px;
}
h5 {
font-size:12px;
}
h6 {
font-size:11px;
}
ul {
list-style-type:disc;
}
code, tt {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
padding-top:4px;
margin-top:8px;
line-height:1.4em;
}
dt code {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
padding-top:4px;
}
table tr td dt code {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
vertical-align:top;
padding-top:4px;
}
sup {
font-size:8px;
}
/*
Document title and Copyright styles
*/
.clear {
clear:both;
height:0px;
overflow:hidden;
}
.aboutLanguage {
float:right;
padding:0px 21px;
font-size:11px;
z-index:200;
margin-top:-9px;
}
.legalCopy {
margin-left:.5em;
}
.bar a, .bar a:link, .bar a:visited, .bar a:active {
color:#FFFFFF;
text-decoration:none;
}
.bar a:hover, .bar a:focus {
color:#bb7a2a;
}
.tab {
background-color:#0066FF;
color:#ffffff;
padding:8px;
width:5em;
font-weight:bold;
}
/*
Navigation bar styles
*/
.bar {
background-color:#4D7A97;
color:#FFFFFF;
padding:.8em .5em .4em .8em;
height:auto;/*height:1.8em;*/
font-size:11px;
margin:0;
}
.topNav {
background-color:#4D7A97;
color:#FFFFFF;
float:left;
padding:0;
width:100%;
clear:right;
height:2.8em;
padding-top:10px;
overflow:hidden;
font-size:12px;
}
.bottomNav {
margin-top:10px;
background-color:#4D7A97;
color:#FFFFFF;
float:left;
padding:0;
width:100%;
clear:right;
height:2.8em;
padding-top:10px;
overflow:hidden;
font-size:12px;
}
.subNav {
background-color:#dee3e9;
float:left;
width:100%;
overflow:hidden;
font-size:12px;
}
.subNav div {
clear:left;
float:left;
padding:0 0 5px 6px;
text-transform:uppercase;
}
ul.navList, ul.subNavList {
float:left;
margin:0 25px 0 0;
padding:0;
}
ul.navList li{
list-style:none;
float:left;
padding: 5px 6px;
text-transform:uppercase;
}
ul.subNavList li{
list-style:none;
float:left;
}
.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited {
color:#FFFFFF;
text-decoration:none;
text-transform:uppercase;
}
.topNav a:hover, .bottomNav a:hover {
text-decoration:none;
color:#bb7a2a;
text-transform:uppercase;
}
.navBarCell1Rev {
background-color:#F8981D;
color:#253441;
margin: auto 5px;
}
.skipNav {
position:absolute;
top:auto;
left:-9999px;
overflow:hidden;
}
/*
Page header and footer styles
*/
.header, .footer {
clear:both;
margin:0 20px;
padding:5px 0 0 0;
}
.indexHeader {
margin:10px;
position:relative;
}
.indexHeader span{
margin-right:15px;
}
.indexHeader h1 {
font-size:13px;
}
.title {
color:#2c4557;
margin:10px 0;
}
.subTitle {
margin:5px 0 0 0;
}
.header ul {
margin:0 0 15px 0;
padding:0;
}
.footer ul {
margin:20px 0 5px 0;
}
.header ul li, .footer ul li {
list-style:none;
font-size:13px;
}
/*
Heading styles
*/
div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 {
background-color:#dee3e9;
border:1px solid #d0d9e0;
margin:0 0 6px -8px;
padding:7px 5px;
}
ul.blockList ul.blockList ul.blockList li.blockList h3 {
background-color:#dee3e9;
border:1px solid #d0d9e0;
margin:0 0 6px -8px;
padding:7px 5px;
}
ul.blockList ul.blockList li.blockList h3 {
padding:0;
margin:15px 0;
}
ul.blockList li.blockList h2 {
padding:0px 0 20px 0;
}
/*
Page layout container styles
*/
.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer {
clear:both;
padding:10px 20px;
position:relative;
}
.indexContainer {
margin:10px;
position:relative;
font-size:12px;
}
.indexContainer h2 {
font-size:13px;
padding:0 0 3px 0;
}
.indexContainer ul {
margin:0;
padding:0;
}
.indexContainer ul li {
list-style:none;
padding-top:2px;
}
.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt {
font-size:12px;
font-weight:bold;
margin:10px 0 0 0;
color:#4E4E4E;
}
.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd {
margin:5px 0 10px 0px;
font-size:14px;
font-family:'DejaVu Sans Mono',monospace;
}
.serializedFormContainer dl.nameValue dt {
margin-left:1px;
font-size:1.1em;
display:inline;
font-weight:bold;
}
.serializedFormContainer dl.nameValue dd {
margin:0 0 0 1px;
font-size:1.1em;
display:inline;
}
/*
List styles
*/
ul.horizontal li {
display:inline;
font-size:0.9em;
}
ul.inheritance {
margin:0;
padding:0;
}
ul.inheritance li {
display:inline;
list-style:none;
}
ul.inheritance li ul.inheritance {
margin-left:15px;
padding-left:15px;
padding-top:1px;
}
ul.blockList, ul.blockListLast {
margin:10px 0 10px 0;
padding:0;
}
ul.blockList li.blockList, ul.blockListLast li.blockList {
list-style:none;
margin-bottom:15px;
line-height:1.4;
}
ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList {
padding:0px 20px 5px 10px;
border:1px solid #ededed;
background-color:#f8f8f8;
}
ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList {
padding:0 0 5px 8px;
background-color:#ffffff;
border:none;
}
ul.blockList ul.blockList ul.blockList ul.blockList li.blockList {
margin-left:0;
padding-left:0;
padding-bottom:15px;
border:none;
}
ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast {
list-style:none;
border-bottom:none;
padding-bottom:0;
}
table tr td dl, table tr td dl dt, table tr td dl dd {
margin-top:0;
margin-bottom:1px;
}
/*
Table styles
*/
.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary {
width:100%;
border-left:1px solid #EEE;
border-right:1px solid #EEE;
border-bottom:1px solid #EEE;
}
.overviewSummary, .memberSummary {
padding:0px;
}
.overviewSummary caption, .memberSummary caption, .typeSummary caption,
.useSummary caption, .constantsSummary caption, .deprecatedSummary caption {
position:relative;
text-align:left;
background-repeat:no-repeat;
color:#253441;
font-weight:bold;
clear:none;
overflow:hidden;
padding:0px;
padding-top:10px;
padding-left:1px;
margin:0px;
white-space:pre;
}
.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link,
.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link,
.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover,
.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover,
.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active,
.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active,
.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited,
.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited {
color:#FFFFFF;
}
.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span,
.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
padding-right:12px;
padding-bottom:7px;
display:inline-block;
float:left;
background-color:#F8981D;
border: none;
height:16px;
}
.memberSummary caption span.activeTableTab span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
padding-right:12px;
margin-right:3px;
display:inline-block;
float:left;
background-color:#F8981D;
height:16px;
}
.memberSummary caption span.tableTab span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
padding-right:12px;
margin-right:3px;
display:inline-block;
float:left;
background-color:#4D7A97;
height:16px;
}
.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab {
padding-top:0px;
padding-left:0px;
padding-right:0px;
background-image:none;
float:none;
display:inline;
}
.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd,
.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd {
display:none;
width:5px;
position:relative;
float:left;
background-color:#F8981D;
}
.memberSummary .activeTableTab .tabEnd {
display:none;
width:5px;
margin-right:3px;
position:relative;
float:left;
background-color:#F8981D;
}
.memberSummary .tableTab .tabEnd {
display:none;
width:5px;
margin-right:3px;
position:relative;
background-color:#4D7A97;
float:left;
}
.overviewSummary td, .memberSummary td, .typeSummary td,
.useSummary td, .constantsSummary td, .deprecatedSummary td {
text-align:left;
padding:0px 0px 12px 10px;
}
th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th,
td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{
vertical-align:top;
padding-right:0px;
padding-top:8px;
padding-bottom:3px;
}
th.colFirst, th.colLast, th.colOne, .constantsSummary th {
background:#dee3e9;
text-align:left;
padding:8px 3px 3px 7px;
}
td.colFirst, th.colFirst {
white-space:nowrap;
font-size:13px;
}
td.colLast, th.colLast {
font-size:13px;
}
td.colOne, th.colOne {
font-size:13px;
}
.overviewSummary td.colFirst, .overviewSummary th.colFirst,
.useSummary td.colFirst, .useSummary th.colFirst,
.overviewSummary td.colOne, .overviewSummary th.colOne,
.memberSummary td.colFirst, .memberSummary th.colFirst,
.memberSummary td.colOne, .memberSummary th.colOne,
.typeSummary td.colFirst{
width:25%;
vertical-align:top;
}
td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover {
font-weight:bold;
}
.tableSubHeadingColor {
background-color:#EEEEFF;
}
.altColor {
background-color:#FFFFFF;
}
.rowColor {
background-color:#EEEEEF;
}
/*
Content styles
*/
.description pre {
margin-top:0;
}
.deprecatedContent {
margin:0;
padding:10px 0;
}
.docSummary {
padding:0;
}
ul.blockList ul.blockList ul.blockList li.blockList h3 {
font-style:normal;
}
div.block {
font-size:14px;
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
}
td.colLast div {
padding-top:0px;
}
td.colLast a {
padding-bottom:3px;
}
/*
Formatting effect styles
*/
.sourceLineNo {
color:green;
padding:0 30px 0 0;
}
h1.hidden {
visibility:hidden;
overflow:hidden;
font-size:10px;
}
.block {
display:block;
margin:3px 10px 2px 0px;
color:#474747;
}
.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink,
.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel,
.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink {
font-weight:bold;
}
.deprecationComment, .emphasizedPhrase, .interfaceName {
font-style:italic;
}
div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase,
div.block div.block span.interfaceName {
font-style:normal;
}
div.contentContainer ul.blockList li.blockList h2{
padding-bottom:0px;
}

660
dita-ot-3.6/doc/css/commonltr.css Normal file
View file

@ -0,0 +1,660 @@
/*!
* This file is part of the DITA Open Toolkit project.
*
* Copyright 2004, 2005 IBM Corporation
*
* See the accompanying LICENSE file for applicable license.
*/
.frame-top {
border-top: solid 1px;
border-right: 0;
border-bottom: 0;
border-left: 0;
}
.frame-bottom {
border-top: 0;
border-right: 0;
border-bottom: solid 1px;
border-left: 0;
}
.frame-topbot {
border-top: solid 1px;
border-right: 0;
border-bottom: solid 1px;
border-left: 0;
}
.frame-all {
border: solid 1px;
}
.frame-sides {
border-top: 0;
border-left: solid 1px;
border-right: solid 1px;
border-bottom: 0;
}
.frame-none {
border: 0;
}
.scale-50 {
font-size: 50%;
}
.scale-60 {
font-size: 60%;
}
.scale-70 {
font-size: 70%;
}
.scale-80 {
font-size: 80%;
}
.scale-90 {
font-size: 90%;
}
.scale-100 {
font-size: 100%;
}
.scale-110 {
font-size: 110%;
}
.scale-120 {
font-size: 120%;
}
.scale-140 {
font-size: 140%;
}
.scale-160 {
font-size: 160%;
}
.scale-180 {
font-size: 180%;
}
.scale-200 {
font-size: 200%;
}
.expanse-page, .expanse-spread {
width: 100%;
}
.hazardstatement td,
.hazardstatement th {
padding: 0.5rem;
}
.hazardstatement th {
text-align: center;
text-transform: uppercase;
}
.hazardstatement--caution {
background-color: #ffd100;
}
.hazardstatement--danger {
background-color: #c8102e;
color: #fff;
}
.hazardstatement--warning {
background-color: #ff8200;
}
.hazardstatement--attention, .hazardstatement--fastpath, .hazardstatement--important, .hazardstatement--note, .hazardstatement--notice, .hazardstatement--other, .hazardstatement--remember, .hazardstatement--restriction, .hazardstatement--tip {
background-color: #0072ce;
color: #fff;
font-style: italic;
}
.line-through {
text-decoration: line-through;
}
.overline {
text-decoration: overline;
}
.codeblock {
font-family: monospace;
}
.syntaxdiagram {
border: 1 black solid;
color: maroon;
display: block;
margin-bottom: 6pt;
padding: 2pt;
}
.codeph {
font-family: monospace;
}
.kwd {
font-weight: bold;
}
.parmname {
font-weight: bold;
}
.var {
font-style: italic;
}
.filepath {
font-family: monospace;
}
.tasklabel {
font-size: 100%;
margin-bottom: 1em;
margin-top: 1em;
}
.lq div {
text-align: right;
}
.boolean {
color: green;
}
.state {
color: red;
}
.screen {
background-color: #ccc;
border: outset;
margin-bottom: 2px;
margin-top: 2px;
padding: 5px;
white-space: pre;
}
.wintitle {
font-weight: bold;
}
.numcharref {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.parameterentity {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.textentity {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.xmlatt {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.xmlelement {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.xmlnsname {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.xmlpi {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.fig {
/* Default of italics to set apart figure captions */
/* Use @frame to create frames on figures */
}
.figcap {
font-style: italic;
}
.figdesc {
font-style: normal;
}
.figborder {
border-color: Silver;
border-style: solid;
border-width: 2px;
margin-top: 1em;
padding-left: 3px;
padding-right: 3px;
}
.figsides {
border-color: Silver;
border-left: 2px solid;
border-right: 2px solid;
margin-top: 1em;
padding-left: 3px;
padding-right: 3px;
}
.figtop {
border-color: Silver;
border-top: 2px solid;
margin-top: 1em;
}
.figbottom {
border-bottom: 2px solid;
border-color: Silver;
}
.figtopbot {
border-bottom: 2px solid;
border-color: Silver;
border-top: 2px solid;
margin-top: 1em;
}
/* Align images based on @align on topic/image */
div.imageleft {
text-align: left;
}
div.imagecenter {
text-align: center;
}
div.imageright {
text-align: right;
}
div.imagejustify {
text-align: justify;
}
/* Set heading sizes, getting smaller for deeper nesting */
.topictitle1 {
font-size: 1.34em;
margin-bottom: 0.1em;
margin-top: 0;
}
.topictitle2 {
font-size: 1.17em;
margin-bottom: 0.45em;
margin-top: 1pc;
}
.topictitle3 {
font-size: 1.17em;
font-weight: bold;
margin-bottom: 0.17em;
margin-top: 1pc;
}
.topictitle4 {
font-size: 1.17em;
font-weight: bold;
margin-top: 0.83em;
}
.topictitle5 {
font-size: 1.17em;
font-weight: bold;
}
.topictitle6 {
font-size: 1.17em;
font-style: italic;
}
.sectiontitle {
color: #000;
font-size: 1.17em;
font-weight: bold;
margin-bottom: 0;
margin-top: 1em;
}
.section {
margin-bottom: 1em;
margin-top: 1em;
}
.example {
margin-bottom: 1em;
margin-top: 1em;
}
.indexterm {
background-color: #fdf;
border: 1pt #000 solid;
margin: 1pt;
}
/* Most link groups are created with <div>. Ensure they have space before and after. */
.ullinks {
list-style-type: none;
}
.ulchildlink {
margin-bottom: 1em;
margin-top: 1em;
}
.olchildlink {
margin-bottom: 1em;
margin-top: 1em;
}
.linklist {
margin-bottom: 1em;
}
ul.linklist {
margin-top: 0;
list-style-type: none;
padding-left: 0;
}
li.linklist {
margin-top: 0;
margin-bottom: 0;
}
.linklistwithchild {
margin-bottom: 1em;
margin-left: 1.5em;
}
.sublinklist {
margin-bottom: 1em;
margin-left: 1.5em;
}
.relconcepts {
margin-bottom: 1em;
margin-top: 1em;
}
.reltasks {
margin-bottom: 1em;
margin-top: 1em;
}
.relref {
margin-bottom: 1em;
margin-top: 1em;
}
.relinfo {
margin-bottom: 1em;
margin-top: 1em;
}
.breadcrumb {
font-size: smaller;
margin-bottom: 1em;
}
/* Simple lists do not get a bullet */
ul.simple {
list-style-type: none;
}
/* Default of bold for definition list terms */
.dlterm {
font-weight: bold;
}
/* Use CSS to expand lists with @compact="no" */
.dltermexpand {
font-weight: bold;
margin-top: 1em;
}
*[compact="yes"] > li {
margin-top: 0;
}
*[compact="no"] > li {
margin-top: 0.53em;
}
.liexpand {
margin-bottom: 1em;
margin-top: 1em;
}
.sliexpand {
margin-bottom: 1em;
margin-top: 1em;
}
.dlexpand {
margin-bottom: 1em;
margin-top: 1em;
}
.ddexpand {
margin-bottom: 1em;
margin-top: 1em;
}
.stepexpand {
margin-bottom: 1em;
margin-top: 1em;
}
.substepexpand {
margin-bottom: 1em;
margin-top: 1em;
}
dt.prereq {
margin-left: 20px;
}
/* All note formats have the same default presentation */
.note {
margin-bottom: 1em;
margin-top: 1em;
}
.note .notetitle, .note .notelisttitle,
.note .note__title {
font-weight: bold;
}
/* Various basic phrase styles */
.bold {
font-weight: bold;
}
.bolditalic {
font-style: italic;
font-weight: bold;
}
.italic {
font-style: italic;
}
.underlined {
text-decoration: underline;
}
.uicontrol {
font-weight: bold;
}
.defkwd {
font-weight: bold;
text-decoration: underline;
}
.shortcut {
text-decoration: underline;
}
.menucascade > abbr {
text-decoration: none;
}
table {
border-collapse: collapse;
}
table .desc {
display: block;
font-style: italic;
}
.cellrowborder {
border-bottom: solid 1px;
border-left: 0;
border-right: solid 1px;
border-top: 0;
}
.row-nocellborder {
border-bottom: solid 1px;
border-left: 0;
border-top: 0;
}
.cell-norowborder {
border-left: 0;
border-right: solid 1px;
border-top: 0;
}
.nocellnorowborder {
border: 0;
}
.firstcol {
font-weight: bold;
}
.table--pgwide-1 {
width: 100%;
}
.align-left {
text-align: left;
}
.align-right {
text-align: right;
}
.align-center {
text-align: center;
}
.align-justify {
text-align: justify;
}
.align-char {
text-align: char;
}
.valign-top {
vertical-align: top;
}
.valign-bottom {
vertical-align: bottom;
}
.valign-middle {
vertical-align: middle;
}
.colsep-0 {
border-right: 0;
}
.colsep-1 {
border-right: 1px solid;
}
.rowsep-0 {
border-bottom: 0;
}
.rowsep-1 {
border-bottom: 1px solid;
}
.entry.rotate {
writing-mode: vertical-rl;
}
.stentry {
border-right: 1px solid;
border-bottom: 1px solid;
}
.stentry:last-child {
border-right: 0;
}
.strow:last-child .stentry {
border-bottom: 0;
}
/* Add space for top level topics */
.nested0 {
margin-top: 1em;
}
/* div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid */
.p {
margin-top: 1em;
}
/* flagging styles */
.flag__style--italics {
font-style: italic;
}
.flag__style--bold {
font-weight: bold;
}
.flag__style--underline {
text-decoration: underline;
}
.flag__style--double-underline {
text-decoration: double-underline;
}
.flag__style--overline {
text-decoration: overline;
}

710
dita-ot-3.6/doc/css/commonrtl.css Normal file
View file

@ -0,0 +1,710 @@
/*!
* This file is part of the DITA Open Toolkit project.
*
* Copyright 2015 Jarno Elovirta
*
* See the accompanying LICENSE file for applicable license.
*/
/*!
* This file is part of the DITA Open Toolkit project.
*
* Copyright 2004, 2005 IBM Corporation
*
* See the accompanying LICENSE file for applicable license.
*/
.frame-top {
border-top: solid 1px;
border-right: 0;
border-bottom: 0;
border-left: 0;
}
.frame-bottom {
border-top: 0;
border-right: 0;
border-bottom: solid 1px;
border-left: 0;
}
.frame-topbot {
border-top: solid 1px;
border-right: 0;
border-bottom: solid 1px;
border-left: 0;
}
.frame-all {
border: solid 1px;
}
.frame-sides {
border-top: 0;
border-left: solid 1px;
border-right: solid 1px;
border-bottom: 0;
}
.frame-none {
border: 0;
}
.scale-50 {
font-size: 50%;
}
.scale-60 {
font-size: 60%;
}
.scale-70 {
font-size: 70%;
}
.scale-80 {
font-size: 80%;
}
.scale-90 {
font-size: 90%;
}
.scale-100 {
font-size: 100%;
}
.scale-110 {
font-size: 110%;
}
.scale-120 {
font-size: 120%;
}
.scale-140 {
font-size: 140%;
}
.scale-160 {
font-size: 160%;
}
.scale-180 {
font-size: 180%;
}
.scale-200 {
font-size: 200%;
}
.expanse-page, .expanse-spread {
width: 100%;
}
.hazardstatement td,
.hazardstatement th {
padding: 0.5rem;
}
.hazardstatement th {
text-align: center;
text-transform: uppercase;
}
.hazardstatement--caution {
background-color: #ffd100;
}
.hazardstatement--danger {
background-color: #c8102e;
color: #fff;
}
.hazardstatement--warning {
background-color: #ff8200;
}
.hazardstatement--attention, .hazardstatement--fastpath, .hazardstatement--important, .hazardstatement--note, .hazardstatement--notice, .hazardstatement--other, .hazardstatement--remember, .hazardstatement--restriction, .hazardstatement--tip {
background-color: #0072ce;
color: #fff;
font-style: italic;
}
.line-through {
text-decoration: line-through;
}
.overline {
text-decoration: overline;
}
.codeblock {
font-family: monospace;
}
.syntaxdiagram {
border: 1 black solid;
color: maroon;
display: block;
margin-bottom: 6pt;
padding: 2pt;
}
.codeph {
font-family: monospace;
}
.kwd {
font-weight: bold;
}
.parmname {
font-weight: bold;
}
.var {
font-style: italic;
}
.filepath {
font-family: monospace;
}
.tasklabel {
font-size: 100%;
margin-bottom: 1em;
margin-top: 1em;
}
.lq div {
text-align: right;
}
.boolean {
color: green;
}
.state {
color: red;
}
.screen {
background-color: #ccc;
border: outset;
margin-bottom: 2px;
margin-top: 2px;
padding: 5px;
white-space: pre;
}
.wintitle {
font-weight: bold;
}
.numcharref {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.parameterentity {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.textentity {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.xmlatt {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.xmlelement {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.xmlnsname {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.xmlpi {
color: #639;
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
}
.fig {
/* Default of italics to set apart figure captions */
/* Use @frame to create frames on figures */
}
.figcap {
font-style: italic;
}
.figdesc {
font-style: normal;
}
.figborder {
border-color: Silver;
border-style: solid;
border-width: 2px;
margin-top: 1em;
padding-left: 3px;
padding-right: 3px;
}
.figsides {
border-color: Silver;
border-left: 2px solid;
border-right: 2px solid;
margin-top: 1em;
padding-left: 3px;
padding-right: 3px;
}
.figtop {
border-color: Silver;
border-top: 2px solid;
margin-top: 1em;
}
.figbottom {
border-bottom: 2px solid;
border-color: Silver;
}
.figtopbot {
border-bottom: 2px solid;
border-color: Silver;
border-top: 2px solid;
margin-top: 1em;
}
/* Align images based on @align on topic/image */
div.imageleft {
text-align: left;
}
div.imagecenter {
text-align: center;
}
div.imageright {
text-align: right;
}
div.imagejustify {
text-align: justify;
}
/* Set heading sizes, getting smaller for deeper nesting */
.topictitle1 {
font-size: 1.34em;
margin-bottom: 0.1em;
margin-top: 0;
}
.topictitle2 {
font-size: 1.17em;
margin-bottom: 0.45em;
margin-top: 1pc;
}
.topictitle3 {
font-size: 1.17em;
font-weight: bold;
margin-bottom: 0.17em;
margin-top: 1pc;
}
.topictitle4 {
font-size: 1.17em;
font-weight: bold;
margin-top: 0.83em;
}
.topictitle5 {
font-size: 1.17em;
font-weight: bold;
}
.topictitle6 {
font-size: 1.17em;
font-style: italic;
}
.sectiontitle {
color: #000;
font-size: 1.17em;
font-weight: bold;
margin-bottom: 0;
margin-top: 1em;
}
.section {
margin-bottom: 1em;
margin-top: 1em;
}
.example {
margin-bottom: 1em;
margin-top: 1em;
}
.indexterm {
background-color: #fdf;
border: 1pt #000 solid;
margin: 1pt;
}
/* Most link groups are created with <div>. Ensure they have space before and after. */
.ullinks {
list-style-type: none;
}
.ulchildlink {
margin-bottom: 1em;
margin-top: 1em;
}
.olchildlink {
margin-bottom: 1em;
margin-top: 1em;
}
.linklist {
margin-bottom: 1em;
}
ul.linklist {
margin-top: 0;
list-style-type: none;
padding-left: 0;
}
li.linklist {
margin-top: 0;
margin-bottom: 0;
}
.linklistwithchild {
margin-bottom: 1em;
margin-left: 1.5em;
}
.sublinklist {
margin-bottom: 1em;
margin-left: 1.5em;
}
.relconcepts {
margin-bottom: 1em;
margin-top: 1em;
}
.reltasks {
margin-bottom: 1em;
margin-top: 1em;
}
.relref {
margin-bottom: 1em;
margin-top: 1em;
}
.relinfo {
margin-bottom: 1em;
margin-top: 1em;
}
.breadcrumb {
font-size: smaller;
margin-bottom: 1em;
}
/* Simple lists do not get a bullet */
ul.simple {
list-style-type: none;
}
/* Default of bold for definition list terms */
.dlterm {
font-weight: bold;
}
/* Use CSS to expand lists with @compact="no" */
.dltermexpand {
font-weight: bold;
margin-top: 1em;
}
*[compact="yes"] > li {
margin-top: 0;
}
*[compact="no"] > li {
margin-top: 0.53em;
}
.liexpand {
margin-bottom: 1em;
margin-top: 1em;
}
.sliexpand {
margin-bottom: 1em;
margin-top: 1em;
}
.dlexpand {
margin-bottom: 1em;
margin-top: 1em;
}
.ddexpand {
margin-bottom: 1em;
margin-top: 1em;
}
.stepexpand {
margin-bottom: 1em;
margin-top: 1em;
}
.substepexpand {
margin-bottom: 1em;
margin-top: 1em;
}
dt.prereq {
margin-left: 20px;
}
/* All note formats have the same default presentation */
.note {
margin-bottom: 1em;
margin-top: 1em;
}
.note .notetitle, .note .notelisttitle,
.note .note__title {
font-weight: bold;
}
/* Various basic phrase styles */
.bold {
font-weight: bold;
}
.bolditalic {
font-style: italic;
font-weight: bold;
}
.italic {
font-style: italic;
}
.underlined {
text-decoration: underline;
}
.uicontrol {
font-weight: bold;
}
.defkwd {
font-weight: bold;
text-decoration: underline;
}
.shortcut {
text-decoration: underline;
}
.menucascade > abbr {
text-decoration: none;
}
table {
border-collapse: collapse;
}
table .desc {
display: block;
font-style: italic;
}
.cellrowborder {
border-bottom: solid 1px;
border-left: 0;
border-right: solid 1px;
border-top: 0;
}
.row-nocellborder {
border-bottom: solid 1px;
border-left: 0;
border-top: 0;
}
.cell-norowborder {
border-left: 0;
border-right: solid 1px;
border-top: 0;
}
.nocellnorowborder {
border: 0;
}
.firstcol {
font-weight: bold;
}
.table--pgwide-1 {
width: 100%;
}
.align-left {
text-align: left;
}
.align-right {
text-align: right;
}
.align-center {
text-align: center;
}
.align-justify {
text-align: justify;
}
.align-char {
text-align: char;
}
.valign-top {
vertical-align: top;
}
.valign-bottom {
vertical-align: bottom;
}
.valign-middle {
vertical-align: middle;
}
.colsep-0 {
border-right: 0;
}
.colsep-1 {
border-right: 1px solid;
}
.rowsep-0 {
border-bottom: 0;
}
.rowsep-1 {
border-bottom: 1px solid;
}
.entry.rotate {
writing-mode: vertical-rl;
}
.stentry {
border-right: 1px solid;
border-bottom: 1px solid;
}
.stentry:last-child {
border-right: 0;
}
.strow:last-child .stentry {
border-bottom: 0;
}
/* Add space for top level topics */
.nested0 {
margin-top: 1em;
}
/* div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid */
.p {
margin-top: 1em;
}
/* flagging styles */
.flag__style--italics {
font-style: italic;
}
.flag__style--bold {
font-weight: bold;
}
.flag__style--underline {
text-decoration: underline;
}
.flag__style--double-underline {
text-decoration: double-underline;
}
.flag__style--overline {
text-decoration: overline;
}
.linklist {
margin-bottom: 1em;
}
ul.linklist {
margin-top: 0;
list-style-type: none;
padding-right: 0;
}
.linklistwithchild {
margin-right: 1.5em;
margin-top: 1em;
}
.sublinklist {
margin-right: 1.5em;
margin-top: 1em;
}
dt.prereq {
margin-right: 20px;
}
.cellrowborder {
border-left: solid 1px;
border-right: none;
}
.row-nocellborder {
border-left: hidden;
border-right: none;
}
.cell-norowborder {
border-left: solid 1px;
border-right: none;
}
.nocellnorowborder {
border-left: hidden;
}

322
dita-ot-3.6/doc/css/dita-ot-doc.css Normal file
View file

@ -0,0 +1,322 @@
/* DITA Open Toolkit documentation style */
/****************************************
Basic fonts and typography
****************************************/
body {
background: white;
background: linear-gradient(to right, #eee 0%, #fff 300px);
color: #212529;
margin: 0;
padding: 1em;
}
/* ↓ header-coderef ↓ */
.header {
font-size: 18pt;
margin: 0;
padding: 0 12px;
}
.header p {
color: #1d365d;
font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
line-height: 1.3;
margin: 0;
}
.header hr {
border: 0;
border-bottom: 1px solid #eee;
height: 0;
}
/* ↑ end-header-ref ↑ */
body {
font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
font-size: 1rem;
}
code,
pre,
samp,
.cmdname,
.codeph,
.filepath,
.msgnum,
.option,
.parmname {
color: #6c757d;
font-family: SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace;
font-size: 90%;
}
.codeblock .cmdname,
.codeblock .filepath,
.codeblock .msgnum,
.codeblock .option,
.codeblock .parmname,
.codeblock .varname,
pre code {
font-size: inherit;
}
/****************************************
Headings
****************************************/
h1,
h2,
h3 {
color: #1d365d;
font-size: 12pt;
font-weight: bold;
margin-bottom: 0.75em;
margin-left: 0;
margin-right: 0;
margin-top: 1em;
padding: 0;
}
h1 .filepath,
h2 .filepath,
h3 .filepath {
font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
font-weight: bold;
}
h1 .filepath {
color: #1d365d;
}
.sectiontitle {
color: #1d365d;
font-weight: bold;
}
.topictitle1 {
margin-top: 1em;
}
/****************************************
Basic identation, padding, and margins
****************************************/
main {
margin-left: 300px;
}
blockquote,
li,
p {
line-height: 125%;
margin-bottom: 0.75em;
margin-left: 0;
margin-right: 0;
margin-top: 0.75em;
padding: 0;
}
dd {
line-height: 125%;
margin-bottom: 0.75em;
margin-top: 0.75em;
}
dl {
line-height: 125%;
margin-bottom: 0.75em;
margin-left: 2em;
margin-right: 0;
margin-top: 0.75em;
padding: 0;
}
ol,
ul {
margin-bottom: 0.75em;
margin-left: 2em;
margin-right: 0;
margin-top: 0.75em;
padding: 0;
}
pre {
margin: 10px 0;
padding: 0;
}
/****************************************
Block elements
****************************************/
.codeblock,
.screen {
background-color: #f5f5f5;
border: 1px solid #ccc;
border-radius: 4px;
padding: 6px;
}
/****************************************
Figures
****************************************/
figcaption {
font-style: italic;
}
/****************************************
In-line elements
****************************************/
.cmdname,
.msgnum {
font-weight: bold;
}
/****************************************
Links
****************************************/
a:link {
color: #3563ab;
text-decoration: none;
}
a:visited {
color: #3563ab;
}
a:active,
a:hover {
color: #1d365d;
text-decoration: underline;
}
.related-links {
color: #555;
}
.linklist {
margin-top: 1em;
}
/****************************************
Notes
****************************************/
.note {
line-height: 125%;
margin-left: 2em;
margin-right: 0;
padding: 0;
}
.caution {
font-weight: bold;
}
/****************************************
Tables
****************************************/
table,
.table {
border-color: #dee2e6;
border-style: solid;
border-width: 1px;
font-size: 90%;
margin-bottom: 1em;
margin-top: 1em;
padding: 0.5rem;
}
tr {
border-color: #dee2e6;
padding: 0.5rem;
}
td {
border-color: #dee2e6;
padding: 0.5rem;
}
th {
background-color: #f5f5f5;
padding: 0.5rem;
text-align: left;
}
caption,
figcaption {
color: #6c757d;
padding: 1em 0;
text-align: left;
}
/****************************************
Navigation
****************************************/
/* ↓ nav-coderef ↓ */
nav[role='toc'] {
float: left;
width: 300px;
}
nav[role='toc'] li.active > a {
font-weight: bold;
}
/* ↑ end-nav-ref ↑ */
nav[role='toc'] > ul {
margin-right: 2em;
}
nav[role='toc'] > ul li {
margin-bottom: 0.5em;
margin-top: 0.5em;
}
nav[role='toc'] > ul > li ul {
margin-bottom: 0.5em;
margin-left: 1.2em;
margin-top: 0.5em;
}
/****************************************
Glossary
****************************************/
.glossAbbreviation,
.glossAcronym {
color: #555;
font-size: 90%;
font-style: italic;
font-weight: normal;
margin-left: 2em;
}
.glossAbbreviation::before,
.glossAcronym::before {
content: 'Abbreviation: “';
}
.glossAbbreviation::after,
.glossAcronym::after {
content: '”';
}
/* Append video icon to DITA-OT Day links in related links and link lists (but not in page footers) */
a.link[href*='dita-ot_day']::after,
.link a[href*='dita-ot_day']::after {
display: inline;
content: '    ';
background-image: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill="%233563ab" fill-rule="evenodd" d="M16 3.75a.75.75 0 00-1.136-.643L11 5.425V4.75A1.75 1.75 0 009.25 3h-7.5A1.75 1.75 0 000 4.75v6.5C0 12.216.784 13 1.75 13h7.5A1.75 1.75 0 0011 11.25v-.675l3.864 2.318A.75.75 0 0016 12.25v-8.5zm-5 5.075l3.5 2.1v-5.85l-3.5 2.1v1.65zM9.5 6.75v-2a.25.25 0 00-.25-.25h-7.5a.25.25 0 00-.25.25v6.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-4.5z"></path></svg>');
background-position: bottom;
background-repeat: no-repeat;
background-size: contain;
margin-left: 6px;
}

229
dita-ot-3.6/doc/extension-points/all-extension-points.html Normal file
View file

@ -0,0 +1,229 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The 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."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>All DITA-OT extension points</title></head><body id="all-extension-points"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li class="active"><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="all-extension-points__title"><h1 class="title topictitle1 generated" id="all-extension-points__title">All DITA-OT extension points</h1><div class="body refbody"><p class="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.</p><section class="section"><dl class="dl"><dt class="dt dlterm" id="all-extension-points__dita.conductor.target"><span class="keyword parmname">dita.conductor.target</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.target.desc">Adds an Ant
import to the main Ant build file.
<div class="p">
<div class="note attention note_attention"><span class="note__title">Attention:</span> This extension point is deprecated; use <code class="ph codeph">ant.import</code> instead.</div>
</div>
</dd><dt class="dt dlterm" id="all-extension-points__dita.conductor.target.relative"><span class="keyword parmname">dita.conductor.target.relative</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.target.relative.desc">Adds
an Ant import to the main Ant build file.
<div class="p">
<div class="note tip note_tip"><span class="note__title">Tip:</span> As of DITA-OT 3.0, the <code class="ph codeph">ant.import</code> extension point can be used
instead.</div>
</div>
</dd><dt class="dt dlterm" id="all-extension-points__dita.conductor.plugin"><span class="keyword parmname">dita.conductor.plugin</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.plugin.desc">Ant conductor plug-in information</dd><dt class="dt dlterm" id="all-extension-points__ant.import"><span class="keyword parmname">ant.import</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__ant.import.desc">Adds an Ant import to the main Ant build file.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.chunk.pre"><span class="keyword parmname">depend.preprocess.chunk.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.chunk.pre.desc">Runs an
Ant target before the <code class="ph codeph">chunk</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.clean-temp.pre"><span class="keyword parmname">depend.preprocess.clean-temp.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.clean-temp.pre.desc">Runs
an Ant target before the <code class="ph codeph">clean-temp</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.coderef.pre"><span class="keyword parmname">depend.preprocess.coderef.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.coderef.pre.desc">Runs an
Ant target before the <code class="ph codeph">coderef</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__org.dita.pdf2.catalog.relative"><span class="keyword parmname">org.dita.pdf2.catalog.relative</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__org.dita.pdf2.catalog.relative.desc">Adds
the content of a catalog file to the main catalog file for the PDF plug-in.</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.conref"><span class="keyword parmname">dita.xsl.conref</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.conref.desc">Content reference XSLT import</dd><dt class="dt dlterm" id="all-extension-points__dita.preprocess.conref.param"><span class="keyword parmname">dita.preprocess.conref.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.preprocess.conref.param.desc">Content reference XSLT parameters</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.conref.pre"><span class="keyword parmname">depend.preprocess.conref.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.conref.pre.desc">Runs an
Ant target before the <code class="ph codeph">conref</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.conrefpush.pre"><span class="keyword parmname">depend.preprocess.conrefpush.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.conrefpush.pre.desc">Runs
an Ant target before the <code class="ph codeph">conrefpush</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.copy-html.pre"><span class="keyword parmname">depend.preprocess.copy-html.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.copy-html.pre.desc">Runs
an Ant target before the <code class="ph codeph">copy-html</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.copy-files.pre"><span class="keyword parmname">depend.preprocess.copy-files.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.copy-files.pre.desc">Runs
an Ant target before the <code class="ph codeph">copy-files</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.copy-flag.pre"><span class="keyword parmname">depend.preprocess.copy-flag.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.copy-flag.pre.desc">Runs
an Ant target before the <code class="ph codeph">copy-flag</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.copy-image.pre"><span class="keyword parmname">depend.preprocess.copy-image.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.copy-image.pre.desc">Runs
an Ant target before the <code class="ph codeph">copy-image</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.copy-subsidiary.pre"><span class="keyword parmname">depend.preprocess.copy-subsidiary.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.copy-subsidiary.pre.desc">Runs an Ant target before the <code class="ph codeph">copy-subsidiary</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__dita.parser"><span class="keyword parmname">dita.parser</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.parser.desc">Custom DITA parser</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.debug-filter.pre"><span class="keyword parmname">depend.preprocess.debug-filter.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.debug-filter.pre.desc">Runs an Ant target before the <code class="ph codeph">debug-filter</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__dita.preprocess.debug-filter.param"><span class="keyword parmname">dita.preprocess.debug-filter.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.preprocess.debug-filter.param.desc">Debug filter module parameters</dd><dt class="dt dlterm" id="all-extension-points__dita.preprocess.map-reader.param"><span class="keyword parmname">dita.preprocess.map-reader.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.preprocess.map-reader.param.desc">Debug filter module parameters</dd><dt class="dt dlterm" id="all-extension-points__dita.preprocess.topic-reader.param"><span class="keyword parmname">dita.preprocess.topic-reader.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.preprocess.topic-reader.param.desc">Debug filter module parameters</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.messages"><span class="keyword parmname">dita.xsl.messages</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.messages.desc">Adds new diagnostic
messages to DITA-OT.</dd><dt class="dt dlterm" id="all-extension-points__dita.conductor.eclipse.toc.param"><span class="keyword parmname">dita.conductor.eclipse.toc.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.eclipsehelp.html" title="Certain extension points are specific to the Eclipse Help transformation."><code class="ph codeph">org.dita.eclipsehelp</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.eclipse.toc.param.desc">Pass parameters to the XSLT step that generates the Eclipse Help table of contents (TOC).</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.eclipse.toc"><span class="keyword parmname">dita.xsl.eclipse.toc</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.eclipsehelp.html" title="Certain extension points are specific to the Eclipse Help transformation."><code class="ph codeph">org.dita.eclipsehelp</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.eclipse.toc.desc">Overrides the default XSLT step that generates the Eclipse Help table of contents (TOC).</dd><dt class="dt dlterm" id="all-extension-points__dita.map.eclipse.index.pre"><span class="keyword parmname">dita.map.eclipse.index.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.eclipsehelp.html" title="Certain extension points are specific to the Eclipse Help transformation."><code class="ph codeph">org.dita.eclipsehelp</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.map.eclipse.index.pre.desc">Runs an Ant target before the Eclipse index extraction process.</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.eclipse.plugin"><span class="keyword parmname">dita.xsl.eclipse.plugin</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.eclipsehelp.html" title="Certain extension points are specific to the Eclipse Help transformation."><code class="ph codeph">org.dita.eclipsehelp</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.eclipse.plugin.desc">Overrides the default XSLT step that generates the <span class="ph filepath">plugin.xml</span> file for Eclipse
Help.</dd><dt class="dt dlterm" id="all-extension-points__dita.basedir-resource-directory"><span class="keyword parmname">dita.basedir-resource-directory</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.basedir-resource-directory.desc">Flag to use basedir as resource directory</dd><dt class="dt dlterm" id="all-extension-points__dita.conductor.pdf2.formatter.check"><span class="keyword parmname">dita.conductor.pdf2.formatter.check</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.pdf2.formatter.check.desc">Formatter check</dd><dt class="dt dlterm" id="all-extension-points__depend.org.dita.pdf2.format.post"><span class="keyword parmname">depend.org.dita.pdf2.format.post</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.org.dita.pdf2.format.post.desc">Formatting post-target</dd><dt class="dt dlterm" id="all-extension-points__depend.org.dita.pdf2.format.pre"><span class="keyword parmname">depend.org.dita.pdf2.format.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.org.dita.pdf2.format.pre.desc">Formatting pre-target</dd><dt class="dt dlterm" id="all-extension-points__depend.org.dita.pdf2.format"><span class="keyword parmname">depend.org.dita.pdf2.format</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.org.dita.pdf2.format.desc">Formatting target</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.gen-list.pre"><span class="keyword parmname">depend.preprocess.gen-list.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.gen-list.pre.desc">Runs
an Ant target before the <code class="ph codeph">gen-list</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.strings"><span class="keyword parmname">dita.xsl.strings</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.strings.desc">Generated text</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.htmlhelp.map2hhc"><span class="keyword parmname">dita.xsl.htmlhelp.map2hhc</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.htmlhelp.html" title="Certain extension points are specific to the HTML Help transformation."><code class="ph codeph">org.dita.htmlhelp</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.htmlhelp.map2hhc.desc">Overrides the default XSLT step that generates the HTML Help contents (<span class="ph filepath">.hhc</span>)
file.</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.htmlhelp.map2hhp"><span class="keyword parmname">dita.xsl.htmlhelp.map2hhp</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.htmlhelp.html" title="Certain extension points are specific to the HTML Help transformation."><code class="ph codeph">org.dita.htmlhelp</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.htmlhelp.map2hhp.desc">Overrides the default XSLT step that generates the HTML Help project (<span class="ph filepath">.hhp</span>) file.</dd><dt class="dt dlterm" id="all-extension-points__dita.conductor.html.param"><span class="keyword parmname">dita.conductor.html.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.xhtml.html" title="The org.dita.xhtml 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."><code class="ph codeph">org.dita.xhtml</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.html.param.desc">Pass
parameters to the HTML and HTML Help
transformations.</dd><dt class="dt dlterm" id="all-extension-points__dita.html.extensions"><span class="keyword parmname">dita.html.extensions</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.html.extensions.desc">HTML file extension</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.html.cover"><span class="keyword parmname">dita.xsl.html.cover</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.xhtml.html" title="The org.dita.xhtml 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."><code class="ph codeph">org.dita.xhtml</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.html.cover.desc">Overrides the
default HTML cover page generation process.</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.htmltoc"><span class="keyword parmname">dita.xsl.htmltoc</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.xhtml.html" title="The org.dita.xhtml 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."><code class="ph codeph">org.dita.xhtml</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.htmltoc.desc">Overrides the
default XSLT step that generates the HTML table of contents (TOC).</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.xhtml"><span class="keyword parmname">dita.xsl.xhtml</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.xhtml.html" title="The org.dita.xhtml 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."><code class="ph codeph">org.dita.xhtml</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__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><dt class="dt dlterm" id="all-extension-points__dita.conductor.html5.toc.param"><span class="keyword parmname">dita.conductor.html5.toc.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.html5.html" title="In addition to the extension points provided by common processing and those shared by with other HTML-based transformations, the org.dita.html5 plug-in provides extension points that are specific to the HTML5 transformation."><code class="ph codeph">org.dita.html5</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.html5.toc.param.desc">Pass
parameters to the XSLT step that generates the HTML5 table of contents (TOC).</dd><dt class="dt dlterm" id="all-extension-points__dita.conductor.xhtml.toc.param"><span class="keyword parmname">dita.conductor.xhtml.toc.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.xhtml.html" title="The org.dita.xhtml 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."><code class="ph codeph">org.dita.xhtml</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.xhtml.toc.param.desc">Pass
parameters to the XSLT step that generates the XHTML table of contents (TOC).</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.html5.cover"><span class="keyword parmname">dita.xsl.html5.cover</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.html5.html" title="In addition to the extension points provided by common processing and those shared by with other HTML-based transformations, the org.dita.html5 plug-in provides extension points that are specific to the HTML5 transformation."><code class="ph codeph">org.dita.html5</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.html5.cover.desc">Overrides the
default HTML5 cover page generation process.</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.html5.toc"><span class="keyword parmname">dita.xsl.html5.toc</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.html5.html" title="In addition to the extension points provided by common processing and those shared by with other HTML-based transformations, the org.dita.html5 plug-in provides extension points that are specific to the HTML5 transformation."><code class="ph codeph">org.dita.html5</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.html5.toc.desc">Overrides the
default XSLT step that generates the HTML5 table of contents (TOC).</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.html5"><span class="keyword parmname">dita.xsl.html5</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.html5.html" title="In addition to the extension points provided by common processing and those shared by with other HTML-based transformations, the org.dita.html5 plug-in provides extension points that are specific to the HTML5 transformation."><code class="ph codeph">org.dita.html5</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.html5.desc">Overrides the
default HTML5 transformation. The referenced file is integrated directly into the XSLT step that generates
HTML5.</dd><dt class="dt dlterm" id="all-extension-points__dita.conductor.html5.param"><span class="keyword parmname">dita.conductor.html5.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.html5.html" title="In addition to the extension points provided by common processing and those shared by with other HTML-based transformations, the org.dita.html5 plug-in provides extension points that are specific to the HTML5 transformation."><code class="ph codeph">org.dita.html5</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.html5.param.desc">Pass
parameters to the HTML5 transformation.</dd><dt class="dt dlterm" id="all-extension-points__dita.image.extensions"><span class="keyword parmname">dita.image.extensions</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.image.extensions.desc">Image file extension</dd><dt class="dt dlterm" id="all-extension-points__depend.org.dita.pdf2.index"><span class="keyword parmname">depend.org.dita.pdf2.index</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.org.dita.pdf2.index.desc">Indexing target</dd><dt class="dt dlterm" id="all-extension-points__depend.org.dita.pdf2.init.pre"><span class="keyword parmname">depend.org.dita.pdf2.init.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.org.dita.pdf2.init.pre.desc">Initialization pre-target</dd><dt class="dt dlterm" id="all-extension-points__dita.conductor.lib.import"><span class="keyword parmname">dita.conductor.lib.import</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.lib.import.desc">Adds a Java
library to the DITA-OT classpath.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.keyref.pre"><span class="keyword parmname">depend.preprocess.keyref.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.keyref.pre.desc">Runs an
Ant target before the <code class="ph codeph">keyref</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.maplink"><span class="keyword parmname">dita.xsl.maplink</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.maplink.desc">Map link XSLT import</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.maplink.pre"><span class="keyword parmname">depend.preprocess.maplink.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.maplink.pre.desc">Runs an
Ant target before the <code class="ph codeph">maplink</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__dita.preprocess.mappull.param"><span class="keyword parmname">dita.preprocess.mappull.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.preprocess.mappull.param.desc">Map pull XSLT parameters</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.mappull"><span class="keyword parmname">dita.xsl.mappull</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.mappull.desc">Map pull XSLT import</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.mappull.pre"><span class="keyword parmname">depend.preprocess.mappull.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.mappull.pre.desc">Runs an
Ant target before the <code class="ph codeph">mappull</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.mapref"><span class="keyword parmname">dita.xsl.mapref</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.mapref.desc">Map reference XSLT import</dd><dt class="dt dlterm" id="all-extension-points__dita.preprocess.mapref.param"><span class="keyword parmname">dita.preprocess.mapref.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.preprocess.mapref.param.desc">Map reference XSLT parameters</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.mapref.pre"><span class="keyword parmname">depend.preprocess.mapref.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.mapref.pre.desc">Runs an
Ant target before the <code class="ph codeph">mapref</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.move-meta-entries.pre"><span class="keyword parmname">depend.preprocess.move-meta-entries.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.move-meta-entries.pre.desc">Runs an Ant target before the <code class="ph codeph">move-meta-entries</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.xslfo.i18n-postprocess"><span class="keyword parmname">dita.xsl.xslfo.i18n-postprocess</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.xslfo.i18n-postprocess.desc">PDF I18N postprocess import</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.xslfo"><span class="keyword parmname">dita.xsl.xslfo</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__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><dt class="dt dlterm" id="all-extension-points__dita.conductor.pdf2.param"><span class="keyword parmname">dita.conductor.pdf2.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.pdf2.param.desc">Pass
parameters to the PDF transformation.</dd><dt class="dt dlterm" id="all-extension-points__org.dita.pdf2.xsl.topicmerge"><span class="keyword parmname">org.dita.pdf2.xsl.topicmerge</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.pdf2.html" title="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><code class="ph codeph">org.dita.pdf2</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__org.dita.pdf2.xsl.topicmerge.desc">PDF2 topic merge XSLT import</dd><dt class="dt dlterm" id="all-extension-points__dita.catalog.plugin-info"><span class="keyword parmname">dita.catalog.plugin-info</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.catalog.plugin-info.desc">Plug-in XML catalog information</dd><dt class="dt dlterm" id="all-extension-points__package.support.email"><span class="keyword parmname">package.support.email</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__package.support.email.desc">Specifies the
e-mail address of the person who provides support for the DITA-OT plug-in.</dd><dt class="dt dlterm" id="all-extension-points__package.support.name"><span class="keyword parmname">package.support.name</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__package.support.name.desc">Specifies the
person who provides support for the DITA-OT plug-in.</dd><dt class="dt dlterm" id="all-extension-points__package.version"><span class="keyword parmname">package.version</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__package.version.desc">Specifies the version
of the DITA-OT plug-in.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.post"><span class="keyword parmname">depend.preprocess.post</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.post.desc">Runs an Ant
target after the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.pre"><span class="keyword parmname">depend.preprocess.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.pre.desc">Runs an Ant
target before the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__dita.transtype.print"><span class="keyword parmname">dita.transtype.print</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.transtype.print.desc">Defines a
transformation as a print type.</dd><dt class="dt dlterm" id="all-extension-points__dita.resource.extensions"><span class="keyword parmname">dita.resource.extensions</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.resource.extensions.desc">Resource file extension</dd><dt class="dt dlterm" id="all-extension-points__dita.xsl.topicpull"><span class="keyword parmname">dita.xsl.topicpull</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.xsl.topicpull.desc">Topic pull XSLT import</dd><dt class="dt dlterm" id="all-extension-points__dita.preprocess.topicpull.param"><span class="keyword parmname">dita.preprocess.topicpull.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.preprocess.topicpull.param.desc">Topic pull XSLT parameters</dd><dt class="dt dlterm" id="all-extension-points__depend.preprocess.topicpull.pre"><span class="keyword parmname">depend.preprocess.topicpull.pre</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__depend.preprocess.topicpull.pre.desc">Runs
an Ant target before the <code class="ph codeph">topicpull</code> step in the pre-processing stage.</dd><dt class="dt dlterm" id="all-extension-points__dita.conductor.transtype.check"><span class="keyword parmname">dita.conductor.transtype.check</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.transtype.check.desc">
<p class="p">Adds a new value to the list of valid transformation types.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> This extension point is still supported for backwards compatibility, but since DITA-OT 2.1,
any new customizations should instead use the <code class="keyword markupname xmlelement">&lt;transtype&gt;</code> element in the
<a class="xref" href="../topics/plugin-configfile.html" title="The plug-in descriptor file (plugin.xml) controls all aspects of a plug-in, making each extension visible to the rest of the toolkit. The file uses pre-defined extension points to locate changes, and then integrates those changes into the core DITA-OT code.">Plug-in descriptor file</a> to define a new transformation.</div>
</dd><dt class="dt dlterm" id="all-extension-points__dita.conductor.xhtml.param"><span class="keyword parmname">dita.conductor.xhtml.param</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.xhtml.html" title="The org.dita.xhtml 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."><code class="ph codeph">org.dita.xhtml</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.conductor.xhtml.param.desc">Pass
parameters to the XHTML and Eclipse Help transformations.</dd><dt class="dt dlterm" id="all-extension-points__dita.specialization.catalog"><span class="keyword parmname">dita.specialization.catalog</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.specialization.catalog.desc">Adds the
content of a catalog file to the main DITA-OT catalog file. <div class="note attention note_attention"><span class="note__title">Attention:</span> This extension point is
deprecated; use <code class="ph codeph">dita.specialization.catalog.relative</code> instead.</div></dd><dt class="dt dlterm" id="all-extension-points__dita.specialization.catalog.relative"><span class="keyword parmname">dita.specialization.catalog.relative</span><span class="ph"></span></dt><dd class="dd">Defined in plug-in
<a class="xref" href="extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports."><code class="ph codeph">org.dita.base</code></a>.
</dd><dd class="dd ddexpand" id="all-extension-points__dita.specialization.catalog.relative.desc">Adds the content of a catalog file to the main DITA-OT catalog file.</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/plugin-extension-points.html" title="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 plugin.xml file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit.">Extension point reference</a></div></div></nav></article></main></body></html>

18
dita-ot-3.6/doc/extension-points/extension-points-by-plugin.html Normal file
View file

@ -0,0 +1,18 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The 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."><meta name="keywords" content="plug-ins, extension points"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extension points by plug-in</title></head><body id="extension-points-by-plugin"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li class="active"><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a><ul><li><a href="../extension-points/extension-points-in-org.dita.base.html">Common processing</a></li><li><a href="../extension-points/extension-points-in-org.dita.eclipsehelp.html">Eclipse Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.html5.html">HTML5</a></li><li><a href="../extension-points/extension-points-in-org.dita.htmlhelp.html">HTML Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.pdf2.html">PDF</a></li><li><a href="../extension-points/extension-points-in-org.dita.xhtml.html">HTML-based output</a></li></ul></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Extension points by plug-in</h1>
<div class="body refbody"><p class="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.</p>
<section class="section">
<p class="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>
</div>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../extension-points/extension-points-in-org.dita.base.html">Extension points in org.dita.base</a></strong><br>The <code class="ph codeph">org.dita.base</code> plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports. <span class="ph"> </span> </li><li class="link ulchildlink"><strong><a href="../extension-points/extension-points-in-org.dita.eclipsehelp.html">Extension points in org.dita.eclipsehelp</a></strong><br>Certain extension points are specific to the Eclipse Help transformation. <span class="ph"> </span> </li><li class="link ulchildlink"><strong><a href="../extension-points/extension-points-in-org.dita.html5.html">Extension points in org.dita.html5</a></strong><br>In addition to the extension points provided by common processing and those shared by with other HTML-based transformations, the <code class="ph codeph">org.dita.html5</code> plug-in provides extension points that are specific to the HTML5 transformation. <span class="ph"> </span> </li><li class="link ulchildlink"><strong><a href="../extension-points/extension-points-in-org.dita.htmlhelp.html">Extension points in org.dita.htmlhelp</a></strong><br>Certain extension points are specific to the HTML Help transformation. <span class="ph"> </span> </li><li class="link ulchildlink"><strong><a href="../extension-points/extension-points-in-org.dita.pdf2.html">Extension points in org.dita.pdf2</a></strong><br>Certain extension points are specific to the PDF transformation (formerly known as “PDF2”). <span class="ph"> </span> </li><li class="link ulchildlink"><strong><a href="../extension-points/extension-points-in-org.dita.xhtml.html">Extension points in org.dita.xhtml</a></strong><br>The <code class="ph codeph">org.dita.xhtml</code> 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. <span class="ph"> </span> </li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/plugin-extension-points.html" title="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 plugin.xml file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit.">Extension point reference</a></div></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/rebuilding-docs.html" title="When you add or remove plug-ins, you can rebuild the documentation to update the information on the extension points, messages, and parameters that are available in your environment.">Rebuilding the DITA-OT documentation</a></li></ul></div></nav></article></main></body></html>

53
dita-ot-3.6/doc/extension-points/extension-points-in-org.dita.base.html Normal file
View file

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

13
dita-ot-3.6/doc/extension-points/extension-points-in-org.dita.eclipsehelp.html Normal file
View file

@ -0,0 +1,13 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain extension points are specific to the Eclipse Help transformation."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extension points in org.dita.eclipsehelp</title></head><body id="org.dita.eclipsehelp-ext"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a><ul><li><a href="../extension-points/extension-points-in-org.dita.base.html">Common processing</a></li><li class="active"><a href="../extension-points/extension-points-in-org.dita.eclipsehelp.html">Eclipse Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.html5.html">HTML5</a></li><li><a href="../extension-points/extension-points-in-org.dita.htmlhelp.html">HTML Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.pdf2.html">PDF</a></li><li><a href="../extension-points/extension-points-in-org.dita.xhtml.html">HTML-based output</a></li></ul></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">Extension points in <code class="ph codeph">org.dita.eclipsehelp</code></h1><div class="body refbody"><p class="shortdesc">Certain extension points
are specific to the Eclipse Help transformation. <span class="ph">
</span>
</p><section class="section"><dl class="dl"><dt class="dt dlterm" id="org.dita.eclipsehelp-ext__dita.conductor.eclipse.toc.param"><span class="keyword parmname">dita.conductor.eclipse.toc.param</span><span class="ph"></span></dt><dd class="dd" id="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><dt class="dt dlterm" id="org.dita.eclipsehelp-ext__dita.map.eclipse.index.pre"><span class="keyword parmname">dita.map.eclipse.index.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.eclipsehelp-ext__dita.map.eclipse.index.pre.desc">Runs an Ant target before the Eclipse index extraction process.</dd><dt class="dt dlterm" id="org.dita.eclipsehelp-ext__dita.xsl.eclipse.plugin"><span class="keyword parmname">dita.xsl.eclipse.plugin</span><span class="ph"></span></dt><dd class="dd" id="org.dita.eclipsehelp-ext__dita.xsl.eclipse.plugin.desc">Overrides the default XSLT step that generates the <span class="ph filepath">plugin.xml</span> file for Eclipse
Help.</dd><dt class="dt dlterm" id="org.dita.eclipsehelp-ext__dita.xsl.eclipse.toc"><span class="keyword parmname">dita.xsl.eclipse.toc</span><span class="ph"></span></dt><dd class="dd" id="org.dita.eclipsehelp-ext__dita.xsl.eclipse.toc.desc">Overrides the default XSLT step that generates the Eclipse Help table of contents (TOC).</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/extension-points-by-plugin.html" title="The default plug-ins that ship with DITA Open Toolkit include a series of extension points that can be used to modify various aspects of toolkit processing.">Extension points by plug-in</a></div></div></nav></article></main></body></html>

19
dita-ot-3.6/doc/extension-points/extension-points-in-org.dita.html5.html Normal file
View file

@ -0,0 +1,19 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="In addition to the extension points provided by common processing and those shared by with other HTML-based transformations, the org.dita.html5 plug-in provides extension points that are specific to the HTML5 transformation."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extension points in org.dita.html5</title></head><body id="org.dita.html5-ext"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a><ul><li><a href="../extension-points/extension-points-in-org.dita.base.html">Common processing</a></li><li><a href="../extension-points/extension-points-in-org.dita.eclipsehelp.html">Eclipse Help</a></li><li class="active"><a href="../extension-points/extension-points-in-org.dita.html5.html">HTML5</a></li><li><a href="../extension-points/extension-points-in-org.dita.htmlhelp.html">HTML Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.pdf2.html">PDF</a></li><li><a href="../extension-points/extension-points-in-org.dita.xhtml.html">HTML-based output</a></li></ul></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">Extension points in <code class="ph codeph">org.dita.html5</code></h1><div class="body refbody"><p class="shortdesc">In
addition to the extension points provided by common processing and those shared by with other HTML-based
transformations, the <code class="ph codeph">org.dita.html5</code> plug-in provides extension points that are specific to the
HTML5 transformation. <span class="ph">
</span>
</p><section class="section"><dl class="dl"><dt class="dt dlterm" id="org.dita.html5-ext__dita.conductor.html5.param"><span class="keyword parmname">dita.conductor.html5.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.html5-ext__dita.conductor.html5.param.desc">Pass
parameters to the HTML5 transformation.</dd><dt class="dt dlterm" id="org.dita.html5-ext__dita.conductor.html5.toc.param"><span class="keyword parmname">dita.conductor.html5.toc.param</span><span class="ph"></span></dt><dd class="dd" id="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><dt class="dt dlterm" id="org.dita.html5-ext__dita.xsl.html5"><span class="keyword parmname">dita.xsl.html5</span><span class="ph"></span></dt><dd class="dd" id="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><dt class="dt dlterm" id="org.dita.html5-ext__dita.xsl.html5.cover"><span class="keyword parmname">dita.xsl.html5.cover</span><span class="ph"></span></dt><dd class="dd" id="org.dita.html5-ext__dita.xsl.html5.cover.desc">Overrides the
default HTML5 cover page generation process.</dd><dt class="dt dlterm" id="org.dita.html5-ext__dita.xsl.html5.toc"><span class="keyword parmname">dita.xsl.html5.toc</span><span class="ph"></span></dt><dd class="dd" id="org.dita.html5-ext__dita.xsl.html5.toc.desc">Overrides the
default XSLT step that generates the HTML5 table of contents (TOC).</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/extension-points-by-plugin.html" title="The default plug-ins that ship with DITA Open Toolkit include a series of extension points that can be used to modify various aspects of toolkit processing.">Extension points by plug-in</a></div></div></nav></article></main></body></html>

13
dita-ot-3.6/doc/extension-points/extension-points-in-org.dita.htmlhelp.html Normal file
View file

@ -0,0 +1,13 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain extension points are specific to the HTML Help transformation."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extension points in org.dita.htmlhelp</title></head><body id="org.dita.htmlhelp-ext"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a><ul><li><a href="../extension-points/extension-points-in-org.dita.base.html">Common processing</a></li><li><a href="../extension-points/extension-points-in-org.dita.eclipsehelp.html">Eclipse Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.html5.html">HTML5</a></li><li class="active"><a href="../extension-points/extension-points-in-org.dita.htmlhelp.html">HTML Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.pdf2.html">PDF</a></li><li><a href="../extension-points/extension-points-in-org.dita.xhtml.html">HTML-based output</a></li></ul></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">Extension points in <code class="ph codeph">org.dita.htmlhelp</code></h1><div class="body refbody"><p class="shortdesc">Certain extension points are
specific to the HTML Help transformation. <span class="ph">
</span>
</p><section class="section"><dl class="dl"><dt class="dt dlterm" id="org.dita.htmlhelp-ext__dita.xsl.htmlhelp.map2hhc"><span class="keyword parmname">dita.xsl.htmlhelp.map2hhc</span><span class="ph"></span></dt><dd class="dd" id="org.dita.htmlhelp-ext__dita.xsl.htmlhelp.map2hhc.desc">Overrides the default XSLT step that generates the HTML Help contents (<span class="ph filepath">.hhc</span>)
file.</dd><dt class="dt dlterm" id="org.dita.htmlhelp-ext__dita.xsl.htmlhelp.map2hhp"><span class="keyword parmname">dita.xsl.htmlhelp.map2hhp</span><span class="ph"></span></dt><dd class="dd" id="org.dita.htmlhelp-ext__dita.xsl.htmlhelp.map2hhp.desc">Overrides the default XSLT step that generates the HTML Help project (<span class="ph filepath">.hhp</span>) file.</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/extension-points-by-plugin.html" title="The default plug-ins that ship with DITA Open Toolkit include a series of extension points that can be used to modify various aspects of toolkit processing.">Extension points by plug-in</a></div></div></nav></article></main></body></html>

15
dita-ot-3.6/doc/extension-points/extension-points-in-org.dita.pdf2.html Normal file
View file

@ -0,0 +1,15 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain extension points are specific to the PDF transformation (formerly known as “PDF2”)."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extension points in org.dita.pdf2</title></head><body id="org.dita.pdf2-ext"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a><ul><li><a href="../extension-points/extension-points-in-org.dita.base.html">Common processing</a></li><li><a href="../extension-points/extension-points-in-org.dita.eclipsehelp.html">Eclipse Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.html5.html">HTML5</a></li><li><a href="../extension-points/extension-points-in-org.dita.htmlhelp.html">HTML Help</a></li><li class="active"><a href="../extension-points/extension-points-in-org.dita.pdf2.html">PDF</a></li><li><a href="../extension-points/extension-points-in-org.dita.xhtml.html">HTML-based output</a></li></ul></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">Extension points in <code class="ph codeph">org.dita.pdf2</code></h1><div class="body refbody"><p class="shortdesc">Certain extension points are specific to the PDF transformation (formerly known as “PDF2”). <span class="ph">
</span>
</p><section class="section"><dl class="dl"><dt class="dt dlterm" id="org.dita.pdf2-ext__depend.org.dita.pdf2.format"><span class="keyword parmname">depend.org.dita.pdf2.format</span><span class="ph"></span></dt><dd class="dd" id="org.dita.pdf2-ext__depend.org.dita.pdf2.format.desc">Formatting target</dd><dt class="dt dlterm" id="org.dita.pdf2-ext__depend.org.dita.pdf2.format.post"><span class="keyword parmname">depend.org.dita.pdf2.format.post</span><span class="ph"></span></dt><dd class="dd" id="org.dita.pdf2-ext__depend.org.dita.pdf2.format.post.desc">Formatting post-target</dd><dt class="dt dlterm" id="org.dita.pdf2-ext__depend.org.dita.pdf2.format.pre"><span class="keyword parmname">depend.org.dita.pdf2.format.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.pdf2-ext__depend.org.dita.pdf2.format.pre.desc">Formatting pre-target</dd><dt class="dt dlterm" id="org.dita.pdf2-ext__depend.org.dita.pdf2.index"><span class="keyword parmname">depend.org.dita.pdf2.index</span><span class="ph"></span></dt><dd class="dd" id="org.dita.pdf2-ext__depend.org.dita.pdf2.index.desc">Indexing target</dd><dt class="dt dlterm" id="org.dita.pdf2-ext__depend.org.dita.pdf2.init.pre"><span class="keyword parmname">depend.org.dita.pdf2.init.pre</span><span class="ph"></span></dt><dd class="dd" id="org.dita.pdf2-ext__depend.org.dita.pdf2.init.pre.desc">Initialization pre-target</dd><dt class="dt dlterm" id="org.dita.pdf2-ext__dita.conductor.pdf2.formatter.check"><span class="keyword parmname">dita.conductor.pdf2.formatter.check</span><span class="ph"></span></dt><dd class="dd" id="org.dita.pdf2-ext__dita.conductor.pdf2.formatter.check.desc">Formatter check</dd><dt class="dt dlterm" id="org.dita.pdf2-ext__dita.conductor.pdf2.param"><span class="keyword parmname">dita.conductor.pdf2.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.pdf2-ext__dita.conductor.pdf2.param.desc">Pass
parameters to the PDF transformation.</dd><dt class="dt dlterm" id="org.dita.pdf2-ext__dita.xsl.xslfo"><span class="keyword parmname">dita.xsl.xslfo</span><span class="ph"></span></dt><dd class="dd" id="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><dt class="dt dlterm" id="org.dita.pdf2-ext__dita.xsl.xslfo.i18n-postprocess"><span class="keyword parmname">dita.xsl.xslfo.i18n-postprocess</span><span class="ph"></span></dt><dd class="dd" id="org.dita.pdf2-ext__dita.xsl.xslfo.i18n-postprocess.desc">PDF I18N postprocess import</dd><dt class="dt dlterm" id="org.dita.pdf2-ext__org.dita.pdf2.catalog.relative"><span class="keyword parmname">org.dita.pdf2.catalog.relative</span><span class="ph"></span></dt><dd class="dd" id="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><dt class="dt dlterm" id="org.dita.pdf2-ext__org.dita.pdf2.xsl.topicmerge"><span class="keyword parmname">org.dita.pdf2.xsl.topicmerge</span><span class="ph"></span></dt><dd class="dd" id="org.dita.pdf2-ext__org.dita.pdf2.xsl.topicmerge.desc">PDF2 topic merge XSLT import</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/extension-points-by-plugin.html" title="The default plug-ins that ship with DITA Open Toolkit include a series of extension points that can be used to modify various aspects of toolkit processing.">Extension points by plug-in</a></div></div></nav></article></main></body></html>

29
dita-ot-3.6/doc/extension-points/extension-points-in-org.dita.xhtml.html Normal file
View file

@ -0,0 +1,29 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The org.dita.xhtml 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."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extension points in org.dita.xhtml</title></head><body id="org.dita.xhtml-ext"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a><ul><li><a href="../extension-points/extension-points-in-org.dita.base.html">Common processing</a></li><li><a href="../extension-points/extension-points-in-org.dita.eclipsehelp.html">Eclipse Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.html5.html">HTML5</a></li><li><a href="../extension-points/extension-points-in-org.dita.htmlhelp.html">HTML Help</a></li><li><a href="../extension-points/extension-points-in-org.dita.pdf2.html">PDF</a></li><li class="active"><a href="../extension-points/extension-points-in-org.dita.xhtml.html">HTML-based output</a></li></ul></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">Extension points in <code class="ph codeph">org.dita.xhtml</code></h1><div class="body refbody"><p class="shortdesc">The
<code class="ph codeph">org.dita.xhtml</code> 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. <span class="ph">
</span>
</p><section class="section"><dl class="dl"><dt class="dt dlterm" id="org.dita.xhtml-ext__dita.conductor.html.param"><span class="keyword parmname">dita.conductor.html.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.xhtml-ext__dita.conductor.html.param.desc">Pass
parameters to the HTML and HTML Help
transformations.</dd><dt class="dt dlterm" id="org.dita.xhtml-ext__dita.conductor.xhtml.param"><span class="keyword parmname">dita.conductor.xhtml.param</span><span class="ph"></span></dt><dd class="dd" id="org.dita.xhtml-ext__dita.conductor.xhtml.param.desc">Pass
parameters to the XHTML and Eclipse Help transformations.</dd><dt class="dt dlterm" id="org.dita.xhtml-ext__dita.conductor.xhtml.toc.param"><span class="keyword parmname">dita.conductor.xhtml.toc.param</span><span class="ph"></span></dt><dd class="dd" id="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><dt class="dt dlterm" id="org.dita.xhtml-ext__dita.xsl.html.cover"><span class="keyword parmname">dita.xsl.html.cover</span><span class="ph"></span></dt><dd class="dd" id="org.dita.xhtml-ext__dita.xsl.html.cover.desc">Overrides the
default HTML cover page generation process.</dd><dt class="dt dlterm" id="org.dita.xhtml-ext__dita.xsl.htmltoc"><span class="keyword parmname">dita.xsl.htmltoc</span><span class="ph"></span></dt><dd class="dd" id="org.dita.xhtml-ext__dita.xsl.htmltoc.desc">Overrides the
default XSLT step that generates the HTML table of contents (TOC).</dd><dt class="dt dlterm" id="org.dita.xhtml-ext__dita.xsl.xhtml"><span class="keyword parmname">dita.xsl.xhtml</span><span class="ph"></span></dt><dd class="dd" id="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></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/extension-points-by-plugin.html" title="The default plug-ins that ship with DITA Open Toolkit include a series of extension points that can be used to modify various aspects of toolkit processing.">Extension points by plug-in</a></div></div></nav></article></main></body></html>

80
dita-ot-3.6/doc/extension-points/plugin-extension-points-general.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="These extension points enable you to extend DITA-OT. You can add Ant targets or imports; add a Java library to the classpath parameter; add a new transformation type; extend a catalog file; add new diagnostic messages, and more."><meta name="keywords" content="deprecated features, dita.conductor.target, dita.specialization.catalog"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>General extension points</title></head><body id="plugin-general-extension-points"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li class="active"><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">General extension points</h1>
<div class="body refbody"><p class="shortdesc">These extension points enable you to extend DITA-OT. You can add Ant targets or imports; add a Java library
to the <span class="keyword parmname">classpath</span> parameter; add a new transformation type; extend a catalog file; add new
diagnostic messages, and more.</p>
<section class="section">
<dl class="dl">
<dt class="dt dlterm" id="plugin-general-extension-points__ant.import"><span class="keyword parmname">ant.import</span></dt>
<dd class="dd">Adds an Ant import to the main Ant build file.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.lib.import</span></dt>
<dd class="dd">Adds a Java
library to the DITA-OT classpath.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.target</span></dt>
<dd class="dd">Adds an Ant
import to the main Ant build file.
<div class="p">
<div class="note attention note_attention"><span class="note__title">Attention:</span> This extension point is deprecated; use <code class="ph codeph">ant.import</code> instead.</div>
</div>
</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.target.relative</span></dt>
<dd class="dd">Adds
an Ant import to the main Ant build file.
<div class="p">
<div class="note tip note_tip"><span class="note__title">Tip:</span> As of DITA-OT 3.0, the <code class="ph codeph">ant.import</code> extension point can be used
instead.</div>
</div>
</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.transtype.check</span></dt>
<dd class="dd">
<p class="p">Adds a new value to the list of valid transformation types.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> This extension point is still supported for backwards compatibility, but since DITA-OT 2.1,
any new customizations should instead use the <code class="keyword markupname xmlelement">&lt;transtype&gt;</code> element in the
<a class="xref" href="../topics/plugin-configfile.html" title="The plug-in descriptor file (plugin.xml) controls all aspects of a plug-in, making each extension visible to the rest of the toolkit. The file uses pre-defined extension points to locate changes, and then integrates those changes into the core DITA-OT code.">Plug-in descriptor file</a> to define a new transformation.</div>
</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.specialization.catalog</span></dt>
<dd class="dd">Adds the
content of a catalog file to the main DITA-OT catalog file. <div class="note attention note_attention"><span class="note__title">Attention:</span> This extension point is
deprecated; use <code class="ph codeph">dita.specialization.catalog.relative</code> instead.</div></dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.specialization.catalog.relative</span></dt>
<dd class="dd">Adds the content of a catalog file to the main DITA-OT catalog file.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.transtype.print</span></dt>
<dd class="dd">Defines a
transformation as a print type.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.messages</span></dt>
<dd class="dd">Adds new diagnostic
messages to DITA-OT.</dd>
<dt class="dt dlterm"><span class="keyword parmname">org.dita.pdf2.catalog.relative</span></dt>
<dd class="dd">Adds
the content of a catalog file to the main catalog file for the PDF plug-in.</dd>
</dl>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/plugin-extension-points.html" title="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 plugin.xml file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit.">Extension point reference</a></div></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../extension-points/extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports.">Extension points in org.dita.base</a></li></ul></div></nav></article></main></body></html>

130
dita-ot-3.6/doc/extension-points/plugin-extension-points-pre-processing.html Normal file
View file

@ -0,0 +1,130 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="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."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Pre-processing extension points</title></head><body id="plugin-extension-points-pre-processing"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li class="active"><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Pre-processing extension points</h1>
<div class="body refbody"><p class="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.</p>
<section class="section">
<div class="note tip note_tip"><span class="note__title">Tip:</span> For maximum compatibility with future versions of
DITA-OT, most plug-ins should use the extension points that run <strong class="ph b">before</strong> or <strong class="ph b">after</strong>
pre-processing.</div>
<dl class="dl">
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.pre</span></dt>
<dd class="dd">Runs an Ant
target before the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.post</span></dt>
<dd class="dd">Runs an Ant
target after the pre-processing stage.</dd>
</dl>
</section>
<section class="section"><h2 class="title sectiontitle">Legacy pre-processing extensions</h2>
<p class="p">The following extension points are available in the original <code class="ph codeph">preprocess</code> pipeline that was used
by default for all transformations prior to DITA-OT 3.0. These extensions are not available in the newer
<a class="xref" href="../reference/map-first-preprocessing.html" title="DITA-OT 3.0 provides a map-first preprocessing option as an alternative to the default preprocess operation. The method, which was introduced in DITA-OT 2.5 as an experimental feature, has been improved and is ready for use in many production scenarios. Map-first-preprocessing provides the same functionality as the default preprocess, but takes a different approach.">map-first preprocessing</a> pipeline (<code class="ph codeph">preprocess2</code>), which
is used in the PDF and HTML Help transformations as of DITA-OT 3.0.</p>
<div class="note caution note_caution"><span class="note__title">CAUTION:</span> The internal order of preprocessing steps is
subject to change between versions of DITA-OT. New versions may remove, reorder, combine, or add steps to
the process, so the extension points <strong class="ph b">within</strong> the preprocessing stage should only be used if absolutely
necessary.</div>
<dl class="dl">
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.chunk.pre</span></dt>
<dd class="dd">Runs an
Ant target before the <code class="ph codeph">chunk</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.coderef.pre</span></dt>
<dd class="dd">Runs an
Ant target before the <code class="ph codeph">coderef</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.conref.pre</span></dt>
<dd class="dd">Runs an
Ant target before the <code class="ph codeph">conref</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.conrefpush.pre</span></dt>
<dd class="dd">Runs
an Ant target before the <code class="ph codeph">conrefpush</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.clean-temp.pre</span></dt>
<dd class="dd">Runs
an Ant target before the <code class="ph codeph">clean-temp</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-files.pre</span></dt>
<dd class="dd">Runs
an Ant target before the <code class="ph codeph">copy-files</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-flag.pre</span></dt>
<dd class="dd">Runs
an Ant target before the <code class="ph codeph">copy-flag</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-html.pre</span></dt>
<dd class="dd">Runs
an Ant target before the <code class="ph codeph">copy-html</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-image.pre</span></dt>
<dd class="dd">Runs
an Ant target before the <code class="ph codeph">copy-image</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.copy-subsidiary.pre</span></dt>
<dd class="dd">Runs an Ant target before the <code class="ph codeph">copy-subsidiary</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.debug-filter.pre</span></dt>
<dd class="dd">Runs an Ant target before the <code class="ph codeph">debug-filter</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.gen-list.pre</span></dt>
<dd class="dd">Runs
an Ant target before the <code class="ph codeph">gen-list</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.keyref.pre</span></dt>
<dd class="dd">Runs an
Ant target before the <code class="ph codeph">keyref</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.maplink.pre</span></dt>
<dd class="dd">Runs an
Ant target before the <code class="ph codeph">maplink</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.mappull.pre</span></dt>
<dd class="dd">Runs an
Ant target before the <code class="ph codeph">mappull</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.mapref.pre</span></dt>
<dd class="dd">Runs an
Ant target before the <code class="ph codeph">mapref</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.move-meta-entries.pre</span></dt>
<dd class="dd">Runs an Ant target before the <code class="ph codeph">move-meta-entries</code> step in the pre-processing stage.</dd>
<dt class="dt dlterm"><span class="keyword parmname">depend.preprocess.topicpull.pre</span></dt>
<dd class="dd">Runs
an Ant target before the <code class="ph codeph">topicpull</code> step in the pre-processing stage.</dd>
</dl>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/plugin-extension-points.html" title="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 plugin.xml file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit.">Extension point reference</a></div></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../extension-points/extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports.">Extension points in org.dita.base</a></li></ul></div></nav></article></main></body></html>

52
dita-ot-3.6/doc/extension-points/plugin-extension-points-support.html Normal file
View file

@ -0,0 +1,52 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="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."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Version and support information</title></head><body id="plugin-support"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li class="active"><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Version and support information</h1>
<div class="body refbody"><p class="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.</p>
<section class="section">
<dl class="dl">
<dt class="dt dlterm"><span class="keyword parmname">package.support.name</span></dt>
<dd class="dd">Specifies the
person who provides support for the DITA-OT plug-in.</dd>
<dt class="dt dlterm"><span class="keyword parmname">package.support.email</span></dt>
<dd class="dd">Specifies the
e-mail address of the person who provides support for the DITA-OT plug-in.</dd>
<dt class="dt dlterm"><span class="keyword parmname">package.version</span></dt>
<dd class="dd">Specifies the version
of the DITA-OT plug-in.</dd>
<dd class="dd ddexpand">
<p class="p">The value uses the following syntax:</p>
<pre class="pre codeblock"><code><var class="keyword varname">major</var>.<var class="keyword varname">minor</var>.<var class="keyword varname">micro</var>.<var class="keyword varname">qualifier</var></code></pre>
<p class="p">where:</p>
<ul class="ul">
<li class="li"><var class="keyword varname">major</var> is a number and is required.</li>
<li class="li"><var class="keyword varname">minor</var> is a number and is optional.</li>
<li class="li"><var class="keyword varname">micro</var> is a number and is optional.</li>
<li class="li"><var class="keyword varname">qualifier</var> is optional and can be composed of numerals, uppercase or lower case
letters, underscores, and hyphens.</li>
</ul>
<p class="p">By default, the <span class="keyword parmname">package.version</span> value is set to <code class="ph codeph">0.0.0</code>.</p>
</dd>
</dl>
</section>
<div class="example"><h2 class="title sectiontitle">Example</h2>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;plugin id="com.example.WithSupportInfo"&gt;
&lt;feature extension="package.support.name" value="Joe the Author"/&gt;
&lt;feature extension="package.support.email" value="joe@example.com"/&gt;
&lt;feature extension="package.version" value="1.2.3"/&gt;
&lt;/plugin&gt;</code></pre>
</div>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/plugin-extension-points.html" title="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 plugin.xml file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit.">Extension point reference</a></div></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../extension-points/extension-points-in-org.dita.base.html" title="The org.dita.base plug-in provides common extension points that are available to extend processing in all transformations that DITA Open Toolkit supports.">Extension points in org.dita.base</a></li></ul></div></nav></article></main></body></html>

138
dita-ot-3.6/doc/extension-points/plugin-extension-points-xslt-import.html Normal file
View file

@ -0,0 +1,138 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="You can use these extension points to override XSLT processing steps in pre-processing and certain transformation types. The value of the file attribute in the feature 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."><meta name="keywords" content=", xref, file, XSLT, extension points, extension points, XSLT, preprocessing, extension points, XSLT"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>XSLT-import extension points</title></head><body id="plugin-extension-points-xslt-import"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li class="active"><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">XSLT-import extension points</h1>
<div class="body refbody"><p class="shortdesc">You can use these extension points to override XSLT processing steps in pre-processing and certain
transformation types. The value of the <code class="keyword markupname xmlatt">@file</code> attribute in the <code class="keyword markupname xmlelement">&lt;feature&gt;</code>
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.</p>
<section class="section"><h2 class="title sectiontitle">Pre-processing</h2>
<p class="p">You can use the following extension points to add XSLT processing to modules in the pre-processing
pipeline:</p>
<dl class="dl">
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.conref</span></dt>
<dd class="dd">Overrides the pre-processing step that resolves conref.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.maplink</span></dt>
<dd class="dd">Overrides the <code class="ph codeph">maplink</code> step in the pre-processing pipeline. This is the step that
generates map-based links.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.mappull</span></dt>
<dd class="dd">Overrides the <code class="ph codeph">mappull</code> step in the pre-processing pipeline. This is the step that updates
navigation titles in maps and causes attributes to cascade.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.mapref</span></dt>
<dd class="dd">Overrides the <code class="ph codeph">mapref</code> step in the pre-processing pipeline. This is the step that resolves
references to other maps.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.topicpull</span></dt>
<dd class="dd">Overrides the <code class="ph codeph">topicpull</code> step in the pre-processing pipeline. This is the step that pulls
text into <code class="keyword markupname xmlelement">&lt;xref&gt;</code> elements, as well as performing other tasks.</dd>
</dl>
</section>
<section class="section"><h2 class="title sectiontitle">Transformations</h2>
<p class="p">You can use the following extension points to add XSLT processing to modules in DITA-OT transformations:</p>
<dl class="dl">
<dt class="dt dlterm"><span class="keyword parmname">dita.map.eclipse.index.pre</span></dt>
<dd class="dd">Runs an Ant target before the Eclipse index extraction process.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.eclipse.plugin</span></dt>
<dd class="dd">Overrides the default XSLT step that generates the <span class="ph filepath">plugin.xml</span> file for Eclipse
Help.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.eclipse.toc</span></dt>
<dd class="dd">Overrides the default XSLT step that generates the Eclipse Help table of contents (TOC).</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.html.cover</span></dt>
<dd class="dd">Overrides the
default HTML cover page generation process.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.htmltoc</span></dt>
<dd class="dd">Overrides the
default XSLT step that generates the HTML table of contents (TOC).</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.html5</span></dt>
<dd class="dd">Overrides the
default HTML5 transformation. The referenced file is integrated directly into the XSLT step that generates
HTML5.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.html5.cover</span></dt>
<dd class="dd">Overrides the
default HTML5 cover page generation process.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.html5.toc</span></dt>
<dd class="dd">Overrides the
default XSLT step that generates the HTML5 table of contents (TOC).</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.htmlhelp.map2hhc</span></dt>
<dd class="dd">Overrides the default XSLT step that generates the HTML Help contents (<span class="ph filepath">.hhc</span>)
file.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.htmlhelp.map2hhp</span></dt>
<dd class="dd">Overrides the default XSLT step that generates the HTML Help project (<span class="ph filepath">.hhp</span>) file.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.xhtml</span></dt>
<dd class="dd">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>
<dt class="dt dlterm"><span class="keyword parmname">dita.xsl.xslfo</span></dt>
<dd class="dd">Overrides the default
PDF transformation. The referenced XSL file is integrated directly into the XSLT step that generates the
XSL-FO.</dd>
</dl>
</section>
<div class="example"><h2 class="title sectiontitle">Example</h2>
<p class="p">The following two files represent a complete (albeit simple) plug-in that adds a company banner to the XHTML
output. The <span class="ph filepath">plugin.xml</span> file declares an XSLT file that extends the XHTML processing; the
<span class="ph filepath">xsl/header.xsl</span> file overrides the default header processing to provide a company
banner.</p>
<figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 1. </span>Contents of the <span class="ph filepath">plugin.xml</span> file</figcaption>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;plugin id="com.example.brandheader"&gt;
&lt;feature extension="dita.xsl.xhtml" file="xsl/header.xsl"/&gt;
&lt;/plugin&gt;</code></pre>
</figure>
<figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 2. </span>Contents of the <span class="ph filepath">xsl/header.xsl</span> file</figcaption>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"&gt;
&lt;xsl:template name="gen-user-header"&gt;
&lt;div&gt;
&lt;img src="http://www.example.com/company_banner.jpg"
alt="Example Company Banner"/&gt;
&lt;/div&gt;
&lt;/xsl:template&gt;
&lt;/xsl:stylesheet&gt;</code></pre>
</figure>
</div>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/plugin-extension-points.html" title="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 plugin.xml file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit.">Extension point reference</a></div></div></nav></article></main></body></html>

97
dita-ot-3.6/doc/extension-points/plugin-extension-points-xslt-parameters.html Normal file
View file

@ -0,0 +1,97 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="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 xsl:param values with XSLT overrides."><meta name="keywords" content="XSLT, parameters, preprocessing, extension points, parameters"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>XSLT-parameter extension points</title></head><body id="plugin-extension-points-xslt-parameters"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li class="active"><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">XSLT-parameter extension points</h1>
<div class="body refbody"><p class="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
<code class="keyword markupname xmlelement">&lt;xsl:param&gt;</code> values with XSLT overrides.</p>
<section class="section"><h2 class="title sectiontitle">Pre-processing</h2>
<p class="p">You can use the following extension points to pass parameters to modules in the pre-processing pipeline:</p>
<dl class="dl">
<dt class="dt dlterm"><span class="keyword parmname">dita.preprocess.conref.param</span></dt>
<dd class="dd">Pass parameters to the <code class="ph codeph">conref</code> module in the pre-processing pipeline</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.preprocess.mappull.param</span></dt>
<dd class="dd">Pass parameters to the <code class="ph codeph">mappull</code> module in the pre-processing pipeline</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.preprocess.mapref.param</span></dt>
<dd class="dd">Pass parameters to the <code class="ph codeph">mapref</code> module in the pre-processing pipeline</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.preprocess.topicpull.param</span></dt>
<dd class="dd">Pass parameters to the <code class="ph codeph">topicpull</code> module in the pre-processing pipeline</dd>
</dl>
</section>
<section class="section"><h2 class="title sectiontitle">Transformations</h2>
<p class="p">You can use the following extension points to pass parameters to modules in DITA-OT transformations:</p>
<dl class="dl">
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.eclipse.toc.param</span></dt>
<dd class="dd">Pass parameters to the XSLT step that generates the Eclipse Help table of contents (TOC).</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.html.param</span></dt>
<dd class="dd">Pass
parameters to the HTML and HTML Help
transformations.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.html5.param</span></dt>
<dd class="dd">Pass
parameters to the HTML5 transformation.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.html5.toc.param</span></dt>
<dd class="dd">Pass
parameters to the XSLT step that generates the HTML5 table of contents (TOC).</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.pdf2.param</span></dt>
<dd class="dd">Pass
parameters to the PDF transformation.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.xhtml.param</span></dt>
<dd class="dd">Pass
parameters to the XHTML and Eclipse Help transformations.</dd>
<dt class="dt dlterm"><span class="keyword parmname">dita.conductor.xhtml.toc.param</span></dt>
<dd class="dd">Pass
parameters to the XSLT step that generates the XHTML table of contents (TOC).</dd>
</dl>
</section>
<div class="example"><h2 class="title sectiontitle">Example</h2>
<p class="p">The following two files represent a complete (albeit simple) plug-in that passes the parameters defined in the
<span class="ph filepath">insertParameters.xml</span> file to the XHTML transformation process.</p>
<figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 1. </span>Contents of the <span class="ph filepath">plugin.xml</span> file</figcaption>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;plugin id="com.example.newparam"&gt;
&lt;feature extension="dita.conductor.xhtml.param"
file="insertParameters.xml"/&gt;
&lt;/plugin&gt;</code></pre>
</figure>
<figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 2. </span>Contents of the <span class="ph filepath">insertParameters.xml</span></figcaption>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;dummy xmlns:if="ant:if" xmlns:unless="ant:unless"&gt;
<em class="ph i">&lt;!-- Any Ant code allowed in xslt task is possible. Example: --&gt;</em>
&lt;param name="paramNameinXSLT" expression="${antProperty}"
if:set="antProperty"/&gt;
&lt;/dummy&gt;</code></pre>
</figure>
</div>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../extension-points/plugin-extension-points.html" title="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 plugin.xml file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit.">Extension point reference</a></div></div></nav></article></main></body></html>

13
dita-ot-3.6/doc/extension-points/plugin-extension-points.html Normal file
View file

@ -0,0 +1,13 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="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 plugin.xml file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit."><meta name="keywords" content="extension points, overview, plug-in, preprocessing, plugin.xml, topicmerge, org.dita.pdf2.xsl.topicmerge"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extension point reference</title></head><body id="plugin-extension-points"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li class="active"><a href="../extension-points/plugin-extension-points.html">Extension points</a><ul><li><a href="../extension-points/all-extension-points.html">All extension points</a></li><li><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></li><li><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></li><li><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></li><li><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></li><li><a href="../extension-points/extension-points-by-plugin.html">Plug-in extension points</a></li></ul></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Extension point reference</h1>
<p class="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 <span class="ph filepath">plugin.xml</span> file for each plug-in. When plug-ins are
installed, DITA-OT makes each extension visible to the rest of the toolkit.</p>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../extension-points/all-extension-points.html">All DITA-OT extension points</a></strong><br>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.</li><li class="link ulchildlink"><strong><a href="../extension-points/plugin-extension-points-general.html">General extension points</a></strong><br>These extension points enable you to extend DITA-OT. You can add Ant targets or imports; add a Java library to the <span class="keyword parmname">classpath</span> parameter; add a new transformation type; extend a catalog file; add new diagnostic messages, and more.</li><li class="link ulchildlink"><strong><a href="../extension-points/plugin-extension-points-pre-processing.html">Pre-processing extension points</a></strong><br>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.</li><li class="link ulchildlink"><strong><a href="../extension-points/plugin-extension-points-xslt-import.html">XSLT-import extension points</a></strong><br>You can use these extension points to override XSLT processing steps in pre-processing and certain transformation types. The value of the <code class="keyword markupname xmlatt">@file</code> attribute in the <code class="keyword markupname xmlelement">&lt;feature&gt;</code> 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.</li><li class="link ulchildlink"><strong><a href="../extension-points/plugin-extension-points-xslt-parameters.html">XSLT-parameter extension points</a></strong><br>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 <code class="keyword markupname xmlelement">&lt;xsl:param&gt;</code> values with XSLT overrides.</li><li class="link ulchildlink"><strong><a href="../extension-points/plugin-extension-points-support.html">Version and support information</a></strong><br>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.</li><li class="link ulchildlink"><strong><a href="../extension-points/extension-points-by-plugin.html">Extension points by plug-in</a></strong><br>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.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/index.html" title="The Reference topics provide more advanced information about the DITA-OT architecture, OASIS specification support, and licensing.">Reference</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2014/dita-ot_day.html#Extending_the_DITA_Open_Toolkit" target="_blank" rel="external noopener" title="DITA-OT includes extension points that let you do any number of things. This session will cover what's available, what you should or shouldn't extend, and give out sample plugins to slice and dice your content.">Extending the DITA Open Toolkit: How crazy can you get?</a></li></ul></div></nav></article></main></body></html>

66
dita-ot-3.6/doc/index.html Normal file
View file

@ -0,0 +1,66 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit, or DITA-OT for short, is a set of Java-based, open-source tools that provide processing for content authored in the Darwin Information Typing Architecture."><meta name="keywords" content="OASIS"><link rel="stylesheet" type="text/css" href="css/commonltr.css"><link rel="stylesheet" type="text/css" href="css/dita-ot-doc.css"><title>DITA Open Toolkit 3.6</title></head><body id="dita-otprojecthome"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li class="active"><a href="index.html">DITA Open Toolkit 3.6</a></li><li><a href="release-notes/index.html">Release Notes</a></li><li><a href="topics/installing-client.html">Installing DITA-OT</a></li><li><a href="topics/building-output.html">Building output</a></li><li><a href="topics/input-formats.html">Authoring formats</a></li><li><a href="topics/output-formats.html">Output formats</a></li><li><a href="parameters/index.html">Parameters</a></li><li><a href="topics/html-customization.html">Customizing HTML</a></li><li><a href="topics/pdf-customization.html">Customizing PDF</a></li><li><a href="topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="reference/index.html">Reference</a></li><li><a href="topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">DITA Open Toolkit <span class="keyword">3.6</span></h1>
<div class="body"><p class="shortdesc"><dfn class="term">DITA Open Toolkit</dfn>, or <dfn class="term">DITA-OT</dfn> for short, is a set of Java-based, open-source
tools that provide processing for content authored in the <dfn class="term">Darwin Information Typing
Architecture</dfn>.</p>
<div class="note note note_note"><span class="note__title">Note:</span> 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
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part0-overview.html" target="_blank" rel="external noopener">DITA standard</a>.</div>
<section class="section"><h2 class="title sectiontitle">DITA-OT documentation</h2>
<p class="p">The DITA Open Toolkit documentation provides information about installing, running, configuring and extending
the toolkit.</p>
<ul class="ul list-group mb-5">
<li class="li list-group-item list-group-item-action">See the
<a class="xref stretched-link" href="release-notes/index.html" title="DITA Open Toolkit 3.6 includes performance enhancements such as processing in parallel and in memory, support for PDF changebars with Apache FOP, and an updated preview of features for the latest draft of the upcoming DITA 2.0 standard, including the audio and video elements, and the new emphasis domain.">DITA Open Toolkit 3.6 Release Notes</a> for information on the changes in the current
release.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="topics/installing-client.html" title="The DITA-OT distribution package can be installed on Linux, macOS, and Windows. It contains everything that you need to run the toolkit except for Java.">Installing DITA Open Toolkit</a> shows how to install the toolkit and run a
build to verify the installation.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="topics/building-output.html" title="You can use the dita command-line tool, Ant, or the Java API to transform DITA content to the various output formats that DITA Open Toolkit supports.">Building output</a> explains the methods that can be used to
transform DITA content to other formats, including the <span class="keyword cmdname">dita</span> command, Ant, and the Java API,
along with information on publishing DITA content from a containerized environment.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="topics/input-formats.html" title="In addition to standard DITA XML, DITA-OT supports several alternative input formats, including Markdown and the proposed XDITA, MDITA and HDITA authoring formats currently in development for Lightweight DITA.">Authoring formats</a> provides information on supported input formats,
including standard DITA XML, Markdown and the Lightweight DITA formats (XDITA, MDITA and HDITA).</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="topics/output-formats.html" title="DITA Open Toolkit ships with several core transformations that convert DITA content to different output formats. Additional formats are available from the plug-in registry at dita-ot.org/plugins.">Output formats</a> describes the core
transformations that convert DITA to other formats.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="parameters/index.html" title="You can adjust DITA Open Toolkit behavior via dita command arguments and options, DITA-OT parameter settings, and configuration properties.">DITA Open Toolkit parameters</a> explains how to adjust the behavior of DITA Open
Toolkit via <span class="keyword cmdname">dita</span> command arguments and options, DITA-OT parameter settings, and
configuration properties.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="topics/html-customization.html" title="You can modify the look and feel of your HTML output by changing parameter settings to include custom CSS, headers and footers, or table-of-contents navigation in topics.">Customizing HTML output</a> shows how to <span class="ph">modify the look and feel of your HTML output by changing parameter settings
to include custom CSS, headers and footers, or table-of-contents navigation in topics</span>.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="topics/pdf-customization.html" title="You can adjust various aspects of PDF output by changing parameter settings. For more complex customizations, you can create custom DITA-OT plug-ins.">Customizing PDF output</a> explains how to <span class="ph">adjust various aspects of PDF output by changing parameter settings</span>.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="topics/adding-plugins.html" title="You can extend DITA-OT with additional plug-ins to change the default output types in various ways, add entirely new kinds of output formats, or implement DITA specializations. A variety of open source plug-ins are available from the plug-in registry at dita-ot.org/plugins.">Adding and removing plug-ins</a> explains how to install, remove and discover new
plug-ins.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="topics/custom-plugins.html" title="In addition to adding plug-ins from the plug-in registry at dita-ot.org/plugins, you can create custom DITA-OT plug-ins of your own to modify the default output, add new output formats, support new languages, or implement DITA topic specializations.">Creating custom plug-ins</a> provides information on extending DITA-OT with
plug-ins of your own.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="topics/troubleshooting-overview.html" title="This section contains information about problems that you might encounter and how to resolve them.">Error messages and troubleshooting</a> contains information about resolving
problems that you might encounter.</li>
<li class="li list-group-item list-group-item-action">
<a class="xref stretched-link" href="reference/index.html" title="The Reference topics provide more advanced information about the DITA-OT architecture, OASIS specification support, and licensing.">Reference</a> topics provide additional information about the
<a class="xref" href="reference/architecture.html" title="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.">DITA Open Toolkit Architecture</a>,
<a class="xref" href="reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a>, a
<a class="xref" href="reference/glossary.html" title="Certain terms have particular meaning in the context of the DITA Open Toolkit project.">Glossary</a> and other
<a class="xref" href="topics/dita-and-dita-ot-resources.html" title="In addition to the DITA Open Toolkit documentation, there are other resources about DITA and DITA-OT that you might find helpful.">DITA and DITA-OT resources</a>.</li>
</ul>
</section>
</div>
<nav role="navigation" class="related-links"><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2014/dita-ot_day.html#Overview_of_the_DITA_Open_Toolkit" target="_blank" rel="external noopener" title="Are you new to the DITA-OT? Come and get an overview of what it is, how it works, its history, and the people involved. This will be an excellent start to DITA-OT day for novices.">Overview of the DITA Open Toolkit</a></li></ul></div></nav></article></main></body></html>

120
dita-ot-3.6/doc/parameters/configuration-properties-file.html Normal file
View file

@ -0,0 +1,120 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The configuration.properties file controls certain common properties, as well as some properties that control PDF processing."><meta name="keywords" content="configuration properties, default.cascade, org.dita.pdf2.i18n.enabled, plugin.ignores, plugin.order, plugindirs, temp-file-name-scheme, cli.color, registry, default.coderef-charset, files, config/configuration.properties file, PDF, configuration properties, cascade, macOS, colored console output, Linux, Windows, command line, dita command, terminal, command line, grammar files, schema, DTD, command, dita, metadata, DITA 1.3, Java, temporary file names, catalog, import precedence, internationalization, I18N"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>The configuration.properties file</title></head><body id="configuration"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a><ul><li><a href="../parameters/local-properties-file.html">local.properties</a></li><li><a href="../parameters/plugin-properties-file.html">plugin.properties</a></li><li class="active"><a href="../parameters/configuration-properties-file.html">configuration.properties</a></li><li><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">The <span class="ph filepath">configuration.properties</span> file</h1>
<div class="body refbody"><p class="shortdesc">The <span class="ph filepath">configuration.properties</span> file controls certain common properties, as well as some
properties that control PDF processing.</p>
<section class="section">
<p class="p">The contents of the <span class="ph filepath">config/configuration.properties</span> file are added to the DITA-OT
configuration in the <code class="ph codeph">dost-configuration.jar</code> file when the plug-in integration process runs. The
following properties are typically set in this file:</p>
<dl class="dl parml">
<dt class="dt pt dlterm" id="configuration__default-cascade"><span class="keyword parmname">default.cascade</span></dt>
<dd class="dd pd">
<p class="p">Specifies the processing default value for the DITA 1.3 <code class="keyword markupname xmlatt">@cascade</code> attribute, which
determines how map-level metadata attributes are applied to the children of elements where the attributes
are specified. DITA-OT uses the <span class="keyword option">merge</span> value by default for backwards compatibility with
DITA 1.2 and earlier.</p>
<div class="note warning note_warning" id="configuration__protected-config-props"><span class="note__title">Warning:</span> This property can only be set in
<span class="ph filepath">configuration.properties</span> and should not be modified.</div></dd>
<dt class="dt pt dlterm" id="configuration__temp-file-name-scheme"><span class="keyword parmname">temp-file-name-scheme</span></dt>
<dd class="dd pd">
<p class="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>
<div class="note warning note_warning"><span class="note__title">Warning:</span> This property can only be set in
<span class="ph filepath">configuration.properties</span> and should not be modified.</div>
</dd>
<dt class="dt pt dlterm" id="configuration__cli-color"><span class="keyword parmname">cli.color</span></dt>
<dd class="dd pd">
<p class="p">Specifies whether the <span class="keyword cmdname">dita</span> command prints colored output on the command line console.
When set to <span class="keyword option">true</span>, error messages in <span class="keyword cmdname">dita</span> command output will appear in
red on terminals that support
<a class="xref" href="https://en.wikipedia.org/wiki/ANSI_escape_code" target="_blank" rel="external noopener">ANSI escape
codes</a>, such as on Linux or macOS. Set to <span class="keyword option">false</span> to disable the color. (Colored
output is not supported on Windows consoles such as <span class="keyword cmdname">cmd.exe</span> or PowerShell).</p>
</dd>
<dt class="dt pt dlterm" id="configuration__plugindirs"><span class="keyword parmname">plugindirs</span></dt>
<dd class="dd pd" id="configuration__plugindirs.desc">
<p class="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
<span class="ph filepath">plugin.xml</span> file is installed.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> 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
<span class="ph filepath">;docsrc/samples/plugins</span> to the property value and run <span class="keyword cmdname">dita</span>
<span class="keyword parmname">--install</span>. 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.</div></dd>
<dt class="dt pt dlterm" id="configuration__plugin.ignores"><span class="keyword parmname">plugin.ignores</span></dt>
<dd class="dd pd" id="configuration__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.</dd>
<dt class="dt pt dlterm" id="configuration__plugin-order"><span class="keyword parmname">plugin.order</span></dt>
<dd class="dd 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.</dd>
<dt class="dt pt dlterm" id="configuration__registry"><span class="keyword parmname">registry</span></dt>
<dd class="dd 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
<a class="xref" href="https://www.dita-ot.org/plugins" target="_blank" rel="external noopener">dita-ot.org/plugins</a>, 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 <code class="ph codeph">registry</code> key value, separating each entry with a space. For more information, see
<a class="xref" href="../topics/plugins-registry.html" title="DITA-OT 3.2 supports a new plug-in registry that makes it easier to discover and install new plug-ins. The registry provides a searchable list of plug-ins at dita-ot.org/plugins.">Adding plug-ins via the registry</a>.</dd>
<dt class="dt pt dlterm"><span class="keyword parmname">org.dita.pdf2.i18n.enabled</span></dt>
<dd class="dd pd">
<p class="p">Enables internationalization (I18N) font processing to provide per-character font selection for FO
renderers that do not support the <code class="ph codeph">font-selection-strategy</code> property (such as Apache
FOP).
</p>
<p class="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 class="p">The following values are allowed:</p>
<ul class="ul">
<li class="li"><span class="keyword option">true</span> (default) — Enables font mapping</li>
<li class="li"><span class="keyword option">false</span> — Disables font mapping</li>
</ul>
<div class="note tip note_tip"><span class="note__title">Tip:</span> 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
<a class="xref" href="http://www.elovirta.com/2016/02/18/font-configuration-in-pdf2.html" target="_blank" rel="external noopener">Font configuration in PDF2</a>.</div>
</dd>
<dt class="dt pt dlterm" id="configuration__charset"><span class="keyword parmname">default.coderef-charset</span></dt>
<dd class="dd 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
<a class="xref" href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" target="_blank" rel="external noopener">Charset</a> class.</dd>
</dl>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/configuration-properties.html" title="DITA-OT uses .properties 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.">Configuration properties</a></div></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/plugins-installing.html" title="Use the dita install subcommand to install plug-ins.">Installing plug-ins</a></li></ul></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/cascading-in-a-ditamap.html#cascading-in-a-ditamap" target="_blank" rel="external noopener">DITA 1.3 specification: Cascading of metadata attributes in a DITA map</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/example-how-cascade-att-functions.html" target="_blank" rel="external noopener">Example: How the @cascade attribute functions</a></li><li class="linklist"><a class="link" href="http://www.elovirta.com/2016/02/18/font-configuration-in-pdf2.html" target="_blank" rel="external noopener">Font configuration in PDF2</a></li></ul></div></nav>
</article></main></body></html>

30
dita-ot-3.6/doc/parameters/configuration-properties.html Normal file
View file

@ -0,0 +1,30 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA-OT uses .properties 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."><meta name="keywords" content="command line, properties, Ant, Java, configuring, precedence, local.properties file"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Configuration properties</title></head><body id="configuring-the-dita-ot"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li class="active"><a href="../parameters/configuration-properties.html">Configuration properties</a><ul><li><a href="../parameters/local-properties-file.html">local.properties</a></li><li><a href="../parameters/plugin-properties-file.html">plugin.properties</a></li><li><a href="../parameters/configuration-properties-file.html">configuration.properties</a></li><li><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Configuration properties</h1>
<div class="body refbody"><p class="shortdesc">DITA-OT uses <span class="ph filepath">.properties</span> 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.</p>
<section class="section">
<p class="p">When DITA-OT starts the Ant process, it looks for property values in the following order and locations:</p>
<ol class="ol">
<li class="li">Any property passed to Ant from the command line with <span class="keyword parmname">-Dproperty</span> or
<span class="keyword parmname">--property</span>=<span class="keyword option">value</span></li>
<li class="li">A custom property file passed with <span class="keyword parmname">--propertyfile</span></li>
<li class="li">A <span class="ph filepath">local.properties</span> file in the root directory of the DITA-OT installation</li>
<li class="li">The <span class="ph filepath">lib/org.dita.dost.platform/plugin.properties</span> file</li>
<li class="li">The <span class="ph filepath">configuration.properties</span> file</li>
</ol>
<p class="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 class="p">You can use this mechanism to override DITA-OT default settings for your environment by passing parameters to
the <span class="keyword cmdname">dita</span> command with <span class="keyword parmname">--property</span>=<span class="keyword option">value</span>, or using
entries in <span class="ph filepath">.properties</span> files.</p>
</section>
</div>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../parameters/local-properties-file.html">The local.properties file</a></strong><br>A <span class="ph filepath">local.properties</span> file in the root directory of the DITA-OT installation can be used to override the default values of various DITA-OT parameters.</li><li class="link ulchildlink"><strong><a href="../parameters/plugin-properties-file.html">The plugin.properties file</a></strong><br>The <span class="ph filepath">plugin.properties</span> file is used to store configuration properties that are set by the plug-in installation process.</li><li class="link ulchildlink"><strong><a href="../parameters/configuration-properties-file.html">The configuration.properties file</a></strong><br>The <span class="ph filepath">configuration.properties</span> file controls certain common properties, as well as some properties that control PDF processing.</li><li class="link ulchildlink"><strong><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></strong><br>Reference list of Ant properties used by DITA-OT internally.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/index.html" title="You can adjust DITA Open Toolkit behavior via dita command arguments and options, DITA-OT parameter settings, and configuration properties.">DITA Open Toolkit parameters</a></div></div></nav></article></main></body></html>

424
dita-ot-3.6/doc/parameters/dita-command-arguments.html Normal file
View file

@ -0,0 +1,424 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The dita 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."><meta name="keywords" content="filters, command, dita, command, arguments list, arguments, installing, uninstalling, artlbl, args.artlbl"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Arguments and options for the dita command</title></head><body id="dita-command-properties"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li class="active"><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Arguments and options for the <span class="keyword cmdname">dita</span> command</h1>
<div class="body refbody"><p class="shortdesc">The <span class="keyword cmdname">dita</span> 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.</p>
<section class="section"><h2 class="title sectiontitle">Usage</h2>
<p class="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>
<div class="fig syntaxdiagram">
<div><a name=""></a>
<blockquote>
<kbd><b>dita</b></kbd>
<kbd><b>--input</b></kbd>
<kbd class="ph oper">=</kbd>
<var>file</var>
<kbd><b>--format</b></kbd>
<kbd class="ph oper">=</kbd>
<var>name</var>
[
<var>options</var>
]
</blockquote>
</div>
<div><a name=""></a>
<blockquote>
<kbd><b>dita</b></kbd>
<kbd><b>--project</b></kbd>
<kbd class="ph oper">=</kbd>
<var>file</var>
[
<var>options</var>
]
</blockquote>
</div>
</div>
<div class="note note note_note"><span class="note__title">Note:</span> Most <span class="keyword cmdname">dita</span> 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.</div>
<p class="p">The <span class="keyword cmdname">dita</span> 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>
<div class="fig syntaxdiagram">
<div><a name=""></a>
<blockquote>
<kbd><b>dita</b></kbd>
<kbd><b>deliverables</b></kbd>
<var>file</var>
</blockquote>
</div>
<div><a name=""></a>
<blockquote>
<kbd><b>dita</b></kbd>
<kbd><b>install</b></kbd>
[ {
<var>ID</var>
<var> | URL</var>
<var> | file</var>
} ]
</blockquote>
</div>
<div><a name=""></a>
<blockquote>
<kbd><b>dita</b></kbd>
<kbd><b>plugins</b></kbd>
</blockquote>
</div>
<div><a name=""></a>
<blockquote>
<kbd><b>dita</b></kbd>
<kbd><b>transtypes</b></kbd>
</blockquote>
</div>
<div><a name=""></a>
<blockquote>
<kbd><b>dita</b></kbd>
<kbd><b>uninstall</b></kbd>
<var>ID</var>
</blockquote>
</div>
<div><a name=""></a>
<blockquote>
<kbd><b>dita</b></kbd>
<kbd><b>version</b></kbd>
</blockquote>
</div>
</div>
<div class="note attention note_attention"><span class="note__title">Attention:</span> Prior to DITA-OT 3.5, subcommands were specified with the double-hyphen option syntax,
which is still supported for backwards compatibility. (For example, <span class="keyword cmdname">dita</span>
<span class="keyword parmname">--install</span> will still work.)</div>
</section>
<section class="section"><h2 class="title sectiontitle">Arguments</h2>
<p class="p">Each transformation requires you to specify at least the file to transform and the desired output format.</p>
<dl class="dl parml">
<dt class="dt pt dlterm">
<span class="keyword parmname">--input</span>=<var class="keyword varname">file</var></dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">-i</span>
<var class="keyword varname">file</var>
</dt>
<dd class="dd pd" id="dita-command-properties__args.input.desc">Specifies the master file for your documentation project. This argument corresponds
to the common parameter <span class="keyword parmname">args.input</span>. 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
<span class="keyword parmname">args.input.dir</span>, or relative to the current directory if
<span class="keyword parmname">args.input.dir</span> is not defined.</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--format</span>=<var class="keyword varname">name</var></dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">-f</span>
<var class="keyword varname">name</var>
</dt>
<dd class="dd pd">Specifies the output format (transformation type).</dd>
<dd class="dd pd ddexpand">This argument corresponds to the common parameter <span class="keyword parmname">transtype</span>.</dd>
<dd class="dd pd ddexpand">To list the formats that are currently available in your environment, use <span class="keyword cmdname">dita
transtypes</span>.</dd>
<dd class="dd pd ddexpand">
<div class="p">You can create plug-ins to add new output formats; by default, the following values are
available:
<ul class="ul">
<li class="li"><span class="keyword option">dita</span></li>
<li class="li"><span class="keyword option">eclipsehelp</span></li>
<li class="li"><span class="keyword option">html5</span></li>
<li class="li"><span class="keyword option">htmlhelp</span></li>
<li class="li"><span class="keyword option">markdown</span>, <span class="keyword option">markdown_gitbook</span>, and
<span class="keyword option">markdown_github</span></li>
<li class="li"><span class="keyword option">pdf</span></li>
<li class="li"><span class="keyword option">xhtml</span></li>
</ul>
<div class="note tip note_tip"><span class="note__title">Tip:</span> See
<a class="xref" href="../topics/output-formats.html" title="DITA Open Toolkit ships with several core transformations that convert DITA content to different output formats. Additional formats are available from the plug-in registry at dita-ot.org/plugins.">DITA-OT transformations (output formats)</a> for sample command line syntax and more information on each
transformation. </div>
</div>
</dd>
</dl>
</section>
<section class="section"><h2 class="title sectiontitle">Subcommands</h2>
<dl class="dl parml">
<dt class="dt pt dlterm">
<span class="keyword parmname">deliverables</span>
<var class="keyword varname">file</var></dt>
<dd class="dd pd">Show a list of the available deliverables in the specified project <var class="keyword varname">file</var>.</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">install</span>
<var class="keyword varname">{ ID | URL | file }</var></dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">--install</span>=<var class="keyword varname">{ ID | URL | file }</var></dt>
<dd class="dd pd">Install a single plug-in <var class="keyword varname">ID </var>from the registry at
<a class="xref" href="https://www.dita-ot.org/plugins" target="_blank" rel="external noopener">dita-ot.org/plugins</a> (or a local registry), from a remote <var class="keyword varname">URL</var>, or a
local ZIP <var class="keyword varname">file</var>.</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">install</span>
</dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">--install</span>
</dt>
<dd class="dd pd"><span class="ph">If no <var class="keyword varname">ID</var>, <var class="keyword varname">URL</var>, or
<var class="keyword varname">file</var> argument is provided, the installation process reloads the current set of
plug-ins from the <span class="ph filepath">plugins</span> directory (or any custom locations defined via the
<span class="keyword parmname">pluginsdir</span> property in the <span class="ph filepath">configuration.properties</span> file
in the <span class="ph filepath">config</span> directory). This approach can be used to add or remove multiple
plug-ins at once, or any individual plug-ins you have already copied to (or removed from) the plug-in
directories. Any plug-ins added or removed in the process will be listed by their plug-in
ID.</span></dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">uninstall</span>
<var class="keyword varname">ID</var>
</dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">--uninstall</span>=<var class="keyword varname">ID</var>
</dt>
<dd class="dd pd">Remove the plug-in with the specified <var class="keyword varname">ID</var>.</dd>
<dd class="dd pd ddexpand">For a list of the currently installed plug-in IDs, use <span class="keyword cmdname">dita plugins</span>.</dd>
<dd class="dd pd ddexpand">
<div class="note attention note_attention"><span class="note__title">Attention:</span> The <span class="keyword cmdname">uninstall</span> subcommand also
removes the corresponding plug-in directory from the <span class="ph filepath">plugins</span> folder.
</div>
</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">plugins</span>
</dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">--plugins</span>
</dt>
<dd class="dd pd">Show a list of the currently installed plug-ins.</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">transtypes</span>
</dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">--transtypes</span>
</dt>
<dd class="dd pd">Show a list of the available output formats (transformation types).</dd>
<dd class="dd pd ddexpand">The entries in this list may be passed as values to the <span class="keyword parmname">--format</span> argument.</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">version</span>
</dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">--version</span>
</dt>
<dd class="dd pd">Print version information and exit.</dd>
</dl>
</section>
<section class="section"><h2 class="title sectiontitle">Options</h2>
<dl class="dl parml" id="dita-command-properties__dita_build_options">
<dt class="dt pt dlterm">
<span class="keyword parmname">--debug</span></dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">-d</span>
</dt>
<dd class="dd 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.</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--output</span>=<var class="keyword varname">dir</var></dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">-o</span>
<var class="keyword varname">dir</var>
</dt>
<dd class="dd pd" id="dita-command-properties__output.dir.desc">
<p class="p">Specifies the path of the output directory; the path can be absolute or relative to the current
directory.</p>
<p class="p">This argument corresponds to the common parameter <span class="keyword parmname">output.dir</span>. By default, the output
is written to the <span class="ph filepath">out</span> subdirectory of the current directory.</p>
</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--filter</span>=<var class="keyword varname">files</var>
</dt>
<dd class="dd pd">
<p class="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>
<div class="note note note_note"><span class="note__title">Note:</span>
<p class="p">To specify multiple filter files, use the system path separator character to delimit individual file
paths (semicolon ‘<code class="ph codeph">;</code>’ on Windows, and colon ‘<code class="ph codeph">:</code>’ on macOS and Linux) and
wrap the value in quotes:</p>
<p class="p"><code class="ph codeph">--filter="filter1.ditaval;filter2.ditaval;filter3.ditaval"</code></p>
<p class="p">As of DITA-OT 3.6, the <span class="keyword parmname">--filter</span> option can also be passed multiple times:</p>
<p class="p"><code class="ph codeph">--filter=filter1.ditaval --filter=filter2.ditaval --filter=filter3.ditaval</code></p>
<p class="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>
</div>
</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--force</span>
</dt>
<dd class="dd pd">Force-install an existing plug-in.</dd>
<dd class="dd pd ddexpand">Passed as an additional option to the installation subcommand: <span class="keyword cmdname">dita
install</span>&nbsp;<var class="keyword varname">plug-in-zip</var>&nbsp;<span class="keyword parmname">--force</span></dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--help</span></dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">-h</span>
</dt>
<dd class="dd pd">Print a list of available arguments, options, and subcommands.</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--logfile</span>=<var class="keyword varname">file</var></dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">-l</span>
<var class="keyword varname">file</var>
</dt>
<dd class="dd pd">Write logging messages to a file.</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--parameter</span>=<var class="keyword varname">value</var></dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">-D</span><var class="keyword varname">parameter</var>=<var class="keyword varname">value</var>
</dt>
<dd class="dd pd">Specify a value for a DITA-OT or Ant build parameter.</dd>
<dd class="dd pd ddexpand">The GNU-style <span class="keyword parmname">--parameter</span>=<var class="keyword varname">value</var> form is only available for
parameters that are configured in the plug-in configuration file; the Java-style <span class="keyword parmname">-D</span>
form can also be used to specify additional non-configured parameters or set system properties.</dd>
<dd class="dd pd ddexpand">Parameters not implemented by the specified transformation type or referenced in a
<span class="ph filepath">.properties</span> file are ignored. <div class="note tip note_tip"><span class="note__title">Tip:</span> If you are building in different environments where the location of the input
files is not consistent, set <span class="keyword option">args.input.dir</span> with the <span class="keyword cmdname">dita</span> command and
reference its value with <code class="ph codeph">${args.input.dir}</code> in your <span class="ph filepath">.properties</span> file.
</div>
</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--propertyfile</span>=<var class="keyword varname">file</var>
</dt>
<dd class="dd pd">Use build parameters defined in the referenced <span class="ph filepath">.properties</span> file.</dd>
<dd class="dd pd ddexpand">Build parameters specified on the command line override those set in the <span class="ph filepath">.properties</span>
file.</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--repeat</span>=<var class="keyword varname">N</var>
</dt>
<dd class="dd pd">Repeat the transformation <var class="keyword varname">N</var> number of times.</dd>
<dd class="dd pd ddexpand">This option can be used by plug-in developers to measure performance. To run a conversion five times, for
example, use <span class="keyword parmname">--repeat</span>=<span class="keyword option">5</span>. The duration of each execution will appear in
the console when the final transformation is complete.
<pre class="pre codeblock syntax-bash multi-platform"><code>$ <span class="keyword cmdname">dita</span> <span class="keyword parmname">--input</span>=<span class="ph filepath">docsrc/samples/sequence.ditamap</span> <span class="keyword parmname">--format</span>=<span class="keyword option">html5</span> <span class="keyword parmname">--repeat</span>=<span class="keyword option">5</span>
1 11281ms
2 4132ms
3 3690ms
4 4337ms
5 3634ms</code></pre>
</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--resource</span>=<var class="keyword varname">file</var>
</dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">-r</span>
<var class="keyword varname">file</var>
</dt>
<dd class="dd pd">Convert partial documentation sets by processing input with additional resources.</dd>
<dd class="dd pd ddexpand">For example, to process a single topic file with a map that contains key definitions, use a command like
this:
<pre class="pre codeblock syntax-bash"><code><span class="keyword cmdname">dita</span> <span class="keyword parmname">--input</span>=<span class="ph filepath">topic.dita</span> <span class="keyword parmname">--resource</span>=<span class="ph filepath">keys.ditamap</span> <span class="keyword parmname">--format</span>=<span class="keyword option">html5</span></code></pre>
</dd>
<dd class="dd pd ddexpand">To convert a chapter map to HTML5 and insert related links from relationship tables in a separate map,
use:
<pre class="pre codeblock syntax-bash"><code><span class="keyword cmdname">dita</span> <span class="keyword parmname">--input</span>=<span class="ph filepath">chapter.ditamap</span> <span class="keyword parmname">--resource</span>=<span class="ph filepath">reltables.ditamap</span> <span class="keyword parmname">--format</span>=<span class="keyword option">html5</span></code></pre>
</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--temp</span>=<var class="keyword varname">dir</var></dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">-t</span>
<var class="keyword varname">dir</var>
</dt>
<dd class="dd pd">Specifies the location of the temporary directory.</dd>
<dd class="dd pd ddexpand">This argument corresponds to the common parameter <span class="keyword parmname">dita.temp.dir</span>.</dd>
<dt class="dt pt dlterm">
<span class="keyword parmname">--verbose</span></dt>
<dt class="dt pt dlterm">
<span class="keyword parmname">-v</span>
</dt>
<dd class="dd 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.</dd>
</dl>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/index.html" title="You can adjust DITA Open Toolkit behavior via dita command arguments and options, DITA-OT parameter settings, and configuration properties.">DITA Open Toolkit parameters</a></div></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/build-using-dita-command.html" title="You can generate output using the dita command-line tool. Build parameters can be specified on the command line or with .properties files.">Building output using the dita command</a></li><li class="linklist"><a class="link" href="../topics/using-dita-properties-file.html" title="Usually, DITA builds require setting a number of parameters that do not change frequently. You can reference a set of build parameters defined in a .properties file when building output with the dita command. If needed, you can override any parameter by specifying it explicitly as an argument to the dita command.">Setting build parameters with .properties files</a></li><li class="linklist"><a class="link" href="../topics/dita-command-help.html" title="You can access a list of subcommands and supported parameters for the dita command by passing the --help option on the command line.">Accessing help for the dita command</a></li></ul></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/parameters_intro.html" title="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 dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></li><li class="linklist"><a class="link" href="../parameters/internal-ant-properties.html" title="Reference list of Ant properties used by DITA-OT internally.">Internal Ant properties</a></li></ul></div></nav></article></main></body></html>

72
dita-ot-3.6/doc/parameters/generate-copy-outer.html Normal file
View file

@ -0,0 +1,72 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="By default, DITA-OT assumes content is located in or beneath the directory containing the DITA map file. The generate.copy.outer parameter can be used to adjust how output is generated for content that is located outside the map directory."><meta name="keywords" content=", generate.copy.outer, HTML, files outside map directory, DITA maps, relative file locations"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Handling content outside the map directory</title></head><body id="ID"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a><ul><li><a href="../topics/html-customization-parameters.html">Setting HTML parameters</a><ul><li><a href="../topics/html-customization-navigation.html">Adding navigation</a></li><li><a href="../topics/html-customization-css.html">Adding custom CSS</a></li><li><a href="../topics/html-customization-header.html">Headers and footers</a></li><li class="active"><a href="../parameters/generate-copy-outer.html">Handling content outside the map directory</a></li></ul></li><li><a href="../topics/html-customization-properties-file.html">Using a properties file</a></li></ul></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Handling content outside the map directory</h1>
<div class="body conbody"><p class="shortdesc">By default, DITA-OT assumes content is located in or beneath the directory containing the DITA map file.
The <span class="keyword parmname">generate.copy.outer</span> parameter can be used to adjust how output is generated for content
that is located outside the map directory.</p>
<section class="section"><h2 class="title sectiontitle">Background</h2>
<div class="p">This is an issue in the following situations:
<ul class="ul">
<li class="li">The DITA map is in a directory that is a peer to directories that contain referenced objects.</li>
<li class="li">The DITA map is in a directory that is below the directories that contain the referenced objects.</li>
</ul></div>
<p class="p">Let’s assume that the directory structure for the DITA content looks like the following:</p>
<div class="p"><pre class="pre">images/
fig.png
maps/
start.ditamap
topics/
topic.dita</pre></div>
<p class="p">The DITA map is in the <span class="ph filepath">maps</span> directory, the topics are in the <span class="ph filepath">topics</span>
directory, and the images are in the <span class="ph filepath">images</span> directory.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Exclude content outside the map directory</h2>
<p class="p">Let’s assume that you run the HTML5 transformation. By default, DITA-OT uses the
<span class="keyword parmname">generate.copy.outer</span> parameter with a value of <span class="keyword option">1</span>, which means that no
output is generated for content that is located outside the DITA map directory.</p>
<p class="p">You receive only the following output:</p>
<div class="p"><pre class="pre">index.html
commonltr.css
commonrtl.css</pre></div>
<p class="p">The <span class="ph filepath">index.html</span> file contains the navigation structure, but all the links are broken, since
no HTML files were built for the topics.</p>
<p class="p">How do you fix this? By adjusting the parameter setting to shift the output directory.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Shift the output directory to include all content</h2>
<p class="p">To preserve the links to referenced topics and images and make it easier to copy the output directory, set the
<span class="keyword parmname">generate.copy.outer</span> parameter to <span class="keyword option">3</span>.</p>
<p class="p">Now your output directory structure resembles the structure of the source directory:</p>
<div class="p"><pre class="pre">images/
fig.png
maps/
index.html
topics/
topic.html
commonltr.css
commonrtl.css</pre></div>
<p class="p">The <span class="ph filepath">index.html</span> file is in the <span class="ph filepath">maps</span> directory, the HTML files for the
topics are in the <span class="ph filepath">topics</span> directory, and the referenced images are in the
<span class="ph filepath">images</span> directory.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> If <span class="keyword parmname">args.csspath</span> is not set, the default CSS files (and any custom CSS files
specified via <span class="keyword parmname">args.css</span>) will be copied to the root level of the output folder. To copy CSS
files to an output subfolder named <span class="ph filepath">css</span>, set <span class="keyword parmname">args.csspath</span> to
<span class="keyword option">css</span>.
</div>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/html-customization-parameters.html" title="For simple branded HTML pages, you can adjust the look and feel of the default output to match your company style by setting parameters to include custom CSS, header branding, or table-of-contents navigation in topics. (These changes do not require a custom plug-in.)">Setting parameters for custom HTML</a></div></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/html-customization-navigation.html" title="In HTML5 output, you can set a parameter to include table-of-contents navigation in the nav element of each page. The navigation can be rendered in a sidebar or menu via CSS.">Adding navigation to topics</a></li><li class="linklist"><a class="link" href="../topics/html-customization-css.html" title="To modify the appearance of the default HTML output that DITA Open Toolkit generates, you can reference a custom Cascading Style Sheet (CSS) file with the typography, colors, and other presentation aspects that define your corporate identity.">Adding custom CSS</a></li><li class="linklist"><a class="link" href="../topics/html-customization-header.html" title="You add a custom header to include a publication title, company logo, or other common branding elements in HTML output. A custom footer can also be added with copyright information, legal boilerplate, or other fine print.">Adding custom headers and footers</a></li></ul></div></nav></article></main></body></html>

13
dita-ot-3.6/doc/parameters/index.html Normal file
View file

@ -0,0 +1,13 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="You can adjust DITA Open Toolkit behavior via dita command arguments and options, DITA-OT parameter settings, and configuration properties."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA Open Toolkit parameters</title></head><body id="ID"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li class="active"><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">DITA Open Toolkit parameters</h1>
<p class="shortdesc">
<span class="ph" id="ID__ph_docs-pr-desc">You can adjust DITA Open Toolkit behavior via <span class="keyword cmdname">dita</span> command arguments and
options, DITA-OT parameter settings, and configuration properties.</span>
</p>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../parameters/dita-command-arguments.html">Arguments and options for the dita command</a></strong><br>The <span class="keyword cmdname">dita</span> 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.</li><li class="link ulchildlink"><strong><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></strong><br>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 <span class="keyword cmdname">dita</span> command using the <span class="keyword parmname">--parameter</span>=<var class="keyword varname">value</var> syntax or included in build scripts as Ant properties.</li><li class="link ulchildlink"><strong><a href="../parameters/configuration-properties.html">Configuration properties</a></strong><br>DITA-OT uses <span class="ph filepath">.properties</span> 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.</li></ul><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2015/dita-ot_day.html#Parameters_Annotations_For_DITA_OT_Plugins" target="_blank" rel="external noopener" title="Each DITA-OT plugin provides a set of parameters that can be configured to customize the publishing process. As these need to be made available to users it is important to have an automated way of discovering these parameters and additional information about them - what they represent, what values are possible, etc. DITA-OT makes this possible by allowing parameters to be annotated.">Parameters annotations for DITA-OT plugins</a></li></ul></div></nav></article></main></body></html>

46
dita-ot-3.6/doc/parameters/internal-ant-properties.html Normal file
View file

@ -0,0 +1,46 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Reference list of Ant properties used by DITA-OT internally."><meta name="keywords" content=", role, args.rellinks, PDF, related links, HTML5"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Internal Ant properties</title></head><body id="ant-properties"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a><ul><li><a href="../parameters/local-properties-file.html">local.properties</a></li><li><a href="../parameters/plugin-properties-file.html">plugin.properties</a></li><li><a href="../parameters/configuration-properties-file.html">configuration.properties</a></li><li class="active"><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Internal Ant properties</h1>
<div class="body refbody"><p class="shortdesc">Reference list of Ant properties used by DITA-OT internally.</p>
<section class="section">
<dl class="dl parml">
<dt class="dt pt dlterm"><code class="ph codeph">include.rellinks</code></dt>
<dd class="dd pd">A space-separated list of link roles to be output; the <code class="ph codeph">#default</code> value token represents
links without an explicit role (those for which no <code class="keyword markupname xmlatt">@role</code> attribute is defined). Defined by
<code class="ph codeph">args.rellinks</code>, but may be overridden directly. Valid roles include:
<ul class="ul">
<li class="li">parent </li>
<li class="li">child </li>
<li class="li">sibling </li>
<li class="li">friend </li>
<li class="li">next </li>
<li class="li">previous </li>
<li class="li">cousin </li>
<li class="li">ancestor </li>
<li class="li">descendant </li>
<li class="li">sample </li>
<li class="li">external </li>
<li class="li">other</li>
</ul></dd>
<dt class="dt pt dlterm"><code class="ph codeph">temp.output.dir.name</code></dt>
<dd class="dd 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 class="p">For example, if a custom HTML5 transform sets the property to <code class="ph codeph">zip_dir</code>, all output files
(including HTML, images, and CSS) will be placed within the directory <span class="ph filepath">zip_dir</span> 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></dd>
</dl>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/configuration-properties.html" title="DITA-OT uses .properties 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.">Configuration properties</a></div></div></nav></article></main></body></html>

36
dita-ot-3.6/doc/parameters/local-properties-file.html Normal file
View file

@ -0,0 +1,36 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="A local.properties file in the root directory of the DITA-OT installation can be used to override the default values of various DITA-OT parameters."><meta name="keywords" content="files, local.properties, local.properties file, Windows, RenderX, Antenna House, command line, file, Java, PDF, formatter, formatter, Apache FOP, Antenna House, RenderX"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>The local.properties file</title></head><body id="local.properties"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a><ul><li class="active"><a href="../parameters/local-properties-file.html">local.properties</a></li><li><a href="../parameters/plugin-properties-file.html">plugin.properties</a></li><li><a href="../parameters/configuration-properties-file.html">configuration.properties</a></li><li><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">The <span class="ph filepath">local.properties</span> file</h1>
<div class="body refbody"><p class="shortdesc">A <span class="ph filepath">local.properties</span> file in the root directory of the DITA-OT installation can be used
to override the default values of various DITA-OT parameters.</p>
<div class="example">
<p class="p">For example, if you always use the same rendering engine to produce PDF output for all of your projects, you
could create a <span class="ph filepath">local.properties</span> file in the root directory of your DITA-OT installation to
set the <span class="keyword parmname">pdf.formatter</span> parameter and additional options for the XSL processor:</p>
<pre class="pre codeblock language-properties normalize-space show-line-numbers show-whitespace"><code># Use RenderX XEP Engine for PDF output
pdf.formatter = xep
# Specify the user configuration file for RenderX
custom.xep.config = /path/to/custom.config</code></pre>
<p class="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>
<pre class="pre codeblock language-properties normalize-space show-line-numbers show-whitespace"><code># 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</code></pre>
</div>
<section class="section">
<div class="note note note_note"><span class="note__title">Note:</span> 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.</div>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/configuration-properties.html" title="DITA-OT uses .properties 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.">Configuration properties</a></div></div></nav></article></main></body></html>

86
dita-ot-3.6/doc/parameters/parameters-base-html.html Normal file
View file

@ -0,0 +1,86 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain parameters apply to all HTML-based transformation types: HTML5, XHTML, HTML&nbsp;Help, and Eclipse help."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>HTML-based output parameters</title></head><body id="base-html"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li><a href="../parameters/parameters-base.html">Common</a></li><li><a href="../parameters/parameters-pdf.html">PDF</a></li><li class="active"><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-xhtml.html">XHTML</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTML Help</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-other.html">Other</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">HTML-based output parameters</h1><div class="body refbody"><p class="shortdesc">Certain parameters apply
to all HTML-based transformation types: HTML5, XHTML, HTML&nbsp;Help, and Eclipse help. <span class="ph">
</span>
</p><section class="section"><dl class="dl parml"><dt class="dt pt dlterm" id="base-html__args.artlbl"><span class="keyword parmname">args.artlbl</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.artlbl.desc">Specifies whether to generate a label for each image; the label will contain the image file name. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="base-html__args.copycss"><span class="keyword parmname">args.copycss</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.copycss.desc">Specifies whether to copy the custom .css file to the output directory. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__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 <span class="keyword option">no</span>). If DITA-OT should copy the
file when generating output, set it to <span class="keyword option">yes</span>.</div></dd><dt class="dt pt dlterm" id="base-html__args.css"><span class="keyword parmname">args.css</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.css.desc">Specifies the name of a custom .css file.</dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__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 <span class="keyword parmname">args.cssroot</span>.</div></dd><dt class="dt pt dlterm" id="base-html__args.csspath"><span class="keyword parmname">args.csspath</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.csspath.desc">
<div class="div" id="base-html__args.csspath.desc">Specifies the <strong class="ph b">destination</strong> directory to which .css files are copied
(relative to the output directory).</div></dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__args.csspath.details">
<p class="p">Corresponds to the XSLT parameter <span class="keyword parmname">CSSPATH</span>.</p>
<p class="p">DITA-OT will copy the file <strong class="ph b">to</strong> this location.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> If <span class="keyword parmname">args.csspath</span> 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 <span class="ph filepath">css</span>, set <span class="keyword parmname">args.csspath</span> to
<span class="keyword option">css</span>.
</div></div>
</dd><dt class="dt pt dlterm" id="base-html__args.cssroot"><span class="keyword parmname">args.cssroot</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.cssroot.desc">
<div class="div" id="base-html__args.cssroot.desc">Specifies the <strong class="ph b">source</strong> directory that contains the custom .css
file.</div></dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__args.cssroot.details">
<p class="p">DITA-OT will copy the file <strong class="ph b">from</strong> this location.</p>
<div class="note important note_important"><span class="note__title">Important:</span> Enter the absolute path to the parent directory of the custom CSS file specified
with <span class="keyword parmname">args.css</span>.</div>
</div></dd><dt class="dt pt dlterm" id="base-html__args.dita.locale"><span class="keyword parmname">args.dita.locale</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.dita.locale.desc">Specifies the language locale file to use for sorting index entries.</dd><dd class="dd pd ddexpand">
<div class="note note note_note"><span class="note__title">Note:</span> This parameter is not available for the XHTML transformation.</div>
</dd><dt class="dt pt dlterm" id="base-html__args.eclipse.provider"><span class="keyword parmname">args.eclipse.provider</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.eclipse.provider.desc">Specifies the name of the person or organization that provides the Eclipse help.</dd><dt class="dt pt dlterm" id="base-html__args.eclipse.symbolic.name"><span class="keyword parmname">args.eclipse.symbolic.name</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.eclipse.symbolic.name.desc">Specifies the symbolic name (aka plugin ID) in the output for an Eclipse Help project.</dd><dt class="dt pt dlterm" id="base-html__args.eclipse.version"><span class="keyword parmname">args.eclipse.version</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.eclipse.version.desc">Specifies the version number to include in the output.</dd><dt class="dt pt dlterm" id="base-html__args.eclipsehelp.country"><span class="keyword parmname">args.eclipsehelp.country</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.eclipsehelp.country.desc">Specifies the region for the language that is specified by the args.</dd><dt class="dt pt dlterm" id="base-html__args.eclipsehelp.jar.name"><span class="keyword parmname">args.eclipsehelp.jar.name</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.eclipsehelp.jar.name.desc">Specifies that the output should be zipped and returned using this name.</dd><dt class="dt pt dlterm" id="base-html__args.eclipsehelp.language"><span class="keyword parmname">args.eclipsehelp.language</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.eclipsehelp.language.desc">Specifies the base language for translated content, such as en for English.</dd><dt class="dt pt dlterm" id="base-html__args.ftr"><span class="keyword parmname">args.ftr</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.ftr.desc">Specifies an XML file that contains content for a running footer.</dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__args.ftr.details">
<span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">FTR</span>.</span>
<div class="note note note_note"><span class="note__title">Note:</span> 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 <code class="keyword markupname xmlelement">&lt;div&gt;</code> element. In HTML5 output, the
footer file contents will be wrapped in an HTML5 <code class="keyword markupname xmlelement">&lt;footer&gt;</code> element with the
<code class="keyword markupname xmlatt">@role</code> attribute set to <span class="keyword option">contentinfo</span>.
</div>
</div></dd><dt class="dt pt dlterm" id="base-html__args.gen.default.meta"><span class="keyword parmname">args.gen.default.meta</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.gen.default.meta.desc">Generate metadata for parental control scanners, meta elements with name="security" and name="Robots". The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__args.gen.default.meta.details">Corresponds to the XSLT parameter <span class="keyword parmname">genDefMeta</span>.
</div>
</dd><dt class="dt pt dlterm" id="base-html__args.hdf"><span class="keyword parmname">args.hdf</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.hdf.desc">Specifies an XML file that contains content to be placed in the document head.</dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__args.hdf.details">
<p class="p">The contents of the header file will be inserted in the <code class="keyword markupname xmlelement">&lt;head&gt;</code> element of the
generated HTML files.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> 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
<code class="keyword markupname xmlelement">&lt;div&gt;</code> 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.
</div></div></dd><dt class="dt pt dlterm" id="base-html__args.hdr"><span class="keyword parmname">args.hdr</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.hdr.desc">Specifies an XML file that contains content for a running header.</dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__args.hdr.details">
<span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">HDR</span>.</span>
<div class="note note note_note"><span class="note__title">Note:</span> 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 <code class="keyword markupname xmlelement">&lt;div&gt;</code> element. In HTML5 output, the
contents of the header file will be wrapped in an HTML5 <code class="keyword markupname xmlelement">&lt;header&gt;</code> element with
the <code class="keyword markupname xmlatt">@role</code> attribute set to <span class="keyword option">banner</span>.
</div>
</div></dd><dt class="dt pt dlterm" id="base-html__args.hide.parent.link"><span class="keyword parmname">args.hide.parent.link</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.hide.parent.link.desc">Specifies whether to hide links to parent topics in the HTML or XHTML output. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__args.hide.parent.link.details">
<span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">NOPARENTLINK</span>.</span>
<div class="note notice note_notice"><span class="note__title">Notice:</span> This parameter is deprecated in favor of the <span class="keyword parmname">args.rellinks</span>
parameter.</div>
</div></dd><dt class="dt pt dlterm" id="base-html__args.htmlhelp.includefile"><span class="keyword parmname">args.htmlhelp.includefile</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.htmlhelp.includefile.desc">Specifies the name of a file that you want included in the HTML Help.</dd><dt class="dt pt dlterm" id="base-html__args.indexshow"><span class="keyword parmname">args.indexshow</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.indexshow.desc">Specifies whether the content of &lt;indexterm&gt; elements are rendered in the output. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="base-html__args.outext"><span class="keyword parmname">args.outext</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.outext.desc">Specifies the file extension for HTML or XHTML output.</dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__args.outext.details">
<span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">OUTEXT</span>.</span>
</div></dd><dt class="dt pt dlterm" id="base-html__args.xhtml.classattr"><span class="keyword parmname">args.xhtml.classattr</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.xhtml.classattr.desc">Specifies whether to include the DITA class ancestry inside the XHTML elements. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">yes</span>.</dd><dd class="dd pd ddexpand">For example, the <code class="keyword markupname xmlelement">&lt;prereq&gt;</code> element (which is specialized
from <code class="keyword markupname xmlelement">&lt;section&gt;</code>) would generate <code class="ph codeph">class="section prereq"</code>. <span class="ph">Corresponds to the XSLT parameter
<span class="keyword parmname">PRESERVE-DITA-CLASS</span>.</span><div class="note note note_note"><span class="note__title">Note:</span> Beginning with DITA-OT release 1.5.2, the default
value is <span class="keyword option">yes</span>. For release 1.5 and 1.5.1, the default value was <span class="keyword option">no</span>. </div>
</dd><dt class="dt pt dlterm" id="base-html__args.xhtml.contenttarget"><span class="keyword parmname">args.xhtml.contenttarget</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.xhtml.contenttarget.desc">Specifies the value of the @target attribute on the &lt;base&gt; element in the TOC file.</dd><dt class="dt pt dlterm" id="base-html__args.xhtml.toc"><span class="keyword parmname">args.xhtml.toc</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.xhtml.toc.desc">Specifies the base name of the TOC file.</dd><dt class="dt pt dlterm" id="base-html__args.xhtml.toc.class"><span class="keyword parmname">args.xhtml.toc.class</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.xhtml.toc.class.desc">Specifies the value of the @class attribute on the &lt;body&gt; element in the TOC file.</dd><dt class="dt pt dlterm" id="base-html__args.xhtml.toc.xsl"><span class="keyword parmname">args.xhtml.toc.xsl</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.xhtml.toc.xsl.desc">Specifies a custom XSL file to be used for TOC generation.</dd><dt class="dt pt dlterm" id="base-html__args.xsl"><span class="keyword parmname">args.xsl</span><span class="ph"></span></dt><dd class="dd pd" id="base-html__args.xsl.desc">Specifies a custom XSL file to be used instead of the default XSL transformation.</dd><dd class="dd pd ddexpand">
<div class="div" id="base-html__args.xsl.details">The parameter must specify a fully qualified file name.</div></dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="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 dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div><div class="linklist relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/dita2eclipsehelp.html" title="The eclipsehelp transformation generates XHTML output, CSS files, and the control files that are needed for Eclipse help.">Eclipse help transformation</a></li><li class="linklist"><a class="link" href="../topics/dita2htmlhelp.html" title="The htmlhelp transformation generates HTML output, CSS files, and the control files that are needed to produce a Microsoft Compiled HTML Help (.chm) file.">HTML help transformation</a></li><li class="linklist"><a class="link" href="../topics/dita2xhtml.html" title="The xhtml transformation generates XHTML output and a table of contents (TOC) file. This was the first transformation created for DITA Open Toolkit, and originally served as the basis for all HTML-based transformations.">XHTML transformation</a></li><li class="linklist"><a class="link" href="../topics/dita2html5.html" title="The html5 transformation generates HTML5 output and a table of contents (TOC) file.">HTML5 transformation</a></li></ul></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/html-customization-parameters.html" title="For simple branded HTML pages, you can adjust the look and feel of the default output to match your company style by setting parameters to include custom CSS, header branding, or table-of-contents navigation in topics. (These changes do not require a custom plug-in.)">Setting parameters for custom HTML</a></li><li class="linklist"><a class="link" href="../topics/html-customization-plugin-bundle-css.html" title="You can create a DITA-OT plug-in that provides a custom stylesheet with the typography and colors that define your corporate identity. Coworkers can install this plug-in to ensure consistent HTML output across projects without having to copy the stylesheet to each project.">Bundling CSS in a custom HTML plug-in</a></li><li class="linklist"><a class="link" href="../topics/html-customization-plugin-webfont.html" title="A custom plug-in can be created to generate HTML output that uses custom fonts for enhanced typographic features, extended character sets or a unique corporate identity.">Embedding web fonts in HTML output</a></li><li class="linklist"><a class="link" href="../topics/html-customization-plugin-javascript.html" title="JavaScript code can be bundled in a custom plug-in and automatically inserted into the generated HTML pages to enable web analytics or dynamic content delivery.">Inserting JavaScript in generated HTML</a></li></ul></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/parameters-eclipsehelp.html" title="Certain parameters are specific to the Eclipse help transformation.">Eclipse Help parameters</a></li><li class="linklist"><a class="link" href="../parameters/parameters-html5.html" title="The HTML5 transformation shares common parameters with other HTML-based transformations and provides additional parameters that are specific to HTML5 output.">HTML5 parameters</a></li><li class="linklist"><a class="link" href="../parameters/parameters-htmlhelp.html" title="Certain parameters are specific to the Microsoft Compiled HTML Help (.chm) transformation.">Microsoft Compiled HTML Help parameters</a></li><li class="linklist"><a class="link" href="../parameters/parameters-xhtml.html" title="Certain parameters are specific to the XHTML transformation.">XHTML parameters</a></li></ul></div></nav></article></main></body></html>

136
dita-ot-3.6/doc/parameters/parameters-base.html Normal file
View file

@ -0,0 +1,136 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain parameters apply to all transformations that DITA Open Toolkit supports."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Common parameters</title></head><body id="base"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li class="active"><a href="../parameters/parameters-base.html">Common</a></li><li><a href="../parameters/parameters-pdf.html">PDF</a></li><li><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-xhtml.html">XHTML</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTML Help</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-other.html">Other</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">Common parameters</h1><div class="body refbody"><p class="shortdesc">Certain parameters apply to all
transformations that DITA Open Toolkit supports.</p><section class="section"><dl class="dl parml"><dt class="dt pt dlterm" id="base__args.debug"><span class="keyword parmname">args.debug</span><span class="ph"></span><span class="ph"></span></dt><dd class="dd pd" id="base__args.debug.desc">Specifies whether debugging information is included in the log. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="base__args.draft"><span class="keyword parmname">args.draft</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.draft.desc">Specifies whether the content of &lt;draft-comment&gt; and &lt;required-cleanup&gt; elements is included in the output. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">Corresponds to the XSLT parameter
<span class="keyword parmname">DRAFT</span> in most XSLT modules.<div class="note tip note_tip"><span class="note__title">Tip:</span> For PDF output, setting the
<span class="keyword parmname">args.draft</span> parameter to <span class="keyword option">yes</span> causes the contents of the
<code class="keyword markupname xmlelement">&lt;titlealts&gt;</code> element to be rendered below the title.
</div>
</dd><dt class="dt pt dlterm" id="base__args.figurelink.style"><span class="keyword parmname">args.figurelink.style</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.figurelink.style.desc">Specifies how cross references to figures are styled in output. The allowed values are <span class="keyword option">NUMBER</span>, <span class="keyword option">TITLE</span>, and <span class="keyword option">NUMTITLE</span>.</dd><dd class="dd pd ddexpand">Specifying <span class="keyword option">NUMBER</span> results in "Figure 5"; specifying
<span class="keyword option">TITLE</span> results in the title of the figure. <span class="ph">Corresponds to
the XSLT parameter <span class="keyword parmname">FIGURELINK</span>.</span><div class="note note note_note"><span class="note__title">Note:</span> Support for PDF was added in
DITA-OT 2.0. By default PDF uses the value <span class="keyword option">NUMTITLE</span>, which is not supported for other
transformation types; this results in "Figure 5. Title".</div></dd><dt class="dt pt dlterm" id="base__args.filter"><span class="keyword parmname">args.filter</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.filter.desc">
<p class="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>
<div class="note note note_note"><span class="note__title">Note:</span>
<p class="p">To specify multiple filter files, use the system path separator character to delimit individual file
paths (semicolon ‘<code class="ph codeph">;</code>’ on Windows, and colon ‘<code class="ph codeph">:</code>’ on macOS and Linux)
and wrap the value in quotes:</p>
<p class="p"><code class="ph codeph">--args.filter="filter1.ditaval;filter2.ditaval;filter3.ditaval"</code></p>
<p class="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>
</div>
</dd><dt class="dt pt dlterm" id="base__args.gen.task.lbl"><span class="keyword parmname">args.gen.task.lbl</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.gen.task.lbl.desc">Specifies whether to generate headings for sections within task topics. The allowed values are <span class="keyword option">YES</span> and <span class="keyword option">NO</span>.</dd><dd class="dd pd ddexpand">
<span class="ph">Corresponds to the XSLT parameter
<span class="keyword parmname">GENERATE-TASK-LABELS</span>.</span></dd><dt class="dt pt dlterm" id="base__args.grammar.cache"><span class="keyword parmname">args.grammar.cache</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.grammar.cache.desc">Specifies whether the grammar-caching feature of the XML parser is used. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">yes</span>.</dd><dd class="dd pd ddexpand">
<div class="note note note_note"><span class="note__title">Note:</span> 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 <span class="keyword option">no</span>.
</div>
</dd><dt class="dt pt dlterm" id="base__args.input"><span class="keyword parmname">args.input</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.input.desc">Specifies the master file for your documentation project.</dd><dd class="dd pd ddexpand">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 <span class="keyword parmname">args.input.dir</span>,
or relative to the directory where your project’s Ant build script resides if
<span class="keyword parmname">args.input.dir</span> is not defined. </dd><dt class="dt pt dlterm" id="base__args.input.dir"><span class="keyword parmname">args.input.dir</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.input.dir.desc">Specifies the base directory for your documentation project.</dd><dt class="dt pt dlterm" id="base__args.output.base"><span class="keyword parmname">args.output.base</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.output.base.desc">Specifies the name of the output file without file extension.</dd><dt class="dt pt dlterm" id="base__args.rellinks"><span class="keyword parmname">args.rellinks</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.rellinks.desc">Specifies which links to include in the output. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">none</span> – No links are included.</li><li class="li"><span class="keyword option">all</span> – All links are included.</li><li class="li"><span class="keyword option">noparent</span> – Parent links are not included.</li><li class="li"><span class="keyword option">nofamily</span> – Parent, child, next, and previous links are not included.</li></ul></dd><dd class="dd pd ddexpand">
<p class="p">For PDF output, the default value is <span class="keyword option">nofamily</span>. For all other formats, the default
value is <span class="keyword option">all</span>.
</p></dd><dt class="dt pt dlterm" id="base__args.resources"><span class="keyword parmname">args.resources</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.resources.desc">Specifies resource files.</dd><dt class="dt pt dlterm" id="base__args.tablelink.style"><span class="keyword parmname">args.tablelink.style</span><span class="ph"></span></dt><dd class="dd pd" id="base__args.tablelink.style.desc">Specifies how cross references to tables are styled. The allowed values are <span class="keyword option">NUMBER</span>, <span class="keyword option">TITLE</span>, and <span class="keyword option">NUMTITLE</span>.</dd><dd class="dd pd ddexpand">Specifying <span class="keyword option">NUMBER</span> results in "Table 5"; specifying
<span class="keyword option">TITLE</span> results in the title of the table. <span class="ph">Corresponds to
the XSLT parameter <span class="keyword parmname">TABLELINK</span>.</span><div class="note note note_note"><span class="note__title">Note:</span> Support for PDF was added in
DITA-OT 2.0. By default PDF uses the value <span class="keyword option">NUMTITLE</span>, which is not supported for other
transformation types; this results in "Table 5. Title".
</div></dd><dt class="dt pt dlterm" id="base__clean.temp"><span class="keyword parmname">clean.temp</span><span class="ph"></span></dt><dd class="dd pd" id="base__clean.temp.desc">Specifies whether DITA-OT deletes the files in the temporary directory after it finishes a build. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">yes</span>.</dd><dd class="dd pd ddexpand"></dd><dt class="dt pt dlterm" id="base__conserve-memory"><span class="keyword parmname">conserve-memory</span><span class="ph"></span></dt><dd class="dd pd" id="base__conserve-memory.desc">Conserve memory at the expense of processing speed. The allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">false</span>.</dd><dt class="dt pt dlterm" id="base__default.language"><span class="keyword parmname">default.language</span><span class="ph"></span></dt><dd class="dd pd" id="base__default.language.desc">Specifies the language
that is used if the input file does not have the <code class="keyword markupname xmlatt">@xml:lang</code> attribute set on the root
element. By default, this is set to <span class="keyword option">en</span>. The allowed values are those that are defined in
IETF BCP 47,
<a class="xref" href="https://tools.ietf.org/html/bcp47" target="_blank" rel="external noopener">Tags for Identifying
Languages</a>.
</dd><dt class="dt pt dlterm" id="base__dita.dir"><span class="keyword parmname">dita.dir</span><span class="ph"></span></dt><dd class="dd pd" id="base__dita.dir.desc">Specifies where DITA-OT is installed.</dd><dt class="dt pt dlterm" id="base__dita.input.valfile"><span class="keyword parmname">dita.input.valfile</span><span class="ph"></span><span class="ph"></span></dt><dd class="dd pd" id="base__dita.input.valfile.desc">Specifies a filter file to be used to include, exclude, or flag content.</dd><dd class="dd pd ddexpand">
<div class="note notice note_notice"><span class="note__title">Notice:</span> Deprecated in favor of the <span class="keyword parmname">args.filter</span> parameter.</div>
</dd><dt class="dt pt dlterm" id="base__dita.temp.dir"><span class="keyword parmname">dita.temp.dir</span><span class="ph"></span></dt><dd class="dd pd" id="base__dita.temp.dir.desc">Specifies the location of the temporary directory.</dd><dd class="dd pd ddexpand">The temporary directory is where DITA-OT writes temporary files that are generated
during the transformation process.</dd><dt class="dt pt dlterm" id="base__filter-stage"><span class="keyword parmname">filter-stage</span><span class="ph"></span></dt><dd class="dd pd" id="base__filter-stage.desc">Specifies whether filtering is done before all other processing, or after key and conref processing. The allowed values are <span class="keyword option">early</span> and <span class="keyword option">late</span>; the default value is <span class="keyword option">early</span>.</dd><dd class="dd pd ddexpand">
<div class="note note note_note"><span class="note__title">Note:</span> Changing the filtering stage may produce different results for the same initial data set and
filtering conditions.</div>
</dd><dt class="dt pt dlterm" id="base__force-unique"><span class="keyword parmname">force-unique</span><span class="ph"></span></dt><dd class="dd pd" id="base__force-unique.desc">Generate copy-to attributes to duplicate topicref elements. The allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">false</span>.</dd><dd class="dd pd ddexpand">
<p class="p">Setting this to <span class="keyword option">true</span> ensures that unique output files are created for each instance of
a resource when a map contains multiple references to a single topic.</p></dd><dt class="dt pt dlterm" id="base__generate-debug-attributes"><span class="keyword parmname">generate-debug-attributes</span><span class="ph"></span></dt><dd class="dd pd" id="base__generate-debug-attributes.desc">Specifies whether the @xtrf and @xtrc debugging attributes are generated in the temporary files. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">true</span> (default) – Enables generation of debugging attributes</li><li class="li"><span class="keyword option">false</span> – Disables generation of debugging attributes</li></ul></dd><dd class="dd pd ddexpand">
<div class="note note note_note"><span class="note__title">Note:</span> 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.
</div>
</dd><dt class="dt pt dlterm" id="base__generate.copy.outer"><span class="keyword parmname">generate.copy.outer</span><span class="ph"></span></dt><dd class="dd pd" id="base__generate.copy.outer.desc">Adjust how output is generated for content that is located outside the directory containing the DITA map. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">1</span> (default) – Do not generate output for content that is located outside the DITA map directory.</li><li class="li"><span class="keyword option">3</span> – Shift the output directory so that it contains all output for the publication.</li></ul></dd><dd class="dd pd ddexpand">
<p class="p">See
<a class="xref" href="generate-copy-outer.html" title="By default, DITA-OT assumes content is located in or beneath the directory containing the DITA map file. The generate.copy.outer parameter can be used to adjust how output is generated for content that is located outside the map directory.">Handling content outside the map directory</a> for more information.</p>
</dd><dt class="dt pt dlterm" id="base__link-crawl"><span class="keyword parmname">link-crawl</span><span class="ph"></span></dt><dd class="dd pd" id="base__link-crawl.desc">Specifies whether to crawl only those topic links found in maps, or all discovered topic links. The allowed values are <span class="keyword option">map</span> and <span class="keyword option">topic</span>; the default value is <span class="keyword option">topic</span>.</dd><dt class="dt pt dlterm" id="base__onlytopic.in.map"><span class="keyword parmname">onlytopic.in.map</span><span class="ph"></span></dt><dd class="dd pd" id="base__onlytopic.in.map.desc">Specifies whether files that are linked to, or referenced with a @conref attribute, generate output. The allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">false</span>.</dd><dd class="dd pd ddexpand">If set to <span class="keyword option">true</span>, only files that are referenced directly from the
map will generate output.</dd><dt class="dt pt dlterm" id="base__outer.control"><span class="keyword parmname">outer.control</span><span class="ph"></span></dt><dd class="dd pd" id="base__outer.control.desc">Specifies whether to warn or fail if content is located outside the directory containing the DITA map. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">fail</span> – Fail quickly if files are going to be generated or copied outside of the directory.</li><li class="li"><span class="keyword option">warn</span> (default) – Complete the operation if files will be generated or copied outside of the directory, but log a warning.</li><li class="li"><span class="keyword option">quiet</span> – Quietly finish without generating warnings or errors.</li></ul></dd><dd class="dd pd ddexpand">
<div class="note warning note_warning"><span class="note__title">Warning:</span> 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
<code class="keyword markupname xmlatt">@href</code> attributes for <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> elements.
</div>
</dd><dt class="dt pt dlterm" id="base__output.dir"><span class="keyword parmname">output.dir</span><span class="ph"></span></dt><dd class="dd pd" id="base__output.dir.desc">Specifies the name and location of the output directory.</dd><dd class="dd pd ddexpand">By default, the output is written to
<span class="ph filepath"><var class="keyword varname">DITA-dir</var>/out</span>.</dd><dt class="dt pt dlterm" id="base__parallel"><span class="keyword parmname">parallel</span><span class="ph"></span></dt><dd class="dd pd" id="base__parallel.desc">Run processes in parallel when possible. The allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">false</span>.</dd><dt class="dt pt dlterm" id="base__processing-mode"><span class="keyword parmname">processing-mode</span><span class="ph"></span></dt><dd class="dd pd" id="base__processing-mode.desc">Specifies how DITA-OT handles errors and error recovery. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">strict</span> – When an error is encountered, DITA-OT stops processing</li><li class="li"><span class="keyword option">lax</span> (default) – When an error is encountered, DITA-OT attempts to recover from it</li><li class="li"><span class="keyword option">skip</span> – When an error is encountered, DITA-OT continues processing but does not attempt error recovery</li></ul></dd><dt class="dt pt dlterm" id="base__remove-broken-links"><span class="keyword parmname">remove-broken-links</span><span class="ph"></span></dt><dd class="dd pd" id="base__remove-broken-links.desc">Remove broken related links. The allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">false</span>.</dd><dt class="dt pt dlterm" id="base__result.rewrite-rule.class"><span class="keyword parmname">result.rewrite-rule.class</span><span class="ph"></span></dt><dd class="dd pd" id="base__result.rewrite-rule.class.desc">Specifies the name of the Java class used to rewrite filenames.</dd><dd class="dd pd ddexpand">The custom class should implement the
<code class="ph codeph">org.dita.dost.module.RewriteRule</code> interface.
</dd><dt class="dt pt dlterm" id="base__result.rewrite-rule.xsl"><span class="keyword parmname">result.rewrite-rule.xsl</span><span class="ph"></span></dt><dd class="dd pd" id="base__result.rewrite-rule.xsl.desc">Specifies the name of the XSLT file used to rewrite filenames.</dd><dd class="dd pd ddexpand">See
<a class="xref" href="../topics/plugin-rewrite-rules.html" title="To dynamically adjust the names and locations of output files in the map-first pre-processing routine (preprocess2), you can create a custom plug-in and specify the code that contains your custom rewrite rules.">Adjusting file names in map-first pre-processing</a> for details.
</dd><dt class="dt pt dlterm" id="base__root-chunk-override"><span class="keyword parmname">root-chunk-override</span><span class="ph"></span></dt><dd class="dd pd" id="base__root-chunk-override.desc">Override for map chunk attribute value.</dd><dd class="dd pd ddexpand">Acceptable values include any value normally allowed on the <code class="keyword markupname xmlatt">@chunk</code>
attribute. If the map does not have a <code class="keyword markupname xmlatt">@chunk</code> attribute, this value will be used; if the
map already has a <code class="keyword markupname xmlatt">@chunk</code> attribute specified, this value will be used instead.
</dd><dt class="dt pt dlterm" id="base__store-type"><span class="keyword parmname">store-type</span><span class="ph"></span></dt><dd class="dd pd" id="base__store-type.desc">Temporary file store type. The allowed values are <span class="keyword option">file</span> and <span class="keyword option">memory</span>; the default value is <span class="keyword option">file</span>.</dd><dd class="dd pd ddexpand">
<p class="p">
<span class="ph">In-memory processing provides performance advantages in I/O bound environments such as cloud
computing platforms, where processing time depends primarily on how long it takes to read and write temporary
files.</span> For more information, see
<a class="xref" href="../reference/store-api.html" title="DITA-OT originally assumed resources would be available on disk and available from file paths. Recent versions added URI input, so HTTPS resources could be used, but temporary and output resources were still file-based. DITA-OT 3.6 introduces a new Store API that can process temporary resources in memory instead of writing them to disk.">Store API – Processing in memory</a>.</p>
<div class="note important note_important"><span class="note__title">Important:</span> Custom plug-ins that expect to find certain files on disk in the temporary
directory will not work with in-memory processing.</div>
</dd><dt class="dt pt dlterm" id="base__transtype"><span class="keyword parmname">transtype</span><span class="ph"></span></dt><dd class="dd pd" id="base__transtype.desc">Specifies the output format (transformation type).</dd><dd class="dd pd ddexpand">
<div class="p">You can create plug-ins to add new output formats; by default, the following values are
available:
<ul class="ul">
<li class="li"><span class="keyword option">dita</span></li>
<li class="li"><span class="keyword option">eclipsehelp</span></li>
<li class="li"><span class="keyword option">html5</span></li>
<li class="li"><span class="keyword option">htmlhelp</span></li>
<li class="li"><span class="keyword option">markdown</span>, <span class="keyword option">markdown_gitbook</span>, and
<span class="keyword option">markdown_github</span></li>
<li class="li"><span class="keyword option">pdf</span></li>
<li class="li"><span class="keyword option">xhtml</span></li>
</ul>
<div class="note tip note_tip"><span class="note__title">Tip:</span> See
<a class="xref" href="../topics/output-formats.html" title="DITA Open Toolkit ships with several core transformations that convert DITA content to different output formats. Additional formats are available from the plug-in registry at dita-ot.org/plugins.">DITA-OT transformations (output formats)</a> for sample command line syntax and more information on each
transformation. </div>
</div>
</dd><dt class="dt pt dlterm" id="base__validate"><span class="keyword parmname">validate</span><span class="ph"></span></dt><dd class="dd pd" id="base__validate.desc">Specifies whether DITA-OT validates the content. The allowed values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is <span class="keyword option">true</span>.</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="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 dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div><div class="linklist relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/dita2eclipsehelp.html" title="The eclipsehelp transformation generates XHTML output, CSS files, and the control files that are needed for Eclipse help.">Eclipse help transformation</a></li><li class="linklist"><a class="link" href="../topics/dita2htmlhelp.html" title="The htmlhelp transformation generates HTML output, CSS files, and the control files that are needed to produce a Microsoft Compiled HTML Help (.chm) file.">HTML help transformation</a></li><li class="linklist"><a class="link" href="../topics/dita2pdf.html" title="The pdf transformation generates output in Portable Document Format.">PDF transformation</a></li><li class="linklist"><a class="link" href="../topics/dita2xhtml.html" title="The xhtml transformation generates XHTML output and a table of contents (TOC) file. This was the first transformation created for DITA Open Toolkit, and originally served as the basis for all HTML-based transformations.">XHTML transformation</a></li><li class="linklist"><a class="link" href="../topics/dita2html5.html" title="The html5 transformation generates HTML5 output and a table of contents (TOC) file.">HTML5 transformation</a></li></ul></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/html-customization-parameters.html" title="For simple branded HTML pages, you can adjust the look and feel of the default output to match your company style by setting parameters to include custom CSS, header branding, or table-of-contents navigation in topics. (These changes do not require a custom plug-in.)">Setting parameters for custom HTML</a></li></ul></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/dita2markdown.html" title="Along with Markdown input, DITA-OT now provides three new transformation types to convert DITA content to Markdown, including the original syntax, GitHub-Flavored Markdown, and GitBook.">Markdown transformations</a></li><li class="linklist"><a class="link" href="../topics/dita2dita.html" title="The dita transformation generates normalized topics and maps from DITA input. The normalized output includes the results of DITA Open Toolkit pre-processing operations, which resolve map references, keys, content references, code references and push metadata back and forth between maps and topics.">Normalized DITA transformations</a></li></ul></div></nav></article></main></body></html>

24
dita-ot-3.6/doc/parameters/parameters-eclipsehelp.html Normal file
View file

@ -0,0 +1,24 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain parameters are specific to the Eclipse help transformation."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Eclipse Help parameters</title></head><body id="eclipsehelp"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li><a href="../parameters/parameters-base.html">Common</a></li><li><a href="../parameters/parameters-pdf.html">PDF</a></li><li><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-xhtml.html">XHTML</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTML Help</a></li><li class="active"><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-other.html">Other</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">Eclipse Help parameters</h1><div class="body refbody"><p class="shortdesc">Certain parameters are
specific to the Eclipse help transformation.</p><section class="section"><dl class="dl parml"><dt class="dt pt dlterm" id="eclipsehelp__args.eclipse.provider"><span class="keyword parmname">args.eclipse.provider</span><span class="ph"></span></dt><dd class="dd pd" id="eclipsehelp__args.eclipse.provider.desc">Specifies the name of the person or organization that provides the Eclipse help.</dd><dd class="dd pd ddexpand">The default value is <span class="keyword option">DITA</span>. <div class="note tip note_tip"><span class="note__title">Tip:</span> The toolkit ignores
the value of this parameter when it processes an Eclipse map.</div>
</dd><dt class="dt pt dlterm" id="eclipsehelp__args.eclipse.symbolic.name"><span class="keyword parmname">args.eclipse.symbolic.name</span><span class="ph"></span></dt><dd class="dd pd" id="eclipsehelp__args.eclipse.symbolic.name.desc">Specifies the symbolic name (aka plugin ID) in the output for an Eclipse Help project.</dd><dd class="dd pd ddexpand">
The
<code class="keyword markupname xmlatt">@id</code> 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
<span class="keyword option">org.sample.help.doc</span>.<div class="note tip note_tip"><span class="note__title">Tip:</span> The toolkit ignores the value of this parameter
when it processes an Eclipse map.
</div>
</dd><dt class="dt pt dlterm" id="eclipsehelp__args.eclipse.version"><span class="keyword parmname">args.eclipse.version</span><span class="ph"></span></dt><dd class="dd pd" id="eclipsehelp__args.eclipse.version.desc">Specifies the version number to include in the output.</dd><dd class="dd pd ddexpand">The default value is <span class="keyword option">0.0.0</span>.<div class="note tip note_tip"><span class="note__title">Tip:</span> The toolkit ignores
the value of this parameter when it processes an Eclipse map.</div></dd><dt class="dt pt dlterm" id="eclipsehelp__args.eclipsehelp.country"><span class="keyword parmname">args.eclipsehelp.country</span><span class="ph"></span></dt><dd class="dd pd" id="eclipsehelp__args.eclipsehelp.country.desc">Specifies the region for the language that is specified by the args.</dd><dd class="dd pd ddexpand">For example, <span class="keyword option">us</span>, <span class="keyword option">ca</span>, and <span class="keyword option">gb</span>
would clarify a value of <span class="keyword option">en</span> set for the <span class="keyword parmname">args.eclipsehelp.language</span>
parameter. The content will be moved into the appropriate directory structure for an Eclipse
fragment.</dd><dt class="dt pt dlterm" id="eclipsehelp__args.eclipsehelp.jar.name"><span class="keyword parmname">args.eclipsehelp.jar.name</span><span class="ph"></span></dt><dd class="dd pd" id="eclipsehelp__args.eclipsehelp.jar.name.desc">Specifies that the output should be zipped and returned using this name.</dd><dt class="dt pt dlterm" id="eclipsehelp__args.eclipsehelp.language"><span class="keyword parmname">args.eclipsehelp.language</span><span class="ph"></span></dt><dd class="dd pd" id="eclipsehelp__args.eclipsehelp.language.desc">Specifies the base language for translated content, such as en for English.</dd><dd class="dd pd ddexpand">This parameter is a prerequisite for the
<span class="keyword parmname">args.eclipsehelp.country</span> parameter. The content will be moved into the appropriate
directory structure for an Eclipse fragment.</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="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 dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div><div class="linklist relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/dita2eclipsehelp.html" title="The eclipsehelp transformation generates XHTML output, CSS files, and the control files that are needed for Eclipse help.">Eclipse help transformation</a></li></ul></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that DITA Open Toolkit supports.">Common parameters</a></li><li class="linklist"><a class="link" href="../parameters/parameters-base-html.html" title="Certain parameters apply to all HTML-based transformation types: HTML5, XHTML, HTML&nbsp;Help, and Eclipse help.">HTML-based output parameters</a></li></ul></div></nav></article></main></body></html>

94
dita-ot-3.6/doc/parameters/parameters-html5.html Normal file
View file

@ -0,0 +1,94 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The HTML5 transformation shares common parameters with other HTML-based transformations and provides additional parameters that are specific to HTML5 output."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>HTML5 parameters</title></head><body id="html5"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li><a href="../parameters/parameters-base.html">Common</a></li><li><a href="../parameters/parameters-pdf.html">PDF</a></li><li><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li class="active"><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-xhtml.html">XHTML</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTML Help</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-other.html">Other</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">HTML5 parameters</h1><div class="body refbody"><p class="shortdesc">The HTML5 transformation shares
common parameters with other HTML-based transformations and provides additional parameters that are specific to
HTML5 output. <span class="ph">
</span>
</p><section class="section"><dl class="dl parml"><dt class="dt pt dlterm" id="html5__args.artlbl"><span class="keyword parmname">args.artlbl</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.artlbl.desc">Specifies whether to generate a label for each image; the label will contain the image file name. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="html5__args.copycss"><span class="keyword parmname">args.copycss</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.copycss.desc">Specifies whether to copy the custom .css file to the output directory. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">
<div class="div">If an external process will copy your custom .css file to the output
directory, leave this parameter unset (or set it to <span class="keyword option">no</span>). If DITA-OT should copy the
file when generating output, set it to <span class="keyword option">yes</span>.</div></dd><dt class="dt pt dlterm" id="html5__args.css"><span class="keyword parmname">args.css</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.css.desc">Specifies the name of a custom .css file.</dd><dd class="dd pd ddexpand">
<div class="div">The value of this parameter should be only the file name. The absolute path to
the parent directory should be specified with <span class="keyword parmname">args.cssroot</span>.</div></dd><dt class="dt pt dlterm" id="html5__args.csspath"><span class="keyword parmname">args.csspath</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.csspath.desc">
<div class="div">Specifies the <strong class="ph b">destination</strong> directory to which .css files are copied
(relative to the output directory).</div>
</dd><dd class="dd pd ddexpand">
<div class="div">
<p class="p">Corresponds to the XSLT parameter <span class="keyword parmname">CSSPATH</span>.</p>
<p class="p">DITA-OT will copy the file <strong class="ph b">to</strong> this location.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> If <span class="keyword parmname">args.csspath</span> 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 <span class="ph filepath">css</span>, set <span class="keyword parmname">args.csspath</span> to
<span class="keyword option">css</span>.
</div></div>
</dd><dt class="dt pt dlterm" id="html5__args.cssroot"><span class="keyword parmname">args.cssroot</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.cssroot.desc">
<div class="div">Specifies the <strong class="ph b">source</strong> directory that contains the custom .css
file.</div></dd><dd class="dd pd ddexpand">
<div class="div">
<p class="p">DITA-OT will copy the file <strong class="ph b">from</strong> this location.</p>
<div class="note important note_important"><span class="note__title">Important:</span> Enter the absolute path to the parent directory of the custom CSS file specified
with <span class="keyword parmname">args.css</span>.</div>
</div></dd><dt class="dt pt dlterm" id="html5__args.dita.locale"><span class="keyword parmname">args.dita.locale</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.dita.locale.desc">Specifies the language locale file to use for sorting index entries.</dd><dt class="dt pt dlterm" id="html5__args.ftr"><span class="keyword parmname">args.ftr</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.ftr.desc">Specifies an XML file that contains content for a running footer.</dd><dd class="dd pd ddexpand">
<div class="div">
<span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">FTR</span>.</span>
<div class="note note note_note"><span class="note__title">Note:</span> 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 <code class="keyword markupname xmlelement">&lt;div&gt;</code> element. In HTML5 output, the
footer file contents will be wrapped in an HTML5 <code class="keyword markupname xmlelement">&lt;footer&gt;</code> element with the
<code class="keyword markupname xmlatt">@role</code> attribute set to <span class="keyword option">contentinfo</span>.
</div>
</div></dd><dt class="dt pt dlterm" id="html5__args.gen.default.meta"><span class="keyword parmname">args.gen.default.meta</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.gen.default.meta.desc">Generate metadata for parental control scanners, meta elements with name="security" and name="Robots". The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">
<div class="div">Corresponds to the XSLT parameter <span class="keyword parmname">genDefMeta</span>.
</div>
</dd><dt class="dt pt dlterm" id="html5__args.hdf"><span class="keyword parmname">args.hdf</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.hdf.desc">Specifies an XML file that contains content to be placed in the document head.</dd><dd class="dd pd ddexpand">
<div class="div">
<p class="p">The contents of the header file will be inserted in the <code class="keyword markupname xmlelement">&lt;head&gt;</code> element of the
generated HTML files.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> 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
<code class="keyword markupname xmlelement">&lt;div&gt;</code> 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.
</div></div></dd><dt class="dt pt dlterm" id="html5__args.hdr"><span class="keyword parmname">args.hdr</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.hdr.desc">Specifies an XML file that contains content for a running header.</dd><dd class="dd pd ddexpand">
<div class="div">
<span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">HDR</span>.</span>
<div class="note note note_note"><span class="note__title">Note:</span> 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 <code class="keyword markupname xmlelement">&lt;div&gt;</code> element. In HTML5 output, the
contents of the header file will be wrapped in an HTML5 <code class="keyword markupname xmlelement">&lt;header&gt;</code> element with
the <code class="keyword markupname xmlatt">@role</code> attribute set to <span class="keyword option">banner</span>.
</div>
</div></dd><dt class="dt pt dlterm" id="html5__args.hide.parent.link"><span class="keyword parmname">args.hide.parent.link</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.hide.parent.link.desc">Specifies whether to hide links to parent topics in the HTML5 output. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">
<div class="div">
<span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">NOPARENTLINK</span>.</span>
<div class="note notice note_notice"><span class="note__title">Notice:</span> This parameter is deprecated in favor of the <span class="keyword parmname">args.rellinks</span>
parameter.</div>
</div></dd><dt class="dt pt dlterm" id="html5__args.html5.classattr"><span class="keyword parmname">args.html5.classattr</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.html5.classattr.desc">Specifies whether to include the DITA class ancestry inside the HTML5 elements. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">yes</span>.</dd><dt class="dt pt dlterm" id="html5__args.html5.contenttarget"><span class="keyword parmname">args.html5.contenttarget</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.html5.contenttarget.desc">Specifies the value of the @target attribute on the &lt;base&gt; element in the TOC file.</dd><dt class="dt pt dlterm" id="html5__args.html5.toc"><span class="keyword parmname">args.html5.toc</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.html5.toc.desc">Specifies the base name of the TOC file.</dd><dt class="dt pt dlterm" id="html5__args.html5.toc.class"><span class="keyword parmname">args.html5.toc.class</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.html5.toc.class.desc">Specifies the value of the @class attribute on the &lt;body&gt; element in the TOC file.</dd><dt class="dt pt dlterm" id="html5__args.html5.toc.xsl"><span class="keyword parmname">args.html5.toc.xsl</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.html5.toc.xsl.desc">Specifies a custom XSL file to be used for TOC generation.</dd><dt class="dt pt dlterm" id="html5__args.indexshow"><span class="keyword parmname">args.indexshow</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.indexshow.desc">Specifies whether the content of &lt;indexterm&gt; elements are rendered in the output. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="html5__args.outext"><span class="keyword parmname">args.outext</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.outext.desc">Specifies the file extension for HTML5 output.</dd><dd class="dd pd ddexpand">
<div class="div">
<span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">OUTEXT</span>.</span>
</div></dd><dt class="dt pt dlterm" id="html5__args.xsl"><span class="keyword parmname">args.xsl</span><span class="ph"></span></dt><dd class="dd pd" id="html5__args.xsl.desc">Specifies a custom XSL file to be used instead of the default XSL transformation.</dd><dd class="dd pd ddexpand">
<div class="div">The parameter must specify a fully qualified file name.</div></dd><dt class="dt pt dlterm" id="html5__html5.toc.generate"><span class="keyword parmname">html5.toc.generate</span><span class="ph"></span></dt><dd class="dd pd" id="html5__html5.toc.generate.desc">Generate TOC file from the DITA map. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">yes</span>.</dd><dt class="dt pt dlterm" id="html5__nav-toc"><span class="keyword parmname">nav-toc</span><span class="ph"></span></dt><dd class="dd pd" id="html5__nav-toc.desc">
<p class="p">Specifies whether to generate a table of contents (ToC) in the HTML5 <code class="keyword markupname xmlelement">&lt;nav&gt;</code>
element of each page. The navigation can then be rendered in a sidebar or menu via CSS.
</p>
<div class="p">The following values are supported:
<ul class="ul">
<li class="li"><span class="keyword option">none</span> (default) – No table of contents will be generated</li>
<li class="li"><span class="keyword option">partial</span> – Include the current topic in the ToC along with its parents, siblings
and children</li>
<li class="li"><span class="keyword option">full</span> – Generate a complete ToC for the entire map</li>
</ul>
</div>
</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="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 dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div><div class="linklist relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/dita2html5.html" title="The html5 transformation generates HTML5 output and a table of contents (TOC) file.">HTML5 transformation</a></li></ul></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/html-customization-parameters.html" title="For simple branded HTML pages, you can adjust the look and feel of the default output to match your company style by setting parameters to include custom CSS, header branding, or table-of-contents navigation in topics. (These changes do not require a custom plug-in.)">Setting parameters for custom HTML</a></li></ul></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/parameters-base-html.html" title="Certain parameters apply to all HTML-based transformation types: HTML5, XHTML, HTML&nbsp;Help, and Eclipse help.">HTML-based output parameters</a></li></ul></div></nav></article></main></body></html>

7
dita-ot-3.6/doc/parameters/parameters-htmlhelp.html Normal file
View file

@ -0,0 +1,7 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain parameters are specific to the Microsoft Compiled HTML Help (.chm) transformation."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Microsoft Compiled HTML Help parameters</title></head><body id="htmlhelp"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li><a href="../parameters/parameters-base.html">Common</a></li><li><a href="../parameters/parameters-pdf.html">PDF</a></li><li><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-xhtml.html">XHTML</a></li><li class="active"><a href="../parameters/parameters-htmlhelp.html">HTML Help</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-other.html">Other</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">Microsoft Compiled HTML Help parameters</h1><div class="body refbody"><p class="shortdesc">Certain parameters are
specific to the Microsoft Compiled HTML Help (.chm) transformation.</p><section class="section"><dl class="dl parml"><dt class="dt pt dlterm" id="htmlhelp__args.htmlhelp.includefile"><span class="keyword parmname">args.htmlhelp.includefile</span><span class="ph"></span></dt><dd class="dd pd" id="htmlhelp__args.htmlhelp.includefile.desc">Specifies the name of a file that you want included in the HTML Help.</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="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 dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div><div class="linklist relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/dita2htmlhelp.html" title="The htmlhelp transformation generates HTML output, CSS files, and the control files that are needed to produce a Microsoft Compiled HTML Help (.chm) file.">HTML help transformation</a></li></ul></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that DITA Open Toolkit supports.">Common parameters</a></li><li class="linklist"><a class="link" href="../parameters/parameters-base-html.html" title="Certain parameters apply to all HTML-based transformation types: HTML5, XHTML, HTML&nbsp;Help, and Eclipse help.">HTML-based output parameters</a></li></ul></div></nav></article></main></body></html>

66
dita-ot-3.6/doc/parameters/parameters-other.html Normal file
View file

@ -0,0 +1,66 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="These parameters enable you to reload style sheets that DITA-OT uses for specific pre-processing stages."><meta name="keywords" content="XSLT, extension points, preprocessing, preprocessing, XSLT, Java, extension points, parameters, Java, out of memory, memory"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Other parameters</title></head><body id="ant-parameters-other"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li><a href="../parameters/parameters-base.html">Common</a></li><li><a href="../parameters/parameters-pdf.html">PDF</a></li><li><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-xhtml.html">XHTML</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTML Help</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li class="active"><a href="../parameters/parameters-other.html">Other</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Other parameters</h1>
<div class="body refbody"><p class="shortdesc">These parameters enable you to reload style sheets that DITA-OT uses for specific pre-processing
stages.</p>
<section class="section">
<dl class="dl parml">
<dt class="dt pt dlterm" id="ant-parameters-other__dita.html5.reloadstylesheet">
<span class="keyword parmname">dita.html5.reloadstylesheet</span>
</dt>
<dt class="dt pt dlterm" id="ant-parameters-other__dita.preprocess.reloadstylesheet">
<span class="keyword parmname">dita.preprocess.reloadstylesheet</span>
</dt>
<dt class="dt pt dlterm" id="ant-parameters-other__dita.preprocess.reloadstylesheet.clean-map">
<span class="keyword parmname">dita.preprocess.reloadstylesheet.clean-map</span>
</dt>
<dt class="dt pt dlterm" id="ant-parameters-other__dita.preprocess.reloadstylesheet.conref">
<span class="keyword parmname">dita.preprocess.reloadstylesheet.conref</span>
</dt>
<dt class="dt pt dlterm" id="ant-parameters-other__dita.preprocess.reloadstylesheet.flag-module">
<span class="keyword parmname">dita.preprocess.reloadstylesheet.lag-module</span>
</dt>
<dt class="dt pt dlterm" id="ant-parameters-other__dita.preprocess.reloadstylesheet.mapref">
<span class="keyword parmname">dita.preprocess.reloadstylesheet.mapref</span>
</dt>
<dt class="dt pt dlterm" id="ant-parameters-other__dita.preprocess.reloadstylesheet.mappull">
<span class="keyword parmname">dita.preprocess.reloadstylesheet.mappull</span>
</dt>
<dt class="dt pt dlterm" id="ant-parameters-other__dita.preprocess.reloadstylesheet.maplink">
<span class="keyword parmname">dita.preprocess.reloadstylesheet.maplink</span>
</dt>
<dt class="dt pt dlterm" id="ant-parameters-other__dita.preprocess.reloadstylesheet.topicpull">
<span class="keyword parmname">dita.preprocess.reloadstylesheet.topicpull</span>
</dt>
<dt class="dt pt dlterm" id="ant-parameters-other__dita.xhtml.reloadstylesheet">
<span class="keyword parmname">dita.xhtml.reloadstylesheet</span>
</dt>
<dd class="dd pd" id="ant-parameters-other__dita.preprocess.reloadstylesheet.desc">
<p class="p">Specifies whether DITA-OT reloads the XSL style sheets that are used for the transformation. The allowed
values are <span class="keyword option">true</span> and <span class="keyword option">false</span>; the default value is
<span class="keyword option">false</span>.</p>
<p class="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
<code class="ph codeph">Transformer</code> object in Java, the object that handles the XSLT processing, for all
topics, or create a separate <code class="ph codeph">Transformer</code> for each topic.</p>
<p class="p">The default (<span class="keyword option">false</span>) option uses the same <code class="ph codeph">Transformer</code>, 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 <code class="ph codeph">document()</code> once. The downside is that it will not release the source trees
from memory, so you can run out of memory.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> For large projects that generate Java out-of-memory errors during transformation, set the
parameter to <span class="keyword option">true</span> to allow the XSLT processor to release memory. You may also need to
increase the memory available to Java.</div>
</dd>
</dl>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="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 dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/increasing-the-jvm.html" title="If you are working with large documents with extensive metadata or key references, you will need to increase the memory allocation for the Java process. You can do this from the command-line prompt for a specific session, or you can increase the value of the ANT_OPTS environment variable.">Increasing Java memory allocation</a></li></ul></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/other-errors.html" title="In addition to error messages that DITA Open Toolkit generates, you might also encounter error messages generated by Java or other tools.">Other error messages</a></li></ul></div></nav></article></main></body></html>

47
dita-ot-3.6/doc/parameters/parameters-pdf.html Normal file
View file

@ -0,0 +1,47 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain parameters are specific to the PDF transformation."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>PDF parameters</title></head><body id="pdf"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li><a href="../parameters/parameters-base.html">Common</a></li><li class="active"><a href="../parameters/parameters-pdf.html">PDF</a></li><li><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-xhtml.html">XHTML</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTML Help</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-other.html">Other</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">PDF parameters</h1><div class="body refbody"><p class="shortdesc">Certain parameters are specific to the
PDF transformation.</p><section class="section"><dl class="dl parml"><dt class="dt pt dlterm" id="pdf__args.artlbl"><span class="keyword parmname">args.artlbl</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.artlbl.desc">Specifies whether to generate a label for each image; the label will contain the image file name. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="pdf__args.bookmap-order"><span class="keyword parmname">args.bookmap-order</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.bookmap-order.desc">Specifies if the frontmatter and backmatter content order is retained in bookmap. The allowed values are <span class="keyword option">retain</span> and <span class="keyword option">discard</span>; the default value is <span class="keyword option">discard</span>.</dd><dt class="dt pt dlterm" id="pdf__args.bookmark.style"><span class="keyword parmname">args.bookmark.style</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.bookmark.style.desc">Specifies whether PDF bookmarks are by default expanded or collapsed. The allowed values are <span class="keyword option">EXPANDED</span> and <span class="keyword option">COLLAPSE</span>.</dd><dt class="dt pt dlterm" id="pdf__args.chapter.layout"><span class="keyword parmname">args.chapter.layout</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.chapter.layout.desc">Specifies whether chapter level TOCs are generated. The allowed values are <span class="keyword option">MINITOC</span> and <span class="keyword option">BASIC</span>; the default value is <span class="keyword option">MINITOC</span>.</dd><dt class="dt pt dlterm" id="pdf__args.fo.userconfig"><span class="keyword parmname">args.fo.userconfig</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.fo.userconfig.desc">Specifies the user configuration file for FOP.</dd><dt class="dt pt dlterm" id="pdf__args.xsl.pdf"><span class="keyword parmname">args.xsl.pdf</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__args.xsl.pdf.desc">Specifies an XSL file that is used to override the default XSL transformation.</dd><dd class="dd pd ddexpand">You must specify the fully qualified file name.</dd><dt class="dt pt dlterm" id="pdf__axf.cmd"><span class="keyword parmname">axf.cmd</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__axf.cmd.desc">Specifies the path to the Antenna House Formatter executable.</dd><dt class="dt pt dlterm" id="pdf__axf.opt"><span class="keyword parmname">axf.opt</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__axf.opt.desc">Specifies the user configuration file for Antenna House Formatter.</dd><dt class="dt pt dlterm" id="pdf__custom.xep.config"><span class="keyword parmname">custom.xep.config</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__custom.xep.config.desc">Specifies the user configuration file for RenderX.</dd><dt class="dt pt dlterm" id="pdf__customization.dir"><span class="keyword parmname">customization.dir</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__customization.dir.desc">Specifies the customization directory.</dd><dt class="dt pt dlterm" id="pdf__maxJavaMemory"><span class="keyword parmname">maxJavaMemory</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__maxJavaMemory.desc">Specifies the amount of memory allocated to the RenderX process.</dd><dt class="dt pt dlterm" id="pdf__org.dita.index.skip"><span class="keyword parmname">org.dita.index.skip</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__org.dita.index.skip.desc">Disable index processing. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">
<p class="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 class="p">If you have overridden PDF index processing via the <code class="ph codeph">transform.topic2fo</code> target in the
past, you can set the <span class="keyword parmname">org.dita.index.skip</span> property to <span class="keyword option">yes</span> and
re-enable the <code class="ph codeph">transform.topic2fo.index</code> target with <code class="keyword markupname xmlelement">&lt;feature
extension="depend.org.dita.pdf2.index" value="transform.topic2fo.index"/&gt;</code> in your plug-in
configuration.</p>
</dd><dt class="dt pt dlterm" id="pdf__org.dita.pdf2.chunk.enabled"><span class="keyword parmname">org.dita.pdf2.chunk.enabled</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__org.dita.pdf2.chunk.enabled.desc">Enables chunk attribute processing. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">true</span> – Enables chunk processing</li><li class="li"><span class="keyword option">false</span> (default) – Disables chunk processing</li></ul></dd><dt class="dt pt dlterm" id="pdf__org.dita.pdf2.i18n.enabled"><span class="keyword parmname">org.dita.pdf2.i18n.enabled</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__org.dita.pdf2.i18n.enabled.desc">
<p class="p">Enables internationalization (I18N) font processing to provide per-character font selection for FO
renderers that do not support the <code class="ph codeph">font-selection-strategy</code> property (such as Apache
FOP).
</p>
<p class="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 class="p">The following values are allowed:</p>
<ul class="ul">
<li class="li"><span class="keyword option">true</span> (default) — Enables font mapping</li>
<li class="li"><span class="keyword option">false</span> — Disables font mapping</li>
</ul>
<div class="note tip note_tip"><span class="note__title">Tip:</span> 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
<a class="xref" href="http://www.elovirta.com/2016/02/18/font-configuration-in-pdf2.html" target="_blank" rel="external noopener">Font configuration in PDF2</a>.</div>
</dd><dt class="dt pt dlterm" id="pdf__outputFile.base"><span class="keyword parmname">outputFile.base</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__outputFile.base.desc">Specifies the base file name of the generated PDF file.</dd><dd class="dd pd ddexpand">By default, the PDF file uses the base filename of the input
<span class="ph filepath">.ditamap</span> file.
</dd><dt class="dt pt dlterm" id="pdf__pdf.formatter"><span class="keyword parmname">pdf.formatter</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__pdf.formatter.desc">Specifies the XSL processor. The following values are supported:<ul class="ul"><li class="li"><span class="keyword option">ah</span> – Antenna House Formatter</li><li class="li"><span class="keyword option">xep</span> – RenderX XEP Engine</li><li class="li"><span class="keyword option">fop</span> (default) – Apache FOP</li></ul></dd><dd class="dd pd ddexpand">
</dd><dt class="dt pt dlterm" id="pdf__publish.required.cleanup"><span class="keyword parmname">publish.required.cleanup</span><span class="ph"></span></dt><dd class="dd pd" id="pdf__publish.required.cleanup.desc">Specifies whether draft-comment and required-cleanup elements are included in the output. The allowed values are <span class="keyword option">yes</span>, <span class="keyword option">no</span>, <span class="keyword option">yes</span>, and <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">The default value is the value of the <span class="keyword parmname">args.draft</span> parameter.
<span class="ph">Corresponds to the XSLT parameter
<span class="keyword parmname">publishRequiredCleanup</span>.</span><div class="note notice note_notice"><span class="note__title">Notice:</span> This parameter is deprecated in
favor of the <span class="keyword parmname">args.draft</span> parameter.</div></dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="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 dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div><div class="linklist relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/dita2pdf.html" title="The pdf transformation generates output in Portable Document Format.">PDF transformation</a></li></ul></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that DITA Open Toolkit supports.">Common parameters</a></li></ul></div></nav></article></main></body></html>

10
dita-ot-3.6/doc/parameters/parameters-xhtml.html Normal file
View file

@ -0,0 +1,10 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain parameters are specific to the XHTML transformation."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>XHTML parameters</title></head><body id="xhtml"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li><a href="../parameters/parameters-base.html">Common</a></li><li><a href="../parameters/parameters-pdf.html">PDF</a></li><li><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li class="active"><a href="../parameters/parameters-xhtml.html">XHTML</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTML Help</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-other.html">Other</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">XHTML parameters</h1><div class="body refbody"><p class="shortdesc">Certain parameters are specific to
the XHTML transformation.</p><section class="section"><dl class="dl parml"><dt class="dt pt dlterm" id="xhtml__args.xhtml.contenttarget"><span class="keyword parmname">args.xhtml.contenttarget</span><span class="ph"></span></dt><dd class="dd pd" id="xhtml__args.xhtml.contenttarget.desc">Specifies the value of the @target attribute on the &lt;base&gt; element in the TOC file.</dd><dd class="dd pd ddexpand">The default value is <span class="keyword option">contentwin</span>. Change this value to use a
different target name for the table of contents.
</dd><dt class="dt pt dlterm" id="xhtml__args.xhtml.toc"><span class="keyword parmname">args.xhtml.toc</span><span class="ph"></span></dt><dd class="dd pd" id="xhtml__args.xhtml.toc.desc">Specifies the base name of the TOC file.</dd><dt class="dt pt dlterm" id="xhtml__args.xhtml.toc.class"><span class="keyword parmname">args.xhtml.toc.class</span><span class="ph"></span></dt><dd class="dd pd" id="xhtml__args.xhtml.toc.class.desc">Specifies the value of the @class attribute on the &lt;body&gt; element in the TOC file.</dd><dt class="dt pt dlterm" id="xhtml__args.xhtml.toc.xsl"><span class="keyword parmname">args.xhtml.toc.xsl</span><span class="ph"></span></dt><dd class="dd pd" id="xhtml__args.xhtml.toc.xsl.desc">Specifies a custom XSL file to be used for TOC generation.</dd></dl></section></div><nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="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 dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div><div class="linklist relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/dita2xhtml.html" title="The xhtml transformation generates XHTML output and a table of contents (TOC) file. This was the first transformation created for DITA Open Toolkit, and originally served as the basis for all HTML-based transformations.">XHTML transformation</a></li></ul></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/html-customization-parameters.html" title="For simple branded HTML pages, you can adjust the look and feel of the default output to match your company style by setting parameters to include custom CSS, header branding, or table-of-contents navigation in topics. (These changes do not require a custom plug-in.)">Setting parameters for custom HTML</a></li></ul></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that DITA Open Toolkit supports.">Common parameters</a></li><li class="linklist"><a class="link" href="../parameters/parameters-base-html.html" title="Certain parameters apply to all HTML-based transformation types: HTML5, XHTML, HTML&nbsp;Help, and Eclipse help.">HTML-based output parameters</a></li></ul></div></nav></article></main></body></html>

21
dita-ot-3.6/doc/parameters/parameters_intro.html Normal file
View file

@ -0,0 +1,21 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="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 dita command using the --parameter=value syntax or included in build scripts as Ant properties."><meta name="keywords" content="command, dita, parameters, transformations, HTML, Ant, properties, build script, script"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA-OT parameters</title></head><body id="dita-ot-ant-properties"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li class="active"><a href="../parameters/parameters_intro.html">DITA-OT parameters</a><ul><li><a href="../parameters/parameters-base.html">Common</a></li><li><a href="../parameters/parameters-pdf.html">PDF</a></li><li><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-xhtml.html">XHTML</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTML Help</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-other.html">Other</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">DITA-OT parameters</h1>
<div class="body refbody"><p class="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 <span class="keyword cmdname">dita</span> command using the <span class="keyword parmname">--parameter</span>=<var class="keyword varname">value</var>
syntax or included in build scripts as Ant properties.</p>
<section class="section">
<p class="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>
</div>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../parameters/parameters-base.html">Common parameters</a></strong><br>Certain parameters apply to all transformations that DITA Open Toolkit supports.</li><li class="link ulchildlink"><strong><a href="../parameters/parameters-pdf.html">PDF parameters</a></strong><br>Certain parameters are specific to the PDF transformation.</li><li class="link ulchildlink"><strong><a href="../parameters/parameters-base-html.html">HTML-based output parameters</a></strong><br>Certain parameters apply to all HTML-based transformation types: HTML5, XHTML, HTML&nbsp;Help, and Eclipse help. <span class="ph"> </span> </li><li class="link ulchildlink"><strong><a href="../parameters/parameters-html5.html">HTML5 parameters</a></strong><br>The HTML5 transformation shares common parameters with other HTML-based transformations and provides additional parameters that are specific to HTML5 output. <span class="ph"> </span> </li><li class="link ulchildlink"><strong><a href="../parameters/parameters-xhtml.html">XHTML parameters</a></strong><br>Certain parameters are specific to the XHTML transformation.</li><li class="link ulchildlink"><strong><a href="../parameters/parameters-htmlhelp.html">Microsoft Compiled HTML Help parameters</a></strong><br>Certain parameters are specific to the Microsoft Compiled HTML Help (.chm) transformation.</li><li class="link ulchildlink"><strong><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help parameters</a></strong><br>Certain parameters are specific to the Eclipse help transformation.</li><li class="link ulchildlink"><strong><a href="../parameters/parameters-other.html">Other parameters</a></strong><br>These parameters enable you to reload style sheets that DITA-OT uses for specific pre-processing stages.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/index.html" title="You can adjust DITA Open Toolkit behavior via dita command arguments and options, DITA-OT parameter settings, and configuration properties.">DITA Open Toolkit parameters</a></div></div><div class="linklist reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/using-dita-properties-file.html" title="Usually, DITA builds require setting a number of parameters that do not change frequently. You can reference a set of build parameters defined in a .properties file when building output with the dita command. If needed, you can override any parameter by specifying it explicitly as an argument to the dita command.">Setting build parameters with .properties files</a></li><li class="linklist"><a class="link" href="../topics/rebuilding-docs.html" title="When you add or remove plug-ins, you can rebuild the documentation to update the information on the extension points, messages, and parameters that are available in your environment.">Rebuilding the DITA-OT documentation</a></li></ul></div></nav></article></main></body></html>

23
dita-ot-3.6/doc/parameters/plugin-properties-file.html Normal file
View file

@ -0,0 +1,23 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The plugin.properties file is used to store configuration properties that are set by the plug-in installation process."><meta name="keywords" content="files, plugin.properties, plugin.properties file, Java"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>The plugin.properties file</title></head><body id="lib-org.dita.dost.platform-plugin.properties"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a><ul><li><a href="../parameters/local-properties-file.html">local.properties</a></li><li class="active"><a href="../parameters/plugin-properties-file.html">plugin.properties</a></li><li><a href="../parameters/configuration-properties-file.html">configuration.properties</a></li><li><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">The <span class="ph filepath">plugin.properties</span> file</h1>
<div class="body refbody"><p class="shortdesc">The <span class="ph filepath">plugin.properties</span> file is used to store configuration properties that are set by
the plug-in installation process.</p>
<section class="section">
<p class="p">The file is located in the <span class="ph filepath">lib/org.dita.dost.platform</span> directory of the DITA-OT
installation and stores a cached version of the plug-in configuration used by the Java code.</p>
<p class="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>
<div class="note warning note_warning"><span class="note__title">Warning:</span> The <span class="ph filepath">plugin.properties</span> 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.</div>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/configuration-properties.html" title="DITA-OT uses .properties 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.">Configuration properties</a></div></div></nav></article></main></body></html>

13
dita-ot-3.6/doc/reference/architecture.html Normal file
View file

File diff suppressed because one or more lines are too long

46
dita-ot-3.6/doc/reference/books.html Normal file
View file

@ -0,0 +1,46 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Several DITA-related publications include information on configuring and customizing DITA Open Toolkit with detailed examples on creating custom plug-ins for PDF output."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Books</title></head><body id="books"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Books</h1>
<div class="body"><p class="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.</p>
<section class="section"><h2 class="title sectiontitle"><cite class="cite">DITA for Print: A DITA Open Toolkit Workbook</cite> (Second Edition, 2017)</h2>
<p class="p">Authored by Leigh W. White, DITA Specialist at IXIASOFT, and published by XML Press, <cite class="cite">DITA for
Print</cite> walks readers through developing a PDF customization from scratch. </p>
<p class="p">Here is an excerpt from the back cover:</p>
<blockquote class="lq"><cite class="cite">DITA for Print</cite> is for anyone who wants to learn how to create PDFs using the DITA Open Toolkit
without learning everything there is to know about XSL-FO, XSLT, or XPath, or even about the DITA Open Toolkit
itself. <cite class="cite">DITA for Print</cite> is written for non-programmers, by a non-programmer, and although it is
written for people who have a good understanding of the DITA standard, you don’t need a technical background to
get custom PDFs up and running quickly.</blockquote>
<p class="p">This is an excellent, long-needed resource that was initially developed in 2013 for DITA-OT 1.8.</p>
<p class="p">The second edition has been revised to cover DITA Open Toolkit Version 2, including customizing the DITA 1.3
troubleshooting topic type, localization strings, bookmarks, and the new back-cover functionality.</p>
<div class="note important note_important"><span class="note__title">Important:</span>
<p class="p">The first edition of <cite class="cite">DITA for Print</cite> recommended copying entire files from the PDF2 plug-in to
your custom plug-in. The DITA-OT project — and the second edition of the book — do not recommend this
practice.</p>
<p class="p">Instead, you should copy only the specific attribute sets and templates that you want to override. Following
this practice will more cleanly isolate your customizations from the DITA-OT code, which will make it easier
for you to update your plug-ins to work with future versions of DITA-OT.</p></div>
</section>
<section class="section"><h2 class="title sectiontitle"><cite class="cite">DITA for Practitioners: Volume 1, Architecture and Technology</cite> (2012)</h2>
<p class="p">Authored by Eliot Kimber and published by XML Press, this seminal resource contains a chapter dedicated to DITA
Open Toolkit: “Running, Configuring, and Customizing the Open Toolkit”. In addition to a robust overview of
DITA-OT customization and extension, the chapter contains a detailed example of customizing a PDF plug-in to
specify 7" × 10" paper size and custom fonts for body text and headers.</p>
<p class="p">The DITA-OT chapter in <cite class="cite">DITA for Practitioners: Volume 1</cite> was written for DITA-OT 1.5.4, which was
the latest stable version at the time it was written.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/dita-and-dita-ot-resources.html" title="Are you new to the DITA-OT? Come and get an overview of what it is, how it works, its history, and the people involved. This will be an excellent start to DITA-OT day for novices.">Overview of the DITA Open Toolkit</a></div></div></nav></article></main></body></html>

30
dita-ot-3.6/doc/reference/common-html-processing.html Normal file
View file

@ -0,0 +1,30 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="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."><meta name="keywords" content=", chunk, HTML-based processing, DITAVAL, HTML-based formats, HTML, common processing, CSS, HTML transforms"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Common HTML-based processing</title></head><body id="common-html-processing"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li class="active"><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li><a href="../reference/html5-processing.html">HTML5 processing</a></li><li><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Common HTML-based processing</h1>
<div class="body conbody"><p class="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.</p>
<p class="p">After the pre-processing is completed, the following targets are run for all of the HTML-based builds:</p>
<div class="p">
<ul class="ul">
<li class="li">If the <span class="keyword parmname">args.css</span> parameter is passed to the build to add a CSS file, the
<code class="ph codeph">copy-css</code> target copies the CSS file from its source location to the relative location in
the output directory.</li>
<li class="li">If a DITAVAL file is used, the <code class="ph codeph">copy-revflag</code> target copies the default start- and
end-revision flags into the output directory.</li>
<li class="li">The DITA topics are converted to HTML files. Unless the <code class="keyword markupname xmlatt">@chunk</code> attribute was specified, each
DITA topic in the temporary directory now corresponds to one HTML file. The
<code class="ph codeph">dita.inner.topics.xhtml</code> target is used to process documents that are in the map directory
(or subdirectories of the map directory). The <code class="ph codeph">dita.outer.topics.xhtml</code> 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
<code class="ph codeph">dita.outer.topics.xhtml</code> target are handled.</li>
</ul>
</div>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/html-based-processing.html" title="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.">HTML-based processing modules</a></div></div></nav></article></main></body></html>

12
dita-ot-3.6/doc/reference/dita-spec-support.html Normal file
View file

@ -0,0 +1,12 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3."><meta name="keywords" content="authoring formats, DITA, DITA 1.0, DITA 1.1"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA specification support</title></head><body id="dita-spec-support"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li class="active"><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">DITA specification support</h1>
<div class="body conbody"><p class="shortdesc">DITA Open Toolkit <span class="keyword">3.6</span> supports all versions of the OASIS DITA specification,
including 1.0, 1.1, 1.2, and 1.3.</p></div>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></strong><br>DITA Open Toolkit <span class="keyword">3.6</span> 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.</li><li class="link ulchildlink"><strong><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></strong><br><span class="ph">DITA Open Toolkit <span class="keyword">3.6</span> 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.</span></li><li class="link ulchildlink"><strong><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview support</a></strong><br>DITA Open Toolkit <span class="keyword">3.6</span> 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&nbsp;NG grammar files from OASIS (as of October 2020).</li><li class="link ulchildlink"><strong><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></strong><br>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.</li><li class="link ulchildlink"><strong><a href="../reference/extended-functionality.html">Extended codeblock processing</a></strong><br>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.</li><li class="link ulchildlink"><strong><a href="../reference/docs-dita-features.html">DITA features in the documentation</a></strong><br>DITA Open Toolkit uses various recent DITA features in the project documentation.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/index.html" title="The Reference topics provide more advanced information about the DITA-OT architecture, OASIS specification support, and licensing.">Reference</a></div></div></nav></article></main></body></html>

37
dita-ot-3.6/doc/reference/dita-v1-2-support.html Normal file
View file

@ -0,0 +1,37 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit 3.6 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."><meta name="keywords" content=", abbreviated-form, keyref, processing-role, , conref, support, filters, subject scheme, DITA, specializations, DTD, schema, DITA 1.2, grammar files, SCORM"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA 1.2 support</title></head><body id="dita1.2specification"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li class="active"><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">DITA 1.2 support</h1>
<div class="body conbody"><p class="shortdesc">DITA Open Toolkit <span class="keyword">3.6</span> 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.</p>
<div class="p">Highlights of DITA 1.2 support in the toolkit include:
<ul class="ul">
<li class="li">Processing support for all new elements and attributes</li>
<li class="li">Link redirection and text replacement using <code class="keyword markupname xmlatt">@keyref</code></li>
<li class="li">New <code class="keyword markupname xmlatt">@processing-role</code> attribute in maps to allow references to topics that will not produce
output artifacts</li>
<li class="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 <code class="keyword markupname xmlatt">@conref</code> attribute.</li>
<li class="li">The ability to filter content with controlled values and taxonomies using Subject Scheme Maps</li>
<li class="li">Processing support for both default versions of task (original, limited task, and the general task with
fewer constraints on element order)</li>
<li class="li">Acronym and abbreviation support with the new <code class="keyword markupname xmlelement">&lt;abbreviated-form&gt;</code> element</li>
<li class="li">New link grouping abilities available with headers in relationship tables</li>
<li class="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></div>
<p class="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>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2014/dita-ot_day.html#SCORM_wrapper_for_DITA_to_SCORM" target="_blank" rel="external noopener" title="Hal Trent of Comtech will present a SCORM wrapper developed for learning and training output, which could be potentially donated to the DITA-OT. The wrapper incorporates the current DITA to SCORM output and adds a layer of JavaScript with the SCORM API to integrate the output generated from the DITA-OT into an LMS. The wrapper passes test completion status to and from the LMS and provides a much needed output for the learning and training implementation.">SCORM Wrapper for DITA to SCORM</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/v1.2/spec/DITA1.2-spec.html" target="_blank" rel="external noopener">DITA 1.2 Specification (XHTML)</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/v1.2/spec/DITA1.2-spec.pdf" target="_blank" rel="external noopener">DITA 1.2 Specification (PDF)</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/v1.2/spec/DITA1.2-spec.zip" target="_blank" rel="external noopener">DITA 1.2 Specification (DITA source)</a></li><li class="linklist"><a class="link" href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita" target="_blank" rel="external noopener">OASIS DITA Technical Committee</a></li><li class="linklist"><a class="link" href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita-adoption" target="_blank" rel="external noopener">OASIS DITA Adoption Technical Committee</a></li></ul></div></nav>
</article></main></body></html>

53
dita-ot-3.6/doc/reference/dita-v1-3-support.html Normal file
View file

@ -0,0 +1,53 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit 3.6 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."><meta name="keywords" content=", ditavalref, xmlelement, xmlatt, line-through, overline, object, , div, support, keyscope, deliveryTarget, orient, keyref, cascade, profiling, filters, branch filters, DTD, schema, DITA 1.3, grammar files, DITA 1.3, specification support, catalog, grammar file resolution"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA 1.3 support</title></head><body id="dita-13-spec-support"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li class="active"><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">DITA 1.3 support</h1>
<div class="body conbody"><p class="shortdesc"><span class="ph" id="dita-13-spec-support__shortdesc-ph">DITA Open Toolkit <span class="keyword">3.6</span> 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.</span></p>
<p class="p" id="dita-13-spec-support__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 class="section"><h2 class="title sectiontitle">Major features of DITA 1.3</h2>
<p class="p">The following DITA 1.3 features are supported in DITA Open Toolkit.</p>
<ul class="ul">
<li class="li">
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/keyScopes.html" target="_blank" rel="external noopener">Scoped keys</a> supported using DITA 1.3 <code class="keyword markupname xmlatt">@keyscope</code>
attribute</li>
<li class="li">
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/branch-filtering.html" target="_blank" rel="external noopener">Branch filtering</a> using <code class="keyword markupname xmlelement">&lt;ditavalref&gt;</code>
elements in a map</li>
<li class="li">Support formatting based on new XML Mention elements, such as adding angle brackets around elements tagged
with <code class="keyword markupname xmlelement">&lt;xmlelement&gt;</code> and adding <code class="ph codeph">@</code> before attributes tagged with
<code class="keyword markupname xmlelement">&lt;xmlatt&gt;</code></li>
<li class="li">New highlighting elements <code class="keyword markupname xmlelement">&lt;line-through&gt;</code> and <code class="keyword markupname xmlelement">&lt;overline&gt;</code></li>
<li class="li">Support for profiling based on <code class="keyword markupname xmlatt">@deliveryTarget</code> attribute</li>
<li class="li">Support for the new <code class="keyword markupname xmlatt">@orient</code> attribute for rotating tables</li>
<li class="li">Profile (filter or flag) based on
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/usage-of-conditional-processing-attributes.html" target="_blank" rel="external noopener">groups within profiling attributes</a></li>
<li class="li"><code class="keyword markupname xmlatt">@keyref</code> and related key referencing attributes supported on
<code class="keyword markupname xmlelement">&lt;object&gt;</code></li>
<li class="li">New in-topic link syntax using <code class="ph codeph">.</code> in place of the topic ID: <code class="ph codeph">#./figure</code></li>
<li class="li">Support for additional new elements, such as the <code class="keyword markupname xmlelement">&lt;div&gt;</code> element for grouping</li>
<li class="li">Support <code class="keyword markupname xmlatt">@cascade</code> attribute in maps (processing defaults to the value <code class="ph codeph">merge</code>,
which is the
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/example-how-cascade-att-functions.html" target="_blank" rel="external noopener">default cascade operation</a> described by the DITA
specification)</li>
</ul>
<div class="note note note_note"><span class="note__title">Note:</span> For the latest status information on DITA 1.3-related features and fixes, see the
<a class="xref" href="https://github.com/dita-ot/dita-ot/issues?q=label%3A%22DITA+1.3%22" target="_blank" rel="external noopener">DITA 1.3 label</a> in the GitHub issues tracker.</div>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2017/dita-ot_day.html#Accessibility_DITA-OT" target="_blank" rel="external noopener" title="Not only is accessible content often mandatory, it's also just a good idea -- assuming you want your content available to as many readers as possible. This session provides an overview of the accessibility features in output generated by the DITA-OT. While many features are automated thanks to the semantic nature of DITA elements, others rely on you to make sure your content includes everything it needs to. While going over these features, we will explain how DITA-OT handles your content, while also giving tips for how to ensure your content reaches users on all sorts of devices.">Accessibility in DITA-OT</a></li><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2014/dita-ot_day.html#RNG_to_DTD_and_XSD_using_the_DITA_Open_Toolkit" target="_blank" rel="external noopener" title="The new version of DITA, version 1.3, will use Relax NG as the normative grammar to express the DITA content models. George proposed this idea and provided a working prototype under the DITA-NG open source project and Eliot took this further making it an official proposal for DITA 1.3 and finalized its implementation. See how Relax NG simplifies the way DITA content models and specializations are defined and what other benefits it brings to DITA 1.3.">RNG to DTD and XSD using the DITA Open Toolkit</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.html" target="_blank" rel="external noopener">DITA 1.3 Part 3 latest errata version: All-Inclusive Edition (HTML)</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.pdf" target="_blank" rel="external noopener">DITA 1.3 Part 3 latest errata version: All-Inclusive Edition (PDF)</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part3-all-inclusive/dita-v1.3-errata01-os-part3-all-inclusive-complete-dita.zip" target="_blank" rel="external noopener">DITA Version 1.3 Errata 01 (Distribution ZIP of the DITA source)</a></li><li class="linklist"><a class="link" href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita" target="_blank" rel="external noopener">OASIS DITA Technical Committee</a></li><li class="linklist"><a class="link" href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita-adoption" target="_blank" rel="external noopener">OASIS DITA Adoption Technical Committee</a></li></ul></div></nav>
</article></main></body></html>

100
dita-ot-3.6/doc/reference/dita-v2-0-support.html Normal file
View file

@ -0,0 +1,100 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit 3.6 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&nbsp;NG grammar files from OASIS (as of October 2020)."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA 2.0 preview support</title></head><body id="ID"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li class="active"><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">DITA 2.0 preview support</h1>
<div class="body conbody"><p class="shortdesc">DITA Open Toolkit <span class="keyword">3.6</span> 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&nbsp;NG grammar files from OASIS (as of October 2020).</p>
<p class="p" id="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 class="section"><h2 class="title sectiontitle">DITA-OT 3.5</h2>
<p class="p">DITA-OT 3.5 provided an initial preview of DITA 2.0 features.</p>
<ul class="ul">
<li class="li" id="ID__3453">
<p class="p">
<span class="ph" id="ID__include">The new <code class="keyword markupname xmlelement">&lt;include&gt;</code> 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
<code class="keyword markupname xmlelement">&lt;coderef&gt;</code> elements (see
<a class="xref" href="extended-functionality.html" title="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.">Extended codeblock processing</a>).</span>
</p>
</li>
<li class="li" id="ID__3462">
<p class="p">
<span class="ph" id="ID__specializations">The new <code class="keyword markupname xmlatt">@specializations</code> attribute, which replaces the DITA 1.x
<code class="keyword markupname xmlatt">@domains</code> attribute, can now be used as an alternative method of declaring specialized
attributes.</span>
</p>
</li>
<li class="li" id="ID__3463">
<p class="p">
<span class="ph" id="ID__outputclass">The <code class="keyword markupname xmlatt">@outputclass</code> 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
<code class="keyword markupname xmlatt">@class</code> 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 <code class="keyword markupname xmlatt">@style</code> attributes generated by DITA 1.x flagging options such as
<code class="keyword markupname xmlatt">@color</code> and <code class="keyword markupname xmlatt">@backcolor</code>.</span>
</p>
</li>
<li class="li" id="ID__3464">
<p class="p">
<span class="ph" id="ID__simple-table-titles">Titles can now be specified on simple tables, and
<code class="keyword markupname xmlelement">&lt;simpletable&gt;</code> entries now support row and column spanning attributes.</span>
</p>
</li>
<li class="li" id="ID__3483">
<p class="p">
<span class="ph" id="ID__topic-based-classes">Where DITA 1.x defined conflicting <code class="keyword markupname xmlatt">@class</code> values for
<code class="keyword markupname xmlelement">&lt;linktext&gt;</code>, <code class="keyword markupname xmlelement">&lt;shortdesc&gt;</code>, and
<code class="keyword markupname xmlelement">&lt;searchtitle&gt;</code> in maps and topics, the new draft of DITA 2.0 uses the topic-based
<code class="keyword markupname xmlatt">@class</code> value in all cases. Processing is updated to recognize the updated value when
these elements are used in maps.</span>
</p>
</li>
</ul>
</section>
<section class="section"><h2 class="title sectiontitle">DITA-OT 3.6</h2>
<p class="p">DITA-OT 3.6 adds support for additional DITA 2.0 features.</p>
<ul class="ul" id="ID__added-in-3.6">
<li class="li">Where earlier DITA versions relied on the <code class="keyword markupname xmlelement">&lt;object&gt;</code> to embed media in DITA source
files, DITA 2.0 provides new <code class="keyword markupname xmlelement">&lt;audio&gt;</code> and <code class="keyword markupname xmlelement">&lt;video&gt;</code> elements that
correspond to their HTML5 equivalents.</li>
<li class="li">For HTML5 compatibility, the new emphasis domain adds support for the <code class="keyword markupname xmlelement">&lt;strong&gt;</code> and
<code class="keyword markupname xmlelement">&lt;em&gt;</code> elements in addition to the existing <code class="keyword markupname xmlelement">&lt;b&gt;</code> and
<code class="keyword markupname xmlelement">&lt;i&gt;</code> elements in the highlighting domain.</li>
<li class="li">The troubleshooting domain has been updated with additional constructs that can be used to provide detailed
diagnostic information.</li>
<li class="li">Several obsolete elements and attributes have been removed from DITA 2.0, including:
<ul class="ul">
<li class="li"><code class="keyword markupname xmlelement">&lt;boolean&gt;</code></li>
<li class="li"><code class="keyword markupname xmlelement">&lt;data-about&gt;</code></li>
<li class="li"><code class="keyword markupname xmlelement">&lt;indextermref&gt;</code></li>
<li class="li"><code class="keyword markupname xmlatt">@alt</code> on <code class="keyword markupname xmlelement">&lt;image&gt;</code></li>
<li class="li"><code class="keyword markupname xmlatt">@navtitle</code> on <code class="keyword markupname xmlelement">&lt;topicref&gt;</code></li>
<li class="li"><code class="keyword markupname xmlatt">@query</code> on <code class="keyword markupname xmlelement">&lt;topicref&gt;</code></li>
<li class="li"><code class="keyword markupname xmlatt">@refcols</code> on <code class="keyword markupname xmlelement">&lt;simpletable&gt;</code></li>
<li class="li"><code class="keyword markupname xmlatt">@xtrc</code></li>
<li class="li"><code class="keyword markupname xmlatt">@xtrf</code></li>
</ul>
</li>
</ul>
<div class="note note note_note" id="ID__more-to-come"><span class="note__title">Note:</span> 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.</div>
<div class="note tip note_tip"><span class="note__title">Tip:</span> For the latest status information on DITA 2.0-related features and fixes, see the
<a class="xref" href="https://github.com/dita-ot/dita-ot/issues?q=label%3A%22DITA+2.0%22" target="_blank" rel="external noopener">DITA 2.0 label</a> in the GitHub issues tracker.</div>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita" target="_blank" rel="external noopener">OASIS DITA Technical Committee</a></li></ul></div></nav>
</article></main></body></html>

145
dita-ot-3.6/doc/reference/docs-dita-features.html Normal file
View file

@ -0,0 +1,145 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit uses various recent DITA features in the project documentation."><meta name="keywords" content=", audience, orient, profiling, branch filters, Antenna House, DITA XML mention domain, DITA 1.3, XML mention domain"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA features in the documentation</title></head><body id="ID"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li class="active"><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">DITA features in the documentation</h1>
<div class="body conbody"><p class="shortdesc">DITA Open Toolkit uses various recent DITA features in the project documentation.</p>
<p class="p">The
<a class="xref" href="https://github.com/dita-ot/docs" target="_blank" rel="external noopener">source files</a> for the DITA-OT
documentation include examples of the following DITA features (among others):</p>
<ul class="ul">
<li class="li">subjectScheme classification for controlling available attributes</li>
<li class="li">profiling and branch filtering (novice/expert content)</li>
<li class="li">extending topics with conref push</li>
<li class="li">keys and key references</li>
<li class="li">XML mention domain</li>
</ul>
<section class="section"><h2 class="title sectiontitle">Subject schemes </h2>
<p class="p">Various topics, sections and elements in the docs are profiled by audience:</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;li id="novice-variables-last" audience="novice"&gt;
&lt;p id="common-format-info"&gt;
&lt;varname&gt;format&lt;/varname&gt; is the output format (transformation type). This argument corresponds to the
common parameter &lt;parmname&gt;transtype&lt;/parmname&gt;. Use the same values as for the
&lt;parmname&gt;transtype&lt;/parmname&gt; build parameter, for example &lt;option&gt;html5&lt;/option&gt; or
&lt;option&gt;pdf&lt;/option&gt;.&lt;/p&gt;
&lt;/li&gt;</code></pre></div>
<p class="p">An “audience” subject scheme controls the values that are available for the <code class="keyword markupname xmlatt">@audience</code>
attribute:</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;subjectdef keys="audience"&gt;
&lt;subjectdef keys="novice"/&gt;
&lt;subjectdef keys="expert"/&gt;
&lt;subjectdef keys="xslt-customizer"/&gt;
&lt;/subjectdef&gt;</code></pre></div>
<p class="p">A dedicated subject scheme map defines several series of permissible values for <code class="keyword markupname xmlatt">@outputclass</code>
attributes, which apply styling to elements on the project website, enable
<a class="xref" href="extended-functionality.html" title="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.">extended codeblock processing</a> such as whitespace visualization and
line numbering in PDF output, or trigger
<a class="xref" href="https://www.w3.org/TR/html52/textlevel-semantics.html#the-code-element" target="_blank" rel="external noopener">HTML5-compliant syntax highlighting</a> via
<a class="xref" href="https://prismjs.com" target="_blank" rel="external noopener">prism.js</a>.</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;schemeref href="subjectscheme-outputclass.ditamap"/&gt;</code></pre></div>
</section>
<section class="section"><h2 class="title sectiontitle">Branch filtering: re-using profiled content</h2>
</section>
<section class="section">
<p class="p"><cite class="cite">Installing DITA-OT</cite> pulls a subset of the build description from <cite class="cite">using the
<span class="keyword cmdname">dita</span> command</cite>, filtered to display only content deemed suitable for novice users
under
<a class="xref" href="../topics/first-build-using-dita-command.html" title="You can generate output using the dita command-line tool. Build parameters can be specified on the command line or with .properties files.">Building output</a>:</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;topicref href="using-dita-command.dita"
keys="first-build-using-dita-command" locktitle="yes"&gt;
&lt;topicmeta&gt;
&lt;navtitle&gt;Building output&lt;/navtitle&gt;
&lt;/topicmeta&gt;
&lt;ditavalref href="../resources/novice.ditaval"&gt;
&lt;ditavalmeta&gt;
&lt;dvrResourcePrefix&gt;first-build-&lt;/dvrResourcePrefix&gt;
&lt;/ditavalmeta&gt;
&lt;/ditavalref&gt;
&lt;/topicref&gt;</code></pre></div>
<p class="p">The same content appears later in
<a class="xref" href="../topics/build-using-dita-command.html" title="You can generate output using the dita command-line tool. Build parameters can be specified on the command line or with .properties files.">Using the dita command</a> with additional information on arguments, options and examples.</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;topicref href="using-dita-command.dita"
keys="build-using-dita-command" locktitle="yes"&gt;
&lt;topicmeta&gt;
&lt;navtitle&gt;Using the &lt;cmdname&gt;dita&lt;/cmdname&gt; command&lt;/navtitle&gt;
&lt;/topicmeta&gt;
&lt;ditavalref href="../resources/expert.ditaval"&gt;
&lt;ditavalmeta&gt;
&lt;dvrResourcePrefix&gt;build-&lt;/dvrResourcePrefix&gt;
&lt;/ditavalmeta&gt;
&lt;/ditavalref&gt;</code></pre></div>
</section>
<section class="section"><h2 class="title sectiontitle">Conref push</h2>
</section>
<section class="section">
<p class="p">The docs build uses the conref push mechanism (with the <code class="ph codeph">pushreplace</code>, <code class="ph codeph">mark</code>,
and <code class="ph codeph">pushafter</code>
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/langRef/attributes/theconactionattribute.html" target="_blank" rel="external noopener">conactions</a>) to extend the parameter descriptions embedded in the
default plug-ins:</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;plentry id="args.csspath"&gt;
&lt;pt&gt;
&lt;parmname&gt;args.csspath&lt;/parmname&gt;
&lt;/pt&gt;
&lt;pd conaction="pushreplace" conref="parameters-html5.dita#html5/args.csspath.desc"&gt;
&lt;div conref="./ant-parameters-details.dita#base-html/args.csspath.desc"/&gt;
&lt;/pd&gt;
&lt;pd conaction="mark" conref="parameters-html5.dita#html5/args.csspath.desc"/&gt;
&lt;pd conaction="pushafter"&gt;
&lt;div conref="./ant-parameters-details.dita#base-html/args.csspath.details"/&gt;
&lt;/pd&gt;
&lt;/plentry&gt;</code></pre></div>
<p class="p">The pushed content appears in the output after the default description. (See
<a class="xref" href="../parameters/parameters-base-html.html" title="Certain parameters apply to all HTML-based transformation types: HTML5, XHTML, HTML&nbsp;Help, and Eclipse help.">HTML-based output parameters</a>.)</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> You could also use the same mechanism to extend the documentation with custom information that
applies only to your company’s toolkit distribution.</div>
</section>
<section class="section"><h2 class="title sectiontitle">Keys and key references</h2>
</section>
<section class="section">
<p class="p">The <code class="ph codeph">key-definitions.ditamap</code> defines keys for version references, re-usable links, etc.</p>
<p class="p">This key definition defines the maintenance release version:</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space"><code>&lt;keydef keys="maintenance-version"&gt;
&lt;topicmeta&gt;
&lt;keywords&gt;
&lt;keyword&gt;3.6&lt;/keyword&gt;
&lt;/keywords&gt;
&lt;/topicmeta&gt;
&lt;/keydef&gt;</code></pre></div>
<p class="p">In topics, the keyword is used in place of hard-coded version references:</p>
<pre class="pre codeblock language-xml"><code>&lt;title&gt;DITA Open Toolkit &lt;keyword keyref="maintenance-version"/&gt; Release Notes&lt;/title&gt;</code></pre>
</section>
<section class="section"><h2 class="title sectiontitle">XML mention domain</h2>
</section>
<section class="section">
<p class="p">The docs use the
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/langRef/containers/xml-mention-domain.html#xml-mention-domain" target="_blank" rel="external noopener">XML mention domain</a> to mark up XML elements and attributes:</p>
<pre class="pre codeblock language-xml"><code>&lt;li id="1777"&gt;
DITA 1.3: Initial support has been added for the &lt;xmlatt&gt;orient&lt;/xmlatt&gt;
attribute on &lt;xmlelement&gt;table&lt;/xmlelement&gt; elements. These changes allow
Antenna House Formatter to render tables in landscape mode when the
&lt;xmlatt&gt;orient&lt;/xmlatt&gt; attribute is set to &lt;option&gt;land&lt;/option&gt;. […]
&lt;/li&gt;</code></pre>
<p class="p">When the toolkit generates output for the sample above:</p>
<ul class="ul">
<li class="li">the XML element name is wrapped in angle brackets as <code class="keyword markupname xmlelement">&lt;table&gt;</code>
</li>
<li class="li">the attribute name is prefixed with an “at” sign as <code class="keyword markupname xmlatt">@orient</code></li>
</ul>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div></nav></article></main></body></html>

62
dita-ot-3.6/doc/reference/eclipsehelp-processing.html Normal file
View file

@ -0,0 +1,62 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The eclipsehelp 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 dita.map.eclipse target is used to create a set of control files and navigation files."><meta name="keywords" content="HTML, Eclipse Help, dita.map.eclipse, targets, index, table of contents"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Eclipse help processing</title></head><body id="xhtmleclipse"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li><a href="../reference/html5-processing.html">HTML5 processing</a></li><li class="active"><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Eclipse help processing</h1>
<div class="body conbody"><p class="shortdesc">The <span class="keyword option">eclipsehelp</span> 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 <code class="ph codeph">dita.map.eclipse</code>
target is used to create a set of control files and navigation files.</p>
<section class="section">
<p class="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>
<div class="p">
<dl class="dl">
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.init</code></dt>
<dd class="dd">Sets up various default properties</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.toc</code></dt>
<dd class="dd">Creates the XML file that defines an Eclipse table of contents</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.index</code></dt>
<dd class="dd">Creates the sorted XML file that defines an Eclipse index</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.plugin</code></dt>
<dd class="dd">Creates the <span class="ph filepath">plugin.xml</span> file that controls the behavior of an Eclipse plug-in</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.plugin.properties</code></dt>
<dd class="dd">Creates a Java properties file that sets properties for the plug-in, such as name and version
information</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.manifest.file</code></dt>
<dd class="dd">Creates a <span class="ph filepath">MANIFEST.MF</span> file that contains additional information used by
Eclipse</dd>
<dt class="dt dlterm"><code class="ph codeph">copy-plugin-files</code></dt>
<dd class="dd">Checks for the presence of certain control files in the source directory, and copies those found to the
output directory</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.fragment.language.init</code></dt>
<dd class="dd">Works in conjunction with the <code class="ph codeph">dita.map.eclipse.fragment.language.country.init</code> and
<code class="ph codeph">dita.map.eclipse.fragment.error</code> targets to control Eclipse fragment files, which are
used for versions of a plug-in created for a new language or locale</dd>
</dl>
</div>
<p class="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 <code class="ph codeph">dita.out.map.eclipse.toc</code>.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/html-based-processing.html" title="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.">HTML-based processing modules</a></div></div></nav></article></main></body></html>

145
dita-ot-3.6/doc/reference/extended-functionality.html Normal file
View file

@ -0,0 +1,145 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="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."><meta name="keywords" content=", coderef, codeblock, format, outputclass, encoding, DOTJ052E, character set"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extended codeblock processing</title></head><body id="code-reference"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li class="active"><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Extended codeblock processing</h1>
<div class="body refbody"><p class="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.</p>
<section class="section" id="code-reference__coderef-charset"><h2 class="title sectiontitle">Character set definition</h2>
<p class="p">For <code class="keyword markupname xmlelement">&lt;coderef&gt;</code> elements, DITA-OT supports defining the code reference target file
encoding using the <code class="keyword markupname xmlatt">@format</code> attribute. The supported format is:</p>
<pre class="pre codeblock"><code>format (";" space* "charset=" charset)?</code></pre>
<p class="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 <span class="keyword msgnum">DOTJ052E</span> error is thrown and the system default character set is
used as a fallback.</p>
<pre class="pre codeblock language-xml"><code>&lt;coderef href="unicode.txt" format="txt; charset=UTF-8"/&gt;</code></pre>
<p class="p">As of DITA-OT 3.3, the default character set for code references can be changed by adding the
<span class="keyword parmname">default.coderef-charset</span> key to the
<a class="xref" href="../parameters/configuration-properties-file.html" title="The configuration.properties file controls certain common properties, as well as some properties that control PDF processing.">configuration.properties</a> file:</p>
<pre class="pre codeblock language-properties"><code>default.coderef-charset = ISO-8859-1</code></pre>
<p class="p">The character set values are those supported by the Java
<a class="xref" href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" target="_blank" rel="external noopener">Charset</a> class.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Line range extraction</h2>
<p class="p">Code references can be limited to extract only a specified line range by defining the
<code class="ph codeph">line-range</code> pointer in the URI fragment. The format is:</p>
<pre class="pre codeblock"><code>uri ("#line-range(" start ("," end)? ")" )?</code></pre>
<p class="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>
<div class="example">
<pre class="pre codeblock language-xml"><code>&lt;coderef href="Parser.scala#line-range(5,10)" format="scala"/&gt;</code></pre>
<p class="p">Only lines from 5 to 10 will be included in the output.</p>
</div>
<section class="section"><h2 class="title sectiontitle">RFC 5147</h2>
<p class="p">DITA-OT also supports the line position and range syntax from
<a class="xref" href="http://tools.ietf.org/html/rfc5147" target="_blank" rel="external noopener">RFC 5147</a>. The format for line range is:</p>
<pre class="pre codeblock"><code>uri ("#line=" start? "," end? )?</code></pre>
<p class="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>
<pre class="pre codeblock"><code>uri ("#line=" position )?</code></pre>
<p class="p">The position line number starts from 0.</p>
</section>
<div class="example">
<pre class="pre codeblock language-xml"><code>&lt;coderef href="Parser.scala#line=4,10" format="scala"/&gt;</code></pre>
<p class="p">Only lines from 5 to 10 will be included in the output.</p>
</div>
<section class="section"><h2 class="title sectiontitle">Line range by content</h2>
<p class="p">Instead of specifying line numbers, you can also select lines to include in the code reference by specifying
keywords (or “<dfn class="term">tokens</dfn>”) that appear in the referenced file.</p>
<div class="div" id="code-reference__coderef-by-content">
<p class="p">DITA-OT supports the <code class="ph codeph">token</code> 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>
<pre class="pre codeblock"><code>uri ("#token=" start? ("," end)? )?</code></pre>
<p class="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>
<div class="example">
<p class="p">Given a Haskell source file named <span class="ph filepath">fact.hs</span> with the following content,</p>
<pre class="pre codeblock language-haskell normalize-space show-line-numbers show-whitespace"><code>-- START-FACT
fact :: Int -&gt; Int
fact 0 = 1
fact n = n * fact (n-1)
-- END-FACT
main = print $ fact 7</code></pre>
<p class="p">a range of lines can be referenced as:</p>
<pre class="pre codeblock language-xml"><code>&lt;coderef href="fact.hs#token=START-FACT,END-FACT"/&gt;</code></pre>
<p class="p">to include the range of lines that follows the <code class="ph codeph">START-FACT</code> token on Line 1, up to (but not
including) the line that contains the <code class="ph codeph">END-FACT</code> token (Line 5). The resulting
<code class="keyword markupname xmlelement">&lt;codeblock&gt;</code> would contain lines 2–4:</p>
<pre class="pre codeblock language-haskell"><code>fact :: Int -&gt; Int
fact 0 = 1
fact n = n * fact (n-1)</code></pre>
<div class="note tip note_tip" id="code-reference__coderef-by-content-tip"><span class="note__title">Tip:</span> 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 <code class="ph codeph">token</code> keywords are preserved when the referenced
resource is modified.</div></div>
<div class="bodydiv refbodydiv" id="code-reference__normalize-codeblock-whitespace">
<section class="section"><h2 class="title sectiontitle">Whitespace normalization</h2>
<p class="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>
<div class="example">
<div class="p"><pre class="pre codeblock language-xml"><code>··&lt;subjectdef keys="audience"&gt;
····&lt;subjectdef keys="novice"/&gt;
····&lt;subjectdef keys="expert"/&gt;
··&lt;/subjectdef&gt;</code></pre></div>
<p class="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 <code class="keyword markupname xmlatt">@outputclass</code> attribute on the <code class="keyword markupname xmlelement">&lt;codeblock&gt;</code> element to
include the <code class="ph codeph">normalize-space</code> keyword.</p>
<p class="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>
<div class="p"><pre class="pre codeblock language-xml"><code>&lt;subjectdef keys="audience"&gt;
··&lt;subjectdef keys="novice"/&gt;
··&lt;subjectdef keys="expert"/&gt;
&lt;/subjectdef&gt;</code></pre></div>
</div>
</div>
<div class="bodydiv refbodydiv" id="code-reference__visualize-codeblock-whitespace">
<section class="section"><h2 class="title sectiontitle">Whitespace visualization (PDF)</h2>
<p class="p">DITA-OT can be set to display the whitespace characters in code blocks to visualize indentation in PDF
output.</p>
<p class="p">To enable this feature, set the <code class="keyword markupname xmlatt">@outputclass</code> attribute on the
<code class="keyword markupname xmlelement">&lt;codeblock&gt;</code> element to include the <code class="ph codeph">show-whitespace</code> keyword.</p>
<p class="p">When PDF output is generated, space characters in the code will be replaced with a middle dot or “interpunct”
character (&nbsp;<code class="ph codeph">·</code>&nbsp;); tab characters are replaced with a rightwards arrow and three spaces
(&nbsp;<code class="ph codeph">→&nbsp;&nbsp;&nbsp;</code>&nbsp;).</p>
</section>
</div>
<div class="bodydiv refbodydiv" id="code-reference__codeblock-line-numbers">
<section class="section"><h2 class="title sectiontitle">Line numbering (PDF)</h2>
<p class="p">DITA-OT can be set to add line numbers to code blocks to make it easier to distinguish specific lines.</p>
<p class="p">To enable this feature, set the <code class="keyword markupname xmlatt">@outputclass</code> attribute on the
<code class="keyword markupname xmlelement">&lt;codeblock&gt;</code> element to include the <code class="ph codeph">show-line-numbers</code> keyword.</p>
</section>
</div>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div><div class="linklist relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../reference/preprocess-topic-fragment.html" title="The topic-fragment step expands content references to elements in the same topic and resolves references made with the coderef element. This step is implemented in SAX pipes.">Resolve topic fragments and code references (topic-fragment)</a></li></ul></div></nav></article></main></body></html>

183
dita-ot-3.6/doc/reference/flagging-migration.html Normal file
View file

@ -0,0 +1,183 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="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."><meta name="keywords" content=", ul, deprecated features, mode=&#34;elementname-fmt&#34;, DITAVAL templates, DITAVAL, template changes in 1.7, CSS, gen-style, flagging"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>XHTML migration for flagging updates in DITA-OT 1.7</title></head><body id="flagging-migration"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a><ul><li><a href="../topics/plugin-benefits.html">Plug-in benefits</a></li><li><a href="../topics/plugin-configfile.html">Plug-in descriptor file</a></li><li><a href="../topics/plugin-coding-conventions.html">Coding conventions</a></li><li><a href="../topics/plugin-dependencies.html">Plug-in dependencies</a></li><li><a href="../topics/plugin-use-cases.html">Plug-in use cases</a></li><li><a href="../topics/html-customization-plugins.html">Custom HTML plug-ins</a></li><li><a href="../topics/pdf-customization-plugins.html">Custom PDF plug-ins</a></li><li><a href="../topics/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/migration.html">Migrating customizations</a><ul><li><a href="../topics/migrating-to-3.6.html">To 3.6</a></li><li><a href="../topics/migrating-to-3.5.html">To 3.5</a></li><li><a href="../topics/migrating-to-3.4.html">To 3.4</a></li><li><a href="../topics/migrating-to-3.3.html">To 3.3</a></li><li><a href="../topics/migrating-to-3.2.html">To 3.2</a></li><li><a href="../topics/migrating-to-3.1.html">To 3.1</a></li><li><a href="../topics/migrating-to-3.0.html">To 3.0</a></li><li><a href="../topics/migrating-to-2.5.html">To 2.5</a></li><li><a href="../topics/migrating-to-2.4.html">To 2.4</a></li><li><a href="../topics/migrating-to-2.3.html">To 2.3</a></li><li><a href="../topics/migrating-to-2.2.html">To 2.2</a></li><li><a href="../topics/migrating-to-2.1.html">To 2.1</a></li><li><a href="../topics/migrating-to-2.0.html">To 2.0</a></li><li><a href="../topics/migrating-to-1.8.html">To 1.8</a></li><li><a href="../topics/migrating-to-1.7.html">To 1.7</a><ul><li class="active"><a href="../reference/flagging-migration.html">Flagging updates</a></li></ul></li><li><a href="../topics/migrating-to-1.6.html">To 1.6</a></li><li><a href="../topics/migrating-to-1.5.4.html">To 1.5.4</a></li></ul></li></ul></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">XHTML migration for flagging updates in DITA-OT 1.7</h1>
<div class="body refbody"><p class="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.</p>
<section class="section"><h2 class="title sectiontitle">Which XHTML overrides need to migrate?</h2>
<p class="p">If your override does not contain any code related to DITAVAL flagging, then there is nothing to migrate.</p>
<p class="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>
<div class="p">If you do make use of DITAVAL-based flagging, try using your override with 1.7. Check the elements you
override:
<ol class="ol">
<li class="li">In some cases flags may be doubled. This will be the case if you call routines such as
<code class="ph codeph">"start-flagit"</code>.</li>
<li class="li">In some cases flags may be removed. This will be the case if you call shortcut routines such as
<code class="ph codeph">"revtext"</code> or <code class="ph codeph">"revblock"</code>.</li>
<li class="li">In other cases, flags may still appear properly, in which case migration is less urgent.</li>
</ol></div>
<p class="p">For any override that needs migration, please see the instructions that follow.</p></section>
<section class="section"><h2 class="title sectiontitle">Deprecated templates in DITA-OT 1.7</h2>
<p class="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 class="ul">
<li class="li">The <code class="ph codeph">"gen-style"</code> template used to add CSS styling</li>
<li class="li">The <code class="ph codeph">"start-flagit"</code> and <code class="ph codeph">"end-flagit"</code> templates used to generate image flags
based on property attributes like @audience</li>
<li class="li">The <code class="ph codeph">"start-revflag"</code> and <code class="ph codeph">"end-revflag"</code> templates, used to generate images
for active revisions</li>
<li class="li">Shortcut templates that group these templates into a single call, such as:
<ul class="ul">
<li class="li"><code class="ph codeph">"start-flags-and-rev"</code> and <code class="ph codeph">"end-flags-and-rev"</code>, used to combine flags
and revisions into one call</li>
<li class="li"><code class="ph codeph">"revblock"</code> and <code class="ph codeph">"revtext"</code>, both used to output start revisions, element
content, and end revisions</li>
<li class="li">The modes <code class="ph codeph">"outputContentsWithFlags"</code> and
<code class="ph codeph">"outputContentsWithFlagsAndStyle"</code>, both used to combine processing for
property/revision flags with content processing</li>
</ul></li>
<li class="li">All other templates that make use of the <code class="ph codeph">$flagrules</code> variable, which is no longer used in
any of the DITA-OT 1.7 code</li>
<li class="li">All templates within <span class="ph filepath">flag.xsl</span> that were called from the templates listed above</li>
<li class="li">Element processing handled with mode="elementname-fmt", such as <code class="ph codeph">mode="ul-fmt"</code> for
processing unordered lists and <code class="ph codeph">mode="section-fmt"</code> for sections.</li>
</ul></section>
<section class="section"><h2 class="title sectiontitle">What replaces the templates?</h2>
<p class="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 <span class="ph filepath">htmlflag.xsl</span> 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>
<div class="p">For example, the common logic for most element rules before DITA-OT 1.7 could be boiled down to the following:
<ol class="ol">
<li class="li">Match element </li>
<li class="li">Create <code class="ph codeph">"flagrules"</code> variable by reading DITAVAL for active flags </li>
<li class="li">Output start tag such as <code class="ph codeph">&lt;div&gt;</code> or <code class="ph codeph">&lt;span&gt;</code>
</li>
<li class="li">Call <code class="ph codeph">"commonattributes"</code> and ID processing </li>
<li class="li">Call <code class="ph codeph">"gen-style"</code> with <code class="ph codeph">$flagrules</code>, to create DITAVAL based CSS </li>
<li class="li">Call <code class="ph codeph">"start-flagit"</code> with <code class="ph codeph">$flagrules</code>, to create start flag images </li>
<li class="li">Call <code class="ph codeph">"start-revflag"</code> with <code class="ph codeph">$flagrules</code>, to create start revision images </li>
<li class="li">Output contents </li>
<li class="li">Call <code class="ph codeph">"end-revflag"</code> with <code class="ph codeph">$flagrules</code>, to create end revision images </li>
<li class="li">Call <code class="ph codeph">"end-flagit"</code> with <code class="ph codeph">$flagrules</code>, to create end flag images </li>
<li class="li">Output end tag such as <code class="ph codeph">&lt;/div&gt;</code> or <code class="ph codeph">&lt;/span&gt;</code></li>
</ol>
</div>
<p class="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>
<div class="p">The sample above is reduced to:
<ol class="ol">
<li class="li">Match element </li>
<li class="li">Output start tag such as <code class="ph codeph">&lt;div&gt;</code> or <code class="ph codeph">&lt;span&gt;</code>
</li>
<li class="li">Call <code class="ph codeph">"commonattributes"</code> and ID processing </li>
<li class="li">Output contents </li>
<li class="li">Output end tag such as <code class="ph codeph">&lt;/div&gt;</code> or <code class="ph codeph">&lt;/span&gt;</code></li>
</ol>
</div>
</section>
<section class="section"><h2 class="title sectiontitle">Migrating <code class="ph codeph">"gen-style"</code> named template</h2>
<p class="p">Calls to the <code class="ph codeph">"gen-style"</code> template should be deleted. There is no need to replace this call for
most elements.</p>
<p class="p">The <code class="ph codeph">"gen-style"</code> 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>
<div class="p">With DITA-OT 1.7, the style is calculated in the pre-process flagging module. The result is created as
@outputclass on a <code class="ph codeph">&lt;ditaval-startprop&gt;</code> sub-element. The <code class="ph codeph">"commonattributes"</code>
template now includes a line to process that value; the result is that for every element that calls
<code class="ph codeph">"commonattributes"</code>, 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 <code class="ph codeph">"commonattributes"</code> that handles the style is:
<pre class="pre codeblock language-xml"><code>&lt;xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-startprop ')]/@outputclass" mode="add-ditaval-style"/&gt;</code></pre></div></section>
<section class="section"><h2 class="title sectiontitle">Migrating <code class="ph codeph">"start-flagit"</code>, <code class="ph codeph">"start-revflag"</code>, <code class="ph codeph">"end-flagit"</code>,
and <code class="ph codeph">"end-flagit"</code> named templates</h2>
<p class="p">Calls to these templates fall into two general groups.</p>
<p class="p">If the flow of your element rule is to create a start tag like <code class="ph codeph">&lt;div&gt;</code>,
<code class="ph codeph">"start-flagit"</code>/<code class="ph codeph">"start-revflag"</code>, process contents,
<code class="ph codeph">"end-revflag"</code>/<code class="ph codeph">"end-flagit"</code>, 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 class="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 <code class="ph codeph">&lt;ol&gt;</code>, where flags must appear
before the <code class="ph codeph">&lt;ol&gt;</code> in order to create valid XHTML. The second is for elements like
<code class="ph codeph">&lt;section&gt;</code>, 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 class="p">This is done with the following two lines (one for start flag/revision, one for end flag/revision):</p>
<ul class="ul">
<li class="li">
<p class="p">Create starting flag and revision images:</p>
<pre class="pre codeblock language-xml"><code>&lt;xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-startprop ')]" mode="out-of-line"/&gt;</code></pre></li>
<li class="li">
<p class="p">Create ending flag and revision images:</p>
<pre class="pre codeblock language-xml"><code>&lt;xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-endprop ')]" mode="out-of-line"/&gt;</code></pre></li>
</ul>
<div class="p">For example, the following lines are used in DITA-OT 1.7 to process the <code class="keyword markupname xmlelement">&lt;ul&gt;</code> element
(replacing the 29 lines used in DITA-OT
1.6):<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;xsl:template match="*[contains(@class,' topic/ul ')]"&gt;
<strong class="ph b">&lt;xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-startprop ')]" mode="out-of-line"/&gt;</strong>
&lt;xsl:call-template name="setaname"/&gt;
&lt;ul&gt;
&lt;xsl:call-template name="commonattributes"/&gt;
&lt;xsl:apply-templates select="@compact"/&gt;
&lt;xsl:call-template name="setid"/&gt;
&lt;xsl:apply-templates/&gt;
&lt;/ul&gt;
<strong class="ph b">&lt;xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-endprop ')]" mode="out-of-line"/&gt;</strong>
&lt;xsl:value-of select="$newline"/&gt;
&lt;/xsl:template&gt;</code></pre></div></section>
<section class="section"><h2 class="title sectiontitle">Migrating <code class="ph codeph">"start-flags-and-rev"</code> and <code class="ph codeph">"end-flags-and-rev"</code></h2>
<ul class="ul">
<li class="li"><code class="ph codeph">"start-flags-and-rev"</code> is equivalent to calling <code class="ph codeph">"start-flagit"</code> followed by
<code class="ph codeph">"start-revflag"</code>; it should be migrated as in the previous section.</li>
<li class="li"><code class="ph codeph">"end-flags-and-rev"</code> is equivalent to calling <code class="ph codeph">"end-revflag"</code> followed by
<code class="ph codeph">"end-flagit"</code>; it should be migrated as in the previous section.</li>
</ul></section>
<section class="section"><h2 class="title sectiontitle">Migrating <code class="ph codeph">"revblock"</code> and <code class="ph codeph">"revtext"</code></h2>
<p class="p">Calls to these two templates can be replaced with a simple call to
<code class="ph codeph">&lt;xsl:apply-templates/&gt;</code>.</p></section>
<section class="section"><h2 class="title sectiontitle">Migrating modes <code class="ph codeph">"outputContentsWithFlags"</code> and
<code class="ph codeph">"outputContentsWithFlagsAndStyle"</code></h2>
<p class="p">Processing an element with either of these modes can be replaced with a simple call to
<code class="ph codeph">&lt;xsl:apply-templates/&gt;</code>.</p></section>
<section class="section"><h2 class="title sectiontitle">Migrating <code class="ph codeph">mode="elementname-fmt"</code></h2>
<div class="p">Prior to DITA-OT 1.7, many elements were processed with the following
logic:<pre class="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></div>
<p class="p">Beginning with DITA-OT 1.7, styling from revisions is handled automatically with the
<code class="ph codeph">"commonattributes"</code> template. This means there is no need for the extra testing, or the
indirection to <code class="ph codeph">mode="elementname-fmt"</code>. 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
<code class="ph codeph">mode="elementname-fmt"</code>.</p></section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/migrating-to-1.7.html" title="In DITA-OT 1.7, a new preprocessing step implements flagging for HTML-based output formats. PDF processing was corrected with regard to shortdesc handling, and a new XSLT template mode was introduced for HTML TOC processing. Several stylesheets were moved to plug-in specific folders and deprecated properties and XSLT variables were removed.">Migrating to release 1.7</a></div></div></nav></article></main></body></html>

80
dita-ot-3.6/doc/reference/glossary.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain terms have particular meaning in the context of the DITA Open Toolkit project."><meta name="keywords" content="DOST"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Glossary</title></head><body><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li class="active"><a href="../reference/glossary.html#glossary">Glossary</a><ul><li><a href="../reference/glossary.html#gloss-argument">argument</a></li><li><a href="../reference/glossary.html#gloss-dita-open-toolkit">DITA Open Toolkit</a></li><li><a href="../reference/glossary.html#gloss-extension-point">extension point</a></li><li><a href="../reference/glossary.html#gloss-option">option</a></li><li><a href="../reference/glossary.html#gloss-output-format">output format</a></li><li><a href="../reference/glossary.html#gloss-parameter">parameter</a></li><li><a href="../reference/glossary.html#gloss-plug-in">plug-in</a></li><li><a href="../reference/glossary.html#gloss-processor">processor</a></li><li><a href="../reference/glossary.html#gloss-property">property</a></li><li><a href="../reference/glossary.html#gloss-template-plugin">template</a></li><li><a href="../reference/glossary.html#gloss-transformation-type">transformation type</a></li><li><a href="../reference/glossary.html#gloss-variable">variable</a></li><li><a href="../reference/glossary.html#gloss-template-xslt">XSL template</a></li></ul></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><article class="nested0" aria-labelledby="ariaid-title1" id="glossary">
<h1 class="title topictitle1" id="ariaid-title1">Glossary</h1>
<p class="shortdesc">Certain terms have particular meaning in the context of the DITA Open Toolkit project.</p>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/index.html" title="The Reference topics provide more advanced information about the DITA-OT architecture, OASIS specification support, and licensing.">Reference</a></div></div></nav><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title2" id="gloss-argument">
<h2 class="title glossterm topictitle2" id="ariaid-title2">argument</h2>
<div class="abstract glossdef">Required parameter passed to the Ant process or <span class="keyword cmdname">dita</span> command.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title3" id="gloss-dita-open-toolkit">
<h2 class="title glossterm topictitle2" id="ariaid-title3">DITA Open Toolkit</h2>
<div class="body conbody glossBody"><div class="abstract glossdef">The open-source publishing engine for content authored in the Darwin Information Typing
Architecture.</div>
<section class="section glossAlt"><h3 class="title glossAbbreviation sectiontitle">DITA-OT</h3>
<div class="note glossUsage note note_note"><span class="note__title">Note:</span> Treat as a proper noun; do not precede with <em class="ph i">the</em> definite article.</div>
</section>
<section class="section glossAlt"><h3 class="title glossAcronym sectiontitle">DOST</h3>
<div class="note glossUsage note note_note"><span class="note__title">Note:</span> Deprecated acronym for “<strong class="ph b">D</strong>ITA <strong class="ph b">O</strong>pen <em class="ph i"><strong class="ph b">S</strong>ource</em>
<strong class="ph b">T</strong>oolkit”. Use <dfn class="term">DITA-OT</dfn> instead.</div>
</section>
</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title4" id="gloss-extension-point">
<h2 class="title glossterm topictitle2" id="ariaid-title4">extension point</h2>
<div class="abstract 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 <code class="keyword markupname xmlelement">&lt;extension-point&gt;</code>
element in the <span class="ph filepath">plugin.xml</span> file. Other plug-ins can then override the default behavior by
defining custom code that runs when this extension point is called.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title5" id="gloss-option">
<h2 class="title glossterm topictitle2" id="ariaid-title5">option</h2>
<div class="abstract glossdef">Discretionary parameter passed to the Ant process or <span class="keyword cmdname">dita</span> command.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title6" id="gloss-output-format">
<h2 class="title glossterm topictitle2" id="ariaid-title6">output format</h2>
<div class="abstract glossdef">Deliverable file or set of files containing all of the transformed content.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title7" id="gloss-parameter">
<h2 class="title glossterm topictitle2" id="ariaid-title7">parameter</h2>
<div class="abstract glossdef">Command-line argument or option passed to the Ant process or <span class="keyword cmdname">dita</span> command.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title8" id="gloss-plug-in">
<h2 class="title glossterm topictitle2" id="ariaid-title8">plug-in</h2>
<div class="abstract glossdef">Group of related files that change the default behavior of DITA-OT in some way.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title9" id="gloss-processor">
<h2 class="title glossterm topictitle2" id="ariaid-title9">processor</h2>
<div class="abstract glossdef">Software that performs a series of operations to transform DITA content from one format to
another.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title10" id="gloss-property">
<h2 class="title glossterm topictitle2" id="ariaid-title10">property</h2>
<div class="abstract glossdef">Ant-specific argument or option.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title11" id="gloss-template-plugin">
<h2 class="title glossterm topictitle2" id="ariaid-title11">template</h2>
<div class="abstract glossdef">Optional <code class="keyword markupname xmlelement">&lt;template&gt;</code> elements can be added to <span class="ph filepath">plugin.xml</span> files to
define XML or XSL files that integrate DITA-OT extensions. Template files are often named with a
<span class="ph filepath">_template</span> 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.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title12" id="gloss-transformation-type">
<h2 class="title glossterm topictitle2" id="ariaid-title12">transformation type</h2>
<div class="body conbody glossBody"><div class="abstract glossdef">Component of a plug-in that defines an output format.</div>
<section class="section glossAlt"><h3 class="title glossAbbreviation sectiontitle">transtype</h3>
<div class="note glossUsage note note_note"><span class="note__title">Note:</span> Abbreviated form of <dfn class="term">transformation type</dfn>. Use only to refer to the
<span class="keyword parmname">transtype</span> parameter of the <span class="keyword cmdname">dita</span> command, or to the
<code class="keyword markupname xmlelement">&lt;transtype&gt;</code> element in a <span class="ph filepath">plugin.xml</span> file that defines the output
format.</div>
</section>
</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title13" id="gloss-variable">
<h2 class="title glossterm topictitle2" id="ariaid-title13">variable</h2>
<div class="abstract glossdef">Language-specific piece of generated text, most often defined in the files in
<span class="ph filepath">org.dita.base\xsl\common</span>.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title14" id="gloss-template-xslt">
<h2 class="title glossterm topictitle2" id="ariaid-title14">XSL template</h2>
<div class="abstract glossdef">Set of rules in an XSL stylesheet that are applied to nodes that match specific XML structures.</div>
</article></article></article></main></body></html>

16
dita-ot-3.6/doc/reference/html-based-processing.html Normal file
View file

@ -0,0 +1,16 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="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."><meta name="keywords" content="HTML, various output types, pipelines, HTML"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>HTML-based processing modules</title></head><body id="xhtmlwithnavigation"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li class="active"><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li><a href="../reference/html5-processing.html">HTML5 processing</a></li><li><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">HTML-based processing modules</h1>
<div class="body conbody"><p class="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.</p>
<section class="section">
</section>
</div>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../reference/common-html-processing.html">Common HTML-based processing</a></strong><br>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.</li><li class="link ulchildlink"><strong><a href="../reference/xhtml-processing.html">XHTML processing</a></strong><br>After the XHTML files are generated by the common routine, the <code class="ph codeph">dita.map.xhtml</code> target is called by the <span class="keyword option">xhtml</span> transformation. This target generates a TOC file called <span class="ph filepath">index.html</span>, which can be loaded into a frameset.</li><li class="link ulchildlink"><strong><a href="../reference/html5-processing.html">HTML5 processing</a></strong><br>After the HTML5 files are generated, the <span class="keyword option">html5</span> transformation generates a table of contents (ToC) file called <span class="ph filepath">index.html</span>, which can be loaded as a cover page or rendered in a navigation sidebar or menu via CSS.</li><li class="link ulchildlink"><strong><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></strong><br>The <span class="keyword option">eclipsehelp</span> 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 <code class="ph codeph">dita.map.eclipse</code> target is used to create a set of control files and navigation files.</li><li class="link ulchildlink"><strong><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></strong><br>The <span class="keyword option">htmlhelp</span> 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.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/architecture.html" title="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.">DITA Open Toolkit Architecture</a></div></div></nav></article></main></body></html>

16
dita-ot-3.6/doc/reference/html5-processing.html Normal file
View file

@ -0,0 +1,16 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="After the HTML5 files are generated, the html5 transformation generates a table of contents (ToC) file called index.html, which can be loaded as a cover page or rendered in a navigation sidebar or menu via CSS."><meta name="keywords" content="HTML, HTML5, HTML5, CSS, nav-toc, targets, CSS, entry file"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>HTML5 processing</title></head><body id="ID"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li class="active"><a href="../reference/html5-processing.html">HTML5 processing</a></li><li><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">HTML5 processing</h1>
<div class="body conbody"><p class="shortdesc">After the HTML5 files are generated, the <span class="keyword option">html5</span> transformation generates a table of
contents (ToC) file called <span class="ph filepath">index.html</span>, which can be loaded as a cover page or rendered in a
navigation sidebar or menu via CSS.</p>
<p class="p">As of DITA-OT 2.2, the <span class="keyword parmname">nav-toc</span> parameter can be used in HTML5 transformations to embed
navigation directly in topics using native HTML5 elements without JavaScript or framesets.</p>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/html-based-processing.html" title="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.">HTML-based processing modules</a></div></div></nav></article></main></body></html>

33
dita-ot-3.6/doc/reference/htmlhelp-processing.html Normal file
View file

@ -0,0 +1,33 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The htmlhelp 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."><meta name="keywords" content="HTML, CHM, dita.map.htmlhelp, targets, HTML Help, .hhp, .hhc, .hhk"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>HTML Help processing</title></head><body id="xhtmlchm"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li><a href="../reference/html5-processing.html">HTML5 processing</a></li><li><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li class="active"><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">HTML Help processing</h1>
<div class="body conbody"><p class="shortdesc">The <span class="keyword option">htmlhelp</span> 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.</p>
<section class="section">
<p class="p">Once the pre-processing and XHTML processes are completed, most of the HTML Help processing is handled by the
following targets:</p>
<dl class="dl">
<dt class="dt dlterm"><code class="ph codeph">dita.map.htmlhelp</code></dt>
<dd class="dd">Create the HHP, HHC, and HHK files. The HHK file is sorted based on the language of the map.</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.htmlhelp.convertlang</code></dt>
<dd class="dd">Ensures that the content can be processed correctly by the compiler, and that the appropriate code pages
and languages are used.</dd>
<dt class="dt dlterm"><code class="ph codeph">compile.HTML.Help</code></dt>
<dd class="dd">Attempts to detect the HTML Help compiler. If the compiler is found, the full project is compiled into a
single CHM file.</dd>
</dl>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/html-based-processing.html" title="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.">HTML-based processing modules</a></div></div></nav></article></main></body></html>

1
dita-ot-3.6/doc/reference/images/processing-flow.svg Normal file
View file

File diff suppressed because one or more lines are too long
Side by side

After

Width:  |  Height:  |  Size: 18 KiB

114
dita-ot-3.6/doc/reference/implementation-dependent-features.html Normal file
View file

@ -0,0 +1,114 @@
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="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."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Implementation-dependent features</title></head><body id="implementation-dependent-features"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li class="active"><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Implementation-dependent features</h1>
<div class="body refbody"><p class="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.</p>
<section class="section" id="implementation-dependent-features__section_jla_oqn_qc"><h2 class="title sectiontitle">Chunking</h2>
<p class="p">DITA content can be divided or merged into new output documents in different ways, depending on the value of
the <code class="keyword markupname xmlatt">@chunk</code> attribute.</p>
<p class="p">DITA-OT supports the following chunking methods:</p>
<ul class="ul">
<li class="li">select-topic</li>
<li class="li">select-document</li>
<li class="li">select-branch</li>
<li class="li">by-topic</li>
<li class="li">by-document</li>
<li class="li">to-content</li>
<li class="li">to-navigation.</li>
</ul>
<p class="p">When no chunk attribute values are given, no chunking is performed.</p>
<div class="note note note_note"><span class="note__title">Note:</span> For HTML-based transformation types, this is effectively equivalent to select-document and by-document
defaults.</div>
<p class="p">Error recovery:</p>
<ul class="ul">
<li class="li">When two tokens from the same category are used, no error or warning is thrown.</li>
<li class="li">When an unrecognized chunking method is used, no error or warning is thrown.</li>
</ul>
</section>
<section class="section" id="implementation-dependent-features__section_zaa_bgs_qc"><h2 class="title sectiontitle">Filtering</h2>
<p class="p">Error recovery:</p>
<ul class="ul">
<li class="li">When there are multiple <code class="keyword markupname xmlelement">&lt;revprop&gt;</code> elements with the same <code class="keyword markupname xmlatt">@val</code>
attribute, no error or warning is thrown</li>
<li class="li">When multiple prop elements define a duplicate attribute and value combination, attribute default, or
fall-back behavior, the <span class="keyword msgnum">DOTJ007W</span> warning is thrown.</li>
</ul>
</section>
<section class="section" id="implementation-dependent-features__section_kjq_egs_qc"><h2 class="title sectiontitle">Debugging attributes</h2>
<p class="p">The debug attributes are populated as follows:</p>
<dl class="dl">
<dt class="dt dlterm">xtrf</dt>
<dd class="dd">The XML trace filename is used to store the absolute system path of the original source document.</dd>
<dt class="dt dlterm">xtrc</dt>
<dd class="dd">The XML trace counter stores an element counter with the following format:
<pre class="pre codeblock"><code>element-name ":" integer-counter ";" line-number ":" column-number</code></pre></dd>
</dl>
</section>
<section class="section" id="implementation-dependent-features__section_dco_qgs_qc"><h2 class="title sectiontitle">Image scaling</h2>
<p class="p">If both height and width attributes are given, the image is scaled non-uniformly.</p>
<p class="p">If the scale attribute is not an unsigned integer, no error or warning is thrown during preprocessing.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Map processing</h2>
<p class="p">When a <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> element that references a map contains child
<code class="keyword markupname xmlelement">&lt;topicref&gt;</code> elements, the <span class="keyword msgnum">DOTX068W</span> error is thrown and the child
<code class="keyword markupname xmlelement">&lt;topicref&gt;</code> elements are ignored. </p>
</section>
<section class="section" id="implementation-dependent-features__section_h3h_jsx_1h"><h2 class="title sectiontitle">Link processing</h2>
<p class="p">When the value of a hyperlink reference in the <code class="keyword markupname xmlatt">@href</code> attribute is not a valid URI reference,
the <span class="keyword msgnum">DOTJ054E</span> error is thrown. Depending on the
<a class="xref" href="../parameters/parameters-base.html#base__processing-mode">processing-mode</a> setting, error
recovery may be attempted.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Copy-to processing</h2>
<p class="p">When the <code class="keyword markupname xmlatt">@copy-to</code> attribute is specified on a <code class="keyword markupname xmlelement">&lt;topicref&gt;</code>, the content of
the <code class="keyword markupname xmlelement">&lt;shortdesc&gt;</code> element is not used to override the short description of the topic.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Coderef processing</h2>
<p class="p">When <code class="keyword markupname xmlelement">&lt;coderef&gt;</code> 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
<a class="xref" href="extended-functionality.html#code-reference__coderef-charset">Character set definition</a>.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div></nav></article></main></body></html>

Some files were not shown because too many files have changed in this diff Show more