本项目进行的翻译遵循以下原则:
- 尊重原文档的结构、格式
- 采用译、校、审流程
- 保持对上游文档的更新
- 添加Tiny微信 :xlbxiong
- 进行试译流程,就是翻译一个段落,以 1000 字为限,时间限制为 1 天。
- 如果通过就进入 solidity 翻译小组,进入翻译流程。
翻译流程主要分为以下几个环节:
- 未认领,当前状态
- 翻译,包括译者初译、修改等工作
- 选择尚未被认领的工单,备注认领信息,记得跟新状态
- 进行翻译和自我校对……
- 将翻译成果通过 PR(包含文档的commit hash) 的方式提交到仓库,等待校对意见
- 校对,对译者完成的翻译进行初步校对,主要涉及:
- 版式检查,链接检查,用语检查,内容错乱 如果初校过程中发现译文问题较多,可驳回要求译者修改,并指出重点问题。
- 完成,对进行过校对的文章整体审阅,符合项目质量、风格要求的译文,提交进入 develop 分支管理员发布,记得跟新状态
翻译项目为 Solidity 官方文档 0.6.4 版本,获取官方文档0.6.4 版本的方法为:
git clone [email protected]:ethereum/solidity.git
git checkout v0.6.4 -b v0.6.4 # 检出 v0.6.4版本
cd docs # docs 为文档所在目录
这里有一份Git和Github指南
git clone [email protected]:lbc-team/solidity-doc-cn.git
由于文档是sphinx 生成,最好安装下:
sudo pip install -U Sphinx
pip install sphinx_rtd_theme
pip install pygments-lexer-solidity
pip install sphinx-a4doc
make html
之后就可以打编辑器对照英文0.6.4版本进行翻译,翻译完成后提交pull request。
RST文档格式的一个中文说明
文档一个术语库,用于统一文档翻译中的术语使用。
术语库内的术语使用 RAW 格式的 HTML 5 RUBY 标签,鉴于主流浏览器和微信都支持它。格式如下:
.. |glossary| raw:: html
<ruby>术语<rp>(</rp><rt>glossary</rt><rp>)</rp></ruby>
而其它页面则在首部采用 .. include :: glossary.rst
标签统一引入术语库,并在使用该术语处采用 |glossary|
来引用该术语。
- 中文文案排版指北
- fork出的仓库如何同步源的内容:https://www.zhihu.com/question/28676261
- 如何检查文件(参考Solidity英文文档仓库)的提交哈希:
git log filename.rst
- 文档如何构建:目前文档托管在登链社区的CDN上,在管理员校对后,自动发布。
- 原英文文档更新怎么办:我们需要人去 tag 对比,查看更新内容,进行补充。