                      VIMCDOC TRANSLATION GUIDE


本文件用来作为一个翻译文档时的指南。包括必须统一的条目以及参考。任何意见和建议
请和 Willis (yianwillis@gmail.com) 联系。

https://github.com/yianwillis/vimcdoc

==============================================================================
Compulsory Rules ~

1. 不能改动原文件的格式！不能改变各文本的颜色！请打开语法高亮，并使用
>
   :syntax on
   :set list
   :set listchars=tab:>-,trail:-
<
   命令来显示所有的字符用来帮助排板。
   同时，VIM 在帮助文件中使用了很多标记字符，用来帮助语法高亮。
>
   :hi Ignore guifg=color
   :hi Ignore ctermfg=color
<
   可以使它们被显示出来 (使用比较醒目的 color)

2. 一些 VIM 的专用术语必须统一。参阅 dict.txt 中的 Compulsory 区。

3. 如果你不熟悉 VIM 帮助: 在 | | * * < > 等等之间的文本是 vim 用来 hyperlink
   的。不用翻译。

4. 各文件之间的衔接: VIM 文档各文件之间互相参阅, 例如在每个 usr_??.txt 的最后
   都将给出前后的文件主题, 翻译时请参考已经存在的文件, 以确保各个文件中的说法
   一致。

5. 所有文档应当使用 unix 行结束符。
>
   :set ff=unix
<
6. 当在 Vim 文档中出现全大写字母以表示某节的开始时，在翻译的中文字之间加入空
   格。例如：
	DELETING VARIABLES
   =>
	删 除 变 量

7. 行宽: Vim 帮助文件有固定的行宽--78，对于英文文本，Vim 可以自动排版，可是这
   对中文文本无效。所以，请在翻译时注意手动调整行宽，不要超过78。

8. 编码：所有翻译后的文本使用 UTF-8 编码。为保持最大兼容性，请在翻译完文档后，
   运行以下命令确保帮助文档能在 enc=euc-cn 环境下查看。

   $ iconv -f utf-8 -t euc-cn file.txt >/dev/null

9. 翻译日期：每个文档的第一行均有一个 Last Change: 翻译为 “最近更新” 然后使用
   译文的更新日期。

10. 标点符号不能出现在行首。对引号一律使用 *英文引号* 。

11. 关于 note, Note 的翻译：视情况而定，可译为 “注意” 或 “备注”，之后＿必须＿
    是英文 ':' 或空格。以便 Vim 正确地分割 keyword。

==============================================================================
Recommended Rules ~

1. 译者: 译者可将自己的名字 (nickname,etc) 置于文件中原文作者的名字下面一行。
   格式为 译者: （英文标点）名字。但应同时给出本项目网址:
   http://github.com/yianwillis/vimcdoc

2. 这个项目翻译的目标是 Vim 最新版本文档，如果你还在使用较老的版本，请到 Vim
   主页下载，不然文档中介绍新功能可能不适用。
   注意: 非 Vim 官方发行的 plugin 的文档目前不再翻译之列。

3. 标点符号：建议在不改变原文的意思前提下 "尽量" 使用中文标点。有些地方的标点
   有特殊的功能，不能翻译为中文。例如 regexp 中的'.'

4. 中英文混合：因为英文本身带有空格，而中文没有，建议在混合中英文时加入空格。
   如同上面条目 2 中提到 Vim 的名字时。这样比较清楚。


==============================================================================
Using AAP ~

你可以使用 AAP 来 commit 你的翻译结果。 建议 Vimdoc 翻译的成员使用 AAP。 AAP
是跨平台的，在 Linux/BSD 和 Windows 平台都可以使用。

1. 以下是 lang2 在 translate mailinglist 中发的一份用法。

Download AAP from http://www.a-a-p.org

> In an effort to make my life (an hopefully others)
> easier :-), I've been playing with Bram's new toy - aap
>  for a while. I am now coming to a stage where it can be
>  used to more or less replace those Makefiles.
>
> I've checked in three file:
> data/common.aap
> data/doc/main.aap
> data/doc/vim2html.pl
>
> These at this moment only handles automatic updating
> of the HTML version of the translation for both sites
> (wandys have to patch the recipe for cosoft). I've tested
> it with pi_gzip.txt (forgot to mention this) and it
> looks OK so far.
>
> I'd like to suggest you to install aap (http://www.a-a-p.org)
> and give it a try. It won't hurt you. After the installation,
> the first thing you have to do to use it is to modify the
> common.aap to use your own sf handle. Then goto data/doc and try this:
> - 'aap' will tell you what you can do
> - 'aap <filename.txt>' will check in your change to that file
> and generate HTML version and copy it to the remote server.
>
> Quite easy isn't it?

2. 在 Windows 平台上要注意的问题。
  (1) AAP 安装完毕后，记得要把 AAP 可执行文件的路径和其下的子目录 bin 加到环境
      变量 PATH 中。在我这里，是这两个目录：
>
      C:\Program Files\Aap\Exec; C:\Program Files\Aap\Exec\bin
<
  (2) lang2 编写的脚本里面用到几个命令行软件:tar,gzip, 一般情况下，Windows 用
      户没有这些软件，不过没关系，可以很方便的使用 AAP 下载。直接在 Dos 窗口中
      执行:
>
      aap --install tar
      aap --install gzip
<
      软件自动安装在 AAP 子目录 bin 下面。

  (3) 还有一个软件 NSIS 需要安装。它是用来制作 vim 文档的 Windows 安装程序的。
      它的网址是 http://nsis.sf.net 。记住：安装完毕后，也要把的路径加到环境变
      量 PATH 中，只有这样，脚本才能使用这个软件。

  (4) 如果想发布软件，需要输入下面的命令：
>
      aap release
<
      会生成两个软件包，*nix 和 Windows 的安装包

 vim:tw=78:ts=8:ft=help:norl:
