Wiki translation guide

This page explains how to translate wiki pages using the Translate extension.

Instructions for translating pages

Pages that have been marked for translation have a languages bar at the top of the page, like this:

In order to begin translating, first click on the "Translate this page" text above the bar.
You will then be taken to the Translate tab for the page, which contains a list of the sections or units to be translated. Select the appropriate language to be translated to (i.e., "中文" for Chinese) in the top right corner of the page where it says "Translate to".
The page will then refresh to show the units to be translated for the selected language, as seen in the image below. You can select whether you want to see All, Untranslated, Outdated, or Translated units only. To translate a unit, click anywhere on the unit.
Once a unit title is clicked on, you can input the translation in the box below the original text, as seen in the image below. If the option to "Paste Source Text" appears, clicking on it will copy the original untranslated text into the translation box.
Once the translation has been inputted, click Save Translation.
- Skip to next will simply skip to the next unit without saving the current unit.
- Clicking on the X button in the top right corner of the unit will simply close the unit without saving.

Translation Guidelines

The names of classes, properties, methods, and parameters refer to elements of the ADE API. They should stay the same and not be translated. Most section headings contain these names, and so should not be translated. Similarly, code samples should not be translated.

Code and Fixed-Width Text

Don't translate text in tags as well as text between the following tags:

<tt></tt>
<code></code>
<pre></pre>

Lines that begin with a space are also not translated.

This text is software code and does not change for different languages. For example:

Before Translation	After Translation
`Water <code>Water</code>`	`水 <code>Water</code>`
`Water <tt>Water</tt>`	`水 <tt>Water</tt>`
`Water <pre>Water</pre>`	`水 <pre>Water</pre>`
Water 1 Water 2 Water 3 Water 4	水 1 Water 2 Water 3 水 4

Links

Translate link names, but not links. Links appear in double square brackets like so: [[Link]] or [[Link | Link name]]. If a link goes to a page in the ADE User Guide, then the link should be updated to link to the Chinese version of the page. In general, to link to the Chinese version of a page, the link must be updated to Link/zh.

For example:

Before Translation	After Translation
`[[ADE User Guide]]`	`[[ADE User Guide/zh \| ADE用户指南]]`
`[[CAEngine]]`	`[[CAEngine/zh \| CAEngine]]`
`[[Analytica 4.6]]`	`[[Analytica 4.6]]`

In the first example, this updates the link to go to ADE User Guide/zh, the Chinese version of ADE User Guide, but the link will display as ADE用户指南 on the page. In the second example, this updates the link to go to CAEngine/zh, the Chinese version of CAEngine, but the link will display as CAEngine on the page. In the final example, nothing is changed because the page Analytica 4.6 is not in the ADE User Guide.

Parameters

Functions and parameters are a kind of code, but typically aren't marked within <code> tags. They should not be translated.

Function and parameters names are formally formatted like this:

Function( parameter1, paramter2, ... )

But are often referred to in the text in pieces, often within brackets, bold, or italicized, i.e. like «parameter», parameter, or parameter. For example:

When using Function, «parameter1» should have a numerical value and «parameter1» should be true or false.

Do not translate parameters. The important thing is to keep parameters consistent throughout the text.

Properties and Methods

Properties and methods are similar to functions and parameters in that they are code that should not be translated and are displayed in the following format:

Properties: {action} type Command
Methods: type Function( parameter, parameter)

They will be found on the ADE Server Class Reference pages or in their own pages -- there are 106 methods and properties pages within the ADE User Guide.