Dokumentation

Allgemeine Informationen

Informieren Sie die Community immer vor der Arbeit (indem Sie ein neues Problem erstellen oder ein bestehendes kommentieren). Damit soll vermieden werden, dass zwei Personen an der gleichen Sache arbeiten, und Konflikte zu verhindern.

Bitte benutzen Sie den main-Zweig.

Der Quellcode der Dokumentation befindet sich im Ordner support/documentation/content.

Die Dokumentation wird mit Hugo erstellt. Sie müssen es auf Ihrem Computer installieren, wenn Sie eine Vorschau Ihrer Arbeit sehen wollen.

Die erforderliche Mindestversion für Hugo ist 0.121.0. Es wurde mit Version 0.132.2 getestet.

Das verwendete Thema ist hugo-theme-learn. Sie sollten dessen Dokumentation lesen, bevor Sie mit der Bearbeitung der Dokumentation beginnen.

Wenn eine neue Pluginversion veröffentlicht oder die Dokumentation aktualisiert wird, führen die Plugin Verwalter den main-Zweig mit dem documentation-Zweig zusammen. Dadurch werden Github- und Gitlab-Pipelines ausgelöst und die veröffentlichte Dokumentation aktualisiert.

Übersätzungen

Die Hauptsprache ist Englisch (Code en).

Der Ordner support/documentation/content/en enthält nur englische Dokumentationsdateien.

Die Dokumentation wird mit Weblate übersetzt (siehe die Übersetzungsdokumentation). Um dies zu tun, verwenden wir das po4a tool, wie wir später auf dieser Seite sehen werden.

Eine neue Sprache hinzufügen

Kopieren und ändern Sie den Abschnitt [Languages.fr] in der Datei support/documentation/config.toml.

Wenn die Übersetzungen nicht vollständig sind, macht das nichts, die fehlenden Zeichenfolgen werden auf Englisch angezeigt.

Vorschau

Um eine Vorschau Ihrer Änderungen zu sehen, führen Sie einfach diesen Befehl aus:

hugo serve -s support/documentation/

Öffnen Sie dann Ihren Browser und gehen Sie auf die Adresse http://localhost:1313/peertube-plugin-livechat/. Diese Seite wird bei jeder Änderung automatisch aktualisiert.

Aktualisierung von Lokalisierungsdateien und Erstellung von Dokumentationsübersetzungen

Im Moment haben Sie nur die englische Version. Um die Dokumentationszeichenketten zu aktualisieren und Übersetzungen zu erstellen, müssen Sie das Skript doc-translate.sh ausführen.

Stellen Sie dazu sicher, dass Sie po4a (Version >= 0.69) auf Ihrem Computer installiert haben.

Um Übersetzungen zu bearbeiten, machen Sie einfach dies:

npm run doc:translate

Sie können dann eine Vorschau des Ergebnisses mit hugo serve -s support/documentation/ und unter Verwendung der Sprachauswahl anzeigen.

Dokumentation schreiben

Bearbeiten Sie einfach die englischen Dateien in support/documentation/content/en.

Führen Sie dann vor dem Commit immer npm run doc:translate aus, so dass Änderungen in den englischen Dateien in die Datei support/documentation/po/livechat.en.pot übertragen werden können.

Du kannst den Shortcode livechat_label verwenden, um Anwendungsstrings zu verwenden. Siehe hier: Dokumentation übersetzen.

Es ist möglich zu verhindern, dass eine Datei übersetzt wird, indem man livechatnotranslation: true in der Yaml Font Matter Sektion benutzt. Siehe hier: Dokumentation übersetzen.

Bitte verwenden Sie die Option livechatnotranslation für technische Dokumentation. Wir möchten nicht, dass die technische Dokumentation übersetzt wird, um Probleme aufgrund einer falschen Übersetzung zu vermeiden.

Um den Übersetzern die Arbeit zu erleichtern, sollten Sie zu lange Absätze vermeiden.

Im Moment ist es nicht möglich, Markdown-Tabellen zu verwenden: Die Übersetzungswerkzeuge würden sie nicht korrekt darstellen.

When a new feature is released, you can use the livechat_version_notice short code to display an infobox with the version with which the features is available. This short code takes the version number as parameter. Here is an example:

Was ist, wenn ich hugo und/oder po4a nicht verwenden kann?

Bearbeiten Sie einfach die englischen Markdown-Dateien und geben Sie an, dass Sie keine Übersetzungen erstellen können, wenn Sie Ihren Pull Request stellen.

Veröffentlichung

Die Veröffentlichung der Dokumentation erfolgt automatisch, sobald die Änderungen in den documentation Zweig eingefügt wurden.