Editing the Manual

Aktualisieren

Stellen Sie zuerst sicher, dass Ihre lokale Kopie des Handbuches auf dem aktuellen Stand des online Repositorys ist. Benutzen Sie dazu:

svn update

Schreiben

Sie können nun die Dokumentationsdateien, welches die „.rst“-Dateien innerhalb des „manual“-Ordners sind, mit einem Texteditor Ihrer Wahl bearbeiten.

Be sure to check the Leitfaden zum Schreibstil for conventions and Leitfaden zur Texthervorhebung to learn how to write in the reStructuredText markup language.

Viel Spaß beim Schreiben!

Größere Änderungen

Wenn Sie ein Kapitel hinzufügen oder ausbessern wollen, prüfen Sie gründlich, dass es nicht bereits existiert. An einigen Stellen sind die Dokumentationen so unorganisiert, dass Kapitel doppelt oder an seltsamen Orten sein können. In dem Fall, dass Sie ein Duplikat oder ein fehlplatziertes Kapitel finden, können Sie eine Aufgabe erstellen, das Problem beschreiben und optional eine Korrektur (aktuelle Änderungen) einschließen.

Bevor Sie Änderungen vornehmen, die weder einfach noch begründet sind (zum Beispiel Ordner verschieben), sollten Sie mit einem Handbuch-Pfleger überprüfen, ob Ihr Beitrag der Vision der Community für das Handbuch entspricht. Dies sichert den besten Nutzen Ihrer Zeit und Ihres guten Willens, ansonsten ist es aus unterschiedlichsten Gründen möglich, dass Ihre Änderungen damit kollidieren und abgelehnt werden oder zeitaufwändige Nachbearbeitung benötigen. Zum Beispiel könnte jemand anderes bereits an dem Kapitel arbeiten, das Sie ändern möchten, das Kapitel könnte zur Löschung eingeplant sein oder im Zuge einer geplanten Änderung an Blender aktualisiert werden.

Frühe und häufige Kommunikation ist der Schlüssel um eine produktive Umgebung zu haben, um die Anstrengungen der Leute nicht zu verschwenden und um als Ergebnis ein besseres Blender-Handbuch zu erhalten.

Getting Help/Answers

If you are in doubt about functionality that you wish to document, you should pose your questions to the Blender developers responsible for that area or ask at the unofficial user support channel in the #docs or #blender-coders channel in Blender Chat.

Blender itself has a system of module owners with developer and artist members who are responsible for the design and maintenance of the assigned Blender areas. See the module owners page for more information.

Vorschau

Um Ihre Änderungen zu betrachten, erstellen Sie das Handbuch wie beschrieben. Vergessen Sie nicht, dass Sie auch nur das Kapitel erstellen können, das Sie gerade bearbeitet haben, um es schnell betrachten zu können. Öffnen Sie die generierten .html-Dateien innerhalb des build/html-Ordners mit Ihrem Web-Browser 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. Anfänglich wird dies durch das Einreichen (submitting) von Korrekturen (patches) erledigt, damit jemand Ihre Änderungen überprüfen und Ihnen Rückinfo geben kann. Später können Sie Ihre Änderungen direkt übergeben (committen). Dieser Vorgang wird im nächsten Kapitel detailliert beschrieben.