文档翻译规范 & 约定

为了规范文档,提高文档质量和一致性,文档格式建议如下:

翻译方法

文件结构:

+- /doc
|  +- {script_name}.cnx
|  `- {script_name}.txt
`- /README.md
  • 翻译的文档与原始文档同名,后缀改为 .cnx
  • 保留(一般是英文)原始文档 .txt 文件。
  • 文件放置到 /doc 目录中(如 /doc/vimwiki.cnx)。

规范 & 约定

  • 每行不超过 80 列。
  • 中文与英文之间用英文空格间隔。
  • 恰当的使用中文标点,如逗号(,),句号(。),引号(“”)。
  • 使用空格而不是 <Tab>
  • 尽量保持原始文档的风格。

文档相关

Vim 文档由 tags 来链接各个相关的帮助信息,tags 是包含在两个星号之间的关键字, 在 Vim 中使用 :helptags 命令会根据这些信息生成 tags:

*help-tags*

要链接到这些 tags,则将关键字放置在两条竖线之间:

|help-tags|

Vim 文档中如果有代码,可以放置在两个相对的尖括号间,起始括号之后不能有其他字符, 每行代码也需要有空白开始。

下面是实例代码: >
this is code.
more codes.
<

除代码外,标点符号建议使用全角的中文标点,如“,”,“。”等。

署名

建议在自己参与的文档上署名。署名一般是留下自己的真实姓名或者虚拟的昵称,和自己 常用的邮箱地址。这一个是对自己所作付出的认可,也是对自己的工作负责,另外如果其 他人有问题,可以方便和你联系。一般格式为:

闲耘™ (hotoo.cn[AT]gmail.com)

或者:

闲耘™ <hotoo.cn[AT]gmail.com>

中间的 [AT] 是为了防止垃圾邮件,你也可以直接使用 @ 或者其他容易识别的字符。

如果你有建议,请联系 hotoo.cn[AT]gmail.com

Fork me on GitHub