¶ Documentation Naming System
The documentation follows a certain nomenclature that allows the Recalbox wiki to have identical URLs for each translation of every page.
Take this page for example. The French translation has this URL:
/fr/contribute/
And the English page has this:
/en/contribute
This lets people quickly find the translation of a section, and allows contributors to make translations more easily.
This is why the URLs of all documents appear in English.
¶ Formatting Rules
The documents are written in markdown. Markdown is a very simple and accessible document formatting tool. Feel free to use this document as an example to start writing your own.
¶ Titles
The title of the page is to be defined in the editor's page options.
It should be the only level 1 heading in the document.
Within the page's contents, the titles should start with a level 2 heading (double hash: ##):
¶ Citation blocks
To let readers know about important information or details, you can use quote blocks:
> This is information!
> {.is-info}
This is information!
¶ Supported Markdown version
For more information on supported markdown capabilities, visit https://docs.requarks.io/editors/markdown.
¶ Images
When adding images to your documents, make sure you replicate the document hierarchy in the image folders, omitting the language.
For example, on this page, images should be created in the /contribute directory.
¶ Localization
¶ How to translate a page
- Login to the wiki with your Discord account
- Go to the page to translate, in the default language of the wiki (FR for now)
- Click on the language icon at the top of the page and select the language you want to translate the page into
- A screen offers you to create a new page, click on the create page button
- Click on the Markdown editor
- Open a new tab on the original page and click on edit in the page actions menu
- Access the title, tags and description of the page by clicking on the PAGE button:
- You can translate these elements and add them in the form of your newly created page
- After closing the title popup on the original page, copy the markdown content of the page, and go to https://www.deepl.com/translator to paste your text and get a pre-translated version of the page.
- Now you just have to check the translation, the images and the links of the newly created page!
- Don't forget to remove the last line of the text (the translated with deepl line)
- Thank you very much for your contribution 🙏
¶ Relative links
Except in certain cases, page links must be relative to the current language. For example, on this page, a link to the /en/home/ page should point to ./home:
Visit the [home page](./home)
This will allow you to create new pages for your language more easily, so you do not have to specify the language yourself.
¶ Adding new languages
If your language does not appear in the Wiki menu, and you want to start a translation, please contact the team on our social networks, Discord, or the forum.
¶ Tutorial difficulty level
In order to make the Recalbox experience fun and accessible, when you create a tutorial, mention its difficulty level, calibrated as follows:
-
Any action that does not require entering the advanced settings in the general menu or the Recalbox .conf files will be considered as : level
-
Any action that will require configuring the advanced settings to make changes that may cause instabilities: level
-
Any action that will require changing entries in the recalbox.conf file: level
(caution recommended). -
Any action that will require SSH manipulations and/or boot file modifications (MobaXTerm or Powershell the Staff has not yet agreed on the software to use): level
-
Any action that will require to create a merge request : level
-
Finally any tutorial that would try to explain the use of clrmamepro will be automatically classified in the category:
Nightmare
Example:
- Put a rom, a bios, change the language:
- Change the theme, restore factory settings, change the default core:
- Activate AI retroarch translation:
To make the star emoji appear on your tutorials, put ":" in front and behind "star" = : star: all attached.