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

docs: organize readme#124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
josix merged 6 commits intopython:3.9fromgrimmerk:organize_readme
Oct 21, 2021
Merged
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 43 additions & 36 deletionsREADME.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,16 +64,23 @@ the PSF for inclusion in the documentation.
參與翻譯
========

如何參與翻譯
關於 po (Portable Object) 檔
-----------------------------

此為所需翻譯的文字檔，副檔名為 ``.po``，不同語系就會有一個 po 檔。主要內容為翻譯的參考原始字串 (*msgid*)，\
及需要填入的翻譯字串 (*msgstr*)。有時你會看到 ``#, fuzzy`` 的註記，它代表此翻譯字串需要校閱。

翻譯流程
------------

**事先需要有：**
事先需要有
~~~~~~~~~~

- 一個 `GitHub 帳號 <https://github.com/join>`_
- `安裝好 git <https://help.github.com/articles/set-up-git/>`_\ （Windows
上請參考 https://gitforwindows.org/）
- 一個 ``.po`` 檔的編輯器，如果還沒有的話請使用 `poedit <https://poedit.net>`_
-MacOS 的使用者還需要先利用 `homebrew <https://brew.sh/index_zh-tw>`_ 安裝 gettext，屆時 Sphinx 會使用到。
- 一個 ``.po`` 檔的編輯器。推薦使用 `Poedit <https://poedit.net>`_，若熟悉 po 檔用一般文字編輯器亦可。
-macOS 的使用者還需要先利用 `homebrew <https://brew.sh/index_zh-tw>`_ 安裝 gettext，屆時 Sphinx 會使用到。
.. code-block:: bash

brew install gettext
Expand All@@ -84,7 +91,10 @@ the PSF for inclusion in the documentation.
按鈕），這樣會把整個專案複製一份到你的 GitHub 帳號底下，你可以對這個 fork
進行修改。

在\ **第一次貢獻以前**\ （還沒有 clone 過），請在 terminal 裡依照以下步驟：
第一次貢獻以前（還沒有 clone 過)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

請在 terminal 裡依照以下步驟：

.. code-block:: bash

Expand All@@ -97,7 +107,10 @@ the PSF for inclusion in the documentation.
# 將 python/python-docs-zh-tw 設為 upstream remote
git remote add upstream https://github.com/python/python-docs-zh-tw.git

在\ **每一次翻譯時**\ 請遵照以下步驟（`GitHub Flow`_）：
每一次翻譯時
~~~~~~~~~~~~

請遵照以下步驟（`GitHub Flow`_）：

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

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

接著在 terminal 裡按照以下步驟：

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

git fetch upstream
git checkout -b glossary upstream/3.9

2. 接著就可以開始翻譯，你可以使用 Poedit應用程式將檔案打開，或是用以下指令\
（翻譯不同檔案時將 glossary 換成別的檔名） ::
2. 接著就可以開始翻譯（翻譯時可參考`翻譯守則`_），你可以手動開啟 Poedit應用程式再選檔案或用以下指令請 Poedit 將檔案\
打開，翻譯不同檔案時將 glossary 換成別的檔名） ::

poedit glossary.po

3. 存檔以後，可以輸出文件以確保你的修改沒有 rST 的語法錯誤或警告 ::
3. 存檔以後，執行以下列指令編譯輸出文件，以確保你的修改沒有 rST 的語法錯誤或警告 ::
Copy link
Collaborator

@mattwang44mattwang44Oct 21, 2021•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Just found out something worth mentioned here (I can open another PR for this so don't worry 😺):

Actually the Makefile expected the translators to do the translation on3.X branch here andmake command would fail if run on a branch that CPython does not have a corresponding one. Idid a hack allowing users to run make command on any branch when I implementing GitHub Action (but forgot to mention it in README).

VERSION=3.9 make

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Yes, I failed to runmake merge and I can add this note later (or anyone else adds it).

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I can add this note later (or anyone else adds it).
I think that I may write an incorrect note about this.@mattwang44 could you supply the relevant note (commit) about this?

Copy link
Collaborator

@mattwang44mattwang44Oct 21, 2021•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

@grimmer0125 Let's cope with this issue in another PR. This PR is good enough to be merged!


make

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

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

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

Expand DownExpand Up@@ -165,8 +181,10 @@ the PSF for inclusion in the documentation.
要翻譯哪些東西
--------------

最簡單的貢獻方式就是更新 *fuzzy entries*，讓翻譯的內容保持與最新版本的文件\
同步。請參考 `尋找 fuzzy entries`_ 段落。
主要是填入翻譯字串 (*msgid*) 以及更新有標記為 ``#, fuzzy`` 的字串。

其中最簡單的貢獻方式就是更新 *fuzzy entries*，讓曾經翻譯的內容保持與最新版本的文件\
同步。請參考 `尋找有翻譯過但需校閱的 fuzzy entries`_ 段落。

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

.. _Issue: https://github.com/python-doc-tw/python-docs-zh-tw/issues
.. _Telegram: https://t.me/PyDocT
.. _Telegram: https://t.me/PyDocTW

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

與 CPython 同步最新的 pot 檔
----------------------------
與 CPython 同步最新的 pot 檔 (目前由 GitHub Actions 定時代為執行)
----------------------------------------------------------

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

.. code-block:: bash

$ make merge

尋找 fuzzy entries
------------------
尋找有翻譯過但需校閱的 fuzzy entries
---------------------------------

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

.. code-block:: bash

$ make fuzzy

本地端編譯輸出文件
------------------

輸出的文件會被放置在您的本地端 CPython clone（見 `維護、預覽`_ 段落的圖示）\
底下的 ``Doc/build/html``，切換到該目錄再使用 ``python3 -m http.server``
或類似的靜態網頁伺服器即可以預覽成果。編譯程序則使用：

.. code-block:: bash

$ make


Project History
===============

Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp