Mitarbeiten an den Docs on darktable user manual

Übersicht

Mon, 01 Jan 0001 00:00:00 +0000

Diese Seite beinhaltet die Gestaltungsrichtlinien für dtdocs und Informationen, wie an diesem Projekt mitgemacht werden kann.

It is included in the user manual so that you can see how the page is rendered as well as how it is written. Please go to GitHub to see the source for this page.

Die Struktur der Anleitung und der Inhalt wurden nach den folgenden Kriterien sorgfältig ausgewählt:

Die Anleitung soll umfassend sein, d.h. sie sollte in darktable enthaltenen Funktionalität vollständig beschreiben.
Sie sollte eine konsistente und logische Struktur haben und jeder Teil der Funktionalität soll seinen eigenen logischen Platz in dieser Struktur haben.
Sie soll so lang wie nötig, aber so kurz wie möglich sein: Kürze ist ein Muss.
Sie soll objektiv sein.
Funktionalität sollen nur einmal erklärt werden (mit Ausnahme des grundsätzlichen Anleitung zum Arbeitsablauf in der Einführung).
Bilder sollten nur verwendet werden, wenn dies der besseren Verständlichkeit der wesentlichen Prinzipien dient. Bilder sollten keinen Text enthalten, außer es ist unvermeidbar.

Wir sind grundsätzlich nicht interessiert an:

Entwicklung und Veröffentlichung

Mon, 01 Jan 0001 00:00:00 +0000

darktables Handbuch wird über das dtdocs Repository gepflegt. Änderungen werden über Pull Requests eingepflegt (siehe Arbeitsablauf). Übersetzungen werden über Weblate gepflegt. Siehe auch hier.

🔗Bauen

Der vollständige Output (HTML Seite, EPUB und PDFs) wird mit ./tools/build-all.sh <base_url> gebaut.

Dies generiert die übersetzten Dateien aus den PO-Dateien und dann anschließend die HTML-Seite, EPUB und ein PDF pro aktivierter Übersetzung. Die Ausgabe wird unter public/ abgelegt, die PDFs unter public/<lang>/darktable_user_manual.pdf.

Anforderungen: Hugo (extended), weasyprint, und po4a für die Übersetzungen.

Arbeitsablauf

Mon, 01 Jan 0001 00:00:00 +0000

Diese Anleitung setzt voraus, dass du bereits über ein GitHub-Konto verfügst und Git installiert ist. Stelle sicher, dass Git in deinem PATH enthalten ist, indem du den Befehl git in einem beliebigen Terminal oder in der Eingabeaufforderung ausführst - es sollte keine Fehlermeldung angezeigt werden. Falls du Git noch nicht installiert hast, befolgen Sie diese Anleitung.

🔗Undokumentierte Features dokumentieren

Wir sind insbesondere daran interessiert, abgeschlossene Pull Requests, die Änderungen oder Erweiterungen der Dokumentation erforderlich machen, zu dokumentieren. PRs, die Dokumentation erfordern, sind mit dem GitHub Label documentation: pending versehen.

Übersetzungs-Abläufe

Mon, 01 Jan 0001 00:00:00 +0000

Die Übersetzung der Dokumentation von darktable wird mit Weblate ausgeführt.

🔗Übersicht über den Aufbau und Datenaustausch für die Übersetzungen mittels Weblate

In Kürze:

Das Handbuch wird primär auf Englisch in den .md-Dateien in content/*.md gepflegt
Von da aus wird eine POT Datei (po/content.pot) mit allen übersetzbaren Zeichenketten generiert.
Weblate pflegt für jede übersetzte Sprache eine einzelne PO-Datei (po/content.{lang}.po), die die übersetzten Zeichenketten entält.
Bei der Veröffentlichung des Handbuches werden .md Dateien für jede aktivierte Übersetzung mittels generate-translations.sh generiert. hugo rendert daraus dann die .html Dateien sowie den EPUB und PDF Varianten.

🔗GitHub zu Weblate: Synchronisierung der übersetzbaren Zeichenktten

Die originalen Englischen Dateien (content/*.md) werden mittels Pull Request aktualisiert (siehe Arbeitsablauf).

Übersetzungs-Leitfaden

Mon, 01 Jan 0001 00:00:00 +0000

Schön, dass du bei der Übersetzung des Handbuches helfen möchtest. Dieser Leitfaden soll helfen die Gepflogenheiten und Anforderungen der Übersetzungsarbeit zu verstehen.

Die Übersetzungen werden über Weblate gepflegt. Unregistrierte Benutzer können Vorschläge für Übersetzungen abgeben. Um Übersetzungen tatsächlich abzuschicken registere dich bei Weblate.

We do not accept automated AI translations without human review and quality control.

Wir empfehlen das folgende zu lesen:

Leitfaden für Stil und Konventionen: Formalitäten und Konventionen wie wir das Handbuch pflegen.