8000 Add rest of translation guidelines from previous wiki · python/python-docs-zh-tw@14effc0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 14effc0

Browse files
committed
Add rest of translation guidelines from previous wiki
1 parent 0b2c0aa commit 14effc0

File tree

1 file changed

+85
-6
lines changed

1 file changed

+85
-6
lines changed

README.rst

Lines changed: 85 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Python 官方說明文件臺灣繁體中文翻譯計畫
77
:alt: Join Chat on Telegram
88

99
本 GitHub repository 含有 Python 官方說明文件的 zh_TW 翻譯。實際的翻譯內容\
10-
在這個 repository 裡以 Python 的穩定發行版本作為 branch 名稱,請參考 3.6
10+
在這個 repository 裡以 Python 的穩定發行版本作為 branch 名稱,請參考 3.7
1111
branch 以查看目前的翻譯內容。此 master branch 則為專案的貢獻說明。
1212

1313
您可以在 https://python-doc-tw.github.io/ 瀏覽目前翻譯的成果。目前以
14-
Python 3.6 為翻譯的對象,**暫時不考慮 Python 2.7 的翻譯工作**。未來有新的
14+
Python 3.7 為翻譯的對象,**暫時不考慮 Python 2.7 的翻譯工作**。未來有新的
1515
Python 發行版本時,也將會將翻譯滾動至新的版本。
1616

1717
想問問題、認識翻譯同好,歡迎加入 Telegram 聊天室 `t.me/PyDocTW`_
@@ -141,7 +141,7 @@ po 檔皆為首要的翻譯對象。您也可以幫忙校對已經翻譯過的
141141

142142

143143
翻譯守則
144-
--------
144+
========
145145

146146
#. 譯文應兼顧前後文大意。
147147

@@ -180,8 +180,87 @@ po 檔皆為首要的翻譯對象。您也可以幫忙校對已經翻譯過的
180180
``dict``、``set``、``iterator``、``generator``、``iterable``
181181

182182

183+
括號的使用
184+
----------
185+
186+
如果括號中的文字包含中文,使用全形括號;如果括號中只有英文,使用半形括號並\
187+
比照英文的形式加入前後文的空白。
188+
189+
例如:
190+
191+
- list(串列)是 Python 中很常見的資料型別。
192+
- 在本情況使用 ``zip(*[iter(x)]*n)`` 是很常見的情況(Python 慣例)。
193+
- 在超文件標示語言 (HTML) 中應注意跳脫符號。
194+
195+
rST 語法注意事項
196+
----------------
197+
198+
- ``:xxx:`...``` 即為 rST 的語法,應該在譯文中保留。
199+
- rST 諸多語法需要保留前後的空白。在中文裡,該空白可以用 :literal:`\\\ \ `
200+
來取代,製造一個沒有寬度的分隔符號。
201+
202+
例如:
203+
204+
.. code-block:: rst
205+
206+
For more information, please see :ref:`detail-instruction`.
207+
208+
翻譯為
209+
210+
.. code-block:: rst
211+
212+
更多資訊請參考\ :ref:`detail-instruction`\ 。
213+
214+
- 超連結語法該要在譯文中保留原字串。
215+
216+
例如:
217+
218+
.. code-block:: rst
219+
220+
`Documentation bugs`_ on the Python issue tracker
221+
222+
應更改為
223+
224+
.. code-block:: rst
225+
226+
Python issue tracker 上\ `文件相關的錯誤 <Documentation bugs_>`_
227+
228+
才能正確顯示為「Python issue tracker 上\ `文件相關的錯誤 <#>`_」,連結與\
229+
前文才不會有多餘的空白。
230+
231+
- 舉例中有程式碼時,前一段經常為 ``::`` 結尾,此記號\ `具有特殊意義
232+
<http://www.sphinx-doc.org/en/stable/rest.html#source-code>`_,除了該段落\
233+
結尾為冒號外,也代表下段縮排為程式碼。翻譯時應改為全型冒號,並\ **增加以**
234+
``::`` **開頭的新段落**。
235+
236+
例如:
237+
238+
.. code-block:: rst
239+
240+
Here is a code example::
241+
242+
import sys
243+
print(sys.version)
244+
245+
程式碼並不會出現在 po 檔之中,故在 po 檔中會顯示為
246+
247+
.. code-block:: rst
248+
249+
Here is a code example::
250+
251+
此時翻譯應為:
252+
253+
.. code-block:: rst
254+
255+
以下是個程式範例:
256+
257+
::
258+
259+
注意\ **額外的空行是必須的**。
260+
261+
183262
術語表 Glossary
184-
---------------
263+
===============
185264

186265
為了讓翻譯保持統一,我們在這邊整理了一個術語列表,如果您有不同意的地方,歡迎\
187266
打開一個 issue 或是 pull request 一起討論。
@@ -225,7 +304,7 @@ type 型別
225304

226305

227306
問題回報與討論
228-
--------------
307+
==============
229308

230309
如果有需要共同討論的問題,請開設一個新的 Issue_。如果是翻譯上遇到困難需要\
231310
幫助,則可以使用 Telegram_。
@@ -238,7 +317,7 @@ type 型別
238317

239318

240319
額外翻譯資源
241-
------------
320+
============
242321

243322
- Telegram group `t.me/PyDocTW`_
244323
- `Doc-SIG mailing list <https://mail.python.org/mailman/listinfo/doc-sig>`_

0 commit comments

Comments
 (0)
0