pydoccht request for comments

20 views
Skip to first unread message

yungyuc

unread,
Nov 5, 2007, 9:37:46 PM11/5/07
to python.tw
把心裡的想法整理出來了。

以下是我想要建立的 pydoccht:Python official documentation 翻譯計畫。以下列出計畫的大綱,至於完整的初版
架構,請
::

hg clone http://hg.seety.org/translating/pydoccht/

===================
Python 文件中譯計畫
===================

緣起
====

Python 是方便強大的動態語言,在西方世界有許多的使用者。然而,在台灣一直沒有突破性的發展。身處軟體工業並不發達的國家,Python 無法
在台灣流行有許多原因,但缺乏適當的中文文件,確是理由之一。

為此,\ PyTUG_ 決定開始 Python 文件的繁體中譯計畫,將最新的 Python 官方文件譯為符合本地用語的繁體中文版。本中譯計畫暫
定名為 pydoccht。

.. _PyTUG: http://wiki.python.org.tw/

目標
====

完整翻譯 Python official documentation 至繁體中文,並持續自上游更新。

成果授權
========

因 pydoccht 為文件翻譯計畫,故完全遵照原始文件之授權。

技術需求
========

pydoccht 的進行需要一些技術基礎,茲列出如下。

1. docutils/rst and sphinx

新版 Python official document (以下稱 pydoc) 在 Python 2.6 trunk 中已捨
LaTeX 改採 reStructuredText_\ 。事實上,這是 yungyuc_ 決定發起 pydoccht 計畫的主因;相較於
LaTeX,reStructuredText 對中文非常友善,pydoc 所使用的文件工具將可能可以直接套用在 pydoccht 上。

sphinx_ 是新版 pydoc 所使用的文件產生框架。

.. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html

.. _yungyuc: http://blog.seety.org/everydaywork/

.. _sphinx: http://svn.python.org/projects/doctools/trunk/

2. make

pydoc 使用 make 作為 build tool,故需熟悉 Makefile 與 make。

3. mercurial

pydoccht 用 mercurial 為 source code management。透過 mercurial,pydoccht
以去中心化的方式進行多方合作。

4. subversion

Python trunk 使用 subversion,故為了自 trunk checkout 最新的 pydoc 與相關工具,我們也要使
用 subversion。

團隊合作
========

pydoccht (本中譯計畫) 的正式討論與消息發佈管道為 python.tw@ggroup,所有參與者均應注意其中的訊息。另外,為了提高合
作效率,正在計畫以 roundup 建置 issue tracking 系統。同時鼓勵團隊成員使用 #python.tw/Freenode
道即時討論。

pydoccht 計畫設有 coordinator 一名。最初的 coordinator 為計畫的發起人 yungyuc_\ ,直到如今。

在翻譯時,以一人一章為原則。譯者應以註解的方式署名於文稿內,並照英文姓名或代號順序,列於文件的譯者欄。

若某譯者未譯完負責章節,在其表達無力完成或擱置逾時並未予處理,而由另名譯者接手完成該章,則前者不可列名,惟後者列名;finisher
takes all。

校對者也應列名,但不署名於文稿內,而列於獨立的說明文字中。出現順序依照英文姓名或代號。

時程規畫
========

pydoccht 開始於 2007/Nov.。初步預期於兩年內,即 2009 時完成所有文件的中譯。

其它
====

* CONVENTION.rst 說明翻譯文稿的慣例。

* CREED.rst 指出 pydoccht 的信條。

TsungWei Hu

unread,
Nov 5, 2007, 10:41:43 PM11/5/07
to pyth...@googlegroups.com
同意「改進中文文件/學習資料」的重要性。

會有個「認養頁面」「進度頁面」「字詞對照頁面」囉?
我還沒找到。

好的開始,繼續加油!

/marr/

On Nov 6, 2007 10:37 AM, yungyuc <yun...@gmail.com> wrote:
> 把心裡的想法整理出來了。
>
> 以下是我想要建立的 pydoccht:Python official documentation 翻譯計畫。以下列出計畫的大綱,至於完整的初版
> 架構,請
> ::
>
> hg clone http://hg.seety.org/translating/pydoccht/
>
> ===================
> Python 文件中譯計畫
> ===================

gas...@gmail.com

unread,
Nov 5, 2007, 10:59:40 PM11/5/07
to python.tw
+1

剛寫了 sphinx 試玩方法, 應該有點用

http://inet6.blogspot.com/2007/11/sphinx.html

TsungWei Hu

unread,
Nov 6, 2007, 5:30:03 AM11/6/07
to pyth...@googlegroups.com
我看到 glossary.rst 了 這是我想要的「字詞對照」。

中文 Python 文件組識,我們確實需要。

gas...@gmail.com

unread,
Nov 6, 2007, 12:54:32 PM11/6/07
to python.tw
剛整理簡介時發現原來為周蟒寫了份快速語法參考手冊,供 Python 使用者能快速上手。
裡面已清楚列出與 Python 各關鍵詞的中英對照.

