十分钟 QuickStart 《PHP 手册中文翻译指引》

过期提醒

现在 PHP 手册已经迁移到 Github 了,下文中的在线编辑器已经失效,新浪图床地址亦已失效。可通过 GitHub Pull Request 编辑源码。此外我还搭建了分钟级别构建 Pull Request 的镜像站点供预览,位于腾讯云,在大陆访问速度比官方更好。

于 2021-12-08

前言

从 2011 年我开始尝试 PHP 中文手册翻译以来,遇到一系列问题。实际上中文翻译的门槛是比较低的,然而由于学习资源稀缺,阻碍了大家的参与。

这篇教程总结了常见的问题,并且它会保持更新的状态。

翻译前置知识

很多人以为参与翻译需要较好的英文功底,实际上,翻译最重要的是中文能力——不要看到这里就觉得以自己母语水平就足矣胜任,不信你翻翻手册,很多遣词造句生涩难懂,一股“哦我的老天爷,能见到你真是太好了”的翻译腔

“信达雅”的翻译要求里,技术手册最注重的应该是“信”,即准确。为了准确理解句子含义,甚至需要自己跑测试代码来保证自己理解的原句含义和实际情况一致。甚至见到很多 bug 报告,指出原文被译反了,这罪过就大了。

其次是“达”和“雅”并重,能把原文合理翻译,适当增减词语。比如曾有前辈指出,中文没有量词的习惯而英文有,所以要控制 “a” 翻译成 “一个” 的情况,如果不加“一个”也不影响原意,就可以适当删减。再比如一些英文词汇,用原词反而更容易理解。例如 yield, trait。这个时候,可在中文翻译后加括号带入原词,甚至可以不译(比如 Trait 这个词)。

PHP 中文手册前置知识

PHP 的中文手册以 XML 格式托管在 PHP 官网的 svn 服务器上。官网的 HTML、chm 和各类第三方编译的手册原始资源都来自于此。 要更新全网的 PHP 手册,只需编辑此 XML 源文件,审核进入 svn 即可。

十分钟 QuickStart

掌握翻译的基本精髓后,就可以尝试对中文手册进行编辑。我可以保证只要翻译合理,根据这十分钟 Quick Start 你的成果就会出现在最新的 PHP 中文手册上,包括官网。

一、挑选目标页面

比如看到 mysql_fetch_array 页面返回值这段未翻译,我们希望完成翻译。请先不要选择新翻译一个章节,后面的教程还有其他知识点。

二、进入在线编辑器

在线编辑器 https://edit.php.net/,语言模块选择 Chinese (Simplified)。对于新手,使用边上的 oAuth 匿名登录即可进入访客模式,并且能够保存工作进度。 菜单

我们挑选的目标网页 URL 是 http://php.net/manual/zh/function.mysql-fetch-array.php 所以复制其中的 function.mysql-fetch-array,在 All files 中搜索。 All files en 开头的是英文源文件,第二个文件 zh 开头的是我们要编辑的中文源文件。

三、xml 源文件的格式

很快我们找到了文件中未翻译的部分,见截图 Xml source

需要注意

提供翻译示例。 Examples

其他注意事项

可以发现,我省略了单词 “you” 的翻译,是因为这是英文习惯用法,而中文习惯里会较少出现。建议学习《余光中:怎样改进英式中文?——论中文的常态与变态》

然后选择保存,如果没有提醒 XML 语法错误,就可以在 Work in progress 菜单,找到你的用户名和刚才的文件 Work in progress

创建新补丁,等待审核。如果长时间无人审核,你可以发邮件到新闻组 [email protected] 提醒。审核通过后,将收到邮件提醒,并且大约在一个星期左右同步到官网和所有镜像。

小提醒一:这个 URL 更新最快 PHP: PHP 手册 - Manual,它是 PHP 的文档编译服务器。一旦翻译文件进入 svn 代码库,在数个小时内就会更新。

小提醒二:不要因为补丁被接受了就急冲冲去修改手册首页上贡献者名单(还真见过这样的人);如果您长期付出,其他人会自愿把您加入到名单之中。就像佛教说的发心,如果你有意愿贡献 PHP 开源组织,一切都会有。

联系我

如果你有其他疑问可以联系我 [email protected] (建议用国外邮件服务商,QQ 邮箱会被拦截)

参考资源

文章评论:做一头严肃的大叫驴

根据过去的经验得出,大多数评论是毫无意义的灌水,还有一小部分内容是针对文章的补充和纠错。如果你有建议请邮件联系。