PHP Web框架CodeIgniter 3.0 中文文檔
這里是 CodeIgniter 3.0.0 的中文文檔,翻譯自 CodeIgniter 官方的英文版本 , 并參考了 CodeIgniter 中國 提供的 CodeIgniter 2.2.2 中文手冊 。
文檔中的大部分內容我都進行了重新整理和翻譯,我并沒有對原文進行逐字逐句的推敲, 有些不好翻譯的地方使用了一些自己組織的語言進行潤色,力求做到語句通順,易于理解。
鑒于個人能力所限,翻譯之中難免犯錯,歡迎大家批評指正。 你可以在 Github 上直接提交 Issues ,或者 Fork 我的項目作出修改然后向我提交 Pull Request , 我會盡快修復文檔中的錯誤。
安裝步驟
CodeIgniter 的用戶指南是使用 Sphinx 軟件進行管理,并可以生成各種不同的格式。 所有的頁面都是采用 ReStructured Text 格式書寫,這種格式非常方便人們閱讀。
安裝條件
Sphinx 軟件依賴于 Python,如果你使用的是 OS X 系統,則系統已經自帶 Python 了。 你可以在終端中執行不帶參數的 python
命令,以確認你的系統是否已安裝 Python 。 如果你已安裝,會顯示出你當前所使用的版本。 如果顯示的不是2.7以上版本,你可以去這里下載并安裝2.7.2 http://python.org/download/releases/2.7.2/
- 安裝 easy_install
easy_install "sphinx==1.2.3"
easy_install sphinxcontrib-phpdomain
- 安裝 CI Lexer,它可以高亮文檔中的 PHP, HTML, CSS, 和 JavaScript 代碼 (參見 cilexer/README )
cd user_guide_src
make html
譯注:
- Ubuntu 系統上安裝 easy_install 可以直接:
sudo apt-get install python-setuptools
- easy_install 需要 root 權限,前面加上 sudo
編輯并創建文檔
所有的源文件都在 source/ 目錄下,在這里你可以添加新的文檔或修改已有的文檔。 如同代碼的修改一樣,我們推薦從你的 feature 分支發起 pull request 到這里的 develop 分支。
那么,HTML 文檔在哪里?
很顯然,HTML 文檔才是我們最關心的,因為這畢竟才是用戶最終看到的。 由于對自動生成的文件進行版本控制沒有意義,所以它們并不在版本控制之下。 你如果想要預覽 HTML 文檔,你可以重新生成它們。生成 HTML 文檔非常簡單, 首先進入你的用戶指南目錄,然后執行上面安裝步驟中的最后一步:
make html
你將會看到正在編譯中的信息,編譯成功后,生成的用戶指南和圖片都位于 build/html/ 目錄下。 在 HTML 第一次編譯之后,后面將只會針對修改的文件進行重編譯,這將大大的節約我們的時間。 如果你想再重新全部編譯一次,只需刪除 build 目錄然后編譯即可。
風格指南
使用 Sphinx 為 CodeIgniter 編寫文檔,請參考 source/documentation/index.rst 的一般準則。
文檔地址:http://github.com/aneasystone/ci-doc-chinese