diff --git a/LICENSE b/LICENSE index 781372a4..568a9629 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ -The Vimcdoc License, Version 0.1 +The Vimcdoc License, Version 0.2 -Copyright (C) 2003 The Vimcdoc team (http://vimcdoc.sf.net, -http://vcd.gro.clinux.org). All rights reserved. +Copyright (C) 2013 The Vimcdoc team (http://github.com/yianwillis/vimcdoc, +http://vimcdoc.sf.net). All rights reserved. This software is provided 'as-is', without any expressed or implied warranty. In no event will the author be held liable for any damages @@ -17,10 +17,10 @@ are met: 2. No commercial use of this software are allowed without written permission from the author. For written permission, please contact - lang2@users.sourceforge.net - + yianwillis@gmail.com + 3. The origin of this software must not be misrepresented; you must - not claim that you wrote the original software. + not claim that you wrote the original software. 4. Copyright of the individual documents are retained by the author of the document. diff --git a/NEWS b/NEWS index edb2591a..53503c97 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,7 @@ +Migrated to github (7 Sep 2013) by Willis +We are going to migrate our platform to github.com and future work will be +performed there instead of sourceforge.net. + 1.9.0 released (25 Aug 2013) by Willis Fully updated to Vim 7.4. diff --git a/README b/README deleted file mode 100644 index 445eb023..00000000 --- a/README +++ /dev/null @@ -1,49 +0,0 @@ - V i m 中 文 文 档 - -关 于 - -Vim (http://www.vim.org) 是一个功能非常强大，且具有很强扩展 -性的编辑器。而且 Vim 本身带有一个完备的帮助系统。本项目的目 -的就是将 Vim 的这些文档翻译成中文，以便更多的人认识及更好的 -使用这个非常强大的编辑器。文档分成 用户手册 和 参考手册 两 -部分，你即可以象使用教程那样循序渐进，也可以快速的查阅来获取 -帮助。 - -关于如何安装，请看 INSTALL。 -AUTHORS 列出了翻译人员。 -LICENSE 包括版权信息。 - - -加 入 - -我们欢迎各种各样的帮助，翻译，测试，等等等等。如果你也想加入 -本项目的话，请直接与我们联系 (见下) 并同时阅读 guides.txt 和 -TODO 文件。 - - -信 息 - -欢迎访问我们的主页以获取更多的信息和最新的版本: -http://vimcdoc.sf.net (English) -http://vcd.gro.clinux.org （中文） - -如果你希望在有新的版本发布时自动得到通知，可以订阅我们的 -邮件列表 vimcdoc-announce。方法是发信到 -mailto: vimcdoc-announce-request@lists.sourceforge.net -subject: subscribe - -你也可以订阅我们的用户邮件列表 vimcdoc-user，用来和其它用户 -交流，或得到使用中问题的解答。订阅的方法是 -mailto: vimcdoc-user-request@lists.sourceforge.net -subject: subscribe - -另外，你还可以使用 RSS 的方式来得到关于项目的最新消息： -项目新闻 RSS： -http://sourceforge.net/export/rss2_projnews.php?group_id=56777 -项目文件发布 RSS： -http://sourceforge.net/export/rss2_projnews.php?group_id=56777&rss_fulltext=1 - - -联 系 - -建议,问题，等等，请送往 yianwillis@users.sourceforge.net diff --git a/README.md b/README.md index f4a8b578..c332774a 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,38 @@ vimcdoc ======= Vim 中文文档计划 + +关 于 + +Vim (http://www.vim.org) 是一个功能非常强大，且具有很强扩展性的编辑器。而且 Vim +本身带有一个完备的帮助系统。本项目的目的就是将 Vim 的这些文档翻译成中文，以便更 +多的人认识及更好地使用这个非常强大的编辑器。文档分成 用户手册 和 参考手册 两部 +分，你即可以象使用教程那样循序渐进，也可以快速地查阅来获取帮助。 + +关于如何安装，请看 INSTALL。 +AUTHORS 列出了翻译人员。 +LICENSE 包括版权信息。 + + +加 入 + +我们欢迎各种各样的帮助，翻译，测试，等等等等。如果你也想加入本项目的话，请直接 +与我们联系 (见下)，同时请先行阅读 guides.txt。 + + +信 息 + +欢迎访问我们的主页以获取更多的信息和最新的版本: + +https://github.com/yianwillis/vimcdoc + +这将是我们的新主页。原版本 + +http://vimcdoc.sf.net (English) + +的内容已经完整导入。以后的更新也只会在 github 进行。 + + +联 系 + +任何建议、问题等等，请送往 yianwillis@gmail.com。 diff --git a/guides.txt b/guides.txt index 6800e3a2..41632f24 100644 --- a/guides.txt +++ b/guides.txt @@ -1,163 +1,88 @@ VIMCDOC TRANSLATION GUIDE -本文件用来作为一个翻译文档时的指南。包括必须统一的条目以及参考。 -任何意见和建议请在 vim-translate mailinglist 讨论。 - -http://vimcdoc.sf.net -http://vcd.gro.clinux.org - -Note: -后者是本项目的中文主页。请在翻译前先确认要翻译的文档没有被翻译过。 -以下讨论仅以 sourceforge 为例。 - - -============================================================================== -Sourceforge ~ - -本项目使用 sourceforge 服务。翻译人员必须有一个 sourceforge-ID。你可以到 -http://www.sourceforge.net 申请。并通知项目管理员将你加入 developer list。 - - -============================================================================== -CVS ~ - -从 2006 年 5 月 15 日起，vimcdoc 转用 Subversion 做版本管理。CVS repository 将 -被废弃。 - -============================================================================== -Subversion ~ - -vimcdoc 的 Subversion repository 也由 Sourceforge 提供。现在有两个分支：trunk -和 vim6，分别位于： - -https://svn.sourceforge.net/svnroot/vimcdoc/trunk -和 -https://svn.sourceforge.net/svnroot/vimcdoc/branches/vimcdoc-vim6 - -trunk 用来更新完善 Vim 7.x 的翻译文档。vim6 分支用来维护 vim 6.x 相关的内容。 - -关于 svn 的使用，请参阅 sourceforge 文档 -http://sourceforge.net/docs/E09, http://sourceforge.net/docs/B01 -以及 Subversion 的官方文档 -http://svnbook.red-bean.com/ - -Note 在 svn commit 时，尽量填写有意义的注释，并包括以百分比表示的翻译完成的进度。 - -============================================================================== -Mailing List ~ - -http://sourceforge.net/mail/?group_id=56777 -项目共有3个mailing lists: -1. vimcdoc@googlegroups.com - 翻译者必须 subscribe 这个 mailing list 以和大家交流，互相帮助，保持一致。 - 这个是用来替代 sourceforge 原有的 vimcdoc-translate 的。因为旧的 list 稳定 - 性稍差。曾经瘫痪的半月之久。 - http://groups.google.com/group/vimcdoc/subscribe -2. vimcdoc-announce - 发布对外消息。如新版本发行等。 - mailto: vimcdoc-announce-request@lists.sourceforge.net - subject: subscribe -3. vimcdoc-cvs - 用来自动通知 subversion commit 的状态。 - mailto: vimcdoc-cvscommit-request@lists.sourceforge.net - subject: subscribe +本文件用来作为一个翻译文档时的指南。包括必须统一的条目以及参考。任何意见和建议 +请和 Willis (yianwillis@gmail.com) 联系。 +https://github.com/yianwillis/vimcdoc ============================================================================== Compulsory Rules ~ -1. 不能改动原文件的格式！不能改变各文本的颜色！ - 请打开语法加亮，并使用 +1. 不能改动原文件的格式！不能改变各文本的颜色！请打开语法高亮，并使用 > :syntax on :set list :set listchars=tab:>-,trail:- < 命令来显示所有的字符用来帮助排板。 - 同时，VIM 在帮助文件中使用了很多标记字符， - 用来帮助语法加亮。 + 同时，VIM 在帮助文件中使用了很多标记字符，用来帮助语法高亮。 > :hi Ignore guifg=color :hi Ignore ctermfg=color < - 可以使它们被显示出来(使用比较醒目的 color) - -2. 一些 VIM 的专用术语必须统一。参阅 dict.txt - 中的 Compulsory 区。 + 可以使它们被显示出来 (使用比较醒目的 color) -3. 在开始翻译一个新的文档前，请 cvs update 你的 - doc 目录，并确认你所要翻译的文档不在其中。 - 在确定之后，cvs add && cvs checkin 一个 "完整" - 的英文原文用来通知大家该文档已被 taken。请不要 - commit 一个空文件。( 在决定要翻译哪个文件时， - 请参考 TODO 文件。) +2. 一些 VIM 的专用术语必须统一。参阅 dict.txt 中的 Compulsory 区。 -4. 如果你不熟悉 VIM 帮助: 在 | | * * < > 等等 - 之间的文本是 vim 用来 hyperlink 的。不用翻译。 +3. 如果你不熟悉 VIM 帮助: 在 | | * * < > 等等之间的文本是 vim 用来 hyperlink + 的。不用翻译。 -5. 各文件之间的衔接: VIM 文档各文件之间互相参阅, - 例如在每个 usr_??.txt 的最后都将给出前后的 - 文件主题, 翻译时请参考已经存在的文件, 以确保 - 各个文件中的说法一致。 +4. 各文件之间的衔接: VIM 文档各文件之间互相参阅, 例如在每个 usr_??.txt 的最后 + 都将给出前后的文件主题, 翻译时请参考已经存在的文件, 以确保各个文件中的说法 + 一致。 5. 所有文档应当使用 unix 行结束符。 > :set ff=unix < -6. 当在 Vim 文档中出现全大写字母以表示某节的 - 开始时，在翻译的中文字之间加入空格。例： +6. 当在 Vim 文档中出现全大写字母以表示某节的开始时，在翻译的中文字之间加入空 + 格。例如： DELETING VARIABLES => 删 除 变 量 -7. 行宽: Vim 帮助文件有固定的行宽--78，对于英文 - 文本，Vim 可以自动排版，可是这对中文文本无效。 - 所以，请在翻译时注意手动调整行宽，不要超过78。 +7. 行宽: Vim 帮助文件有固定的行宽--78，对于英文文本，Vim 可以自动排版，可是这 + 对中文文本无效。所以，请在翻译时注意手动调整行宽，不要超过78。 -8. 编码：所有翻译后的文本使用 UTF-8 编码。 - 为保持最大兼容性，请在翻译完文档后，运行以下 - 命令确保帮助文档能在 enc=euc-cn 环境下查看。 +8. 编码：所有翻译后的文本使用 UTF-8 编码。为保持最大兼容性，请在翻译完文档后， + 运行以下命令确保帮助文档能在 enc=euc-cn 环境下查看。 $ iconv -f utf-8 -t euc-cn file.txt >/dev/null -9. 翻译日期：每个文档的第一行均有一个 Last Change: - 翻译为 “最近更新” 然后使用译文的更新日期。 +9. 翻译日期：每个文档的第一行均有一个 Last Change: 翻译为 “最近更新” 然后使用 + 译文的更新日期。 10. 标点符号不能出现在行首。对引号一律使用 *英文引号* 。 -11. 关于 note, Note 的翻译：视情况而定，可译为“注意” - 或“备注”，之后＿必须＿是英文 ':' 或空格。这样做 - 是为了便于 Vim 分割 keyword。 +11. 关于 note, Note 的翻译：视情况而定，可译为 “注意” 或 “备注”，之后＿必须＿ + 是英文 ':' 或空格。以便 Vim 正确地分割 keyword。 ============================================================================== Recommended Rules ~ -1. 译者: 译者可将自己的名字(nickname,etc)置于 - 文件中原文作者的名字下面一行。格式为 译者: - （英文标点）但建议同时给出本项目网址: - http://vimcdoc.sf.net。 +1. 译者: 译者可将自己的名字 (nickname,etc) 置于文件中原文作者的名字下面一行。 + 格式为 译者: （英文标点）名字。但应同时给出本项目网址: + http://github.com/yianwillis/vimcdoc -2. 这个项目翻译的目标是 Vim 6.3 的文档，如果 - 你没有这个版本,请到 Vim 主页下载。注意：非 - Vim 官方发行的 plugin 的文档不再翻译之列。 +2. 这个项目翻译的目标是 Vim 最新版本文档，如果你还在使用较老的版本，请到 Vim + 主页下载，不然文档中介绍新功能可能不适用。 + 注意: 非 Vim 官方发行的 plugin 的文档目前不再翻译之列。 -3. 标点符号：建议在不改变原文的意思前提下"尽量" - 使用中文标点。有些地方的标点有特殊的功能， - 不能翻译为中文。例如 regexp 中的'.' +3. 标点符号：建议在不改变原文的意思前提下 "尽量" 使用中文标点。有些地方的标点 + 有特殊的功能，不能翻译为中文。例如 regexp 中的'.' -4. 中英文混和：因为英文本身带有空格，而中文没 - 有，建议在混和中英文时加入空格。如同上面 - 条目 2 中提到 Vim 的名字时。这样比较清楚。 +4. 中英文混合：因为英文本身带有空格，而中文没有，建议在混合中英文时加入空格。 + 如同上面条目 2 中提到 Vim 的名字时。这样比较清楚。 ============================================================================== Using AAP ~ -你可以使用 AAP 来 commit 你的翻译结果。 建议 Vimdoc 翻译的成员使用 AAP。 AAP +你可以使用 AAP 来 commit 你的翻译结果。 建议 Vimdoc 翻译的成员使用 AAP。 AAP 是跨平台的，在 Linux/BSD 和 Windows 平台都可以使用。 -1. 以下是 lang2 在 translate mailinglist中发的一份用法。 +1. 以下是 lang2 在 translate mailinglist 中发的一份用法。 Download AAP from http://www.a-a-p.org @@ -165,18 +90,18 @@ Download AAP from http://www.a-a-p.org > 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 @@ -184,31 +109,32 @@ Download AAP from http://www.a-a-p.org > - 'aap' will tell you what you can do > - 'aap ' 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 窗口中执行： - +< + (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: