CodeIgniter 4 Traditional Chinese(Taiwan) User Guide - codeigniter4 繁體中文(台灣)使用手冊翻譯計畫
中文翻譯的文字排版請以 中文文案排版指北 為主。
專業名詞與框架內用語的統一譯名請以 翻譯詞彙對照表 文件文主;若有新名詞未定義或是有爭議,則請發 issue 討論,我們將會持續更新內容。
繁體中文翻譯請盡量遵守 CodeIgniter3 使用手冊 的翻譯風格。
簡體中文版本的 CodeIgniter4 使用手冊 也正在翻譯中,可以參考其翻譯但不接受直接以簡體中文轉換為繁體中文。請注意,中國與台灣在程式開發專業詞彙上的譯名大不相同。
- fork 一份完整的程式碼。
- 至翻譯認領串認領欲翻譯的檔案。
- 在主線上產出一條屬於你的分支。
- 翻譯結束後編譯一次預覽翻譯效果,並且重複校稿。
- 在分支上 push 你所修改的檔案。
- 回到 github 發出 pull requests。
所有的提交的內容都必須要留下你的簽名,比如說:John Doe <johndoe@example.com>
,其設定方式與你使用 git 的媒介有所不同,請務必設定完成後再進行提交。
CodeIgniter 使用手冊基於 Sphinx 進行撰寫,它可以管理文檔並且輸出成各種格式。頁面以人類可讀的 eStructuredText 格式進行撰寫。
Sphinx 需要 Python3.5+ ,如果你的作業系統是 MacOS 或是 Ubuntu ,則內建了 Python 。你可以透過 Terminal 確認你的版本:
python --version
Python 2.7.17
python3 --version
Python 3.6.9
如果你使用的版本並非 3.5 以上,請透過 Python.org <https://www.python.org/downloads/>
_ 更新或重新安裝。Linux 應該使用作業系統內建的軟體管理器進行更新。
現在,你已經擁有了 Python3.5+ ,你還必須擁有
pip <https://pip.pypa.io/en/stable/>
_ (python套件管理器)。
你可以使用 pip
或是 pip3
檢查你是否安裝了 pip 。pip 遵循了與 python 相同的命名規則。請注意,他應該會在最後寫著 python 3.x 。
pip --version
pip 9.0.1 from /usr/lib/python2.7/dist-packages (python 2.7)
pip3 --version
pip 9.0.1 from /usr/lib/python3/dist-packages (python 3.6)
如果你是從 Python.org <https://www.python.org/downloads/>
_ 下載了 Python3.5+ ,那麼 pip 已經自動安裝好了。
現在,我們需要安裝 Sphinx 和它所依賴的項目。根據作業系統的不同,選擇 pip 或 pip3 作為指令。
pip install -r {project_root}/requirements.txt
pip3 install -r {project_root}/requirements.txt
在完成這一步驟後,你得重新啟動命令列視窗,因為需要重啟 Python 才可以找到我們安裝的應用程式。
現在,是時候產生整個說明文件了
cd {project_root}
make html
所有原始檔案都存放在 source /
底下,你可以新增新的文檔或修改已有的文檔。就和修改程式碼一樣,我們建議新的內容都是以分支的方式新增,並且向此 Repository 發出 pull requests 。
Sphinx 透過 source /
底下的文件自動生成使用者最終看到的網頁。當然,對於自動生成的 HTML 進行版本控制是沒有意義的,所以它並不在版本控制之下。你如果想要預覽翻譯後的效果,可以重新透過 Sphinx 自動產生新的 HTML 文件。首先,你必須先 cd <專案根目錄>
進入專案的根目錄,再執行上節所敘述的最後一個步驟 make html
。
執行步驟後,你將會看到編譯中的提示,待編譯成功後,自動產生的使用手冊以及圖片都會位於 build/html/
底下。 Sphinx 經過第一次編譯後,第二次再執行編譯將只針對修改的文件進行重新編譯,非常節省時間。但如果你想全部重新編譯的話,只需要刪除 build/
整個資料夾後重新編譯即可。