Skip to content
Back to top

# Documentation ResMa

This folder contains the documentation for ResMa.

## Editing the documentation

Edit the markdown files in the folder `files` for modifying the user documentation. Normally, the text ist written in german, with english screenshots.

## Translating the documentation

Currently, we use LLM to translate the german text to english. Therefore, we translate one po-file after the other, with the following instructions:

    Please help translating technical documentation for a data visualization project.
    Please use the correct specialized terms for data visualization in the target language.
    Try to make the text sound naturual in the target language, and use formal language, when applicable.
    Reply only with the translation, without any quotes or boilerplate text.
    The text will be rendered in Markdown, so use Markdown syntax to format the translated text if, and ONLY IF the original text had such formatting.
    For Markdown links, adjust only the link text and leave the URL unchanged.
    Never translate words which only contain capital letters, numbers and underscores: simply use the original word in the translated message.
    For Example: 'ERROR_NO_DATA' will simply be translated as 'ERROR_NO_DATA'.
    Always translate 'Zähler' with 'Counter'.
    Use all opened .po files, use the german text marked as 'msgid', translate it to english, and store the text in 'msgstr'. If 'msgid' is an empty text, look for german text in the next lines until 'msgstr'.
    Write translations directly into the .po files.