编辑手册¶
你可以通过修改本地文件来修改手册。这些文件通过代码仓库与在线文档同步,文档更新正是基于这个服务器。
手册使用 reStructuredText (RST) 标记语言编写,并且可以使用纯文本编辑器编辑。可以将 RST 文件转换(编译)为 HTML 网页文件,来进行本地预览。
更新¶
首先,确保你的本地手册副本与在线资料库是最新的,使用:
make update
编写¶
现在你可以根据自己的喜好选择文本编辑器编辑文档文件,这些文档位于 manual
文件夹中的 .rst
文件。
请务必检查约定写作样式指南,并标记样式指南以了解如何使用 reStructuredText 标记语言编写。
开始写作吧!
较大的修改¶
如果你打算添加或大修某一节,一定要仔细检查,确保现有手册没有这些内容。在一些地方,文档是如此杂乱无章,以至于一些章节内容重复或者位于某个奇怪的位置。在你找到一个重复或位置不当的章节后,请新建任务,把问题解释清楚,还可以附带一份修改(真正的更改)。
在你做出一些不那么简单明了的修改(如,移动文件夹)之前,你需要与手册维护人员确认你的贡献与社区对手册的设想是一致的。这能确保你的时间与善意得到最好的利用,否则的话,因为某些原因,你的修改可能会因造成冲突而被驳回或者经历费时的审查。例如,另外一个人可能已经在负责你想要修改的章节,这一节可能已经计划要删除,或者根据 Blender 的计划变动而相应更新。
提早并频繁地交流是维持一个高效环境的关键,这样才不至于浪费别人的努力,并且完成一份更好的 Blender 手册。
获取帮助/答案¶
如果你对所要记录的功能存在疑问,你应该向负责这一块的 Blender 开发人员提出你的疑问,或者在 讨论 中的非官方用户支持频道 #docs
或 #blender-coders
中提问。
Blender 有自己的模块所有者系统,包括负责指定 Blender 区域设计和维护的开发人员和艺术家。详情参考模块所有者页面。
预览¶
要查看您的更改,请按照说明构建手册。请记住,您也可以只创建您刚刚编辑的章节,以便快速查看。使用网络浏览器在 build/html
文件夹中打开生成的 .html
文件,或者刷新已打开的页面。
上传¶
如果你很满意自己的修改,您可以将它们上传,将其呈现于在线手册中。第一步是提交补丁,从而使他人可以审查你的修改,并给出反馈。之后,你可以直接提交更改。下一节会详细介绍相关流程。