編輯手冊
你可以透過修改本機文字檔案來修改手冊。這些檔案透過存放區與線上保持同步,以這個伺服器內容為基礎來更新線上手冊。
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.
更新
Firstly, make sure that your local copy of the manual is up to date with the online repository using:
git pull --rebase
編寫
現在你可以選擇文字編輯器編輯文件檔案, 這些文件位於 manual
資料夾中的 .rst
檔案。
Be sure to check the Writing Style Guide for conventions and Markup Style Guide to learn how to write in the reStructuredText markup language.
開始寫作吧!
較大的修改
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 a task explaining the issue, and optionally include a revision (actual changes).
在你做了一些不那麽簡單明瞭的修改之前(如,移動文件夾),你需要與手冊維護人員確認你的貢獻與社群對手冊的設想是一致的。這能確保你的時間與善意得到最好的利用,否則的話,因為某些原因,你的修改可能會因造成衝突而被駁回或者經歷費時的審查。例如,另外一個人可能已經在負責你想要修改的章節,這一節可能已經計劃要刪除,或者根據Blender的變化而相應更新。
早一點與頻繁地 交流 ,是維持一個高產能環境的關鍵,這樣才不至於浪費別人的努力,並且完成一份更好的Blender手冊。
獲得幫助/答案
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.
預覽
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.
上傳
如果你很滿意自己的修改,您可以將它們上傳,將其呈現於在線手冊中。首先,這是由提交修補版本,從而使他人可以審查你的修改,並給您反饋完成。之後,你可以直接提交更改。下一節會詳細介紹相關流程。