Skip to main content
MindTouch Success Center

Translation Guidelines

Consider language codes, file formats, and non-translatable content when translating content exported from your MindTouch site.

Language Codes

MindTouch uses a 5-digit language code that includes language and region. This form is most commonly used among translation vendors. For example:

  • en-us   (English, United States)
  • fr-fr      (French, France)

Files and package structure

File formats: The MindTouch export package includes an array of file formats, including .html, .png, .json, .csv, .dat, .css, .mtarc, .xml and other associated files. Do not translate or modify .dat, .css, .mtarc and .xml files.

Customer designated files: Site administrators can use the classification translationstatus: to specify which .html pages should and should not be translated. We recommend the following options:

  • translationstatus:notranslate
  • translationstatus:queued
  • translationstatus:inprogress
  • translationstatus:complete

The translationstatus: classification would be included on the bottom of each .html page, under the heading Page Tags. The classification is always preceded by the <a mt-export-translate="no"> attribute.

Page deletion, page addition and hierarchy persistence: The package hierarchy is referenced as part of the export file package.xml. Modifications to the hierarchy in package.xml, additions of new pages, or deletions of existing pages may cause an error in the import process. Do not delete or add pages in the exported package.

Features in archives and associated files: Some archives and associated files are unique to MindTouch.

Archive file type File name Translatable?
Manifest package.xml X
Site structure hierarchy.dat X
Groups groups.dat X
Templates page.html
Content (pages, tags, attachments, page properties, file properties) page.html
Permissions security.dat X
Guide tabs guideTabs.json
Context IDs contextswithmaps.csv
Query recommendations queryrecommendations.csv
Learning paths learningpathpages.csv X
  learningpaths.csv

 

Unzipping the archive.zip file for translation: There are two compression tools that work well when unzipping your MindTouch archive.

Packaging the archive.zip file for import: When compressing your MindTouch archive, make sure to grab the appropriate files. Do not zip the parent folder or your archive will not import successfully. Select the following files:

Blacklisted (non-translatable) content

MindTouch does not support changes made to non-translatable content. To maintain the integrity of the MindTouch site and to ensure MindTouch can support translated content, do not translate any of the content listed below.

mt-export-translate="no" attribute: Do not translate content in page.html that includes the attribute.mt-export-translate="no". Modification of content associated with this attribute may cause errors upon import.

<pre> sections: Since MindTouch keeps most custom code (DekiScript, JavaScript, CSS) in <pre> tags, do not translate anything in a <pre> tag. Also, leave DekiScript text inside double curly braces {{dekiscript}} untouched.

<pre>These sections are used for MindTouch code and should not be translated or removed</pre>

<head> sections: This <head> section is MindTouch metadata and should not be translated. The <title> in this section has no effect on the name of the page. A page title can only be changed by translating the <h1> header.

<head>
    <meta name="mt-name" value="value"></meta>
    <title>My Page</title></head>

Conditional content: While conditional content can be translated, the MindTouch proprietary code below should remain unchanged.

<div class="mt-style-conditional style-wrap" if="user.anonymous">
    <p>Conditional content!</p>
</div>

Inline DekiScript: Proprietary DekiScript code (in double curly brackets) should remain unchanged.

{{ if(user.anonymous) { "Hello Stranger!"; } }}

Structured tags: Do not translate tags containing a colon (:) . These structured tags are predefined in the system, and translated versions are not understood by MindTouch. In the example below, the text article:stage should not be translated.

<p class="template:tag-insert">
    <strong>Page tags: </strong>
    <a>article:stage</a>
</p>

URLs: The MindTouch export format includes a URL and title for each page. Whether the path and page title are identical or not, do not translate URLs. Maintaining the URL structure is crucial for auto-relating multilingual content during future information architecture developments. The following example demonstrates how a URL and title should look before and after a translation:

  Before translation After translation
URL <Company domain>/security/product_guide/get_started <Company domain>/security/product_guide/get_started
Title Get started Introducción

Whitelisted (translatable) content

Page titles: Translate page titles (the display name of the page) by translating the <h1> text. Do not modify the "mt-export-title" class.

<h1 class="mt-export-title">My Page</h1> 

Conditional content: Conditional content inside <p> tags is translatable. Do not modify any div attributes such as if="user.anonymous".

<div class="mt-style-conditional style-wrap" if="user.anonymous">
    <p>Conditional content!</p></div>

Tags: Tags are displayed at the bottom of a page. Verify whether tags are to be translated. Since tags are often used to categorize and organize pages, it may not be desirable to translate all tags. Do not modify the class name template:tag-insert as it is an important MindTouch element. Only translate text inside <a> tags.

<p class="template:tag-insert">
    <strong>Page tags:  </strong>
    <a>tag1</a>
    <a>tag2</a>
    <a>tag3</a>
    <a>tag4</a>
</p>

Guide tabs: Guide tabs are found in the guidetabs.json file. Only translate templateTitle content. (In the example below, only the text "Article directory" and "Tag directory" should be translated.)

[
  {
    "guid": "1ee90735-0631-d747-178f-402f3b263cb7",
    "templatePath": "MindTouch/IDF3/Views/Article_directory",
    "templateTitle": "Article directory"
  },
  {
    "guid": "6232706f-1cf3-cc22-fd6e-195e013abab5",
    "templatePath": "MindTouch/IDF3/Views/Tag_directory",
    "templateTitle": "Tag directory"
  }
]

Context IDs: Context IDs are stored in the contextswithmaps.csv file. Only translate Description content. (In the example below, only the text "Add file attachments to a page." should be translated.)

ContextId,Description,Language,PageTitle
addfiles,Add file attachments to a page.,en-us,MindTouch_Guide/Manage_content.
addnewpage,,en-us,
adminguide,,en-us,
advancedbranding,,en-us,
advsearch,,en-us,Success_Center_notices/002_January_2016/​

Query recommendations: Query recommendations (or search recommendations) are stored in the file queryrecommendations.csv. Only translate Terms and Title content. (In the example below, only the text "editor how to use", "using the editor", "a add user", "add users" and "articles" should be translated.)

Terms,Title,PageTitle
editor how to use,using the editor,Quick_Start_Guide/The_MindTouch_editor
a add user,,MindTouch_Guide/Manage_users_&_groups/Add_users
add users,,MindTouch_Guide/Manage_users_&_groups/Add_users
articles,,MindTouch_Guide/Manage_content./Best_Practice:_Identify_Articles

Learning paths: Learning paths are stored in the file learningpaths.csv. Only translate Title , Summary and Category content. There is another learning path file, titled learningpathpages.csv. Do not update this file.

Name,Title,Summary,Category
learn_search,All about search,Help your users self-serve through search:,Search
learning_path_experience,Create a learning path experience,Follow our step-by-step process.,Learning paths
create_text_templates,Create text templates,Create content templates you can call in the text editor.,Templates

Comments: Editor Comments can be translated but may not be needed in localized pages. If not needed, we recommend you mark them to not be translated.

  • Was this article helpful?