有一个月左右的时间都没有写博客了,这是因为这个月整个人的心思全都花在对 CodeIgniter 3.0 文档的翻译工作上。从我的 GitHub 主页上也可以看到从7月12号开始到今天8月4号,连续24天提交一直没有间断过。

streak.png

一、序

翻译 CodoIgniter 的文档纯属一个偶然的想法,由于在网上经常会看到有人问 3.0 的中文文档什么时候出?而 CodeIgniter 3.0.0 从5月份发布到现在确实也过去快3个月了,而中文文档在这点上确实有着严重的滞后。正好这段时间比较清闲,打算将之前2.2版本的一个项目升级到3.0,而升级的过程中也遇到了不少的问题,于是就决定将 CodeIgniter 3.0.0 的文档从头到尾仔细看一遍。刚好又在网上看到有人问中文文档的事,于是想着为啥我不自己来试着翻译下呢,就这样一边啃着 3.0.0 的英文文档,一边对照着 CodeIgniter 中国的 2.2.2 版本的中文文档,悄悄的就过了一个月了。

经过这一个月的努力,我发现翻译工作确实非常辛苦,在这里不得不对那些从事技术书籍翻译的人表示敬意,也对网络上那些对技术文档提供中文翻译的大牛表示敬意。同时也对中文技术文档的缺少和滞后感到无力,不止是 CodeIgniter,只要你去搜你就会发现无论是 PHP 的文档也好,MySQL 的文档也好,最新的中文文档都要落后几个版本。希望能有更多的人加入到技术文档的翻译工作中来。如果有哪位朋友正在翻译,欢迎联系我,我愿尽薄力。

二、问题反馈

由于本人能力和精力有限,翻译之中难免犯错,欢迎大家批评指正。你可以通过三种途径来反馈问题:

  1. 直接在我的博客上留言;
  2. 在 GitHub 上直接提交 Issues ;
  3. 或者 Fork 我的项目作出修改然后向我提交 Pull Request 。

我会尽快修复文档中的错误。

三、构建你自己的文档

所有 CodeIgniter 文档的源文件都可以从我的 GitHub 上获取,地址是:https://github.com/aneasystone/ci-doc-chinese。你首先需要使用 git clone 将它获取下来:

$ git clone https://github.com/aneasystone/ci-doc-chinese

CodeIgniter 的文档是采用 ReStructured Text 格式编写的,所以如果你想自己添加或修改文档的话,可以先熟悉下 ReStructured Text 的语法,如果你对 Markdown 的语法有所了解,相信你能很快上手的。

另外,你的电脑上需要安装 Python 和 Sphinx,Sphinx 是一个非常强大的文档生成工具,使用它不仅能生成漂亮美观的 HTML 文档,还可以生成其他的各种格式,包括:PDF,EPUB,LaTeX 等等等等。这里有一篇 IBM 的文章介绍了如何通过 Sphinx 制作文档,你可以简单的看一看。如果你想完整的学习它,这里是有一份 Sphinx 的中文文档,也可以去官网看最新的英文文档

除了 Sphinx ,还需要安装 Sphinx 的扩展 sphinxcontrib-phpdomain 和 CodeIgniter 自带的一个程序 cilexer ,cilexer 实际上是 Pygments 的一个插件,用于文档中的代码高亮。具体的安装步骤中文文档里有详细的说明。

一切准备就绪后,你就可以直接使用 make html 来生成 HTML 文档了。

make-html.png

当然,你也可以使用 make epubmake pdf 来生成其他格式的文档,具体的用法可以看下 Makefile 文件。

四、资源

如果你不想自己折腾,我已经将编译好的 HTML 文件发布到我自己的网站上了,你可以直接在线查看,你也可以和 CodeIgniter 2.2.2 的中文文档(已升级)以及官方的英文版本对照阅读。另外,文末我也提供了离线版下载,你也可以下载到你的电脑上查看,Enjoy!

另外,CI 中国也推出了 3.0 的中文文档,建议以该文档的最新版本为准,可以在上面与其他网友进行讨论!

CodeIgniter 3.0.0 中文文档(CI 中国版)

CodeIgniter 3.0.0 中文文档(本站备份)

CodeIgniter 3.0.0 官方英文文档

CodeIgniter 3.0.0 中文文档下载

扫描二维码,在手机上阅读!