http://code.google.com/p/zhpy/wiki/QuickRef

yoco

unread,
Nov 17, 2007, 4:08:47 PM11/17/07
to python.tw
我很想幫忙,不過我用的是 Windows。

我今天 try 了一下,發現我想要在 Windows 下面 make 似乎有點障礙。一開始是 Windows 沒有 make.exe,這個是小
問題,我去抓了 mingw 的 gnu make 在 win 上面的 port,搞定,svn 的命令列模式我也可以找到來用,但是接下來就卡在
makefile 裡面的語法 Windows 消化不良,我不熟 linux 的 console,不知道怎麼改,只能 orz 了。

閱讀跟翻譯是沒問題,但是弄完以後沒 make 來看一下,實在不能確定自己在 rst 的語法有沒有弄錯。

有沒有人也是用 Windows 的?不知道 cygwin 裝下去是不是就 ok 了......

gas...@gmail.com

unread,
Nov 17, 2007, 8:07:21 PM11/17/07
to python.tw
有些比較輕量的rst->html 生成工具如 mopowg, 可以用easy_install安裝.

$ easy_install mopowg

用法就是用cmd切換到該文件目錄下 run mopowg

$ mopowg

mopowg will collect and translate rst/txt format to html.

Yung-Yu Chen

unread,
Nov 18, 2007, 8:37:48 AM11/18/07
to pyth...@googlegroups.com
mopowg 應該不行,因為 sphinx 定義了 pydoc 專用的 directive,所以一定要用 sphinx build;標準的 docutils 是不會動的。

Yung-Yu Chen

unread,
Nov 18, 2007, 8:44:12 AM11/18/07
to pyth...@googlegroups.com
On Nov 17, 2007 4:08 PM, yoco <peter...@gmail.com> wrote:
我很想幫忙,不過我用的是 Windows。

我今天 try 了一下,發現我想要在 Windows 下面 make 似乎有點障礙。一開始是 Windows 沒有 make.exe,這個是小
問題,我去抓了 mingw 的 gnu make 在 win 上面的 port,搞定,svn 的命令列模式我也可以找到來用,但是接下來就卡在
makefile 裡面的語法 Windows 消化不良,我不熟 linux 的 console,不知道怎麼改,只能 orz 了。

Windows 下很好跑的,請不必擔心;如果 Windows 不能順利 build 這計畫就不會開始了,因為我是 Windows user ;)

我的環境和你差不多,沒有發現什麼問題。把你遇到的 errmsg 貼出來看看如何?
 

Zoom.Quiet

unread,
Nov 18, 2007, 7:51:15 PM11/18/07
to pyth...@googlegroups.com, Python.cn@google, python-chinese列表, cpug-ea...@googlegroups.com, zp...@googlegroups.com, sz...@googlegroups.com
On Nov 6, 2007 10:37 AM, yungyuc <yun...@gmail.com> wrote:
> 把心裡的想法整理出來了。
>
> 以下是我想要建立的 pydoccht:Python official documentation 翻譯計畫。以下列出計畫的大綱,至於完整的初版
> 架構,請
> hg clone http://hg.seety.org/translating/pydoccht/
>
> ===================
> Python 文件中譯計畫
> ===================
>
> 緣起
> ====
>
> Python 是方便強大的動態語言,在西方世界有許多的使用者。然而,在台灣一直沒有突破性的發展。身處軟體工業並不發達的國家,Python 無法
> 在台灣流行有許多原因,但缺乏適當的中文文件,確是理由之一。
其实 CPyUG 已经组织完成了很多文档,包含 Dive Into Python, Python 各个版本的手册,等等,
不过,台湾兄弟整理出了完整的文档计划,就要支持!
建议:
1. 大部头的图书,共同在 OpenBookProject 中完成
工程维基:http://wiki.woodpecker.org.cn/moin/OpenBookProject
工程环境:http://code.google.com/p/openbookproject/
工程列表:http://groups.google.com/group/openbookproject
2. 短小精悍的各种内置文档的翻译和组织,在另外一整体性的中文化工程进行:
i18N_zh : http://code.google.com/p/i18n-zh/
使用 SVN+Git 进行组织,已经有一些作品完成

--
'''Time is unimportant, only life important!
过程改进乃是开始催生可促生靠谱的人的组织!
'''http://zoomquiet.org
博 @ http://blog.zoomquiet.org/pyblosxom/
维 @ http://wiki.woodpecker.org.cn/moin/ZoomQuiet
豆 @ http://www.douban.com/people/zoomq/
看 @ http://zoomq.haokanbu.com/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Pls. usage OOo to replace M$ Office. http://zh.openoffice.org
Pls. usage 7-zip to replace WinRAR/WinZip. http://7-zip.org
You can get the truely Freedom 4 software.

Yung-Yu Chen

