Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit52104be

Browse files
authored
Merge pull request#124 from grimmer0125/organize_readme
docs: organize readme
2 parents8d59554 +da179b8 commit52104be

File tree

1 file changed

+43
-36
lines changed

1 file changed

+43
-36
lines changed

‎README.rst

Lines changed: 43 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,23 @@ the PSF for inclusion in the documentation.
6464
參與翻譯
6565
========
6666

67-
如何參與翻譯
67+
關於 po (Portable Object) 檔
68+
-----------------------------
69+
70+
此為所需翻譯的文字檔,副檔名為 ``.po``,不同語系就會有一個 po 檔。主要內容為翻譯的參考原始字串 (*msgid*),\
71+
及需要填入的翻譯字串 (*msgstr*)。有時你會看到 ``#, fuzzy`` 的註記,它代表此翻譯字串需要校閱。
72+
73+
翻譯流程
6874
------------
6975

70-
**事先需要有:**
76+
事先需要有
77+
~~~~~~~~~~
7178

7279
- 一個 `GitHub 帳號<https://github.com/join>`_
7380
- `安裝好 git<https://help.github.com/articles/set-up-git/>`_\(Windows
7481
上請參考 https://gitforwindows.org/)
75-
- 一個 ``.po`` 檔的編輯器,如果還沒有的話請使用 `poedit<https://poedit.net>`_
76-
-MacOS 的使用者還需要先利用 `homebrew<https://brew.sh/index_zh-tw>`_ 安裝 gettext,屆時 Sphinx 會使用到。
82+
- 一個 ``.po`` 檔的編輯器。推薦使用 `Poedit<https://poedit.net>`_,若熟悉 po 檔用一般文字編輯器亦可。
83+
-macOS 的使用者還需要先利用 `homebrew<https://brew.sh/index_zh-tw>`_ 安裝 gettext,屆時 Sphinx 會使用到。
7784
..code-block::bash
7885
7986
brew install gettext
@@ -84,7 +91,10 @@ the PSF for inclusion in the documentation.
8491
按鈕),這樣會把整個專案複製一份到你的 GitHub 帳號底下,你可以對這個 fork
8592
進行修改。
8693

87-
\**第一次貢獻以前**\(還沒有 clone 過),請在 terminal 裡依照以下步驟:
94+
第一次貢獻以前(還沒有 clone 過)
95+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
96+
97+
請在 terminal 裡依照以下步驟:
8898

8999
..code-block::bash
90100
@@ -97,7 +107,10 @@ the PSF for inclusion in the documentation.
97107
# 將 python/python-docs-zh-tw 設為 upstream remote
98108
git remote add upstream https://github.com/python/python-docs-zh-tw.git
99109
100-
\**每一次翻譯時**\請遵照以下步驟(`GitHub Flow`_):
110+
每一次翻譯時
111+
~~~~~~~~~~~~
112+
113+
請遵照以下步驟(`GitHub Flow`_):
101114

102115
.. _GitHub Flow:https://guides.github.com/introduction/flow/
103116

@@ -106,27 +119,30 @@ the PSF for inclusion in the documentation.
106119

107120
接著在 terminal 裡按照以下步驟:
108121

109-
1. 基於最新版本的 ``upstream/3.9`` 開啟一個 branch,現在假設我們想要翻譯 Glossary
122+
1. 基於最新版本的 ``upstream/3.9`` 開啟一個 branch,現在假設我們想要翻譯 Glossary \
110123
所以把這個 branch 叫做 ``glossary`` ::
111124

112125
git fetch upstream
113126
git checkout -b glossary upstream/3.9
114127

115-
2. 接著就可以開始翻譯,你可以使用 Poedit應用程式將檔案打開,或是用以下指令\
116-
翻譯不同檔案時將 glossary 換成別的檔名) ::
128+
2. 接著就可以開始翻譯(翻譯時可參考`翻譯守則`_),你可以手動開啟 Poedit應用程式再選檔案或用以下指令請 Poedit 將檔案\
129+
打開,翻譯不同檔案時將 glossary 換成別的檔名) ::
117130

118131
poedit glossary.po
119132

120-
3. 存檔以後,可以輸出文件以確保你的修改沒有 rST 的語法錯誤或警告 ::
133+
3. 存檔以後,執行以下列指令編譯輸出文件,以確保你的修改沒有 rST 的語法錯誤或警告 ::
121134

122135
make
123136

124-
這個過程中 Sphinx 會幫你檢查 rST 語法錯誤,我們盡量保持沒有 warning
137+
如果你還沒有執行 `維護、預覽`_ 的 clone CPython 的動作,此指令會自動幫你 clone CPython,\
138+
並且會使用 Sphinx 幫你檢查 rST 語法錯誤,我們盡量保持沒有 warning \
125139
的狀態,因此如果有出現 warning 的話請修復它。另外也記得檢查是否符合\
126140
`翻譯守則`_
127141

128-
4. 在瀏覽器中打開編譯出來的文件以確認整份文件的語意通暢\
129-
(翻譯別的檔案時將 glossary 換成別的檔名) ::
142+
4. 輸出的文件會被放置在您的本地端 CPython clone(見 `維護、預覽`_ 段落的圖示)\
143+
底下的 ``Doc/build/html``,切換到該目錄再使用 ``python3 -m http.server`` \
144+
或類似的靜態網頁伺服器即可以預覽成果。你可以執行下列指令請瀏覽器打開編譯出來的文件\
145+
以確認整份文件的語意通暢(翻譯別的檔案時將 glossary 換成別的檔名) ::
130146

131147
open ../cpython/Doc/build/html/glossary.html
132148

@@ -165,8 +181,10 @@ the PSF for inclusion in the documentation.
165181
要翻譯哪些東西
166182
--------------
167183

168-
最簡單的貢獻方式就是更新 *fuzzy entries*,讓翻譯的內容保持與最新版本的文件\
169-
同步。請參考 `尋找 fuzzy entries`_ 段落。
184+
主要是填入翻譯字串 (*msgid*) 以及更新有標記為 ``#, fuzzy`` 的字串。
185+
186+
其中最簡單的貢獻方式就是更新 *fuzzy entries*,讓曾經翻譯的內容保持與最新版本的文件\
187+
同步。請參考 `尋找有翻譯過但需校閱的 fuzzy entries`_ 段落。
170188

171189
此外,當前的目標為完成 **Tutorial** 的翻譯,因此在 ``tutorial/`` 底下的所有
172190
po 檔皆為首要的翻譯對象。您也可以幫忙校對已經翻譯過的內容。
@@ -344,7 +362,7 @@ type 型別
344362
幫助,則可以使用Telegram_。
345363

346364
.. _Issue:https://github.com/python-doc-tw/python-docs-zh-tw/issues
347-
.. _Telegram:https://t.me/PyDocT
365+
.. _Telegram:https://t.me/PyDocTW
348366

349367
另外,此翻譯的 coordinator 為 `adrianliaw<https://github.com/adrianliaw>`_,\
350368
您也可以透過此 email 聯繫:``adrianliaw2000 at gmail dot com``。
@@ -382,39 +400,28 @@ type 型別
382400
這樣可以避免下載完整的 commit 歷史(對輸出文件沒什麼幫助),但仍然能把所有的
383401
branch clone 下來。
384402

385-
與 CPython 同步最新的 pot 檔
386-
----------------------------
403+
與 CPython 同步最新的 pot 檔 (目前由 GitHub Actions 定時代為執行)
404+
----------------------------------------------------------
387405

388406
pot 檔為翻譯的樣板檔案,它包含需要翻譯的原始字串 (*msgid*) 跟其對應的空白翻譯字串 (*msgstr*),\
389-
此步驟會更新 po 檔,我們在 po 檔的每一個 (*msgstr*) 填上翻譯。
407+
此步驟會參考最新的 CPython 中的 pot 檔來更新 po 檔。如果是之前在 po 檔中已填入過翻議字串但參考的 \
408+
pot 檔的 ``msgid`` 已有變動,則此指令會自動加上 ``#, fuzzy`` 的標記,代表內容有些許差異需要更新。
390409

391410
..code-block::bash
392411
393412
$ make merge
394413
395-
尋找 fuzzy entries
396-
------------------
414+
尋找有翻譯過但需校閱的 fuzzy entries
415+
---------------------------------
397416

398-
*Fuzzy entries* 是指更新 po 檔的原始字串(*msgid*)以後,大部分內容相同但有\
399-
些許差異的字串,即表示該字串的翻譯需要更新。在 po 檔中,您會看到 ``#, fuzzy``
400-
的字樣,這就表示了接下來的字串是 fuzzy entry,需要更新翻譯
417+
在 po 檔中,您會看到 ``#, fuzzy`` 的字樣,這就表示了接下來的字串是 fuzzy entry,需要更新翻譯。\
418+
您可以自行用習慣的文字編輯器、Linux 指令搜尋有包含此字樣的檔案,但請記得 ``#, fuzzy`` 標記的翻譯字串\
419+
有可能是尚未翻譯過的空白字串 (*msgstr*)。執行下列指令會列出有 *Fuzzy entries* 的檔案且會排除這個情形
401420

402421
..code-block::bash
403422
404423
$ make fuzzy
405424
406-
本地端編譯輸出文件
407-
------------------
408-
409-
輸出的文件會被放置在您的本地端 CPython clone(見 `維護、預覽`_ 段落的圖示)\
410-
底下的 ``Doc/build/html``,切換到該目錄再使用 ``python3 -m http.server``
411-
或類似的靜態網頁伺服器即可以預覽成果。編譯程序則使用:
412-
413-
..code-block::bash
414-
415-
$ make
416-
417-
418425
Project History
419426
===============
420427

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp