Localization in Document! X and HelpStudio

In This Topic

Document! X and HelpStudio is the only mainstream Tool to allow you to author multiple languages within a single project.

Define your Topics, Table of Contents and Index Keywords once and manage each language you wish to localize to within the same project. Easily switch between locales and track localization tasks all from within Document! X and HelpStudio.

Movies

Localization Fundamentals

Add a secondary locale to the Project

On the Project Ribbon Tab, click the New Locale button;
On the displayed dialog, choose the Locale that you wish to add to the project;
Click Ok and the new Locale will be added to the Project.

Switch between locales

To switch to another locale, use the Current Locale drop down on the Project Ribbon Tab.

When you switch to another locale, Titles on the Project Explorer and Table of Contents Editor will be shown in that locale and any new editors or project tools you open will open in that locale. The Properties window will also show localizable properties in the current locale.

Localization Issue Indicator

When you are working in a secondary locale and a localization for the current locale cannot be located, HelpStudio will display a localization issue indicator next to the text from the Primary Locale so that you can easily spot the problem.

Localization Issue Indicator on the Project Explorer

Localization Issue Indicator in the Properties Window

Hover your mouse over the localization issue indicator to see a list of locales with missing or out of date localizations.

Open a Topic for edit in a specific locale

To open a Topic for edit in a specific Locale without changing the current locale, right click on the Topic in the Project Explorer and select the required Locale from the Edit (Other Locale) sub-menu.

The Topic Editor will open for the chosen Locale.

Open a Content File for edit in a specific locale

To open a Content File for edit in a specific Locale without changing the current locale, right click on the Content File in the Project Explorer and select the required Locale from the Edit (Other Locale) sub-menu.

The Content File Editor will open for the chosen Locale.

To build an output for a secondary locale

Click the Build button on the Project Ribbon Tab;
Tick the secondary locales you wish to build;
Click the Start Build button.

The output generated for secondary locales is named with a suffix corresponding to the locale. For example if you are generating a help file named myhelpfile.chm then the file name generated for a German secondary locale would be myhelpfile.de-DE.chm and the web output would be generated to a \de-DE sub-directory of the chosen output folder.

To check for outstanding localization work

As you make changes to localizable content in your HelpStudio project, the change date is recorded. This enables HelpStudio to track which secondary locale content is out of date with respect to the Primary Locale.

You can view the list of outstanding localization work in the Project Locale Editor:

On the Project Explorer, select the secondary locale you wish to view outstanding localization work for;
Click the Project Explorer toolbar button;
The Project Locale Editor will be opened for that locale;
Select the Localization Report page;
Click the Execute button;
A list of localizable content which has been modified in the Primary Locale more recently than the secondary locale will be displayed.

Navigation Bar

When you open an item from the results grid (e.g. by double clicking), a Navigation Bar will be opened above the document tab area:

Example Navigation Bar

The navigation bar makes it easy to step through the items on the results grid.

Click the < button to move to the previous item in the results grid.
Click the > button to move to the next item in the results grid.

Export content for translation

If you wish to use a translation company to localize your content, you can take advantage of the Export and Import functionality in Document! X and HelpStudio.

To export content for translation:

On the Project Explorer, select the secondary locale you wish to export content for;
Click the Project Explorer toolbar button;
The Project Locale Editor will be opened for that locale;
Select the Export page;
Select the desired export options;
Click the Export Now button.

The export will generate a set of Xml files in the nominated directory. You can send these files to your translation company and once they have been translated and returned you can use the Import functionality to bring the translated content back in to your Document! X and HelpStudio project.

If you are sending content to a translation company, it is recommended that you use the XLIFF export format. This is an industry standard translation interchange format that your translation company should be familiar with and can work with easily.

Import translated content

Once you have received back from your translation provider some translated content previously exported using the Export content for translation process, you can import that translated content back in to your project:

On the Project Explorer, select the secondary locale you wish to import content for;
Click the Project Explorer toolbar button;
The Project Locale Editor will be opened for that locale;
Select the Import page;
Select the Folder containing the translated Xml files returned by your translation provider;
Click the Import Now button.

The translated content will be imported back in to your project and any builds you now perform for the secondary locale will include the translated content.

Send Feedback