Home » Tutorials

Building translated Help and Manual projects

Once translation for your Help & Manual project is complete, Translation Assistant can generate the translated help project.

To do this, open Translation Assistant and click on Output H&M.

Note: Translation Assistant needs to read the original H&M project in order to build the translation.

Translation Assistant will take the project structure from the original help project and the translations and create a new Help and Manual project for each language. Each translated project will go to a different directory.

Then, open each translated help project with Help and Manual and generate the help file.

This clip shows the entire process:

Read the rest of this tutorial »

Updating the translation when the help project updates

Translation Assistant makes it easy to keep documentation up-do-date in all languages.

When the help project updates, Translation Assistant will find exactly what’s changed and have it translated.  This includes changes to existing help topics and new help topic.

In both cases, Translation Assistant finds the sentences that need update and send them to your translator. When translation is complete, it will rebuild the translated Help and Manual project in all languages, ready to be published.

Steps to follow

  1. Open Translation Assistant and select the help project.
  2. Click on the New revision button.
  3. Select the Help and Manual project (can be the original, edited, Help and Manual project).
  4. Translation Assistant scans it and looks for changes. Complete the project and upload.

You should see that the word count for translation reflects the new and modified texts. The translator will only need to edit those texts and you only pay for the update work.

This clip shows it all in action:

Read the rest of this tutorial »

How to translate Help & Manual projects

This tutorial shows how to use Translation Assistant to translate Help & Manual projects. When we’re done, we’ll have several Help & Manual projects, each one in a different language.

This video, shows all these steps in action on Help and Manual and Translation Assistant.

Creating the translation project

1) Create an account and download Translation Assistant

Translation Assistant is available to download for all users. To create an account, go to the new account page.

Once you’re logged in to your account, click on the Download Translation Assistant button, located at the top of every page. Then, install Translation Assistant on your PC.


2) Log in through Translation Assistant to your account

When Translation Assistant starts it will ask you to log in. Use the same email and password you use to log in to icanlocalize.com.

3) Create a new Help & Manual translation project from Translation Assistant.


First, you’ll be asked to name the project.

Then, Translation Assistant will ask you to select the Help & Manual project file (.hmxp). This fill will be in the root folder of your Help & Manual project.

Note: if your Help and Manual project is saved with an extension .hmxz, you first need to convert it to an uncompressed project. Open the project in Help and Manual, click File->Save as… and choose uncompressed (hmxp).


Next, you’ll select the language you’re translating from.

The last step of the project setup wizard lets you choose what pages on the Help & Manual project need to be translated. Normally, you should leave all pages selected.

Click on Finish to complete the setup wizard.

Choose translators and pay for the work

4) Upload the project to ICanLocalize and complete the project setup

Click on the Upload button in the project control panel.


Translation Assistant will upload the project to your ICanLocalize account. Then, you need to complete its settings.

These include:

  • Description for the project (so that translators will know what the help manual is for).
  • Translation languages.
  • Required fields of expertise.
  • Bidding restrictions.


At the end of that page, you’ll find a button to release to translators. Once a project is released, you’ll start getting applications from qualified translators.

Choose the translators you prefer and deposit the payment for the work.

Then, translation begins.

Creating the translated Help & Manual projects

When translation is complete, you will receive a notification from our system.

Translation Assistant will download the completed project. Click on Output Help & Manual to create the translated help project.


You will receive an identical project to your original, only with translated contents.

Updating the translations when the help project changes

Over time, your help project is likely to update. Translation Assistant can detect what’s new and help you update the translations.

Click on New revision to scan for changes in your help project.


Translation Assistant will identify new and updated texts in the help project and will mark only those for translation.

Repeat the same process as before for uploading and releasing the project for translation.

Getting started

To translate your Help & Manual project using Translation Assistant you’ll need to have an account at ICanLocalize. You only need to pay when you choose translators and the work begins.

Read the rest of this tutorial »

How to exclude WordPress shortcodes from translation

Many WordPress websites use shortcodes. Until now, clients were required to explain these shortcodes to translators in order to prevent accidental translation of these codes. New developments in ICanLocalize allow clients to enter a list of shortcodes, which are automatically blocked by the system during translation. In this way, clients will not be required to pay for the translation of these words and translators will not need to worry about what not to translate.

How to enter your list of shortcodes to be excluded?

ICanLocalize now allows you to create a list of shortcodes that are required to be excluded for each website.