unread,
Nov 18, 2007, 10:30:33 PM11/18/07
to pyth...@googlegroups.com
On Nov 18, 2007 7:51 PM, Zoom. Quiet <zoom....@gmail.com> wrote:
On Nov 6, 2007 10:37 AM, yungyuc <yun...@gmail.com> wrote:
> 把心裡的想法整理出來了。
>
> 以下是我想要建立的 pydoccht:Python official documentation 翻譯計畫。以下列出計畫的大綱,至於完整的初版
> 架構,請
>   hg clone http://hg.seety.org/translating/pydoccht/
>
> ===================
> Python 文件中譯計畫
> ===================
>
> 緣起
> ====
>
> Python 是方便強大的動態語言,在西方世界有許多的使用者。然而,在台灣一直沒有突破性的發展。身處軟體工業並不發達的國家,Python 無法
> 在台灣流行有許多原因,但缺乏適當的中文文件,確是理由之一。
其实 CPyUG 已经组织完成了很多文档,包含 Dive Into Python, Python 各个版本的手册,等等,

這個也是我想問的,Python 各個版本手冊 (除 tut 外) 的中譯在哪裡?我是有看到 PSL,但這是書不是手冊。


不过,台湾兄弟整理出了完整的文档计划,就要支持!
建议:
1. 大部头的图书,共同在 OpenBookProject 中完成
工程维基:http://wiki.woodpecker.org.cn/moin/OpenBookProject
工程环境: http://code.google.com/p/openbookproject/
工程列表:http://groups.google.com/group/openbookproject

我個人是蠻不喜歡用 online wiki 編寫文稿的;反應很慢操作也不便。而且,從大陸外面連到大陸裡面又更慢,剛剛想抓 http://www.woodpecker.org.cn:9081/doc/Python/Py2.5tut/Py2_5_tut_cn.pdf 到現在還下不來 Orz


2. 短小精悍的各种内置文档的翻译和组织,在另外一整体性的中文化工程进行:
i18N_zh : http://code.google.com/p/i18n-zh/
使用 SVN+Git 进行组织,已经有一些作品完成

你們那邊的人力真是充沛呀,實在令人稱羨。

希望可以常常交流 :)



yoco

unread,
Nov 22, 2007, 4:57:30 AM11/22/07
to python.tw
我是進行以下動作:

[code]
D:\yoco\pydoccht\pydoccht\chtdoc>dir/w
磁碟區 D 中的磁碟是 資料
磁碟區序號: F03B-1EDD

D:\yoco\pydoccht\pydoccht\chtdoc 的目錄

[.] [..] about.rst ACKS.txt
bugs.rst
[c-api] conf.py contents.rst copyright.rst [data]
[distutils] [documenting] [extending] glossary.rst
[howto]
[includes] [install] [library] license.rst
make.exe
Makefile README.txt [reference] TODO.txt
[tools]
[tutorial] [using] [whatsnew]
12 個檔案 234,410 位元組
16 個目錄 32,867,938,304 位元組可用

D:\yoco\pydoccht\pydoccht\chtdoc>make html
這個時候不應有 !。
make: *** [checkout] Error 255
[/code]


他給我上面的錯誤訊息,我看了一下那個 Makefile,大概是第 22 行那個驚嘆號出問題吧。
@if [ ! -d tools/sphinx ]; then \
Windows 的 cmd 好像看不懂這行東西。

我裝了 mingw 了,不過裝好以後我也不知道要怎麼辦,現在就是發呆中,請前輩指導一下接下來要幹嘛。

Yung-Yu Chen

unread,
Nov 22, 2007, 9:25:31 AM11/22/07
to pyth...@googlegroups.com
看來你跑的是 nmake,才會有中文錯誤訊息?mingw 裡面有正牌 make,可能先檢查路徑,看是不是有執行到它。

yoco

unread,
Nov 26, 2007, 8:15:07 AM11/26/07
to python.tw
我用的是 mingw 的 make
那個中文的錯誤訊息應該是因為 makefile 裡面第 22 行

@if [ ! -d tools/sphinx ]; then \

裡面的那個驚嘆號。
會有中文的錯誤訊息是因為我的 windows xp 是中文版的
我在 command line 底下直接打上面那行,他也是跟我說「這個時候不應該有 !」。
應該是因為 cmd 看不懂這種語法。

如果前輩可以正確編譯,能不能麻煩解說一下 step by step 過程?因為我弄了好久還是沒有辦法。

Yung-Yu Chen

unread,
Nov 26, 2007, 3:25:48 PM11/26/07
to pyth...@googlegroups.com
會不會是你沒有 [.exe 這個檔。

它是 mingw 的一部分。

with regards,
Yung-Yu Chen

On Nov 26, 2007 3:24 PM, Yung-Yu Chen <y...@seety.org > wrote:
會不會是你沒有 [.exe 這個檔。

它是 mingw 的一部分。

with regards,
Yung-Yu Chen
Reply all
Reply to author
Forward
0 new messages