《Dive Into Python V5.4》中文翻译项目总结

OsmondLiang, ZoomQuiet

http://wiki.woodpecker.org.cn/moin/DiveIntoPythonZhSummary

提纲

• DIP 5.4 简体中文版本正式释放说明
• DIP 5.4 翻译工程的组织
• 翻译项目相关技术

DIP 5.4 简体中文版本正式释放说明

经过大家的共同努力，Dive Into Python 5.4 简体中文版终于在 2006/04/25 出炉了。

• 英文官方站： http://diveintopython.org
• 中文官方站： http://www.woodpecker.org.cn/diveintopython/
• 原来的 http://cn.diveintopython.org 已经重定向到了新地址。

DIP 的翻译成果

• 本次释放的版本 [DIP_5_4_CPUG_RELEASE] 是截止到 2006/04/25 的更新。
• 源代码SVN检出地址:
  • http://cvs.woodpecker.org.cn/svn/woodpecker/zh-translations/tags/DIP_5_4_CPUG_RELEASE/
• 压缩文件下载: http://www.woodpecker.org.cn/diveintopython/
  • HTML
  • HTML
  • CHM
  • XML

继续维护的版本

• 翻译过程中还会有疏漏，我们将继续维护 DIP 5.4 的中译版。
  • SVN地址： http://cvs.woodpecker.org.cn/svn/woodpecker/zh-translations/trunk/diveintopython/
• 大家对本译本有任何问题可以进一步讨论：
  • WIKI： http://wiki.woodpecker.org.cn/moin/DiveIntoPythonZh
  • BLOG： http://www.djangocn.org/blog/DiveIntoPython/
  • ML： [email protected]

翻译工程的组织

希望此信息对其他社区在组织类似的翻译项目时会有所帮助。

• 启 动 DIP中文翻译项目的缘由
• 项 目时间表
• 项 目工具
• 团 队协作和工作流程
• 翻 译和校对的工作流程
• 与 原作者和其他社区联系
• 其 他参与者
• 进 一步思考

启动 DIP 中文翻译项目的缘由(1)

• Python
  • Python 是一个面向对象的优秀的脚本语言
  • Dive Into Python 是一部经典的理解 Python 的书！
  • limodou 曾经翻译了 v1.0 版本，深受 Pythonic 喜爱
  • 中文版本的更新一直没有跟上进度
  • 对 Python 的喜爱
  • 想学习 Python 语言
  • 服务于广大的 Pythonic

启动 DIP 中文翻译项目的缘由(2)

• DocBook
  • DocBook 是种非常好学好用的技术图书组织工具！
  • Dive Into Python 是使用 DocBook 格式写作的。
  • 在翻译过程中学习 DocBook 相关文档技术。
  • 推广 DocBook 文档技术在国内的使用
• 应 ZoomQuiet 之邀
  • 交流过程历史记录 DiveIntoPythonZhConfabulate

项目时间表

• 立项：2005/12/01
• 翻译：2005/12/01 - 2006/03/12
• 第一次整体编译：2006/03/12
• 纠错：2006/03/12 - 2006/04/25
• 与原作者联系：2006/04/05
• 与Ubuntu社区联系：2006/04/20
• 发布：2006/04/25

项目工具

• 服务器端
  • trac+Subversion
  • 作者提供的 DocBook 脚本工具（经过修改）
  • python+xsltproc+Shell
  • 由于Java环境问题，在服务器上用 xsltproc 实现解析，具体的shell 脚本可以参考:build.sh
• 客户端
  • 作者提供的 DocBook 脚本工具
  • JDK+Python
  • SVN 客户端

团队协作

• 本项目是多人共同合作的结果，需要大量的协作交流。
• 大家主要以三种的方式进行协作交流：WIKI、gtalk、邮件列表。
  • 使用wiki：认领文件、汇报翻译和校对进度
  • 使用邮件列表：宣传本项目、招募翻译和校对人员、发布最新消息
  • 使用gtalk：进行实时交流，如翻译问题、术语核对等

工作流程的设立

考虑到本项目是一个多人协作的项目，必须设计好工作流程。

• 为译者提供 SVN 检入帐号
• 为了避免重复劳动，设置了翻译文件认领机制，遵循认领后再进行翻译的原则（在WIKI上认领）
• 在翻译期间，译者应该在WIKI页面上汇报翻译进度，若长时间没有进展，与其协商是否更换译者
• 在翻译期间，执行译者交叉审校机制，由译者间实现 一校、二校、三校，并在WIKI页面上汇报校对进度
• 在翻译后期，执行广泛校对机制，即将翻译结果释出由广大读者提出批评意见，并由译者团队人员进行修改

