Documentation
Table of Contents
Translating documentation
Zabbix documentation is written using Markdown coding language, which is supplemented with several custom syntax elements.
Translate only the text that is inside Markdown text elements. Do not delete, or edit Markdown elements.
For example:
"zabbix_agentd - Zabbix agent daemon " (English - original)
"zabbix_agentd - Zabbix aģenta dēmons " (Latvian - translated)
To distinguish Markdown elements, see the Working with text elements section.
You can check a preliminary preview of the Markdown syntax of the translated text fragment by using any third-party code editor, for example, Stackedit.io. For more details, see the Preview section.
Working with text elements
| Element | Example | Instructions |
|---|---|---|
| Markdown syntax | ###, **text**, |------|, etc. | Do not edit or remove, translate only text. |
| Zabbix custom syntax | |<|, |^|, , :::noteclassic ::: |
Do not edit. Don't worry if these symbols are visible in the markdown editor - this is normal. They are needed for HTML generator of the website to create tables and notes correctly. |
| API method names and parameters | alert.get, selectUsers, etc. | Do not translate API method and parameter names - users need them in English. (please revert them back to English if using Google translate version and some names are translated). If you are unsure, what needs and what doesn't need to be translated, check out an existing documentation page for an example. |
| Hyperlinks | [action](/manual/config/notifications/action) | Translate the text inside the square brackets []. Do not edit or remove the text in regular brackets (). For internal links, the link will automatically point to the documentation page in selected language. |
| Links to the page section (with #) | [action](/manual/config/notifications/action#trigger_action) OR: [trigger_action](#trigger_action) |
If possible, replace the text after # with the section name in your language. Write the section name in small caps, use underscore _ for spaces. If such section doesn't exist yet, leave the section name in English for now. Also, see general instructions for hyperlinks. |
| Images |  OR: {width="600"} |
Do not edit or remove. Keep as is, including all attributes in curly brackets. |
Special syntax should stay on the same line as in the English version. Please do not add or remove line breaks as it may break formatting.
Preview
Once you have completed your translation, you might need to check if Markdown syntax renders accurately. You can use any third-party code editor to preview the text. For example: Stackedit.io.
To do it:
Copy the translated text of the string.
Tip: press
Ctrl+Ato quickly select all, and thenCtrl+Cto copy the whole block of the text in one click.Open a code editor (in this example Stackedit.io is used) in a new tab, then click on Start writing.
Paste the translated text into the left part of the screen.
Check how it renders in the Preview section on the right.
If the rendered version looks good, copy the text from the left side and paste it back into Pontoon - to the white clipboard.
