|
以前に日本語マニュアルの作成についてはご紹介しましたが、checkoutしてきたXMLファイルを実際に和訳・上書き保存した後にbuildしてみると、あっけなく「日本語マニュアル」ができることが分かり、現在正式にPHP/PEARの和訳プロジェクトに参加しています。
Googleで検索すると結構和訳されて公開されている方が大勢いらっしゃいますが、どうせなら日本語マニュアルとして。。。ということ(?)で、「とりあえず和訳作業をやってみたい」「いま和訳を公開しているので、日本語マニュアルにマージしたい」といった方をターゲットとして、実際の作業手順をまとめてみました。
以下の手順を踏まなくても、テキストなりに書いた和訳をPHP-docのメーリングリストに投げても、どなたかに日本語マニュアルにマージしてもらえます(忙しくなければ。。。)。
ちなみにPHP/PEARマニュアルを和訳することのご利益ですが、
- オープンソースプロジェクトに参加できる
- 今よりもPHP/PEARに詳しくなる(新しい発見があります)
- 英読のスキルが上がるかも知れない
といったところでしょうか(^-^;
さっそくですが、まずは「お作法」の確認からです(^-^; 上鍵さんのサイトで「日本語マニュアルはこうしましょう」というものをまとめていらっしゃいますので、目を通しておきます。
次にCVSツリーからマニュアル一式を持ってきます。この手順については、「CVSからPHP日本語マニュアルを作成する」を参照してください。
次に和訳をする対象を選択します。対象が決まったら、可能であれば、PHP-docのメーリングリストに参加し、和訳する旨を流します。表明せずに和訳を進めていると、他の誰かが訳していたりして(最悪)労力が無駄になってしまいます。また、enディレクトリにあるディレクトリ・ファイルをjpディレクトリにコピーし、これ以降コピーしたXMLを修正していきます。この時、各ディレクトリ下にあるCVSディレクトリはコピーしないようにした方がよいかも知れません。
いよいよ実際の和訳作業ですが、大学入試や論文のような難しい英語ではありません。確かに分からない単語がポロポロ出てきますが、そういった場合は英辞郎先生に聞いてみましょう。また、infoseekなどの機械翻訳サービスも利用できますが、頭がグラグラする和訳が出てきたりしますので個人的には利用していません(^-^;
具体的なファイルの編集の仕方ですが、例えば oraexec 関数の場合、
●phpdoc/en/reference/oracle/functions/ora-exec.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<refentry id="function.ora-exec">
<refnamediv>
<refname>ora_exec</refname>
<refpurpose>Execute a parsed statement on an Oracle cursor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ora_exec</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
</methodsynopsis>
<para>
<function>ora_exec</function> execute the parsed statement
<parameter>cursor</parameter>, already parsed by <function>ora_parse</function>.
</para>
<para>
&return.success; Details about the error
can be retrieved using the <function>ora_error</function> and
<function>ora_errorcode</function> functions.
</para>
<simpara>
See also <function>ora_parse</function>,
<function>ora_fetch</function>, and <function>ora_do</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
が以下のようになります。
●phpdoc/ja/reference/oracle/functions/ora-exec.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./ja/functions/oracle.xml, last change in rev 1.1 -->
<!-- EN-Revision: 1.5 Maintainer: shimooka Status: ready -->
<!-- CREDITS: hirokawa -->
<refentry id="function.ora-exec">
<refnamediv>
<refname>ora_exec</refname>
<refpurpose>
Oracleカーソル上でのパースしたステートメントの実行
</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<methodsynopsis>
<type>bool</type><methodname>ora_exec</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
</methodsynopsis>
<para>
<function>ora_exec</function> は <function>ora_parse</function>
によってあらかじめパースされた文
<parameter>cursor</parameter> を実行します。
</para>
<para>
&return.success;
エラーについての詳細は、<function>ora_error</function>
および <function>ora_errorcode</function> 関数を用いて
調べられます。
</para>
<para>
<function>ora_parse</function>, <function>ora_fetch</function>,
<function>ora_do</function>も参照ください。
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
和訳後にいくつかコメントが追加されていますが、
<!-- EN-Revision: 1.5 Maintainer: shimooka Status: ready -->
は「英語版のどのリビジョンが対象となっているか」「メンテナは誰か」「訳のステータスはどうか」という情報が書かれています。これは必ず付けるお約束になっています。また、
<!-- CREDITS: hirokawa -->
は、メンテナ以外の和訳に関わった人を表しています。上記の場合は、前のメンテナであるPHPユーザー会の廣川さんになります。
和訳が終わったら、実際にbuildしてみましょう。この時、make testでエラーが出ていないことを確認してください。エラーがなければ、そのままmake実行し、できあがったマニュアルを見てみましょう。問題ないでしょうか?
ここまでできたら、PHP-docのメーリングリストにその旨をメールします。和訳したファイルはメールに添付するのではなく、HTTP経由でダウンロード出きる場所にUPしメールでそのURLを知らせる方がよいと思います。そうすると本家のCVSアカウントを持っている方がcommitしてくれます(忙しくなければ。。。)。commit後、本家にあるPEARマニュアルが毎週1回(月曜日の明け方頃)更新されていますので、そちらで確認することができます。PHPマニュアルは再buildが止まってしまっているようですが。。。
ただし、ここで作業が終わりではないんです(ここからが重要)。。。英語版のマニュアルも日々更新されていますので、あっという間に日本語版の方が古くなってしまう場合があります。この場合、和訳状況一覧にある差分一覧(ファイル名をクリックすると差分が表示されます)を基に和訳したファイルを更新する必要があります。追記修正したら同様にPHP-docのメーリングリストにメールし差分をcommitしてもらいます。これを繰り返すことになります。
なお、PHP/PEARマニュアルの和訳状況は、www.doyouphp.jpにもあります。
見てもらえると分かりますが、古くなったり英語版の方で追加されたものがまだまだたくさんあります。
みなさんも後込みせず、是非参加してみてください(^-^)
|