Generating DITA from Word Using the Toolkit Plugin
How to use the Word-to-DITA Toolkit Plugin to generate DITA content from Word documents.
To use the transformation as a Toolkit plugin simply deploy the DITA for Publishers Toolkit plugins to your Open Toolkit directory or using the dita install command. The Word-to-DITA transformation type is "word2dita".
Required Parameters
- args.input
- The absolute filename and path of the DOCX file to process.
- w2d.style-to-tag-map
- The absolute filename and path of the style-to-tag mapping to use.
Optional Parameters
- output.dir
- Specifies the absolute path of of the directory to contain the generated output.
- w2d.clean.output.dir
- When set to "true" deletes any files in the output directory before running the generation.
- w2d.filter.br
- When set to any value (e.g., "true"), filters out literal break characters, which are otherwise preserved in the DITA output as DITA for Publishers formatting domain
<br>elements. - w2d.filter.tabs
- When set to any value (e.g. "true"), filters out literal tab characters, which are otherwise preserved in the DITA output as DITA for Publishers formatting domain
<tab>elements. - w2d.root.output.filename
- The filename to use for the root output file (the root map or root topic depending on how your mapping is set up), e.g. "rootmap.ditamap".
- w2d.word2dita.xslt
- Specifies the name of the XSLT transform to use to convert the DOCX file to DITA. Default is the docx2dita.xsl transform in the word2dita Toolkit plugin.
- w2d.debug.xslt
- Turns on debugging of the XSLT transform. Default is "false".
- w2d.media.dir
- Name of the directory to put any media objects extracted from the Word document.
- w2d.root.map.name
- The name for the root map, e.g. "myPubRootmap". Do not include any file extension.
- w2d.root.topic.name
- The name for the root topic, e.g. "myPubRootTopic". Do not include any file extension. This value will be used for the root topic filename and @id value.
- w2d.submap.name.prefix
- The prefix to use for the names of generated submaps. Default is "map".
- w2d.include.word.backpointers
- When set to "true", include @xtrf and @xtrc attributes with the locations of the Word paragraphs that generated each element. Default is "false".
- w2d.include.word.bookmarks
- When set to "true", reflect Word bookmark start and end boundaries in the generated DITA output as <data> elements. Default is "false".
- w2d.filename.prefix
- The prefix to use for all generated filenames, e.g. "pub1234_". Default is no prefix. Use a prefix to ensure that generated map and topic filenames are unique outside the scope of the files generated for a single Word document.
- w2d.submap.name.prefix
- The prefix to use for generated submaps, e.g., "submap_". Default is no prefix.
- w2d.language
- The value to use for the @xml:lang attribute in generated maps and topics. Default is "en-US".
- w2d.generate.navtitles
- When set to "true" generates navigation titles for topicrefs, using the title of the referenced topic. Default is "true".