Available translations
loading results
How to Contribute Translations
Summary: The Docs are originally written in English. Making Superalgos more accessible is a key endeavor to grow the Community and the user base. Translating tutorials and software documentation into languages other than English is of huge value!
Read About Contributing to the Docs
Translations are a particular case of contributing to the Docs. Please read the How to Contribute to the Docs page first, and come back here for the details about how we deal with translations in particular.
About Translations
Foundations->Topic->Docs In English->Content
English is considered the default language. When you switch to a different language, the system attempts to show the content in the new language. However, if the translation is not yet available, it shows the English version instead.
Node types, variable names, the title of pages in the Docs, and a few more elements of Superalgos may not be translated, as they are unique identifiers of the said elements. You will always get those in English.
Tip: To switch languages, click on the flags on the footer of the Docs.
Note: You may only add or delete pages / paragraphs to the Docs when the language is set to English.
The system stores the content of each Docs Page in a single file, regardless of how many translations may exist for each page.
Actually, translations exist at the level of each paragraph. This means that, for each paragraph in a page, there may be as many translations as there are supported languages.
Tip: The above doesn't affect your work directly, but it is worth noting because it means that many contributors may be working on the same page at any point in time. Hence the need to constantly update and to submit contributions frequently.
Important: Whatever you translate, be careful not to translate keywords. They offer the possibility to jump to the docs page of the respective keyword by clicking on the keywords. You can recognize them by the dashed line below them and the fact that they start with a capital letter. For example Node. But it can also be short phrases that are linked by the heading of an docs article. You can translate them by putting them in () after the keywords so that new Superalgos users have an easier start.
Examples of keywords/-phrases that should not be translated:
| Keywords | Key-phrases |
|---|---|
| Nodes | How to Contribute to the Docs |
| Tutorial | Docs Save Command |
| Community | Docs Group |
| Client | Docs Page |
| ... | ... |
Best Practices:
undefined
- As explained in the How to Contribute to the Docs page, you must switch your Contributions Branch and your Current Branch to the develop branch. Remember to restart the app after the switch.
- Make sure your system is up to date running the
app.updatecommand in the Searchbar/Command Line at the top of these Docs.
- Then, switch to the language you wish to translate to.
- To translate a paragraph, right-click to edit the content and replace the English text with your translation. That's it!
- You may find it easier to write your translations in a separate text editor, where you may use spelling and grammar-checking software. Once you've double-checked your translation, you may come back to Superalgos to replace each paragraph with the translated version.
- Remember that translations exist at the level of each paragraph. Always make sure that the translation you input matches the correct paragraph. This is important because if a paragraph is updated in the English version, all translations will get a notice that the particular paragraph may be outdated.
- Participate in the Superalgos Docs Group. Let people know what part of the Docs or which Tutorial you will be working with. This basic coordination will help avoid conflicts when more than one user works on the same pages at the same time.
Tip: You may start with the translation of the Docs in [Language] page that you land on after you switch the language.
You want to add an important information that is missing?
- change your language in the footer to english as it is the origin language. Click on the English Circle in the footer.
- navigte to the docs page you want to add something to.
- find yourself a paragraph after which you want to add the paragraph (no matter what style) right click on it go to the end off the last sentence of the paragraph and hit "Enter". If you switched into a new line right click on another existing paragraph. Trough that you create a line break. Now you should see a new paragraph. If that didnt work, repeat the procedure but write something in the new line, anything.
- You can now again right click on the new paragraph and use all editing Features like, changing the style.
- Remember to switch back your language after you
docs.savethe changes and orapp.contributethe changes. Otherwise you may forget it and later translate the original english text into your language which could cause problems.
Translating Tutorials:
Tutorial pages present certain challenges that we must take into account while translating: the first and foremost is that the space available in the tutorial window is limited. This means that you have to be mindful of the length of the translated text and that you must test each of the tutorial steps to make sure the translation fits the available space.
You will notice that if you open the Docs when a tutorial is running, the Docs automatically load the page of the corresponding tutorial step, so that you may edit it. This is quite helpful, as you may translate the page and see how it looks on the tutorial window in real-time. This is the recommended way.
undefined
Important: However, this is not always the case. Some tutorial steps are configured to close the Docs or the editor, and when you open the Docs manually, the tutorial step page is not loaded automatically. In such cases, you must search for the name of the page — which should match the title of the tutorial step — so that you may access the page manually.
Contributing to Superalgos — TOC
You just read page 5 in the topic.
1. How to Contribute to Superalgos
2. How to Contribute a Trading System
4. How to Contribute to the Docs
5. How to Contribute Translations