XMetaL Tips and Tricks

XMetaL Community Forum XMetaL Tips and Tricks Localization support in the DITA Open Toolkit

  • Su-Laine Yeo

    Localization support in the DITA Open Toolkit

    Participants 1
    Replies 0
    Last Activity 12 years, 5 months ago

    The DITA Open Toolkit (DITA OT), a component which is used for generating output from DITA documents in XMetaL Author Enterprise Edition, includes various configurable features to support localization. This article summarizes where to find documentation on these features.

    Identifying the Language of Your Content
    For instructions on identifying the language of non-English documents so that the DITA Open Toolkit can process them correctly, see [url=http://forums.xmetal.com/index.php/topic,953.0.html]DITA: Indicating the language of content for DITA processing[/url].

    Generated Text
    The DITA OT can implement appropriate generated text, such as “Note:” at the beginning of elements for English and “Nota:” at the beginning of elements for Spanish, for each locale. For details, see [url=http://forums.XMetaL.com/index.php/topic,947.msg2977.html#msg2977]Editing “generated text” strings for DITA output[/url] for details.

    Font and Character Support
    No single font is optimal for all languages. By default, the DITA OT uses different fonts for different locales. For PDF output, you might need to change some settings in order for fonts to appear. See: 

    • [url=http://forums.XMetaL.com/index.php/topic,968.0.html]Troubleshooting Japanese and Simplified Chinese PDF output for DITA[/url]
    • [url=http://forums.XMetaL.com/index.php/topic,965.0.html]Patch for making headings use the correct font in PDF output[/url]

    See also: [url=http://forums.XMetaL.com/index.php/topic,98.msg262.html#msg262]DITA: Configuring XMetaL Author Enterprise to Generate Localized CHM Files[/url].

    Online Help Systems
    If you are creating an online help system, you can make text on the help system’s buttons and tabs appear in the correct language. However, this does not happen automatically.

    For WebHelp, strings used in buttons and tabs are stored in the DITA_OTdemowebhelpcustomizationcommonindex.html file. This file is preconfigured for English only. To produce WebHelp in another language, make a copy of this file, translate the English strings into the required language, and replace the original index.html file with the translated index.html file before you generate WebHelp output.

    For Microsoft HTML Help (CHM) files, a different procedure is required. See [url=http://forums.XMetaL.com/index.php/topic,98.msg262.html#msg262]DITA: Configuring XMetaL Author Enterprise to Generate Localized CHM Files[/url].

    Index Sorting
    Indexes and glossaries are sorted according to locale-specific rules. For details, see [url=http://forums.xmetal.com/index.php/topic,972.msg3038.html#msg3038]Troubleshooting non-English indexes in DITA output[/url].

    Text Direction
    Some languages, such as Arabic and Hebrew, must be displayed right-to-left instead of left-to-right. For non-PDF outputs, the DITA OT does this automatically based on the xml:lang attribute in the content. The preconfigured language files for PDF output do not include any right-to-left languages. It is possible to add support in PDF output for right-to-left languages, however we do not know of any publicly-available documentation on how to do it.


  • You must be logged in to reply to this topic.

Lost Your Password?