When your website project is fully set up in WPML (after activating ICanLocalize as your translation service), go to WPML >Translation Management, scroll down to the ICanLocalize account status box, and click on the “Project Page” link.




The project page will pop up. Scroll down to the bottom of the page to reach the Project Administration section and click on the Blocked shortcodes list button.




In this list, you will see two sections: your website’s shortcodes and Global shortcodes.




Your website’s shortcodes: Specific shortcodes that belong to your project. These can be added, enabled, disabled, edited, and deleted by you.

Global shortcodes: Default shortcodes implemented for all projects in ICanLocalize. These can be disabled anytime for your project but cannot be edited or deleted.

Adding a new shortcode to your project

To add a new shortcode to your project, go to your website’s shortcodes section and click on New Shortcode.




The following dialog box will appear prompting you to enter the shortcode and choose its type.
Fill in the blanks with the shortcode information and click on the Save button.




  • Shortcode: Only enter the text inside the square brackets without the actual brackets.
  • Type of shortcode:
  • Atomic– A shortcode that does not require a closing shortcode, e.g., .
  • Open and close– A shortcode that requires a closing shortcode but the text between the two shortcodes is required to be translated, e.g., [message]This is important[/message].
  • Open, exclude, and close– A shortcode that requires a closing shortcode and the text between the two shortcodes is required to be excluded from the translation. For example, [code]SOME CODE EXAMPLE[/code].
  • Comment: Any comment that you wish to add to differentiate the shortcode from others or as a reminder.

Once your list of blocked shortcodes is fully set up, you are ready to send your content for translation from WPML. The shortcodes that are included and enabled in your list will not be counted in the word count; hence, you will not be charged for those shortcodes.

The system will also guarantee that any shortcodes that appear in the original text will be unchanged in the translation.

NOTE: Shortcodes must be set up in ICanLocalize before sending the content for translation from WPML. The system detects shortcodes in the text when the content is sent for translation. If the content is sent for translation and the list of “blocked shortcodes” is updated later, the content that was already sent will not be affected.

To learn more about how to exclude shortcodes, check this video tutorial:

Read the rest of this tutorial »

iPhone and iPad Apps Localization Guide

This guide will show you how to convert a single-language iPhone application, built with Xcode, into a multilingual application.

Read the rest of this tutorial »

Android Localization Tutorial

In this tutorial we show how to write multilingual Android apps.

To build multilingual Android apps you need to collect the texts into resource files and translate them.

Once you provide the translation, Android OS will choose the resources that match user’s locale. If your application is available in several languages, Android will select the language that the device uses.

Read the rest of this tutorial »

How to Translate plist Files

plist (Property List) is a flexible and convenient format for storing application data. It was originally defined by Apple, for use in iPhone devices and later spread to other applications.

Since plists are actually XML files, you can use a simple text editor to translate them. However, doing so is very tricky as even one character in the wrong place will make the file unusable.

Instead, ICanLocalize allows translating plist files as part of a Software Localization project. A parser will go through the plist file. It will extract all the texts that need translation and make them available to the translators. Translators will translate only the texts, without worrying about the file format.

When translation is complete, the new plist file is created. It has the exact same structure as the original file and only the right fields translated.

Read the rest of this tutorial »

How to Translate With GetText PO and POT Files

GetText Portable Object (PO) files are the industry standard for multilingual websites in PHP.

Read the rest of this tutorial »

Simple Translation Management for Mobile Apps

Managing translations for mobile applications is a big challenge for developers. ICanLocalize invites you to use our software localization system for free and make this process easy and simple. If you decide to use a reviewer from ICanLocalize, it will cost 0.045 USD/word.

Does this scenario sound familiar?

  1. You have users from all over the world, eager to help with translation.
  2. You don’t have time to coordinate and organize translation work.
  3. It’s impossible to tell which translators are actually good.

If that’s the case, you’re going to love our software localization system!

Read the rest of this tutorial »

Translation of Popular iPhone and Android App Keywords

Not sure how to translate basic terminology in iPhone or Android Apps? Before you invent the wheel, find the phrase here and see how ICanLocalize recommends to translate it.

Read the rest of this tutorial »

ICanLocalize - Running a Multilingual Software Business

Localizing software is a great way for rapidly multiplying your income. We’ll go over the different activities required to localize software and explain how they can be done with ICanLocalize.

Read the rest of this tutorial »