中文文档翻译指南


#1

中文文档翻译指南

Julia 中文社区(本地化)群号: 727669138,加群请注明 Transifex ID,有关翻译的任何问题,请到群里提问。

翻译工具

  1. Transifex 平台的注册及使用方法
  2. Transifex 编辑器的使用技巧

排版风格

排版风格请参考中文文案排版指北, 我们采用以下几条:

空格

全角和半角

名词

对于排版的一些补充

  1. 请再次确保理解了上述排版风格,尤其是“中文标点与任何字符之间都不加空格”这一条。建议打开空格符显示,否则容易忽略中文标点句号后面的空格。
  2. 禁止使用斜体,原文中的斜体请用粗体代替。粗体加空格的规则是由其内容决定的,例如,这一句中的 bold 是英文,按照“中英文之间需要加空格”这一条,需要在两端添加空格。
  3. 同理,行内代码 code超链接加空格的规则也是由其内容决定的。
  4. 由于翻译后的内容几乎全是中文,所以根据“使用全角中文标点”这一条,要重点检查是否有遗漏的英文标点。
  5. 这里也推荐读一下其它注意事项

翻译指南的讨论及反馈
#2

Transifex平台的注册及使用方法

  1. 登陆 https://www.transifex.com,点击TRY FOR FREE注册账号

  2. 注册之后第一次登陆,选择加入已存在的项目

  3. 搜索“JuliaCN”(注意大小写)

  4. 选择你想翻译的项目,比如manual,点击加入团队

  5. 点击翻译,并选择待翻译的文档

  6. 开始翻译


#3

Transifex编辑器的使用技巧

1. 显示空格符

1
2

2. 提交修改建议

对于已经审核过的词条,仍可提交翻译建议:
1

3. 给修改建议投票

1

4. 在历史中可以对比译文之间的差异

1

5. 提出问题来征集大家的意见

[注释]-[添加为问题]:

问题会显示在项目首页:

6. 活用过滤器

例如,搜索某个翻译者翻译的某个词:


#4

其它注意事项

辨识 Transifex 的分段 bug

以```开头和结尾的部分是代码块,例如:

但有些代码块会识别错误,需要留意一下:

辨识 Julia 文档中的特别关键字 !!!

Julia 文档有一些特定标识符,例如,!!! info!!! note!!! warning等等,这些不要翻译,而且原文的对齐格式要保留:

辨识 [xxx](@ref) 交叉引用

中括号里的内容 xxx 必须在整个文档中保持一致,否则在构建文档时会丢失相关超链接,例如:

上面的 Type Declarations 必须全文翻译都一致才行。这部分大多是一级或二级标题,@woclass 已经在术语表中打好了 tag,翻译方法请参考此帖

澄清一点,这里只有 [xxx](@ref) 这种形式的标题需要注意,对于 [Compound Expressions](@ref man-compound-expressions) 这种有 id 的就不用管了,正常翻译即可。


#6

维护及同步

Markdown文档

1. 自动更新源文件

Transifex会根据设置的 URL 每天同步2次源文件,请注意要使用 Github 的 raw content:
1

(目前,我们将文档源文件锁死在v1.0.0版本,以后可以跟踪master,即JuliaZH.jl的master分支与Julia的master分支文档同步,版本release的分支与Julia保持一致)

2. Transifex客户端的使用

[manual-zh_cn.arraysmd]                        # Transifex远程同步路径,`项目名.文件名`            
file_filter = <lang>/doc/src/manual/arrays.md  # 本地同步路径
minimum_perc = 0                               # 判断是否同步的翻译百分比门限
source_lang = en                               # 源文件的语言
type = GITHUBMARKDOWN                          # 文件类型

docstrings

暂未实现,请关注 https://github.com/Roger-luo/Localize.jl/issues/7