Bearbeiten des Handbuches¶
Das Handbuch kann geändert werden, indem man lokale Textdateien bearbeitet. Diese werden über ein Repository mit den Online-Dateien synchron gehalten. Demzufolge wird der Server das Online-Handbuch aktualisieren.
Das Handbuch ist in der reStructuredText (RST) Auszeichnungssprache geschrieben und kann mit einem einfachen Texteditor bearbeitet werden. Um eine lokale Vorschau zu erhalten, konvertieren (erstellen) Sie die Quelldateien des Handbuchs von RST in HTML-Webseiten.
Aktualisieren¶
Stellen Sie zuerst sicher, dass Ihre lokale Kopie des Handbuchs mit dem Online-Repository auf dem neuesten Stand ist. Benutzen Sie dazu:
svn update
Schreiben¶
Sie können nun die Dokumentationsdateien, also die „.rst“-Dateien innerhalb des „manual“-Ordners, mit einem Texteditor Ihrer Wahl bearbeiten.
Lesen Sie sorgfältig den Leitfaden zum Schreibstil für Konventionen und den Leitfaden zur Texthervorhebung um zu lernen, wie man in der reStructuredText-Auszeichnungssprache schreibt.
Viel Spaß beim Schreiben!
Größere Änderungen¶
Wenn Sie einen Abschnitt hinzufügen oder ausbessern wollen, sollten Sie genau prüfen, ob er nicht bereits existiert. An manchen Stellen ist die Dokumentation so ungeordnet, dass Abschnitte vielleicht doppelt vorhanden sind oder sich an einem falschen Platz befinden. Falls Sie ein Duplikat oder einen unpassenden Abschnitt finden, dann bitte erstellen Sie eine Aufgabe, die das Problem erläutert, und legen Sie optional eine Revision (tatsächliche Änderungen) bei.
Bevor Sie Änderungen vornehmen, die weder einfach noch eindeutig begründet sind (zum Beispiel Ordner verschieben), sollten Sie mit einem Handbuch-Betreuer überprüfen, ob Ihr Beitrag der Vision der Community für das Handbuch entspricht. Dies sichert den bestmöglichen Nutzen Ihrer Zeit und Ihres guten Willens, da sonst die Möglichkeit besteht, dass aus irgendeinem Grund Ihre Änderungen in Konflikt geraten und abgelehnt werden oder eine zeitaufwändige Nachprüfung benötigen. Zum Beispiel könnte jemand anders bereits am Abschnitt arbeiten, den Sie ändern möchten, oder der Abschnitt könnte zum Löschen bzw. zur Aktualisierung gemäß einer geplanten Änderung an Blender vorgesehen sein.
Eine frühzeitige und häufige Kommunikation ist der Schlüssel zu einer produktiven Umgebung, um die Anstrengungen der Leute nicht zu verschwenden und dadurch ein besseres Blender-Handbuch zu erhalten.
Hilfe/Antworten bekommen¶
Bei Zweifeln bezüglich einer Funktion, die Sie beschreiben möchten, sollten Sie Ihre Fragen den für dieses Gebiet verantwortlichen Blender-Entwicklern stellen oder fragen Sie im Blender Chat unter dem inoffiziellen User-Support-Channel #docs oder #blender-coders.
Blender hat sein eigenes System von Modul-Besitzern, mit Entwickler- und Künstler-Mitgliedern, die für das Design und die Wartung der zugewiesenen Blender-Gebiete zuständig sind. Weitere Informationen finden Sie auf der Modul-Besitzer Seite.
Vorschau¶
Um Ihre Änderungen zu betrachten, erstellen Sie das Handbuch wie angegeben. Vergessen Sie nicht, dass Sie auch das gerade bearbeitete Kapitel gezielt erstellen können, um es schneller anzusehen. Öffnen Sie die generierten .html-Dateien innerhalb des build/html-Ordners mit Ihrem Webbrowser oder aktualisieren Sie die Seite, wenn Sie sie bereits geöffnet haben.
Hochladen¶
Wenn Sie mit Ihren Änderungen zufrieden sind, können Sie sie hochladen, damit sie im Online-Handbuch erscheinen. Dies wird zunächst durch das Einreichen (submitting) von Korrekturen (patches) erledigt, damit jemand Ihre Änderungen überprüfen und Ihnen Feedback geben kann. Danach können Sie Ihre Änderungen direkt übergeben (committen). Dieser Vorgang wird im nächsten Abschnitt detailliert beschrieben.