Localization

This is a workflow procedure and a list of requirements for translators on how to go about preparing localization of this application (its user interface (UI), Help facility and some exportables) into another language.
Once completed successfully (including certification from Capturing Reality), you will be able to switch to the new language in the Application Settings / Visual and language settings / UI Language.

REQUEST: Please do not change the original folder names, or their structure (placement), or file extensions. And, whenever in doubt, contact your assigned person for clarification.
PREREQUISITE: having an account at our webpage and a valid RealityCapture license.

Step 1 - App's XML

There are 2 ways how to go about translating the UI:

Alternative 1 - manual

  1. You need to copy the en-US\ui.xml document from ProgramData folder (typically C:\ProgramData\Capturing Reality\RealityCapture\LanguagePack\languages). We recommend you to create a new 'languages' folder (for example 'languagesMY'). Create a new subfolder, name it (analogically to 'en-US', see language codes), paste the copied ui.xml there, open it in a text editor, translate its content from top to bottom and save it.
    (Note that the supported language xml files as well as the languages.xml file will get overwritten/deleted upon the application reinstallation, repair, and removal if the file timestamp is older. Thus we recommend you to store your work in a separate 'languages' folder.)
  2. When you are finished with the xml translation, add your language description into languages.xml, which can be found here: ProgramData\Capturing Reality\RealityCapture. Just copy a line from the file and update the language code, ID (Locale Identifier), name (see the previous step), and source file path.

Alternative 2 - using RC Translation Tool (recommended)

  1. Contact us to get the tool at sales@capturingreality.com.
  2. Follow the instructions in the Tool Help. To access the Help files, choose a language, and press F1 or click the question mark in the Tool icons.
NOTE: The translation saves automatically to ProgramData (ProgramData\Capturing Reality\RealityCapture\languagesMY). To save a copy of your latest translation in another folder, click the Downwards arrow icon in the Tool menu. The most recent translation is always saved in the ProgramData.

Further instructions

Do not translate (nor remove):

 (symbol creating a new line in the text),
& (ampersand/and symbol; when used at the beginning or inside a word, like in &Exit or Co&ntinue, the letter followed by the symbol is underlined, suggesting there is a shortcut for the action),
" (substitute symbol for a single quote),
< (substitute symbol for the less than sign),
> (substitute symbol for the greater than sign),
<br/> (substitute symbol for a line break, can also occur without the slash sign or with the slash sign before br, or with a space after the br element),
<li> (substitute symbol for an indented line, the starting tag, comes with a closing tag </li>),
<span> (substitute symbol for the span tag used to style a particular text, any content within <span and </span> must not be translated),
%s, %d (symbols used for formatting and displaying specific content on the screen),
$(stat), $Get(key), $(minutes:02d) (words starting with the dollar sign are variables or function names that must stay the same across all language mutations, including the content in the brackets following a word starting with the dollar sign),
postprocess.exe (name of an executable file, words ending with .exe may not be translated),
name="..." (a string identifier).

Plural-specific structures

There are some commands present in the .xml document that automatically add a specified plural ending to a word, or swap a singular expression with its specified plural form (according to a real-time read number associated to the expression). Let us have a look at the explanation of these examples:

This is one of the lines from the .xml document to translate:
More parameters are expected for the command '$(cmdName)'. Add $(maxParamCount-paramCount) more argument$if(maxParamCount-paramCount>1,s).


Here is another instance:
Executing command '$(cmdName)'$if(paramCount==1, with parameter '$(params)')$if(paramCount>1, with parameters '$(params)')
The output in the application will be:


TIP: You can run RealityCapture via the command line using this command: -translatorMode and make use of the visual aids (numbers - string IDs) for individual texts (strings) available for panels and windows. This will help you get the meaning right.

To run the application in this so-called translator mode:
  1. open the (Windows) Command Prompt,
  2. type/paste there a full path to the RealityCapture executable file,
  3. followed by the -translatorMode command,
  4. and press Enter on your keyboard.

It will normally look like this: "C:\Program Files\Capturing Reality\RealityCapture\RealityCapture.exe" -translatorMode.


Step 2 - Help

  1. Copy the whole Help folder from C:\Program Files\Capturing Reality\RealityCapture\help\en-US to C:\Program Files\Capturing Reality\RealityCapture\help.
  2. Rename it analogically to "en-US". You can find the language codes here.
  3. Open each .htm file of the Help folder one by one in a text editor + the file textVars.js in C:\Program Files\Capturing Reality\RealityCapture\Help\en-US\scripts, translate and save it in the same destinations (it is necessary that the structure of folders remains unchanged).
WARNING: Always back up your translated documents when you change the translation for Help already present in the original application files. It is important to do it before any changes to the app's installation.

Make sure the names of buttons, panels, settings and windows (usually in blue in Help) are exactly the same as translated in the .xml document from Step 1, and that the name of tutorials referred to in Help texts are the same as on the Help starting page.
If you come across a link to Wikipedia, open it in your browser and switch its language in the left menu to the language you are making the translation into. If it does not exist, skip this step.
Do not translate html tags, code samples (usually blue on black background in Help tutorials) and name of commands, nor remove any unknown parts.

TIP: Use the Help full-text search facility to navigate quickly to a specific text within Help files. You can also use the shortcut CTRL+F to browse contents of individual Help pages.

Step 3 - Reports

There are 2 ways how to go about translating the Reports, too:

Alternative 1 - manual

  1. Create a new folder here, unless it is already there (see step 2): C:\Program Files\Capturing Reality\RealityCapture\Reports.
  2. Rename it analogically to "en-US". You can find the language codes here.
  3. Copy all xml files from C:\Program Files\Capturing Reality\RealityCapture\Reports\en-US into the folder created in the step 1 and translate them.

Alternative 2 - using RC Translation Tool (recommended)

See the instruction above - Step 1 / Alternative 2.

NOTE: The translation saves automatically to ProgramData (ProgramData\Capturing Reality\RealityCapture\Reports). To save a copy of your latest translation in another folder, click the Downwards arrow icon in the Tool menu. The most recent translation is always saved in the ProgramData.

Final Notes

WARNING: Always back up your translated documents.

The final step is to send us all your translated files (with the same structure of folders) for certification and implementation.