[PHP-doc 221]Re: reference/session/reference.xmlの一部の翻訳
Moriyoshi Koizumi
moriyoshi @ at.wakwak.com
2003年 6月 17日 (火) 00:29:49 JST
小泉です。
廣川さんが書いてくださっていると思いますが、
老婆心ながら、私の浅い経験の中で得た注意点をいくつか。
"Y.Watanabe" <yuw @ msj.biglobe.ne.jp> wrote:
>
> ども。わたなべです。
>
> 英語の勉強がてら、マニュアル翻訳作業を手伝わせて
> いただきたいと常々思っていたこのごろ、
> 勢いあまっていきなりcvsのアカウントを申請し取得して
> しまいました。# そのセツはお手数おかけしました^^;;)。>某氏
これですが、これから協力に名乗りをあげて下さる方のために、
書いておきますと、一度この php-doc @ php.gr.jp や
php-dev @ php.gr.jp のリストで、いろいろ調整をした後で、
本家で申請をしていただいた方が進行がスムーズになりますね。
私の場合は、大垣さんに推薦していただきました。
# 大垣さん、その節はありがとうございました。
> で、まあお試しというか慣らしというか、
> いま既に翻訳されているもので、欠落があるものやtypo等を直して
> コミットしてゆく作業を、できる範囲で少しやろうと思っております。
>
> とりあえず目についたものとして、
> phpdoc-ja/en/reference/session/reference.xml
> に一部翻訳されてない文章(翻訳し忘れ?)がありましたので、
> その翻訳をしてみました。
>
> もしツッコミどころがあればお願いします。
> 問題なければそのままコミットします。
> (xsltproc等を通してhtml化する必要はないですよね?)
ここからが本題です。廣川さん、藤本さん、大垣さん、
何か問題ありましたら遠慮なく突っ込んでください ^^;
[作業の前に]
- CVS のドキュメントをチェックアウトするときの手順の覚書(一応)
$ cvs -d:pserver:[アカウント]@cvs.php.net:/repository login
-- パスワードを入力 --
$ cvs -z4 -d:pserver:[アカウント]@cvs.php.net:/repository co phpdoc-ja
最初のログインは、一度してしまえば、明示的にログアウトをしない限り
2回目以降は必要ないはずですが、作業が終わったら、一応ログアウトしておく
のが安全といえます。
- 面倒でも phpdoc-ja/howto/howto.html.tar.gz は通読してください。
- あとここも。
http://nxweb.dyndns.org:8080/php-translation.html
[CVS に関する注意点]
- トラブルを避けるため、コミットするまえには
$ cvs diff ... | iconv -f UTF-8
などとして、差分を確認したほうがいいでしょう。
- en モジュールに誤ってコミットしないように細心の注意を払って
ください。
- コミットメッセージはめんどうくさくても英語にしましょう。
よく使うものを挙げておきますが、今のところ ja モジュールでは、
特に決まったスタイルはなく、修正個所が簡単に分かる形にして下
さい。以下によく使われるものを挙げておきます。
- "Typo fix" / "Fixed typo"
=> 打ち間違え修正
- "Translation updated" / "Keep up to en tree" / "sync with en"
=> 翻訳更新 / 翻訳文章追加
などなど。
- コミットするファイルは xml ファイルのみです。
[作業時の注意点]
- 文字コードは UTF-8 を基本としています。
- 改行コードは CRLF ではなく、LF に統一しましょう。
- 改行は、出力される文章の読みやすさを考え、(HTML においては、
改行はホワイトスペースなので) 文節で行なうと吉です。
- 新しく追加されたドキュメントを翻訳するときは、どのバージョンを
翻訳したのか、ファイルの頭の方に、元のファイルのリビジョンを
書いておいてください。
ちなみに、私は <!-- sync: 1.xx --> のような書き方をしています。
# これ、統一した書き方を決めた方がいいのでしょうか?
- 日本語のドキュメントは、xsltproc を使うと多少出力がおかしくなるよう
です。面倒でも文字コード対策が元からきちんとしてある jade や openjade
を使った方がしあわせかもしれません。
# もしかしたら私の設定が悪いのかもしれませんが。
- 作業が終わったら、正しい XML を書けているかどうか、
$ make test
で確認するといいかもしれません。
PHP-doc メーリングリストの案内