ClickHelp User Manual

Create Multi-Language Documentation

ClickHelp User Manual/Create Multi-Language Documentation

ClickHelp features a whole ecosystem for translating and localizing content allowing you to present your documentation portal and the documentation in multiple languages without going the extra mile by using third-party translation/localization systems.

Localization Terms

Before diving further into documentation, it's important to understand what is meant by a specific term in ClickHelp. Below you will find a full list of terms related to the localization/translation workflow:

Base language The original language that you create the content in. When you create the first base project in a certain language, a copy of the Home page, global variables, and global settings are created for this language.
Translation language The language that you translate your content into.
Base project A project in your base language.
Base publication A publication of a project in your base language. All translation publications will be linked to this kind of publication.
Translation project The translation of the X project — version of your base project in another language.
Translation publication The version of your base publication in another language.
Translator dashboard A centralized place to overview, search and manage translations.
Translator  An Author with a specific set of permissions with the Translator role. Сounts against the Author license.
Translation document A single translation file - a topic, a home page, a set of settings, etc. It consists of translation units. It can be thought of as equivalent to an XLIFF or a PO file.
Translation unit A single structural part of the text — a single sentence, content from a single table cell, etc., from a translation document. Not necessarily a piece of text —  it can be an image as well.
Translation status  Workflow status of a translation document.
Translation unit state  Workflow state of a translation unit.
Translation editor  A specialized editor for working with translation documents, i.e., translating content.

Translation Document Status vs. Translation Unit State

Translation document status or simply translation status is a workflow status of a translation document. It is very similar to a topic status in this regard - it is a status that shows the current workflow state of the whole document. There are five statuses by default: Needs TranslationDraft TranslationIn TranslationTranslation Review, and Ready Translation. These statuses are used to clearly define the state of a given document and used in the reports: for example, the Project Readiness by Topics Report.

Translation unit state is the workflow status of a single translation unit. Translation units utilize a simplified workflow and have only three states by default: Needs TranslationTranslation Review Needed, and Final.

Automatic translation document status and translation unit state changes

Translation statuses and states can change automatically

When the content changes in the base project, the state of the corresponding translation unit changes to Needs Translation. In addition, the corresponding translation document changes its status in one of the following ways:

  • Translation document gets returned to the Translation Needed status if the base topic has the Ready status.
  • Translation document gets returned to the Draft Translation status if the base topic has any other status besides Ready.

When you change the status of a topic in the base project to Ready, the corresponding translation document's status changes to Translation Needed. The opposite is also true — when you change the base topic's status to any status besides Ready, the corresponding translation document's status changes to Draft Translation.

What Can Be Translated / Localized

You can translate pretty much everything your readers will see: the Home Page, the Reader Menu, different elements of the Reader Interface, email notifications, and, of course, the content.  

There are global entities like the Home Page, and there are project entities like index keywords or the topic content, but in both cases, when you create a translation project, a translation for all of the entities is created. You can see the full list of translatable entities on the Translator Dashboard.

Topic content

Topic content usually makes up a large part of the translation process. You can start translating it by opening a translation project from your Author Dashboard or finding a specific topic on the Translator Dashboard

TOC nodes

In most cases, there's no need to localize the TOC nodes since they inherit the title from topics they are tied to. But there are two cases when you can localize TOC nodes:

  • When the TOC node is a folder, it's not tied to any topic and hence gets its own unique title;
  • When the TOC node is specified to have a Custom Caption in the topic properties.

In both cases, you can find the TOC nodes on the Translator Dashboard.

Portal and project settings

There are plenty of pieces of content from the Portal and Project Settings like Master Page content, Variables, Reader Menu items, and Index Keywords that you can translate. You can access all of these entities for translation from the Translator Dashboard. To learn more detailed information, please read the Translate Settings and Metadata section.

Images and files

Images can be localized with the Translation Editor, although there is a second option that works for files as well. To learn more, read the following topic: Localize Images and Files.

Reader UI

The authoring interface in ClickHelp is not subject to translation, and the environment is always in Engish. However, the Reader Interface can be localized. Read more about it in the Translate Reader UI topic.