How to translate TrueConf documentation

TrueConf documentation is written and processed using markdown formatting, so you may need to take into account some peculiarities for successful translation.

1. We use some html tags in the text:

   • If the “const_name” tag is used instead of a word (e.g. <const name="product-mcu"/>) this is a constant term that doesn't need to be translated (e.g., program names, phone numbers, etc.). Copy this tag into your translation as is.

   • “To-site” tag (e.g., <to-site>our website</to-site>) contains links to some external resources. Copy the tag and translate the text encapsulated between the tags. For example, the <to-site>our website</to-site> should be translated in Spanish as <to-site>nuestra página web</to-site>.

   • “Interface” tag contains GUI element names used in TrueConf software (e.g., <interface ru="{Настройки} {Сеть}" en="{Settings} {Network}">. Please do not translate those, just copy the whole tag into your translation (same as “const_name” tag).

   • <StdPic id="gui/add_button" gui="true"/> are icons, button images and other small interface elements used in the text for better visualization. Do not translate the tag and copy it in your translation as is. However, please take into account that some contextual graphic element (e.g. a button, a screenshot) will be in the final text instead of this tag, so consider the context.

   • “Destination” tag leads to a specified resource (a link or a pdf file). The tag should be copied, the text inside the tag should be translated. E.g., in <destination source="web">documentation</destination> the word “documentation” should be translated.

   • <lang-filter lang="en">some text</lang-filter> is a text required only for a specific locale (in this case Russian). This tag doesn’t need to be translated. However, if it is used inside of a sentence, consider the context to translate correctly taking into account this gap.

   • There are markdown elements such as hashes, asterisks, and apostrophes, for example: * **Please note:** enter your IP address, e.g., `111.123.124.125`.. These characters are used for text formatting, please do not delete them and leave them in their place. The text inside those characters should be translated. For example, the Spanish translation of the text above will be the following: * **Tenga en cuenta:** introduzca la dirección IP, por ejemplo, `111.123.124.125`.

2. Some lines may start with numbers, e,g., 10\.. Please preserve this number in your translation, it means that there’s a numbered list. For example, the line 8\. End the conference. should be translated in Spanish as 8\. Terminar la conferencia.

3. Meta tags look like this:

title: Example title
description: Example description

You need to translate the text after the colon and add three hyphens above and below. Please also note that colons ":" cannot be used in the text of meta tags:

---
title: Example title translation
description: Example description translation
---

To sum up, please follow these guidelines when translating:

• save non-text elements, i.e. the text blocks like <Const name="product-mcu"/> or <interface ru="{Настройки} {Сеть}" en="{Settings} {Network}">. You should save them in your text, making a translation for the text blocks where it is necessary (for example, text inside the tag to-site)

• do not remove asterisks and apostrophes or change their position in the sentence, e.g. ...at `joe@ab12b.trueconf.com`.... (in this example joe@ab12b.trueconf.com remains unchanged)

• don't rearrange sentences if possible

• never insert text from other lines into the translation of a line, even if you have been given the full text of the document.

The final translation should contain the same number of auxiliary html tags and markdown constructs as in the original text.

Example 1

Original English text:

Check <interface ru="Аутентификация" en="Authentication"> to enter username and password and gain access to **Wowza Streaming Cloud**.

Correct Spanish translation:

Verifique <interface ru="Аутентификация" en="Authentication"> para ingresar el nombre de usuario y la contraseña y obtener acceso a **Wowza Streaming Cloud**.

Wrong Spanish translation (the interface tag is missing):

Verifique "Authentication" para ingresar el nombre de usuario y la contraseña y obtener acceso a **Wowza Streaming Cloud**.

Another wrong Spanish translation (extra words are under the asterisks):

Verifique <interface ru="Аутентификация" en="Authentication"> para ingresar el nombre de usuario y la contraseña y **obtener acceso a Wowza Streaming Cloud**.

Example 2

Original text:

If you don’t select a PTZ camera in the <interface all="Camera"/> field, there is no need to fill such fields as <interface all="PTZ Control"/>, <interface all="Pan"/>, <interface all="Tilt"/>and <interface all="Zoom"/>. The <Const name="company-name"/> app will function correctly with a selected camera.

Correct Spanish translation:

Si no selecciona una cámara PTZ en el campo <interface all="Camera"/> field, no es necesario completar campos como <interface all="PTZ Control"/>, <interface all="Pan"/>, <interface all="Tilt"/>and <interface all="Zoom"/>. La aplicación <Const name="company-name"/> funcionará correctamente con una cámara seleccionada.

Wrong Spanish translation (lost and changed tags):

Si no selecciona una cámara PTZ en el campo Camera, no es necesario completar campos como PTZ Control, Pan, Tilt y Zoom. La aplicación <Const name="company-name"/> funcionará correctamente con una cámara seleccionada.

Example 3

Original text:

Use `support@mail.com`.

Correct Spanish translation:

Utilice `support@mail.com`.

Wrong Spanish translation (extra content that wasn't present in the original text):

Utilice el correo electrónico `support@mail.com` para conectarse con nuestro soporte técnico.