How to Index Japanese Content in WebHelp ClassicEdit online
To optimize the indexing of Japanese content in WebHelp pages, the Lucene Kuromoji Japanese analyzer can be used. This analyzer is included in the Oxygen XML Editor/Author installation kit.
Using Oxygen XML Editor/Author
To activate the Japanese indexing in your WebHelp output using a transformation scenario
from within Oxygen XML Editor/Author, follow this procedure:
- Set the language for your content to Japanese (depending on your framework):
- DITA: Edit a DITA to WebHelp transformation scenario
and in the Parameters tab, set the value of the
default.languageparameter toja-jp.Note: Alternatively, you could set thexml:langattribute on the root of the DITA map and the referenced topics toja-jp. Another alternative for DITA output is to use thewebhelp.search.japanese.dictionaryparameter to specify a path to a Japanese dictionary that will be used by the Kuromoji morphological engine. - DocBook: Edit a DocBook to WebHelp transformation
scenario and in the Parameters tab, set the value of the
l10n.gentext.default.languageparameter toja.
- DITA: Edit a DITA to WebHelp transformation scenario
and in the Parameters tab, set the value of the
- Run the WebHelp transformation scenario to generate the output.
Using a Script Outside of Oxygen XML Editor/Author
Important: Running WebHelp transformations from a script outside of Oxygen XML
Editor/Author requires an additional license and some additional setup:
- You must have a valid license for the Oxygen XML WebHelp Plugin (https://www.oxygenxml.com/buy_webhelp.html).
- The Oxygen XML WebHelp Plugin must be installed and integrated for the DITA Open Toolkit or a DocBook XSL Distribution.
To activate the Japanese indexing in your WebHelp output using a script outside of
Oxygen XML Editor/Author, follow this procedure:
- Set the language for your content to Japanese (depending on your framework):
- DITA: Use the
args.default.languageparameter in your transformation script and set its value toja-jp.Note: Alternatively, you could set thexml:langattribute on the root of the DITA map and the referenced topics toja-jp. Another alternative for DITA output is to use thewebhelp.search.japanese.dictionaryparameter to specify a path to a Japanese dictionary that will be used by the Kuromoji morphological engine. - DocBook: Use the
l10n.gentext.default.languageparameter in your transformation script and set its value toja.
- DITA: Use the
- Execute the transformation script.
For example, a DITA script might look like this::
- Windows:
dita.bat -i c:\mySample.ditamap -f webhelp -Dargs.default.language=ja-jp - Mac OS X/ Linux:
dita -i /mySample.ditamap -f webhelp -Dargs.default.language=ja-jp