Word-to-DITA XSLT Transformation Parameters

Required and optional parameters for the Word-to-DITA XSLT transformation

To run the docx2dita.xsl transformation outside the Toolkit use the XSLT parameters shown here.

Required Parameters

outputDir
The directory to put generated output in. Should be an absolute URL.
styleMapUri
The URI of the style-to-tag map to use. Should be specified as an absolute URL, e.g., "file://workspace/word2dita/xsl/mystyle-to-tag-map.xml".

Optional Parameters

chartsAsTables
When set to "true", treat embedded Word charts as tables. Puts the data for the chart into a DITA table. Default is "false" (charts will not be reflected in the DITA result).
fileNamePrefix
The prefix to use for generated filenames other than subordinate maps. Default is "" (no prefix).
filterBr
When set to "true" filters out all literal break characters. If not specified, all literal breaks in the word document are preserved in the intermediate transform and, by default, in the resulting DITA XML (using the DITA4Publishers <br> element from the formatting domain).
filterTabs
When set to "true" filters out all literal tab characters. If not specified, all literal tabs in the word document are preserved in the intermediate transform and, by default, in the resulting DITA XML (using the DITA4Publishers <tab> element from the formatting domain).
generateNavtitles
When set to "true", generated topicrefs will have navigation titles reflecting the titles of the referenced topics. Default is "true".
imageFilenamePrefix
The prefix to use for filenames for images referenced by the generated DITA markup. Use this parameter ensure that the filenames for referenced images will be unique outside the scope of the XML generated from the Word document. For embedded images that are not linked to an external graphic, the filenames are always of the form "image1.xxx", "image2.xxx", etc. The default is no prefix.
includeWordBackPointers
When set to "true", the resulting DITA files include @xtrc attributes that contain XPath expressions that locate the Word paragraph element from which the DITA element was generated. Set to "false" to turn this off. Default is "true" (@xtrc attributes are generated).
includeWordBookmarks
When set to "true", the resulting DITA files include <data> elements that reflect the bookmark start and end markers. This can be useful in debugging cross reference processing or other uses of bookmarks. The default is "false".
language
Specifies the value to use for the @xml:lang attribute, e.g. "ja-JP". If not specified, the value "en-US" is used.
mapNumberFormat
The number formatting string, as for the <xsl:number> instruction, to use when generating map filenames. The default is "_1_1", which produces names like "map_1_1.ditamap". Use a value of "_01_01" to get filenames like "map_01_02.ditamap". Used by the default map URL construction logic.
mediaDirUri
The URI of the folder to put graphics in (determines the value of @src and @href attributes for generated graphic references). Default is "topics/media" under the main output directory.
rawPlatformString
The operating system platform as provided by the Ant os.name property. Default is "unknown".
rootMapName
The name (without extension) to use for the root map. Default is "rootmap".
rootMapUrl
The full filename the root map. Constructed from the rootMapName parameter by default.
rootTopicName
The name (without extension) to use for the root topic.
saveIntermediateDocs
When set to "true", saves the intermediate documents created during the transformation process to the file system for debugging purposes. Default is "false" unless "debug" is also set to "true".
submapNamePrefix
The prefix to use for the filenames of generated submaps. Default is "map".
tableWidthsProportional
When set to "true" generates tables with proportional column widths rather than absolute measurements. The default is "false", which uses the actual column width measurements from the Word table.
topicExtension
The filename extension to use for topics. Default is ".dita".
topicNumberFormat
The number formatting string, as for the <xsl:number> instruction, to use when generating topic filenames. The default is "_1_1", which produces names like "topic_1_1.dita". Use a value of "_01_01" to get filenames like "topic_01_02.dita". Used by the default topic URL construction logic.
useLinkedGraphicNames
Use the names of linked graphics for graphic references when present. Note that Word documents can include images that are not linked to external file. In this case the images will have filenames like "image1.xxx". Default is "false".
warnOnUnstyledParas
Issue warnings for Word paragraphs that do not have any associated style. Default is "false". Unstyled paragraphs will map to DITA <p> by default so it is not strictly necessary to style all paragraphs in the Word document.