How to Index Japanese Content

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.

Restriction: The Kuromoji analyzer does not work if your WebHelp output is accessed locally. In this scenario, a warning message will be displayed informing you that the Kuromoji analyzer is disabled. It is possible to hide this warning message by using a transformation parameter named webhelp.enable.search.kuromoji.js. By default, its value is yes, which means the Kuromoji analyzer is enabled by default. To hide the warning message, set the value of that parameter to no using either of the methods listed below. When it is set to no, the Kuromoji analyzer is disabled even if you deploy your WebHelp output on a web server.

Using a Publishing Template

To add a logo in the title area of your WebHelp output using an Oxygen Publishing Template, follow this procedure:

If you have not already created a Publishing Template, see How to Create a Publishing Template.

Open the template descriptor file associated with your publishing template and add the default.language parameter in the parameters section with its value set to ja-jp.

<publishing-template>
    ...
    <webhelp>
        ...                
        <parameters>
            <parameter name="default.language" value="ja-jp"/>
        </parameters>
    </webhelp>

Open the DITA Map WebHelp Responsive transformation scenario.
Click the Choose Custom Publishing Template link and select your template.
Click OK to save the changes to the transformation scenario.
Run the transformation scenario.

Using a Transformation Scenario in 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:

Edit a DITA to WebHelp transformation scenario and in the Parameters tab, set the value of the default.language parameter to ja-jp.
Note: Alternatively, you could set the @xml:lang attribute on the root of the DITA map and the referenced topics to ja-jp. Another alternative for DITA output is to use the webhelp.search.japanese.dictionary parameter to specify a path to a Japanese dictionary that will be used by the Kuromoji morphological engine (note that the encoding for the dictionary must be UTF8).
Run the WebHelp transformation scenario to generate the output.