编辑手册
手册使用 reStructuredText (RST) 标记语言编写,并且可以使用纯文本编辑器编辑。可以将RST文件转换(编译)为HTML网页文件,来进行本地预览。
Firstly, make sure that your local copy of the manual is up to date with the online repository using:
现在你可以根据自己的喜好选择文本编辑器编辑文档文件,这些文档位于 文件夹中的 .rst
文件。
开始写作吧!
如果你打算添加或大修某一节,一定要仔细检查,确保现有手册没有这些内容。在一些地方,文档是如此杂乱无章,以至于一些章节内容重复或者位于某个奇怪的位置。在你找到一个重复或位置不当的章节后,请 ,把问题解释清楚,还可以附带一份修改(真正的更改)。
在你做出一些不那么简单明了的修改(如,移动文件夹)之前,你需要与手册维护人员确认你的贡献与社区对手册的设想是一致的。这能确保你的时间与善意得到最好的利用,否则的话,因为某些原因,你的修改可能会因造成冲突而被驳回或者经历费时的审查。例如,另外一个人可能已经在负责你想要修改的章节,这一节可能已经计划要删除,或者根据Blender的计划变动而相应更新。
获取帮助/答案
如果你对所要记录的功能存在疑问,你应该向负责这一块的Blender开发人员提出你的疑问,或者在 中的非官方用户支持频道 或 #blender-coders
中提问。
Blender有自己的模块所有者系统,包括负责指定Blender区域设计和维护的开发人员和艺术家。 详情参考 模块所有者页面。
To view your changes, build the manual . Keep in mind that you can also build only the chapter you just edited to view it quickly. Open the generated files inside the build/html
folder using your web browser, or refresh the page if you have it open already.