Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/monkenwu/codeigniter4-taiwan-user-guide
CodeIgniter 4 Traditional Chinese(Taiwan) User Guide - codeigniter4 正體中文(台灣)使用手冊翻譯計畫
https://github.com/monkenwu/codeigniter4-taiwan-user-guide
codeigniter codeigniter4 translation userguide
Last synced: about 22 hours ago
JSON representation
CodeIgniter 4 Traditional Chinese(Taiwan) User Guide - codeigniter4 正體中文(台灣)使用手冊翻譯計畫
- Host: GitHub
- URL: https://github.com/monkenwu/codeigniter4-taiwan-user-guide
- Owner: monkenWu
- Created: 2019-10-08T20:06:33.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-25T06:03:26.000Z (almost 3 years ago)
- Last Synced: 2024-09-20T20:32:14.755Z (5 days ago)
- Topics: codeigniter, codeigniter4, translation, userguide
- Language: CSS
- Homepage: https://monkenwu.github.io/codeIgniter4-taiwan-User-Guide/
- Size: 18.6 MB
- Stars: 15
- Watchers: 2
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# codeIgniter4-taiwan-User-Guide
CodeIgniter 4 Traditional Chinese(Taiwan) User Guide - codeigniter4 繁體中文(台灣)使用手冊翻譯計畫
[Codeigniter台灣站](https://codeigniter.tw)
[Codeigniter4 正式手冊](https://codeigniter.tw/user_guide/index.html)
[查閱最新翻譯認領清單](https://github.com/monkenWu/codeIgniter4-taiwan-User-Guide/wiki/%E7%BF%BB%E8%AD%AF%E8%AA%8D%E9%A0%98%E6%B8%85%E5%96%AE)
## 風格指南
中文翻譯的文字排版請以 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines) 為主。
### 參考
專業名詞與框架內用語的統一譯名請以 [翻譯詞彙對照表](https://hackmd.io/@monkenWu/rkdtL9f_8) 文件文主；若有新名詞未定義或是有爭議，則請發 issue 討論，我們將會持續更新內容。
繁體中文翻譯請盡量遵守 [CodeIgniter3 使用手冊](https://codeigniter.org.tw/userguide3/) 的翻譯風格。
簡體中文版本的 [CodeIgniter4 使用手冊](https://github.com/CodeIgniter-Chinese/codeigniter4-user-guide) 也正在翻譯中，可以參考其翻譯但不接受直接以簡體中文轉換為繁體中文。請注意，中國與台灣在程式開發專業詞彙上的譯名大不相同。
### 提交規範
#### 若你想替翻譯盡一份心力，可以怎麼做？
1. fork 一份完整的程式碼。
2. 至[翻譯認領串](https://github.com/monkenWu/codeIgniter4-taiwan-User-Guide/issues/1)認領欲翻譯的檔案。
3. 在主線上產出一條屬於你的分支。
4. 翻譯結束後編譯一次預覽翻譯效果，並且重複校稿。
5. 在分支上 push 你所修改的檔案。
6. 回到 github 發出 pull requests。
#### 簽名
所有的提交的內容都必須要留下你的簽名，比如說：``John Doe ``，其設定方式與你使用 git 的媒介有所不同，請務必設定完成後再進行提交。
## 如何佈署
CodeIgniter 使用手冊基於 Sphinx 進行撰寫，它可以管理文檔並且輸出成各種格式。頁面以人類可讀的 [eStructuredText](http://sphinx.pocoo.org/rest.html)
格式進行撰寫。
### 首要條件
#### Python
Sphinx 需要 Python3.5+ ，如果你的作業系統是 MacOS 或是 Ubuntu ，則內建了 Python 。你可以透過 Terminal 確認你的版本：
```
python --version
Python 2.7.17
python3 --version
Python 3.6.9
```
如果你使用的版本並非 3.5 以上，請透過 `Python.org `_ 更新或重新安裝。Linux 應該使用作業系統內建的軟體管理器進行更新。
#### pip
現在，你已經擁有了 Python3.5+ ，你還必須擁有
`pip `_ （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 `_ 下載了 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 。
### HTML在哪裡呢？
Sphinx 透過 ``source /`` 底下的文件自動生成使用者最終看到的網頁。當然，對於自動生成的 HTML 進行版本控制是沒有意義的，所以它並不在版本控制之下。你如果想要預覽翻譯後的效果，可以重新透過 Sphinx 自動產生新的 HTML 文件。首先，你必須先 `` cd <專案根目錄> `` 進入專案的根目錄，再執行上節所敘述的最後一個步驟 ``make html`` 。
執行步驟後，你將會看到編譯中的提示，待編譯成功後，自動產生的使用手冊以及圖片都會位於 ``build/html/`` 底下。 Sphinx 經過第一次編譯後，第二次再執行編譯將只針對修改的文件進行重新編譯，非常節省時間。但如果你想全部重新編譯的話，只需要刪除 ``build/`` 整個資料夾後重新編譯即可。