Bearbeiten des Handbuches¶
You can modify the manual by editing local text files. These files are kept in sync with those online via a repository, based on this the server will update the online manual.
The manual is written in the reStructuredText (RST) markup language and can be edited using a plain text editor. For a local preview, you convert (build) the manual source files from RST into HTML web pages.
Aktualisieren¶
Firstly, make sure that your local copy of the manual is up to date with the online repository using:
make update
Schreiben¶
Sie können nun die Dokumentationsdateien, also die „.rst“-Dateien innerhalb des „manual“-Ordners, 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¶
If you are going to add or overhaul a section, be sure to check carefully that it does not already exist. In some places, the docs are so disorganized that sections may be duplicated or in a strange location. In the case that you find a duplicate or out of place section, create an issue explaining the issue, and optionally include a revision (actual changes).
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 Chat unter dem inoffiziellen User-Support-Channel #docs oder #blender-coders.
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 pages for more information.
Vorschau¶
To view your changes, build the manual as instructed.
Keep in mind that you can also build only the chapter you just edited to view it quickly.
Open the generated .html files inside the build/html folder using your web browser,
or refresh the page if you have it open already.
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.