Die Dokumentation folgt einer bestimmten Nomenklatur, die es dem Recalbox-Wiki ermöglicht, identische URLs für jede Übersetzung jeder Seite zu haben.
Nimm zum Beispiel diese Seite. Die französische Übersetzung hat diese URL:
/fr/contribute
Und die deutsche Seite hat diese:
/de/contribute
So kann die Übersetzung eines Abschnitts schnell gefunden werden, und die Autoren können leichter Übersetzungen anfertigen.
Aus diesem Grund erscheinen die URLs aller Dokumente auf Englisch.
Die Dokumente sind in markdown geschrieben. Markdown ist ein sehr einfaches und zugängliches Werkzeug zur Formatierung von Dokumenten. Du kannst dieses Dokument gerne als Beispiel verwenden, um mit dem Schreiben deines eigenen Dokuments zu beginnen.
Der Titel der Seite ist in den Seitenoptionen des Editors festzulegen.
Sie sollte die einzige Überschrift der Ebene 1 im Dokument sein.
Innerhalb des Inhalts der Seite sollten die Titel mit einer Überschrift der Ebene 2 beginnen (doppelte Raute: ##
):
Um Leser auf wichtige Informationen oder Details aufmerksam zu machen, kannst du Zitatblöcke verwenden:
Dies ist der Markdown
> Dies ist eine Information!
> {.is-info}
für dieses Ergebnis:
Dies ist eine Information!
Weitere Informationen zu den unterstützten Markdown-Funktionen findest du unter https://docs.requarks.io/editors/markdown.
Wenn Du Bilder zu Deinen Dokumenten hinzufügst, achte darauf, dass Du die Dokumenthierarchie in den Bildordnern replizierst und die Sprache weglässt.
Auf dieser Seite sollten die Bilder zum Beispiel im Verzeichnis /contribute
erstellt werden.
Außer in bestimmten Fällen muss ein Seitenlink relativ zur aktuellen Sprache sein. Zum Beispiel sollte auf dieser Seite ein Link auf die Seite /de/home/
auf ./home
zeigen:
Besuche die [Startseite](./home)
Damit kannst du leichter neue Seiten für deine Sprache erstellen, so dass du die Sprache nicht selbst angeben musst.
Wenn deine Sprache nicht im Wiki-Menü erscheint und du eine Übersetzung starten möchtest, kontaktiere bitte das Team über unsere sozialen Netzwerke, Discord oder das Forum.
Um das Recalbox-Erlebnis unterhaltsam und zugänglich zu machen, gib beim Erstellen einer Anleitung deren Schwierigkeitsgrad an, der wie folgt bemessen ist:
Jede Aktion, die keine Eingabe der erweiterten Einstellungen im allgemeinen Menü oder in den Recalbox .conf-Dateien erfordert, wird wie folgt gewertet: level
Jede Aktion, die eine Konfiguration der erweiterten Einstellungen erfordert, um Änderungen vorzunehmen, die zu Instabilitäten führen könnten: level
Jede Aktion, die eine Änderung der Einträge in der Datei recalbox.conf erfordert: level (Vorsicht geboten).
Jede Aktion, die SSH-Eingriffe und/oder Änderungen an der Boot-Datei erfordert (MobaXTerm oder Powershell - das Personal hat sich noch nicht auf die zu verwendende Software geeinigt): level
Jede Aktion, die einen Merge-Request auf GitLab notwendig macht: level
Beispiel:
Um das Stern-Emoji in deinen Anleitungen erscheinen zu lassen, setze ":" vor und hinter das Wort "star"
:star: