Skip to content

Commit 0856f4e

Browse files
committed
Add translation guideline and how to build locally
1 parent 637e00b commit 0856f4e

File tree

1 file changed

+109
-38
lines changed

1 file changed

+109
-38
lines changed

README.rst

+109-38
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,54 @@ branch 以查看目前的翻譯內容。此 master branch 則為專案的貢獻
1010
Python 3.6 為翻譯的對象,**暫時不考慮 Python 2.7 的翻譯工作**。未來有新的
1111
Python 發行版本時,也將會將翻譯滾動至新的版本。
1212

13-
14-
Wiki_ 中有更多關於參加翻譯、翻譯風格規範、自行編譯文件等說明(待更新)。
15-
1613
想問問題、認識翻譯同好,歡迎加入 Telegram 聊天室 `t.me/PyDocTW`_
1714

18-
.. _Wiki: https://github.com/python-doc-tw/python-docs-zh-tw/wiki
1915
.. _t.me/PyDocTW: https://t.me/PyDocTW
2016

2117

18+
授權與 License
19+
==============
20+
21+
以下為 Documentation Contribution Agreement,說明文件貢獻協議,請在貢獻以前\
22+
務必詳讀以下內容。原文後附有中文翻譯,但譯文不保證完全正確,請以原文為準。
23+
24+
Documentation Contribution Agreement
25+
------------------------------------
26+
27+
NOTE REGARDING THE LICENSE FOR TRANSLATIONS: Python's documentation is
28+
maintained using a global network of volunteers. By posting this
29+
project on Transifex, Github, and other public places, and inviting
30+
you to participate, we are proposing an agreement that you will
31+
provide your improvements to Python's documentation or the translation
32+
of Python's documentation for the PSF's use under the CC0 license
33+
(available at
34+
https://creativecommons.org/publicdomain/zero/1.0/legalcode). In
35+
return, you may publicly claim credit for the portion of the
36+
translation you contributed and if your translation is accepted by the
37+
PSF, you may (but are not required to) submit a patch including an
38+
appropriate annotation in the Misc/ACKS or TRANSLATORS file. Although
39+
nothing in this Documentation Contribution Agreement obligates the PSF
40+
to incorporate your textual contribution, your participation in the
41+
Python community is welcomed and appreciated.
42+
43+
You signify acceptance of this agreement by submitting your work to
44+
the PSF for inclusion in the documentation.
45+
46+
中文翻譯
47+
~~~~~~~~
48+
49+
請注意此予翻譯專案的授權:Python 的說明文件是以全球的志工社群來維護。透過張貼\
50+
此專案在 Transifex、GitHub 以及其他公眾場合,以及邀請您參與,我們向您提出一個\
51+
協議:您必須將您對於 Python 說明文件或是 Python 說明文件翻譯的貢獻以 CC0\
52+
(請參考 https://creativecommons.org/publicdomain/zero/1.0/legalcode)的方式\
53+
授權給 PSF 使用。您可以公開地聲明您所貢獻翻譯的部分,並且如果您的翻譯被 PSF
54+
採用,您可以(但並不須要)送出一個修改,其包含在 Misc/ACKS 或是 TRANSLATORS
55+
檔案裡增加合適的注釋。雖然這個說明文件貢獻協議並沒有說明 PSF 有義務納入您的\
56+
文本貢獻,您在 Python 社群的參與是受歡迎且受感激的。
57+
58+
您在對 PSF 送出說明文件貢獻的同時,即表示同意上述的協議。
59+
60+
2261
參加翻譯
2362
========
2463

@@ -82,6 +121,46 @@ pull request(記得 base 是此專案的其中一個 branch;目前只有 3.6
82121
執行完 ``poindent`` 以後即可 commit、push 等。
83122

84123

124+
翻譯守則
125+
--------
126+
127+
#. 譯文應兼顧前後文大意。
128+
129+
#. 中文句使用全形標點符號;英文句維持半形的標點符號。
130+
131+
例如:「」()、,。
132+
133+
例如:Python is supported by Python Software Foundation (PSF).
134+
135+
#. 中英文交雜時要插入空白;符號英文間不用。
136+
137+
例如:使用 CPU 運算、使用「CPU」運算
138+
139+
#. 專有名詞應該參考 Transifex 上 Glossary 裡對照表的翻譯方式。
140+
141+
#. 專有名詞可以選擇不翻譯。
142+
143+
例如:CPU、Unicode
144+
145+
#. 在翻譯名稱不常用或不確定的情形,宜用括號註解或直接保留原文。單頁只要首次\
146+
出現有註解即可。
147+
148+
例如:正規表示式 (regular expression)
149+
150+
例如:Network News Transfer Protocol、Portable Network Graphics
151+
(可攜式網路圖形)
152+
153+
#. 務必保留 reStructuredText 格式(如:超連結名稱)
154+
155+
#. po 檔單行不應超過 79 字元寬度(可以使用 |poindent|_ 來確保格式)
156+
157+
#. 高頻詞保留原文。因為翻譯後不一定能較好理解市面上 Python 的文章。 這些高頻詞\
158+
在 Glossary 中的譯文仍保持原文,並加註市面上的翻譯。
159+
160+
例如:``int``、``float``、``str``、``bytes``、``list``、``tuple``、
161+
``dict``、``set``、``iterator``、``generator``、``iterable``
162+
163+
85164
問題回報與討論
86165
--------------
87166

@@ -106,48 +185,40 @@ pull request(記得 base 是此專案的其中一個 branch;目前只有 3.6
106185
<https://www.transifex.com/python-tw-doc/python-36-tw/glossary/zh-Hant/>`_
107186

108187

109-
授權與 License
110-
==============
188+
維護、預覽
189+
==========
111190

112-
以下為 Documentation Contribution Agreement,說明文件貢獻協議,請在貢獻以前\
113-
務必詳讀以下內容。(後面有中文翻譯)
191+
以下的指令皆預設在本機端 ``python-docs-zh-tw`` clone 的根目錄執行,同時預設\
192+
在同一個目錄底下有一個 CPython clone,如下:
114193

115-
Documentation Contribution Agreement
116-
------------------------------------
194+
::
117195

118-
NOTE REGARDING THE LICENSE FOR TRANSLATIONS: Python's documentation is
119-
maintained using a global network of volunteers. By posting this
120-
project on Transifex, Github, and other public places, and inviting
121-
you to participate, we are proposing an agreement that you will
122-
provide your improvements to Python's documentation or the translation
123-
of Python's documentation for the PSF's use under the CC0 license
124-
(available at
125-
https://creativecommons.org/publicdomain/zero/1.0/legalcode). In
126-
return, you may publicly claim credit for the portion of the
127-
translation you contributed and if your translation is accepted by the
128-
PSF, you may (but are not required to) submit a patch including an
129-
appropriate annotation in the Misc/ACKS or TRANSLATORS file. Although
130-
nothing in this Documentation Contribution Agreement obligates the PSF
131-
to incorporate your textual contribution, your participation in the
132-
Python community is welcomed and appreciated.
196+
~/
197+
├── python-docs-zh-tw/
198+
└── cpython/
133199

134-
You signify acceptance of this agreement by submitting your work to
135-
the PSF for inclusion in the documentation.
200+
若要在本機端 clone 一個 CPython,可以使用以下指令:
136201

137-
中文翻譯(請盡量以原文為準)
138-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202+
.. code-block:: bash
139203
140-
請注意此予翻譯專案的授權:Python 的說明文件是以全球的志工社群來維護。透過張貼\
141-
此專案在 Transifex、GitHub 以及其他公眾場合,以及邀請您參與,我們向您提出一個\
142-
協議:您必須將您對於 Python 說明文件或是 Python 說明文件翻譯的貢獻以 CC0\
143-
(請參考 https://creativecommons.org/publicdomain/zero/1.0/legalcode)的方式\
144-
授權給 PSF 使用。您可以公開地聲明您所貢獻翻譯的部分,並且如果您的翻譯被 PSF
145-
採用,您可以(但並不須要)送出一個修改,其包含在 Misc/ACKS 或是 TRANSLATORS
146-
檔案裡增加合適的注釋。雖然這個說明文件貢獻協議並沒有說明 PSF 有義務納入您的\
147-
文本貢獻,您在 Python 社群的參與是受歡迎且受感激的。
204+
$ git clone --depth 1 --no-single-branch https://github.com/python/cpython.git
148205
149-
您在對 PSF 送出說明文件貢獻的同時,即表示同意上述的協議。
206+
這樣可以避免下載完整的 commit 歷史(對輸出文件沒什麼幫助),但仍然能把所有的
207+
branch clone 下來。
208+
209+
與 CPython 同步最新的 pot 檔
210+
----------------------------
211+
212+
.. code-block:: bash
213+
214+
$ make merge
215+
216+
本地端 build 文件
217+
-----------------
218+
219+
.. code-block:: bash
150220
221+
$ make
151222
152223
Acknowledgement
153224
===============

0 commit comments

Comments
 (0)