dita2eclipsehelp

Use the dita2eclipsehelp target to generate Eclipse help.

Parameters

args.artlbl
An optional parameter that specifies whether the path and name of the image file are displayed in brackets after the image. The valid values are yes and no. The default value is no.
args.breadcrumbs
An optional parameter that specifies whether bread crumb links are generated in the output. The valid values are yes and no. The default value is no.
args.copycss
An optional parameter that specifies whether to copy the user-specified CSS file to the output directory. (The default DITA Open Toolkit files, commonltr.css or commonrtl.css, are automatically copied to the output directory.) When used in conjunction with the args.csspath parameter, all CSS files are copied to the specified subdirectory. The valid values are yes and no. The default value is no.
args.css
An optional parameter that specifies a user-supplied CSS file. By default, the HTML references either commonltr.css or commonrtl.css. When you specify an additional CSS file using the args.css parameter, that CSS file also is referenced in the <head> of the HTML page. Use this parameter to locate the CSS file on the build system. The following values are valid:
  • A fully qualified file name.
  • A file name. For this to work, you must also issue the args.cssroot parameter.
  • A relative path and file name. For this to work, you must also issue the args.cssroot parameter.
args.csspath
An optional parameter that specifies the path of the @href attribute for the <link> element in the HTML output. This can be useful if you want all the CSS files to be located in a subdirectory of the output directory, or if you want to refer to a CSS file located on a Web server. Valid values are one of the following:
  • A local relative path. Use / as the path separator; do not append a path separator to the end of the value.
  • An absolute path that begins with http:// or https://.
The default value is no path.
args.csspath
An optional parameter that specifies the path of the @href attribute for the <link> element in the HTML output. This can be useful if you want all the CSS files to be located in a subdirectory of the output directory, or if you want to refer to a CSS file located on a Web server. Valid values are one of the following:
  • A local relative path. Use / as the path separator; do not append a path separator to the end of the value.
  • An absolute path that begins with http:// or https://.
The default value is no path.
args.cssroot
An optional parameter that specifies the root directory of a user-specified CSS file. If this parameter is set, the value of the args.css parameter must be a file path relative to args.cssroot.
args.dita.locale
An optional parameter that specifies the locale that is used to sort the <indexterm> elements. The valid values are specified in the string.xml file that is located in the DITAOT\xsl\common directory, where DITAOT is the directory where the DITA Open Toolkit is installed. By default, the value of the first occurrence of the @xml-lang attribute found in the DITA source is used. If no @xml-lang attribute is found, en-us is used.
args.draft
An optional parameter that specifies whether draft comments and the content of <required-cleanup> elements are rendered in output. The valid values are yes and no. The default value is no.
args.debug
An optional parameter that specifies whether the log contains extra debugging information. The valid values are yes and no. The default value is no.
args.eclipse.provider
An optional parameter that specifies the value of providerName in the plugin.properties file. The default value is DITA.
args.eclipse.version
An optional parameter that specifies the version of the Eclipse help. The default value is 1.0.
args.eclipsehelp.toc
An optional parameter that specifies the root name of the Eclipse table of contents (TOC) file. The default value is the root name of the DITA map.
arg.figurelink.style
An optional parameter that specifies how cross references to figures are rendered. The valid values are figure and title. The default value is figure.
args.ftr
An optional parameter that specifies the fully qualified name of a file that contains an XHTML fragment. The fragment is written before the </body> element in the XHTML output. The HTML fragment must have a single root element, such as <div>.
args.gen.default.meta
An optional parameter that specifies whether to "generate extra metadata that targets parental control scanners (meta elements with name="security" and name="Robots')."
args.gen.task.lbl
An optional parameter that specifies whether to generate locale-based headings for <section> elements in task topics. The valid values are yes and no. The default value is no.
args.hide.parent.link
An optional parameter that specifies whether to hide the links to parent topics in the rendered XHTML. The valid values are yes and no. The default value is no.
args.hdf
An optional parameter that specifies the fully qualified name of a file that contains an XHTML fragment. The fragment, often JavaScript, is written in the <head> element in the XHTML output. The HTML fragment must have a single root element, such as <div>. Since a <div> element is not valid in the <head> element, it is not included in the XHTML output.
args.hdr
An optional parameter that specifies the fully qualified name of a file that contains an XHTML fragment. The fragment is written after the <body> element in the XHTML output. The HTML fragment must have a single root element, such as <div>.
args.indexshow
An optional parameter that specifies whether the content of in-line <indexterm> elements is displayed in the body of the text. The content of <indexterm> elements located in the <prolog> are not displayed. The valid values are yes and no. The default value is no.
args.input
An optional parameter that specifies the name and path of the input file. This parameter is case sensitive.
Note: This parameter must be provided if dita.input and and dita.input.dirname are not provided.
args.logdir
An optional parameter that specifies the directory where the generated log files are written. The default value is the output directory.
Note: If you run an aggregated target, for example, the all target that is used by the DITA Open Toolkit demos, the following behavior occurs:
  • If the value of args.logdir is the same for all transformations, the directory specified by the args.logdir parameter is used.
  • If the value of args.logdir varies among the transformations, but the transformations share a common output directory, the generated log files are written to the common output directory.
  • If the values of both args.logdir and output.dir vary among the transformations, the generated log files are written to the basedir directory.
args.outext
An optional parameter that specifies the extension for the XHTML files that are generated. Valid values are any text strings, although htm or html is required by current Web browsers. The default value is html.
args.tablelink.style
An optional parameter that specifies how cross references to tables are rendered. The valid values are number and title. The default value is number.
args.xhtml.classattr
An optional parameter that specifies whether to include information about DITA class ancestry within the generated XHTML elements. The valid values are yes and no. The default value is no.
args.xsl
An optional parameter that specifies the XSL file. The default value depends on the transformation type:
docbook
dita2docbook.xsl
eclipsehelp
dita2xhtml.xsl
htmlhelp
dita2html.xsl
javahelp
dita2html.xsl
pdf
dita2fo-shell.xsl
wordrtf
dita2rtf.xsl
xhtml
dita2xhtml.xsl
basedir
An optional parameter that specifies the directory where the Ant processing begins. If a relative path is used, basedir is set relative to the current directory. If not specified, the default value is the current directory.
clean.temp
An optional parameter that specifies whether the temp directory is erased after each build. The valid values are yes and no. The default value is yes.
dita.dir
An optional parameter that specifies the absolute path of directory where the DITA Open Toolkit is installed. The default value is the current directory.
dita.extname
An optional parameter that specifies the file extension of the files that are written to the temp directory. The valid values are dita, .dita, xml, and .xml. The default value is xml.
dita.input
An optional parameter that specifies the name of the input file. It must be used in conjunction with the dita.input.dirname parameter.
Note: This is deprecated in favor of the args.input parameter.
dita.input.dirname
An optional parameter that specifies the directory that contains the input file. It must be used in conjunction with the dita.input parameter.
Note: This is deprecated in favor of the args.input parameter.
dita.input.valfile
An optional parameter that specifies name and relative path of the DITAVAL file.
dita.temp.dir
An optional parameter that specifies the directory where the temporary files are written. The default value is temp.
generate.copy.outer
An optional parameter that specifies how the DITA Open Toolkit processes files that are neither in the same directory as the DITA map nor in a subdirectory of the directory that contains the DITA map. The following values are valid:
1
Only files that are in the same directory as the DITA map or in a subdirectory of the DITA map are generated.
2
All files are generated, including files that are written to a directory outside of the output directory.
3
The directories are adjusted so that all files are generated within the output directory.
The default value is 1.
onlytopic.in.map
An optional parameter that specifies whether DITA topics that are not referenced in DITA map files are generated. Examples of files not referenced in a DITA map file are topics that are referenced only from <xref> or <link> elements within a DITA file. Valid values are true and false. The default value is false.
outer.control
An optional parameter that specifies how the DITA Open Toolkit responds if files would be generated outside of the output directory. The following values are valid:
fail
The transformation does not run if files would be generated outside of the output directory.
quiet
The transformation runs, but a warning is logged.
warn
The transformation runs; no warning or error is generated.
output.dir
A required parameter that specifies the directory where the DITA Open Toolkit writes the output.
validate
An optional parameter that specifies whether the input files are validated. The valid values are true and false. The default value is true.
Parent topic: Ant targets