团队成员

• limodou (limodou AT gmail DOT com)
• Zoom.Quiet (zoom.quiet AT gmail DOT com)
• Jason Xie (jason AT sinoesl DOT org)
• YuLin (yulin724 AT gmail DOT com)
• Weigang LI (dimens AT gmail DOT com)
• wolfg (wolfg1969 AT gmail DOT com)
• Osmond (sinosmond AT gmail DOT com)

翻译工作流程

1. 在WIKI中认领要翻译的文件
2. 从SVN检出xml源码
3. 翻译xml文件
4. 本地编译输出html查看效果
5. 自行校对
6. 检入SVN

校对工作流程

• 译者交叉审校机制（有SVN检入帐号）
  1. 在WIKI中认领要校对的文件
  2. 从SVN检出xml源码
  3. 修改xml文件
  4. 检入SVN
• 广泛校对机制（无SVN检入帐号）
  • 适用于不熟悉 DocBook XML 的广大读者
  • 可以使用 WIKI、BLOG、邮件列表等途径汇报错误，再由有SVN检入帐号的成员修改xml源代码并提交

与原作者联系的主要任务

• 翻译前向原作者确认，以免重复劳动
• 对于使用非开源许可证的图书，翻译前应获得原作者授权
• 翻译后向原作者汇报，并确认发布地址

与 Ubuntu 社区联系

• 缘起：由于在Debian/Ubuntu中看到了 DiveIntoPython 的英文包，所以决定与国内的Ubuntu社区联系。
• 制作 .deb 包对HTML原包的要求（注意事项）
  • 文件使用 utf-8 编码
  • 每个文件应该以 换行符 结束
  • HTML原包不能包含 .svn 信息

与Ubuntu社区的交流过程

1. 与 http://ubuntu.org.cn 的站长 oneleaf  联系说明意图
2. 经 oneleaf 介绍与负责中文包的 HouZhengPeng& nbsp;取 得了联系
3. HouZhengPeng 与 http://ubuntu.org 确认是否可以将翻译结果纳入软件包库
4. 提供 HTML 包由 HouZhengPeng 制作 .deb 包
5. HouZhengPeng 提供了供测试的 .deb 包
6. 大家在 Ubantu/Debian 上测试
   • 使用 $ sudo dpkg -i diveintopython-zh_5.4-0ubuntu1_all.deb 命令安装并测试
   • diveintopython-zh_5.4-0ubuntu1_all.deb 啄木鸟本地分享，由SVN维护
7. 向 HouZhengPeng 汇报测试情况
8. HouZhengPeng 将测试好的 .deb 包提交给 Ubuntu 软件包仓库

其他参与者

• 员旭鹏 <recordus AT gmail DOT com> 制作了非官方pdf版
• 以下人员曾对译本提出过校对意见：
  • hydonless
  • nsinit <nsinit AT 163 DOT com>
  • Xie Yanbo <xieyanbo AT gmail DOT com>
  • ……

进一步思考——关于 trac

• 虽然在服务器上安装了 trac，但是在项目中并没有充分利用，如：Ticket功能的使用等
• 在安装了 trac 的情况下，也可以直接使用 trac 的 wiki 实现协同工作，即使用一个统一的管理工具
• 因为Trac 和SVN 紧密结合，是种非常好的针对具体项目的讨论平台

进一步思考——关于评注系统

• 当前在校对征求意见的过程中采用wiki、邮件列表、BLOG等方式，提供多种方式主要是为了方便大家使用自己习惯的工具
• 由于意见源种类多，不便于收集，最好能实现单一的意见源
• 最好安装配置基于 DocBook 的评注系统
  • review-system
  • Add a new dimension to your DocBook documents
  　

进一步思考——关于 翻译项目管理平台

• 熟悉 DocBook XML 的人毕竟是少数，直接修改源代码的方式不利于更多人的参与
• 期望能在不久的未来能为大家提供一个翻译项目管理平台，方便在线翻译

项目相关技术

• DocBook
  • The xsltproc tool
• Subversion 每日更新环境部署

  • 基本思想是通过 SubVersion 自动对更新的XML进行处理生成可读的页面:

  • 使用 SubversionHooks 脚本的定制，来作到将检入的文件自动更新到指定目录
    • 后来由于.deb包的要求，从原先 update 文件修正为 export --force文件到指定目录中
  • 使用 /etc/crontab 定时运行xsltproc 脚本来每日两次重构最终HTML 文件展示

讨论

谢谢大家！！