cvs: peardoc /ja/chapters contributing.xml installation.xml standards.xml support.xml

From: Date: Mon, 24 May 2004 13:36:18 +0000
Subject: cvs: peardoc /ja/chapters contributing.xml installation.xml standards.xml support.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-4084@lists.php.net to get a copy of this message
haruki Mon May 24 09:36:18 2004 EDT Modified files: /peardoc/ja/chapters contributing.xml installation.xml standards.xml support.xml Log: sync with en and change some expr.

http://cvs.php.net/diff.php/peardoc/ja/chapters/contributing.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/ja/chapters/contributing.xml diff -u peardoc/ja/chapters/contributing.xml:1.3 peardoc/ja/chapters/contributing.xml:1.4 --- peardoc/ja/chapters/contributing.xml:1.3 Thu May 20 06:00:34 2004 +++ peardoc/ja/chapters/contributing.xml Mon May 24 09:36:18 2004 @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="utf-8" ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <chapter id="contributing"> -<!-- EN-Revision: 1.13 Maintainer: danielc Status: added english for doc/translate section --> +<!-- EN-Revision: 1.14 Maintainer: Status: ready --> <chapterinfo> <author> <firstname>Tal</firstname> @@ -25,11 +25,11 @@ <sect1 id="contributing.introduction"> <title>はじめに</title> <simpara> - PEARはオープンソースプロジェクトであり、どんな人でもPEARを改良に参 - 加することができます。改良とは、コードを書くことだけを意味するわけ - ではありません。改良は、バグを報告したり、フィードバックを提供し - たり、機能のリクエストをしたりすることも意味し、金銭的なサポートを - 行うことさえも含まれます。 + PEAR はオープンソースプロジェクトであり、どんな人でも PEAR の改良に参 + 加することができます。改良とは、コードを書くことだけを意味するわけでは + ありません。改良は、バグを報告したり、フィードバックを提供したり、 + 機能のリクエストをしたりすることも意味し、 + 金銭的なサポートを行うことさえも含まれます。 </simpara> </sect1> @@ -44,68 +44,63 @@ <sect1 id="contributing.patches"> <title>パッチの投稿</title> <para> - If you have modified a package to expand its functionality or to fix a - bug, you should contribute your changes back to the community (some - licenses force you to do so, and it is generally considered immoral not to). + 機能を拡張したり、バグの修正をするためにパッケージを変更した場合は、 + その変更をコミュニティーに寄贈するべきです + (そうすることを強制するライセンスもあります。また、一般的に、 + そうしないことはモラルに悖るものとみなされます)。 </para> <para> - Before creating the patch, you must first obtain the latest sources of the - package you wish to patch from CVS by running the commands (the package - in this example is Foo_Bar): + パッチを作成する前に、CVS からパッチを当てるべき最新のソースを以下のようにして + 取得してください(この例では、パッケージ名は Foo_Bar とします)。 <screen> <command>cvs -d:pserver:cvsread@cvs.php.net:/repository login</command> -password is "phpfi" +パスワードは "phpfi" です <command> cvs -z3 -d:pserver:cvsread@cvs.php.net:/repository co Foo_Bar </command> </screen> - Now that you have the latest sources, you can edit the relevant file(s). - Make sure that your patch is fully compatible with the &link.coding-standards;. + 最新のソースが取得できたので、対応するファイルを編集します。 + &link.coding-standards; に合致するようにしてください。 </para> <para> - After you have finished adding/changing the code, TEST it: We will not - accept code that hasn't been carefully tested. - When you are absolutely sure the new code doesn't introduce bugs, create a - unified diff by running: + コードに追加・変更を行ったら、テストしてください。注意深くテストが行われていない + コードは受け入れられません。新しいコードにバグが無いことを確信したら、 + 以下のコマンドで unified 形式の diff を作成します。 <screen> <command>cd pear/Foo_Bar</command> <command>cvs diff -u >Foo_Bar.diff</command> </screen> - The resulting .diff file contains your patch. This diff makes it easy - for us to see what has been changed. + できた .diff ファイルは、あなたのパッチを含んでいます。この diff により、 + 変更点を確認することができるようになります。 </para> <para> - Next step is to submit the patch. Send a mail to &email.pear.dev; and - Cc the maintainer(s) of the package. The subject of the mail should be - prefixed with '[Patch]' to make it clear you are submitting a patch. Also - include a verbose explanation of what the patch does. - Don't forget to attach the .diff file to the mail. The maintainers of - the package are usually listed in the header of each source file. Apart - from that their email adresses are available on the package information - page on &url.pear;. + 次のステップは、パッチの送付です。パッケージのメンテナに CC をつけて、 + &email.pear.dev; にメールを書いてください。メールの件名は、 + '[Patch]' からはじめて、パッチの投稿であることを判りやすくすると良いでしょう。 + また、パッチの内容の詳しい説明も書いてください。 + .diff ファイルをメールに添付するのを忘れないように。 + パッケージのメンテナ名は、通常、ソースファイルのヘッダに記載されています。 + メールアドレス以外の情報は、&url.pear; のパッケージ情報のページで見られます。 </para> <note> <para> - If you are using Outlook or Outlook Express, please change the file - extension of the diff file to .txt, because Outlook's MIME-Type - detection depends on the file extension and attachments with a - MIME-Type not equal to <literal>text/plain</literal> will be rejected - by our mailinglist software. + Outlook や Outlook Express を使っている場合は、diff ファイルの拡張子を + .txt へ変更してください。Outlook の MIME 形式の検出は、ファイルの拡張子を + 見ており、MIME 形式が <literal>text/plain</literal> でない添付ファイルは + われわれの使用するメーリングリストのソフトが拒否するためです。 </para> </note> <note> <para> - If your patch does break backwards compatibility, the chances are fairly - good that the maintainers won't be happy about it. Thus you should always - try to fix a bug in a way that does not seriously change the public API. - But if there is absolutely no way to keep backwards compatibility and/or - if your patch contains a groundbraking improvement, even API changes are - fine. + パッチに後方互換性が無ければ、変更がすばらしいものであっても、メンテナは + 困ってしまうでしょう。パブリックな API を大幅に変更することの無いように、 + バグ修正を行ってみるべきです。後方互換性の保つことはまったく不可能で、また、 + パッチが大変な機能向上をもたらす場合は、API を変更しても良いでしょう。 </para> </note> </sect1> @@ -113,62 +108,61 @@ <sect1 id="contributing.bugs"> <title>バグの報告</title> <para> - If you think that you have found a bug in a PEAR package, please - take care that you are using the latest version of the package and - that your system does meet the packages' requirements. + PEAR パッケージにバグがあると思ったら、まず、パッケージの最新版を使用しているか、 + および、システムがパッケージの要求事項に合っているか確認してください。 </para> <para> - If the bug still persists with the latest version of the package, - don't hesitate to fill out a bug report on - <ulink url="&url.php.bugs;">&url.php.bugs;</ulink>. - Please choose "PEAR related" as the category for the report. The developers - on the PEAR development list will be noticed about your report. + バグがパッケージの最新版にも存在する場合は、<ulink url="&url.php.bugs;"> + &url.php.bugs;</ulink> のバグ報告を記述してください。 + 報告のカテゴリには "PEAR related" を選択してください。 + PEAR development メーリングリストにおいて、開発者が報告に目を通します。 </para> <para> - More information and tips on how to report bugs in a proper way - can be found at <ulink url="&url.php.bugs.howto;">&url.php.bugs.howto;</ulink>. + バグを正しく報告するための方法についてのより詳しい情報については + <ulink url="&url.php.bugs.howto;">&url.php.bugs.howto;</ulink> + を参照してください。 </para> <para> - If you have already fixed a bug that you have found in a package, please - read <link linkend="contributing.bugs">this</link>. + もし見つけたバグを修正した場合は、<link linkend="contributing.bugs">こちら + </link>を参照してください。 </para> </sect1> <sect1 id="contributing.documentation"> - <title>Writing &amp; Translating Documentation</title> + <title>ドキュメントの記述と翻訳</title> <para> - Good documentation is essential for users to fully understand any - software. Several PEAR packages lack documentation or have docs which - need improvement. <link - linkend="developers.documentation">Writing documentation</link> - provides more information about helping out on this front. + あるソフトウエアをユーザが理解するためには、良いドキュメントが必須です。 + ドキュメントを欠いていたり、改良が必要な PEAR パッケージもあります。 + <link + linkend="developers.documentation">ドキュメントの作成</link>の章に、 + さらに役にたつ情報が記載されています。 </para> <para> - Translating documentation is another important task. - Not only does new documentation need to be translated - into the existing languages, additional languages are - welcome. Also, existing translations need to be brought - up to date because the English versions have been changed. - Help on how to perform the translation process is in the <link - linkend="faq.translators-revision-tracking">Revision Tracking</link> - section of the manual. + ドキュメントの翻訳も重要な仕事です。 + これまでにも翻訳が行われている言語に、新しいドキュメントを翻訳することも重要 + ですが、翻訳が行われていない言語への訳出も歓迎されます。 + また、英語のドキュメントは変更が加えられていくので、翻訳すみのものを + 更新していくことも必要となります。 + 翻訳プロセスの実行方法については、本マニュアルの<link + linkend="faq.translators-revision-tracking">リビジョン追跡</link>の章を + 参照してください。 </para> </sect1> <sect1 id="contributing.wishlist"> - <title>欲しいものリスト(ウイッシュリスト)</title> + <title>ウイッシュリスト</title> <para> - Some of the PEAR developers have wishlists at Amazon or a similar - service. If you appreciate the work of a certain developer, feel - free to buy something for her from her wishlist. To find out if - a developer has one of those wishlists, go to the - <ulink url="&url.pear.account;">account browser</ulink>, - look for the details of the developer and there you'll see if she - has a wishlist. Buying something from people's wishlists may even - speed up the time in which annoying bugs are fixed ;-). + PEAR 開発者の中には、Amazon 等でウイッシュリストを公開している人もいます。 + ある開発者の仕事に対して感謝の意を表したい場合、ウイッシュリストから + 遠慮なく何かを買って贈ってあげてください。 + 開発者がウイッシュリストを公開しているかどうか調べるには、 + <ulink url="&url.pear.account;">アカウントブラウザ</ulink>で開発者の詳細情報を + 参照します。 + ウイッシュリストから何か贈ると、悩ましいバグが修正される期間が短くなるかも + しれませんよ (^-^)。 </para> </sect1> </chapter> http://cvs.php.net/diff.php/peardoc/ja/chapters/installation.xml?r1=1.4&r2=1.5&ty=u Index: peardoc/ja/chapters/installation.xml diff -u peardoc/ja/chapters/installation.xml:1.4 peardoc/ja/chapters/installation.xml:1.5 --- peardoc/ja/chapters/installation.xml:1.4 Thu May 20 06:00:34 2004 +++ peardoc/ja/chapters/installation.xml Mon May 24 09:36:18 2004 @@ -1,7 +1,6 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!-- sync: 1.8 --> -<!-- $Revision: 1.4 $ --> -<!-- EN-Revision: 1.8 Maintainer: Status: ready --> +<?xml version="1.0" encoding="UTF-8" ?> +<!-- $Revision: 1.5 $ --> +<!-- EN-Revision: 1.18 Maintainer: Status: ready --> <!-- CREDITS: --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING @@ -17,128 +16,135 @@ </chapterinfo> <title>インストール</title> <simpara> - 本章は、PEARからパッケージをインストールする方法について説明します。 + 本章は、PEAR パッケージをインストールする方法について説明します。 </simpara> <sect1 id="installation.introduction"> <title>導入</title> <para> - 本章は、PEARの<link linkend="about.pear">構成</link>に関する知識を + 本章は、PEAR の<link linkend="about.pear">基本的構成</link>に関する知識を 有することを前堤とします。 </para> <para> - 基本部分のインストールは、PFCの部分としてPHPディストリビューションと - 共に行われます。これには、PEARインストールツール等の実行に要するも - のが全て含まれています。PHP 4の最近のバージョンをインストールして - いる場合にはより簡単で、<filename>./configure</filename>にフラグ'-- - without-pear'を指定していない限りPEARの基本部分はシステムにインス - トール済みです。 - </para> - <para> - PFC以外のパッケージは、PEARパッケージマネージャによりインストール - 可能です。このマネージャは、Debianの<quote>apt-get</quote>と互換性 - があります。また、最近のバージョン(&gt; 4.3.0) のPHPを実行して - いる場合、次節を読み飛ばすことができます。PHP 4.2.*およびそれ以前 - のバージョンを使用している場合、このマネージャを別途インストールす - る必要があります。 - </para> - <para> - パッケージのインストール以外に、PEARパッケージマネージャは、他のい - くつかの処理も行います。使用するマシンに新規パッケージを作成し、イ - ンストール済みのパッケージのレジストリを管理し、依存性を確認するこ - とが可能です。そして、他の処理を行うためにpear.php.net上のXML-RPC - サービスにより通信することが可能です。 + PEAR の基本部分 + <link linkend="about-pfc">The PHP Foundation Classes (PFC)</link> + は、PHP ディストリビューションと共に配布されており、 + PEAR インストールツールの実行に要するものをすべて含んでいます。 + PHP 4 の最近のバージョンをインストールする場合には、 + <filename>./configure</filename> にフラグ + <literal>--without-pear</literal> を指定していない限り、 + PEAR の基本部分はシステムにインストールされるようになっています。 + </para> + <para> + <link linkend="about-pfc">PFC</link> 以外のパッケージは、 + PEAR パッケージマネージャによりインストールが可能です。 + このマネージャは、Debian の <quote>apt-get</quote> と似ています。 + 最近のバージョン (&gt; 4.3.0) の PHP を使用している場合は、 + 次節を読み飛ばすことができます。PHP 4.2.* およびそれ以前のバージョンを + 使用している場合は、パッケージマネージャを別途インストールする + 必要があります。 + </para> + <para> + PEAR パッケージマネージャは、パッケージのインストール以外の仕事も行います。 + 新規パッケージの作成・インストール済みパッケージのレジストリ管理・ + 依存性のチェックなどです。 + そして、それらの処理を行うために pear.php.ne 上の XML-RPC サービスと + 通信することが可能です。 </para> </sect1> <sect1 id="installation.getting"> - <title>PEARパッケージマネージャの取得</title> - <simpara> - Linux: PHP 4.3.0以降、./configure で--without-pearが指定されていな - い限り、PEAR Package Managerはインストールされています。 - </simpara> - <note> - <para> - いくつかのLinuxディストリビューション(例: Redhat) は、 - コマンドラインブラウザの名前として<filename>lynx</filename>ではな - く、<filename>links</filename>を使用しているようです。 - この場合、以下の行を同様に変更する必要があります。 - </para> - </note> - <simpara> - Windows: PHP 4.3.2以降、go-pearスクリプトがバンドルされています。 - (ウインドウズエクスプローラのダブルクリックと同様に実行してみて下さい。 - </simpara> - <para> - <screen> - <userinput> -drive:path\to\php\go-pear.bat - </userinput> - </screen> - </para> - <simpara> - この後の質問に全て応えて下さい。 - これにより、PEARパッケージマネージャが指定したパスにインストールさ - れます。このパスをシステムのPATH環境変数 - (スタート > コントロールパネル > システム > 環境変数) - に追加し、コマンドプロンプトでpearとタイプしてみて下さい。 - 見事に動作するはずです。 - </simpara> - <simpara> - 最新版のPHP(&gt; 4.3.0)を使っていないユーザや - パッケージマネージャを再インストールしたい場合は、 - 別の方法が用意されています。 - 以下のコマンドをLinux上で実行することができます。 - </simpara> - <para> - <screen> - <userinput> -&dollar; lynx -source http://go-pear.org | php - </userinput> - </screen> - </para> - <simpara> - Windowsでは、go-pear.orgからスクリプトをダウンロード、保存し、 - 以下のコマンドで実行して下さい。 - </simpara> - <para> - <screen> - <userinput> -php go-pear (または保存したファイル名) - </userinput> - </screen> - </para> - <simpara> - (サーバにsshアクセスできる環境でない限り)pearコマンドを使用できな - いので、Webホストにpearをインストールできるか懸念されるかもしれま - せん。しかし、全く不可能なわけではありません。 - PEARパッケージマネージャは、パッケージインストールの手順を簡単にし - てくれるだけのものです。1つの手段としては、デスクトップPCにpear - コマンドでインストールしてから、サーバーにファイルをコピーするとい - うものがあります。PEARファイルが際とで利用できるように - set_include_path()を使用することを忘れないようにして下さい。 - </simpara> - </sect1> + <title>パッケージマネージャの取得</title> + <sect2> + <title>Unix/Linux/BSD</title> + <para> + PHP 4.3.0以降、 <filename>./configure</filename> で + <literal>--without-pear</literal> オプションを指定しない限り、 + PEAR パッケージマネージャは(PHP と共に)インストールされています。 + </para> + <para> + バージョン 4.3.0 以前の場合や、 + パッケージマネージャを再インストールしたい場合は、 + 以下の方法が暫定的に用意されています。 + <screen> + <userinput> +&dollar; lynx -source http://go-pear.org/ | php + </userinput> + </screen> + </para> + <note> + <para> + いくつかの Linux ディストリビューション(Redhatなど)では、 + コマンドラインブラウザの名前として <filename>lynx</filename> ではな + く、<filename>links</filename> を使用しているようです。 + この場合、上記の行をそのように変更する必要があります。 + </para> + </note> + </sect2> + + <sect2> + <title>Windows</title> + + <para> + PHP をダウンロードしインストールした後、バッチファイルを実行します。 + ファイルは、(インストールした場所によりますが) + <filename>c:\php\go-pear.bat</filename> のような所にあります。 + セットアップ中、いくつかの質問が行われ、指定したパスに PEAR + パッケージマネージャがインストールされます。 + その後、PATH 環境変数にインストールしたフォルダへのパスを追加してください + (スタート &gt; コントロールパネル &gt; システム &gt; 環境変数)。 + PEAR パッケージマネージャを実行するには、 + Windows のコマンドプロンプトで、 <literal>pear</literal> + コマンドを使用します。 + </para> + <para> + PEAR インストールのアップデートを go-pear.org を用いて行うこともできます。 + http://go-pear.org/ をブラウザで表示し、<filename>go-pear.php</filename> + に保存して、以下のコマンドを実行してください。 + <screen> + <userinput> +php go-pear.php + </userinput> + </screen> + Windows のコマンドプロンプトで、アップデートのプロセスがスタートします。 + </para> + </sect2> + <sect2> + <title>ホスティング環境での PEAR</title> + + <para> + Web ホスティングプロバイダを使用しており、(ローカルログインや + Telnet や SSH による)サーバへの直接アクセスができない場合、 + PEAR パッケージマネージャを使用することはできません。 + 気のきいたWeb ホスティング会社であれば、よく使用される PEAR パッケージは + インストール済みである可能性もあります。 + しかし、PEAR がインストール済みでなかったり、追加のパッケージが必要な場合は、 + プロバイダに連絡をとり、パッケージのインストールを丁重に頼んでみるのも + 良いでしょう。インストールしてもらえない場合は、他のホスティング会社を + 探す以外に、<link linkend="installation.manually">手動でインストール + </link>することも可能です。 + </para> + </sect2> + </sect1> <sect1 id="installation.cli"> - <title>コマンドラインインストーラ</title> - <titleabbrev>CLIインストーラ</titleabbrev> + <title>コマンドライン インストーラ</title> + <titleabbrev>CLI インストーラ</titleabbrev> <para> <warning id="installation.web.prerequesite"> - <title>はじめに</title> + <title>前提事項</title> <para> 以下の説明は、最新版の - <link linkend="installation.getting">PEARパッケージマネージャ - </link>がインストールされていることを前提とします。 + <link linkend="installation.getting">パッケージマネージャ</link> + がインストールされていることを前提とします。 </para> </warning> </para> <para> - コマンドラインインストーラは、PEARパッケージをシステムにインストー - ルする最も簡単な方法です。このインストーラは、簡単なHTTP接続により - PEARパッケージサーバに接続し、システムにパッケージをダウンロードし、 - 好きな場所にインストールします。 + コマンドライン インストーラは、PEAR パッケージをシステムにインストールする + 最も簡単な方法です。このインストーラは、単純な HTTP 接続により + PEAR パッケージサーバに接続し、システムにパッケージをダウンロードし、 + 任意の場所にインストールします。 </para> - <sect2> <title>完全自動インストール</title> <para> @@ -153,30 +159,31 @@ </screen> </para> <para> - &lt;package&gt; は、(HTTP_Uploadのような)インストールするパッケー - ジの名前で置き換えて下さい。利用可能なパッケージの一覧を見るには、 - <ulink url="http://pear.php.net/packages.php">PEARパッケージブラ - ウザ</ulink>または以下を実行します。 - </para> + &lt;package&gt; は、(HTTP_Uploadのように)インストールするパッケージの + 名前で置き換えて下さい。利用可能なパッケージの一覧を見るには、 + <ulink url="http://pear.php.net/packages.php">PEAR + パッケージブラウザ</ulink>を参照するか、以下のコマンドを実行します。 + </para> <para> <screen> <userinput> -&dollar; pear list-remote-packages +&dollar; pear remote-list </userinput> </screen> </para> <para> - このコマンドは、PEARで利用可能な全てのパッケージを返します。 + このコマンドは、その時点で PEAR で利用可能なすべてのパッケージの + リストを返します。 </para> </sect2> <sect2> <title>半自動インストール</title> <para> - <ulink url="http://pear.php.net/">pear.php.net</ulink>からダウン - ロードしたリリースパッケージをgzip圧縮されたtarアーカイブとして所 - 有している場合、ローカルな環境でパッケージをインストール可能です。 - これを行うには、シェルで以下のような1行を実行して下さい。 + <ulink url="http://pear.php.net/">pear.php.net</ulink>から + リリースパッケージを gzip 圧縮された tar アーカイブの形式で + (手動で)ダウンロードし、ローカルな環境にインストールできます。 + シェルで以下の1行を実行して下さい。 </para> <para> <screen> @@ -186,20 +193,315 @@ </screen> </para> <para> - このコマンドは、自動的にパッケージをインストールし、オンライン接 - 続を必要としません。<filename>&lt;file&gt;.tgz</filename>は、ダウ - ンロードされたファイルの名前に置き換える必要があります。 + このコマンドは、自動的にパッケージをインストールしますが、 + その際オンライン接続を必要としません。 + <filename>&lt;file&gt;.tgz</filename>は、ダウンロードしたファイルの + 名前に置き換えてください。 </para> </sect2> + </sect1> + + <sect1 id="installation.shared"> + <title>共有ホストにおける PEAR のローカルコピーのインストール</title> + + <para> + システム共有の PEAR インストールにアクセスできるようなプロバイダを使っている + ユーザの方もいらっしゃるでしょう。 + しかし、インストールされていないパッケージを使いたい場合などをはじめ、 + 多くの場面で、PEAR のローカルコピーを作成すると便利です。 + telnet/ssh によるシェルアクセスを通じた方法と、ftp アクセスだけによる方法 + とについて説明します。 + </para> + <sect2 id="installation.shared.shell"> + <title>SSH を使用したインストール</title> + <para> + SSH を通じて PEAR のローカルコピーをインストールするには、 + 以下のコマンドを使用します。 + </para> + <para> + <screen> + <userinput> +&dollar; pear -s -c ~/.pearrc -d doc_dir=~/pear/docs -d ext_dir=~/pear/ext \ + -d php_dir=~/pear/lib -d data_dir=~/pear/data -d test_dir=~/pear/tests \ + -d cache_dir=~/pear/cache -d bin_dir=~/pear/bin + </userinput> + </screen> + </para> + <para> + ローカルの設定ファイルがホームディレクトリに <filename>.pearrc</filename> + という名前で作成されます。 + 加えて、インストールしたパッケージを保存するためのディレクトリ構造は、 + ホームディレクトリの <filename>pear</filename> ディレクトリ下に + 作成されるように設定されます。 + </para> + <para> + 次に、.bashrc(もしくは他のスタートアップファイル)にて、 + ~/pear/bin をパスに追加し、以下のコマンドを実行します。 + </para> + <para> + <screen> + <userinput> +&dollar; pear -c ~/.pearrc install Archive_Tar PEAR Console_Getopt XML_RPC + </userinput> + </screen> + </para> + <para> + システム版とは別に、PEAR のローカル版がインストールされます。 + インストールされたファイルを使用するには、PEAR パッケージを使うコードにおいて、 + PHP の include_path を以下のようにしてセットしてください。 + </para> + <para> + <programlisting role="php"> +<![CDATA[ +<?php +ini_set('include_path', '~/pear/lib' . PATH_SEPARATOR . ini_get('include_path')); +?> +]]> + </programlisting> + </para> + <para> + もしくは、apache の <filename>.htaccess</filename> ファイルで + php_value を使う方法もあります。 + </para> + </sect2> + + <sect2 id="installation.shared.ftp"> + <title>ftp を使用したインストール</title> + <para> + ftp を使用して PEAR のローカルコピーをインストールするには、 + アップロード時にファイルのパーミッションを設定できる ftp クライアントが + 必要です。 + まず、サーバの、ウェブに公開されていない場所にディレクトリをひとつ作成し、 + 好きな名前をつけます。そして、全ユーザから読み書き可能 (0777) とします。 + http://go-pear.org をダウンロードし、<filename>go-pear.php</filename> + という名前で保存します。<filename>go-pear.php</filename> を、 + ウェブからアクセス可能なディレクトリにアップロードします。 + (セキュリティーのため) + <filename>.htaccess</filename> を使って <filename>go-pear.php</filename> + を含むディレクトリにパスワード制限をかけるのが良いでしょう。 + </para> + <para> + 次に、<filename>go-pear.php</filename> ファイルをブラウズします。 + ウェブアドレスが http://www.example.comで、<filename>go-pear.php</filename> を + <filename>public_html/install/go-pear.php</filename> に置いた場合、 + http://www.example.com/install/go-pear.php にアクセスしてください。 + 表示されたインストールの画面に従います。 + どこに PEAR をインストールするか訊かれたら、さきほど作成した + 全ユーザから読み書き可能にしたディレクトリを指定します。 + また、CLI バージョンの PHP のありかも知らせる必要があります。 + PHP のありかは、以下のスクリプトの出力を参照してください。 + </para> + <para> + <programlisting role="php"> +<![CDATA[ +<?php +echo `which php`; +// if this does not work, also try echo PHP_BIN; +?> +]]> + </programlisting> + </para> + <para> + PEAR がインストールされたら、他の PEAR インストールの方法と同様に、 + web 版のインストーラを使って、パッケージのインストールやアップグレードが + できます。 + インストールされた PEAR のファイルを使うには、ウェブサイトのスクリプト中で + include path をセットする必要があります。 + </para> + <para> + <programlisting role="php"> +<![CDATA[ +<?php +ini_set('include_path', '~/pear/lib' . PATH_SEPARATOR . ini_get('include_path')); +?> +]]> + </programlisting> + </para> + </sect2> + </sect1> + + <sect1 id="installation.manually"> + <title>手動インストール</title> + + <para> + パッケージの手動インストールは推奨されません。しかし、 + サイトがシェルアクセスの無いホスティング環境の場合、自動の方法では + 問題を生じる方もいるでしょう。 + </para> + <para> + 以下では、サイトにパッケージを手動でインストールする方法について示します。 + このとき、サイトのドキュメントのルートは、 + <filename>/var/www/www.example.com/htdocs/</filename> とします。 + <filename>htdocs</filename> と同じレベルに、 + <filename>includes</filename> というディレクトリがあり、 + このディレクトリは、<acronym>FTP</acronym> や WebDAV からは + アクセス可能ですが、<acronym>HTTP</acronym> からは + アクセス不能だとします。 + </para> + <para> + インストールは、簡単ないくつかのステップからなります。 + <orderedlist> + <listitem> + <simpara> + パッケージをダウンロードする。 + </simpara> + <para> + web ブラウザを使って <ulink url="&url.pear;">PEAR ホームページ</ulink> + からパッケージをダウンロードします。 + ダウンロードしたいパッケージ情報についての <acronym>URL</acronym> + がわからない場合は、<ulink url="&url.pear.package.browse;"> + パッケージブラウザ</ulink>を使って現在利用可能なパッケージを + 表示させることができます。 + </para> + </listitem> + <listitem> + <simpara> + パッケージのソースコードをアップロードする。 + </simpara> + <para> + .tgz ファイルをダウンロードしたら、ローカルマシンのテンポラリ ディレクトリに + 解凍します。ソースコードを <acronym>FTP</acronym> や WebDAV 等で + <filename>/var/www/www.example.com/includes/</filename> ディレクトリに + アップロードしますが、たとえは Mail_Mime のコードは、 + <filename>/var/www/www.example.com/includes/Mail/</filename> に + 置くようにします。 + </para> + </listitem> + <listitem> + <simpara> + include_path ディレクティブを設定する。 + </simpara> + <para> + 最後に、アップロードしたソースコードのある場所を含むように、 + PHP の include_path ディレクティブを設定します。 + <filename>php.ini</filename> 設定ファイルに触ることができる場合は、 + <filename>/var/www/www.example.com/includes/</filename> を、 + そこの include_path ディレクティブに追加します。 + 触れない場合は、PEAR パッケージを使う各スクリプト中で + include_path をセットします。 + </para> + <para> + <programlisting role="php"> +ini_set("include_path", '/var/www/www.example.com/includes/' . PATH_SEPARATOR . ini_get("include_path")); + </programlisting> + </para> + </listitem> + <listitem> + <simpara> + インストールが済めば、以下のようにして、PEAR パッケージを + 使用できるようになります。 + </simpara> + <para> + <programlisting role="php"> +require_once "Mail/Mime.php"; + +$mime = ... + </programlisting> + </para> + </listitem> + </orderedlist> + </para> + <para> + 手動インストールについて質問がある場合は、 + <ulink url="&email.pear.general;">General メーリングリスト</ulink>で + 質問してください。 + </para> </sect1> <sect1 id="installation.cvs"> - <title>CVSインストーラ</title> + <title>CVS インストーラ</title> <para> - CVSからPEARパッケージの最新の開発バージョンをインストールする方法 - を説明します。 + ここでは、CVS から最新の開発版をインストールする方法について記述します。 + </para> + <para> + 実稼動環境では、CVS から得たパッケージを実行することは控えるべきです。 + CVS バージョンは通常のリリースと異なります。つまり、 + <itemizedlist> + <listitem> + <simpara> + メンテナ他からの援助が得られない。 + </simpara> + </listitem> + <listitem> + <simpara> + CVS バージョンは、PEAR インストーラのアップグレード機能を + 破壊することがある。 + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + CVS から得たパッケージは、以下の場合にのみ使用するべきです。 + <itemizedlist> + <listitem> + <simpara>メンテナが勧めた場合</simpara> + </listitem> + <listitem> + <simpara>パッケージの開発を援助したい場合</simpara> + </listitem> + <listitem> + <simpara>リリースされていない機能やパッチを本当に必要としている場合</simpara> + </listitem> + </itemizedlist> + </para> + <para> + CVS からパッケージをインストールする場合、パッケージのメンテナが + 新しいリリースを作成するのと同じステップを取る必要があります。 + 以下のいずれかのステップで問題がある場合は、本マニュアルの + <link linkend="guide-developers">デベロッパーズガイド</link>を + 参照してください。 + </para> + <orderedlist> + <listitem> + <para> + パッケージを <ulink url="http://www.php.net/anoncvs.php"> + http://www.php.net/anoncvs.php</ulink> に記述の通りに CVS から + チェックアウトする。 + </para> + <para> + チェックアウトすべきモジュールは、<filename>pear/&lt;packagename&gt;</filename> + となります。たとえば、 + <command> cvs -d :pserver:cvsread@cvs.php.net:/repository checkout pear/HTTP_Client</command>。 + </para> + </listitem> + <listitem> + <para> + <filename>package.xml</filename> をチェックし、fileset 要素が + 実際のファイル・ディレクトリ構造にあっているかどうか調べる。 + もし異なるなら、メンテナに連絡をとり、<filename>package.xml</filename> を + アップデートするように頼んでみてください。 + </para> + </listitem> + <listitem> + <para> + 有効なパッケージのアーカイブを PEAR インストーラを使って作成する。 + <command>pear package &lt;path to package.xml&gt;</command> + </para> + </listitem> + <listitem> + <para> + 対象のパッケージがインストール済みの時は、バージョンに関連する問題を + 避けるために削除する。 + <command>pear uninstall &lt;package&gt;</command> + </para> + </listitem> + <listitem> + <para> + パッケージのアーカイブをインストールする。 + <command>pear install &lt;package-file&gt;</command> + </para> + <para> + 以上で CVS バージョンがインストールされました。 + </para> + </listitem> + </orderedlist> + <para> + (CVS バージョンは) + パッケージの正式リリースにできるだけ早くアップグレードするべきです。 + 正式リリースをインストールする前には、バージョンに関連する問題を避けるために、 + CVS バージョンを削除してください。 </para> </sect1> http://cvs.php.net/diff.php/peardoc/ja/chapters/standards.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/ja/chapters/standards.xml diff -u peardoc/ja/chapters/standards.xml:1.1 peardoc/ja/chapters/standards.xml:1.2 --- peardoc/ja/chapters/standards.xml:1.1 Fri Apr 4 23:25:54 2003 +++ peardoc/ja/chapters/standards.xml Mon May 24 09:36:18 2004 @@ -1,37 +1,39 @@ <?xml encoding="utf-8"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> +<!-- EN-Revision: 1.22 Maintainer: Status: ready --> +<!-- CREDITS: --> <chapter id="standards"> <title>標準コーディング規約</title> <note> <simpara> - PEAR標準コーディング規約は、PEARの公式ディストリビューション(PHPと - 共に配布されるかPHP PEARレポジトリからのダウンロードにより取得可能) - に含まれるコードに適用されます。 + PEAR 標準コーディング規約は、PEAR の公式ディストリビューション + (PHP と共に配布されるか、PHP PEAR レポジトリからダウンロードにより + 取得可能なもの)に含まれるコードに適用されます。 </simpara> </note> <sect1 id="standards.indenting"> <title>インデント</title> <para> - タブではなく、空白4つのインデントを使用して下さい。 - PEARコードを編集するためにEmacsを使用する場合、indent-tabs-modeを - nilに設定する必要があります。以下に、これらのガイドラインに基づき - Emacsを設定するモードフックの例を示します。(PHPファイルを編集する - 際にこれがコールされるようにする必要があります) + タブではなく、空白 4 つのインデントを使用してください。 + PEAR コードを編集するために Emacs を使用する場合、indent-tabs-mode を + nil に設定する必要があります。以下に、これらのガイドラインに基づき + Emacs を設定するモードフックの例を示します(PHP ファイルを編集する際に + これがコールされるようにする必要があります)。 <programlisting role="elisp"> <![CDATA[ (defun php-mode-hook () (setq tab-width 4 c-basic-offset 4 c-hanging-comment-ender-p nil - indent-tabs-mode - (not - (and (string-match "/\\(PEAR\\|pear\\)/" (buffer-file-name)) - (string-match "\.php$" (buffer-file-name)))))) + indent-tabs-mode + (not + (and (string-match "/\\(PEAR\\|pear\\)/" (buffer-file-name)) + (string-match "\.php$" (buffer-file-name)))))) ]]> </programlisting> </para> <para> - 以下に同様なことを行うvimルールを示します。 + 以下に、同様なことを行う vim ルールを示します。 <programlisting role="vim"> <![CDATA[ set expandtab @@ -41,13 +43,19 @@ ]]> </programlisting> </para> + <para> + およそ半角 75-85 文字ごとに改行することを推奨します。 + 改行する最善の方法についての標準ルールは存在しませんので、自身の判断で行って + ください。疑問があれば、<ulink url="mailto:&email.pear.qa;"> + PEAR 品質保証メーリングリスト</ulink>で質問してください。 + </para> </sect1> <sect1 id="standards.control"> <title>制御構造</title> <para> - 制御構造には、if, for, while, switch等が含まれます。以下に、最も複 - 雑な制御構造であるif文の例を示します。 + 制御構造には、if, for, while, switch 等があります。以下に、 + 最も複雑な制御構造である if 文の例を示します。 <programlisting role="php"> <![CDATA[ if ((condition1) || (condition2)) { @@ -65,9 +73,9 @@ 間に空白を1つ置くべきです。 </simpara> <simpara> - 構文的に任意の場合にも常に波括弧を使用することが強く推奨されます。 - 波括弧を付けることにより可読性が向上し、新しく行が追加された際に論 - 理的なエラーが紛れこむ可能性が減少します。 + 構文的に任意の場合にも、常に波括弧を使用することが強く推奨されます。 + 波括弧を付けることにより可読性が向上し、新しく行が追加された際に + 論理的なエラーが紛れこむ可能性が減少します。 </simpara> <para> switch文の場合は次のようにします。 @@ -96,9 +104,9 @@ <title>関数コール</title> <para> 関数は、関数名と開き括弧および最初のパラメータの間に空白を置かず、 - カンマと各パラメータの間に空白を置き、最後のパラメータと閉括弧およ - びセミコロンの間に空白を置かずにコールすべきです。以下に例を示しま - す。 + カンマと各パラメータの間には空白を置き、最後のパラメータと閉括弧 + およびセミコロンの間には空白を置かずにコールすべきです。 + 以下に例を示します。 <programlisting role="php"> <![CDATA[ $var = foo($bar, $baz, $quux); @@ -106,9 +114,9 @@ </programlisting> </para> <para> - 上記のように、関数の返り値を変数に代入する際に使用される等号の左右 - には、空白を1つ置くべきです。相関する一連の代入文の場合には、可読 - 性を向上させるために空白をより多く置いても良いでしょう。 + 上記のように、関数の返り値を変数に代入する際に使用される等号の左右には、 + 空白を1つ置くべきです。相関する一連の代入文の場合には、 + 可読性を向上させるために空白をより多く置いても良いでしょう。 <programlisting role="php"> <![CDATA[ $short = foo($bar); @@ -121,7 +129,7 @@ <sect1 id="standards.funcdef"> <title>関数定義</title> <para> - 関数宣言は、以下のような"one true brace"表記に基づきます。 + 関数宣言は、以下のような <quote>one true brace</quote> 表記に基づきます。 <programlisting role="php"> <![CDATA[ function fooFunction($arg1, $arg2 = '') @@ -136,8 +144,8 @@ </para> <para> デフォルト値を有する引数は引数リストの終わりに置きます。 - この関数は処理が適当である場合、常に関数から意味のある値を返すよう - にして下さい。以下にやや長い例を示します。 + 関数は処理が適当である場合、常に関数から意味のある値を返すよう + にしてください。以下にやや長い例を示します。 <programlisting role="php"> <![CDATA[ function connect(&$dsn, $persistent = false) @@ -162,18 +170,18 @@ <sect1 id="standards.comments"> <title>コメント</title> <para> - クラスのインラインドキュメントは、Javadocに似たPHPDocの表記に基づ - く必要があります。PHPDocに関するより詳細な情報は、 + クラスのインラインドキュメントは、Javadoc に似た PHPDoc の表記に基づく + 必要があります。PHPDoc に関するより詳細な情報は、 <ulink url="&url.phpdoc;">&url.phpdoc;</ulink>にあります。 </para> <para> - ドキュメント以外のコメントは、強く推奨されます。一般的な目安として、 + ドキュメント以外のコメントも、強く推奨されます。一般的な目安として、 コードのあるセクションを見た時に「これを説明したくないな」と思うと したら、処理内容を忘れる前にコメントを追加する必要があります。 </para> <para> - C言語形式の(/* */)と標準C++コメント(//)のどちらも使用可能です。 - Perl/shell形式のコメント(#)の使用は推奨されません。 + C 言語形式 (/* */) と標準 C++ コメント (//) のどちらも使用可能です。 + Perl/shell 形式のコメント (#) は使用するべきではありません。 </para> </sect1> @@ -181,19 +189,19 @@ <title>コードの読み込み</title> <para> あるクラスファイルを無条件で読み込む場合は、 - <function>require_once</function>を使用して下さい。あるクラスファ - イルを条件付きで読み込む場合(例えば、factoryメソッド)は、 - <function>include_once</function>を使用して下さい。 - これらはどちらもクラスファイルが1度だけ読み込まれることを保証しま - す。これらは、同じファイルリストを共有しており、混用することについ - て心配する必要はありません。<function>require_once</function>で読 - み込まれたファイルは、<function>include_once</function>により再度 + <function>require_once</function> を使用してください。あるクラスファイルを + 条件付きで読み込む場合(例えば、factory メソッド)は、 + <function>include_once</function> を使用してください。 + どちらもクラスファイルが1度だけ読み込まれることを保証します。 + これらは、同じファイルリストを共有しており、混用することについて心配する + 必要はありません。<function>require_once</function> で読み込まれた + ファイルは、<function>include_once</function> により再度 読み込まれることはありません。 <note> <simpara> - <function>include_once</function>および - <function>require_once</function>は命令であり、関数ではありませ - ん。読み込むファイル名の前後に括弧は不要です。 + <function>include_once</function> および + <function>require_once</function> は命令であり、関数ではありません。 + 読み込むファイル名の前後に括弧は不要です。 </simpara> </note> </para> @@ -202,70 +210,67 @@ <sect1 id="standards.tags"> <title>PHPコードタグ</title> <para> - PHPコードを区分するために<emphasis>、短縮型の - <literal>&lt;? ?></literal>ではなく、常に - </emphasis><literal>&lt;?php ?></literal>を使用して下さい。 - PEAR対応のために必要で、オペレーティングシステムや設定が異なる情况 - でPHPコードを導入するための最も互換性の高い方法でもあります。 + PHPコードを区分するためには、短縮型の<literal>&lt;? ?></literal>ではなく、 + <emphasis>常に</emphasis> <literal>&lt;?php ?></literal> を使用してください。 + PEAR 対応のために必要で、オペレーティングシステムや設定が異なる情况で + PHP コードを読み込む際の最も互換性の高い方法でもあります。 </para> </sect1> <sect1 id="standards.header"> <title>ヘッダのコメントブロック</title> <para> - コアPEAR配布ファイルにある全てのソースコードファイルには、以下のコ - メントブロックがヘッダとして含まれている必要があります。 + コア PEAR 配布ファイルにあるすべてのソースコードファイルには、 + 以下のコメントブロックがヘッダとして記載されている必要があります。 <programlisting role="php"> -<![CDATA[ -/* vim: set expandtab tabstop=4 shiftwidth=4: */ +/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ // +----------------------------------------------------------------------+ -// | PHP version 4.0 | +// | PHP version 4 | // +----------------------------------------------------------------------+ -// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group | +// | Copyright (c) 1997-2004 The PHP Group | // +----------------------------------------------------------------------+ -// | This source file is subject to version 2.0 of the PHP license, | +// | This source file is subject to version 3.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | -// | available at through the world-wide-web at | -// | http://www.php.net/license/2_02.txt. | +// | available through the world-wide-web at the following url: | +// | http://www.php.net/license/3_0.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ -// | Authors: Original Author <author@example.com> | -// | Your Name <you@example.com> | +// | Authors: Original Author &lt;author@example.com> | +// | Your Name &lt;you@example.com> | // +----------------------------------------------------------------------+ // -// $Id: standards.xml,v 1.1 2003/04/05 04:25:54 hirokawa Exp $ -]]> +// &dollar;Id:&dollar; </programlisting> </para> <para> - あるソースファイルの作者のリストに新たなコード提供者の名前を追加す - るべきかどうかを定義する明確な規則はありません。一般的に、作者に属 - する変更点は、"本質的な"分類に属する(10%から20%のコード変更を意味 - します)必要があります。関数の書換えや新たなロジックを提供する場合 - には、例外がある場合があります。 + ソースファイルの作者リストに新たなコード提供者の名前を追加するべきかどうか + を定義する明確な規則はありません。一般的には、 + <quote>相当な</quote>部分(10%から20%のコード変更を意味します)の変更を + 行った場合に、作者とするようです。 + 関数のリライトや新たなロジックの提供の場合には、例外もありえます。 </para> <para> 簡単なコードの整理やバグ修正は、作者のリストに新たに個人を追加する までの理由にはなりません。 </para> <para> - コアPEARリポジトリにないファイルには、似たような著作権、ライセンス、 - 作者を記述したブロックを含む必要があります。全てのファイルには、統 - 一したmodelineコメントを含むべきです + コア PEAR リポジトリにないファイルについても、著作権・ライセンス・ + 作者を記述した同様のブロックを含む必要があります。すべてのファイルには、 + 統一したmodelineコメントを含むべきです </para> </sect1> <sect1 id="standards.cvs"> <title>CVSの使用</title> <simpara> - 本節は、cvs.php.netにあるCVSを使用するパッケージにのみ適用されます。 + 本節は、cvs.php.net の CVS を使用するパッケージにのみ適用されます。 </simpara> <para> - 各ファイルに、CVSのキーワード &dollar;Id&dollar; を含めて下さい。 - 各ファイルを編集した際、まだない場合にはこのタグを追加して下さい。 - (または、"Last Modified:"のような既存の形式を置換して下さい) + 各ファイルに、CVS のキーワード &dollar;Id&dollar; を含めてください。 + 各ファイルを編集した際、まだない場合にはこのタグを追加してください + (または、<quote>Last Modified:</quote>のような既存の形式を置換してください)。 <!-- <note> <simpara> @@ -278,22 +283,22 @@ --> </para> <para> - 本節の残りの部分は、読者がCVSタグおよびブランチに関する基本的な知 - 識を有していることを前堤とします。 + 本節の残りの部分は、読者が CVS タグおよびブランチに関する基本的な + 知識を有していることを前堤とします。 </para> <para> - CVSタグは、指定したリリースに属するパッケージのファイルのリビジョ - ンを示すラベルとして使用されます。以下に必須及び推奨されるCVSタグ - のリストを示します。 + CVS タグは、指定したリリースに属するパッケージのファイルのリビジョンを + 示すラベルとして使用されます。以下に必須及び推奨される CVS + タグ のリストを示します。 <variablelist> <varlistentry> <term>RELEASE_<replaceable>n_n</replaceable></term> <listitem> <simpara> - (必須) リリース用タグとして使用されます。これを使用しない場合、 - リリース時点の状態でCVSサーバからパッケージを取得する手段がな - くなります。 + (必須)リリース用タグとして使用されます。これを使用しない場合、 + リリース時点の状態で CVS サーバからパッケージを取得する手段が + なくなります。 </simpara> </listitem> </varlistentry> @@ -301,11 +306,10 @@ <term>QA_<replaceable>n_n</replaceable></term> <listitem> <simpara> - (ブランチ, オプション) リリース前にリリース侯補版を公開する必 - 要があると考えた場合には、リリース版を分岐し、実際のリリース前 - に重要な修正のみが適用されるようにするというのは良い考えです。 - その間に、通常の開発はメイントランクにおいて継続することが可能 - です。 + (ブランチ, オプション)リリース前にリリース侯補版を公開する必要が + あると考えた場合には、リリース版を分岐し、実際のリリース前に重要な + 修正のみが適用されるようにするというのは良い考えです。 + その間にも、通常の開発はメイントランクにおいて継続することが可能です。 </simpara> </listitem> </varlistentry> @@ -313,33 +317,33 @@ <term>MAINT_<replaceable>n_n</replaceable></term> <listitem> <simpara> - (ブランチ, オプション) (例えば1.2の後に1.2.1といった)"マイクロ - リリース"を行う際に、メインの開発トランクが非常に活溌で、マイ - クロリリース間で僅かな変更のみを行いたい場合に、ブランチを使用 - することもできます。 + (ブランチ, オプション)(例えば1.2の後に1.2.1といった) + <quote>マイクロリリース</quote>を行う際に、 + メインの開発トランクが非常に活溌で、マイクロリリース間で + 僅かな変更のみを行いたい場合に、ブランチを使用することもできます。 </simpara> </listitem> </varlistentry> </variablelist> - RELEASEタグのみが必須で、残りは有用なものを推奨しているだけです。 + RELEASE タグのみが必須で、残りは有用なものを推奨しているだけです。 </para> <para> - 以下は、"Money_Fast"パッケージに1.2リリースタグを付ける方法を示す - ものです。 + 以下は、<classname>Money_Fast</classname>パッケージに + 1.2 リリースタグを付ける方法を示すものです。 <informalexample> <screen><prompt>$ </prompt><command>cd pear/Money_Fast</command> <prompt>$ </prompt><command>cvs tag RELEASE_1_2</command> <computeroutput>T Fast.php T README T package.xml - </computeroutput> - </screen> +</computeroutput> +</screen> </informalexample> - これにより、PEAR Webサイトでリリース手順の残りを行うことができるよ - うになります。 + これにより、PEAR Web サイトでリリース手順の残りを行うことが + できるようになります。 </para> <para> - 以下は、QAブランチを作成する方法を示す例です。 + 以下は、QA ブランチを作成する方法の例です。 <informalexample> <screen><prompt>$ </prompt><command>cvs tag QA_2_0_BP</command> ... @@ -350,17 +354,20 @@ <prompt>$ </prompt><command>cvs tag RELEASE_2_0</command> </screen> </informalexample> - "QA_2_0_BP"タグは"分岐点"タグで、タグの開始点です。このような分岐 - 点からCVSブランチを開始するのは常に良い考えです。 - MAINTブランチはその分岐点と同様にRELEASEタグを使用することが可能で - す。 + <literal>QA_2_0_0_BP</literal>タグは、<quote>分岐点 (branch point)</quote> + タグで、タグの開始点です。このような分岐点から CVS ブランチを開始するのは + 常に良い考えです。MAINT ブランチは、その分岐点と同様に RELEASE + タグを使用することが可能です。 </para> </sect1> <sect1 id="standards.exampleurls"> - <title>URLの例</title> + <title> URL の例</title> <para> - 全てのURLの例についてRFC 2606に基づくURLを使用して下さい。 + URL の例には、<literal>example.com</literal> および + <literal>example.org</literal>, <literal>example.net</literal> + を使用してください。電子メールアドレスは、 + <ulink url="&url.rfc;2606">RFC 2606</ulink> を参照してください。 </para> </sect1> @@ -369,19 +376,18 @@ <sect2> <title>クラス</title> <para> - クラスは、内容が分かる名前を指定する必要があります。可能ならば省 - 略した名前を使用することは避けて下さい。クラス名は、常に大文字で - 始まる必要があります。PEARクラス階層は、クラス名にも反映され、各 - 階層レベルは、アンダースコア1つで区切られます。 - 良いクラス名の例を以下に示します。 + クラスは、内容が分かる名前を指定する必要があります。可能ならば略語の + 使用は避けてください。クラス名は、常に大文字で始まる必要があります。 + PEAR クラス階層は、クラス名にも反映され、各階層レベルは、 + アンダースコア1つで区切られます。良いクラス名の例を以下に示します。 <informaltable> <tgroup cols="3"> <tbody> - <row> - <entry><simpara>Log</simpara></entry> - <entry><simpara>Net_Finger</simpara></entry> - <entry><simpara>HTML_Upload_Error</simpara></entry> - </row> + <row> + <entry><simpara>Log</simpara></entry> + <entry><simpara>Net_Finger</simpara></entry> + <entry><simpara>HTML_Upload_Error</simpara></entry> + </row> </tbody> </tgroup> </informaltable> @@ -390,38 +396,39 @@ <sect2> <title>関数とメソッド</title> <para> - 関数とメソッドは、"studly caps"形式("bumpy case"または"camel - caps"とも呼ばれます)を使用して名前を付ける必要があります。 - 関数は、パッケージ間の名前の衝突を避けるためにパッケージ名を接頭 - 辞として加える必要があります。(接頭辞の後の)名前の最初の文字は、 - 小文字で、新しい単語を始める際の各先頭文字は大文字とします。例を - いくつか以下に示します。 + 関数とメソッドは、<quote>studly caps</quote>形式 + (<quote>bumpy case</quote> または <quote>camel caps</quote> とも呼ばれます) + を使用して名前を付ける必要があります。 + 関数は、パッケージ間の名前の衝突を避けるためにパッケージ名を接頭辞として + 加える必要があります。(接頭辞の後の)名前の最初の文字は小文字で、 + 新しい単語を始める際の各先頭文字は大文字とします。 + 例をいくつか以下に示します。 <informaltable> <tgroup cols="4"> <tbody> - <row> - <entry><simpara>connect()</simpara></entry> - <entry><simpara>getData()</simpara></entry> - <entry><simpara>buildSomeWidget()</simpara></entry> - <entry><simpara>XML_RPC_serializeData()</simpara></entry> - </row> + <row> + <entry><simpara>connect()</simpara></entry> + <entry><simpara>getData()</simpara></entry> + <entry><simpara>buildSomeWidget()</simpara></entry> + <entry><simpara>XML_RPC_serializeData()</simpara></entry> + </row> </tbody> </tgroup> </informaltable> </para> <para> - プライベートクラスメンバ(このクラスメンバは宣言された同じクラスの - 内部からのみ使用されることを意図しています。PHPはプライベート名前 - 空間をまだサポートしていません)は、アンダースコア1つを前に付けま - す。例を以下に示します。 + プライベートなクラスメンバ(宣言された同じクラスの内部からだけの使用を + 意図したクラスメンバ。 + PHP は、プライベート名前空間をまだサポートしていません。)は、 + アンダースコア 1 つを前に付けます。例を以下に示します。 <informaltable> <tgroup cols="3"> <tbody> - <row> - <entry><simpara>_sort()</simpara></entry> - <entry><simpara>_initTree()</simpara></entry> - <entry><simpara>$this->_status</simpara></entry> - </row> + <row> + <entry><simpara>_sort()</simpara></entry> + <entry><simpara>_initTree()</simpara></entry> + <entry><simpara>$this->_status</simpara></entry> + </row> </tbody> </tgroup> </informaltable> @@ -430,10 +437,10 @@ <sect2> <title>定数</title> <para> - 定数は常に全て大文字で記述し、単語を区切る際にはアンダースコアを - 使用します。使用されるクラス/パッケージを大文字で表した名前を前置 - 定数名として使用します。例えば、<literal>DB::</literal>パッケージ - で使用される定数は全て"<literal>DB_</literal>"で始まります。 + 定数は、常にすべて大文字で記述し、単語を区切る際にはアンダースコアを + 使用します。使用されるクラス/パッケージを大文字で表した名前を + 定数の接頭辞として使用します。例えば、<literal>DB::</literal> パッケージ + で使用される定数はすべて<literal>DB_</literal>で始まります。 </para> </sect2> <sect2> @@ -441,11 +448,235 @@ <para> パッケージでグローバル変数を定義する必要がある場合、その名前は、 アンダースコアで始まり、その後にパッケージ名と別のアンダースコア - が続くようにする必要があります。例えば、PEARパッケージは、 - $_PEAR_destructor_object_listという名前のグローバル変数を使用しま - す。 + が続くようにする必要があります。例えば、PEAR パッケージは、 + $_PEAR_destructor_object_list という名前のグローバル変数を使用します。 </para> </sect2> + </sect1> + + <sect1 id="standards.sample"> + <title>サンプルファイル</title> + <para> + サンプル中の <command>Id</command> という CVS キーワードは、今読んでいる + ドキュメントの作成に使われたファイルに関するデータを保持しています。 + 自身の PEAR スクリプトを作成する場合は、空のキーワード + <literal>&dollar;Id:&dollar;</literal> に置き換えてください。 + </para> + <para> + 上下左右方向のスペースにも注意してください。それらも、規約の一部です。 + </para> + <para> + <quote>折り畳みマーカ (fold markers)</quote> + (<literal>// {{{</literal> および <literal>// }}}</literal>) + は、オプションです。折り畳みマーカを使わない場合は、 + <literal>foldmethod=marker</literal> を vim のヘッダから削除してください。 + </para> + <para> + サンプルには、Docblock コメントの書き方の多くの詳細が記載されています。 + これらの指示に従うことは、2 つの意味で重要です。第1は、docblocks は + 読みやすく、コードが何の動作をするか、ユーザや開発者がすばやく理解できます。 + 第2に、PEAR の WEB サイトでは、パッケージの各リリースに対して + phpDocumentor により生成されたドキュメントを掲載しています。 + WEB サイト上の API ドキュメントを役立つものにするには、 + きちんとコメントを記述する必要があります。 + </para> + <para> + <programlisting role="php"> + <![CDATA[ +<?php +/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */ +// +----------------------------------------------------------------------+ +// | PHP version 4 | +// +----------------------------------------------------------------------+ +// | Copyright (c) 1997-2004 The PHP Group | +// +----------------------------------------------------------------------+ +// | This source file is subject to version 3.0 of the PHP license, | +// | that is bundled with this package in the file LICENSE, and is | +// | available through the world-wide-web at the following url: | +// | http://www.php.net/license/3_0.txt. | +// | If you did not receive a copy of the PHP license and are unable to | +// | obtain it through the world-wide-web, please send a note to | +// | license@php.net so we can mail you a copy immediately. | +// +----------------------------------------------------------------------+ +// | Authors: Original Author <author@example.com> | +// | Your Name <you@example.com> | +// +----------------------------------------------------------------------+ +// +// $Id: standards.xml,v 1.2 2004/05/24 13:36:18 haruki Exp $ + +require_once 'PEAR.php'; + +// {{{ constants + +/** + * This is a "Docblock Comment," also known as a "docblock." The class' + * docblock, below, contains a complete description of how to write these. + */ +define('NET_SAMPLE_OK', 1); + +// }}} +// {{{ Net_Sample + +/** + * An example of how to write code to PEAR's standards + * + * Docblock comments start with "/**" at the top. Notice how the "/" + * lines up with the normal indenting and the asterisks on subsequent rows + * are in line with the first asterisk. The last line of comment text + * should be immediately followed on the next line by the closing asterisk + * and slash and then the item you are commenting on should be on the next + * line below that. Don't add extra lines. Please put a blank line + * between paragraphs as well as between the end of the description and + * the start of the @tags. Wrap comments before 80 columns in order to + * ease readability for a wide variety of users. + * + * Docblocks can only be used for programming constructs which allow them + * (classes, properties, methods, defines, includes, globals). See the + * phpDocumentor documentation for more information. + * http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html + * + * The Javadoc Style Guide is an excellent resource for figuring out + * how to say what needs to be said in docblock comments. Much of what is + * written here is a summary of what is found there, though there are some + * cases where what's said here overrides what is said there. + * http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide + * + * The first line of any docblock is the summary. Make them one short + * sentence, without a period at the end. Summaries for classes, properties + * and constants should omit the subject and simply state the object, + * because they are describing things rather than actions or behaviors. + * + * Below are the tags commonly used for classes. @category through @access + * are required. The remainder should only be used when necessary. + * Please use them in the order they appear here. phpDocumentor has + * several other tags available, feel free to use them. + * + * @category categoryname + * @package packagename + * @author Original Author <author@example.com> + * @version $Id: standards.xml,v 1.2 2004/05/24 13:36:18 haruki Exp $ + * @access public + * @see NetOther, Net_Sample::Net_Sample() + * @since Class available since Release 1.2.0 + * @deprecated Class deprecated in Release 2.0.0 + */ +class Net_Sample +{ + // {{{ properties + + /** + * The status of foo's universe + * + * Potential values are 'good', 'fair', 'poor' and 'unknown'. + * + * @var string + */ + var $foo = 'unknown'; + + // }}} + // {{{ setFoo() + + /** + * Registers the status of foo's universe + * + * Summaries for methods should use 3rd person declarative rather + * than 2nd person imperative, begining with a verb phrase. + * + * Summaries should add description beyond the method's name. The + * best method names are "self-documenting", meaning they tell you + * basically what the method does. If the summary merely repeats + * the method name in sentence form, it is not providing more + * information. + * + * Summary Examples: + * + Sets the label (preferred) + * + Set the label (avoid) + * + This method sets the label (avoid) + * + * Below are the tags commonly used for methods. A @param tag is + * required for each parameter the method has. The @return and + * @access tags are mandatory. The @throws tag is required if the + * method uses exceptions. @static is required if the method can + * be called statically. The remainder should only be used when + * necessary. Please use them in the order they appear here. + * phpDocumentor has several other tags available, feel free to use + * them. + * + * The @param tag contains the data type, then the parameter's + * name, followed by a description. By convention, the first noun in + * the description is the data type of the parameter. Articles like + * "a", "an", and "the" can precede the noun. The descriptions + * should start with a phrase. If further description is necessary, + * follow with sentences. Having two spaces between the name and the + * description aids readability. + * + * When writing a phrase, do not capitalize and do not end with a + * period: + * + the string to be tested + * + * When writing a phrase followed by a sentence, do not capitalize the + * phrase, but end it with a period to distinguish it from the start + * of the next sentence: + * + the string to be tested. Must use UTF-8 encoding. + * + * Return tags should contain the data type then a description of + * the data returned. The data type can be any of PHP's data types + * (int, float, bool, string, array, object, resource, mixed) + * and should contain the type primarily returned. For example, if + * a method returns an object when things work correctly but false + * when an error happens, say 'object' rather than 'mixed.' Use + * 'void' if nothing is returned. + * + * @param string $arg1 the string to quote + * @param int $arg2 an integer of how many problems happened. + * Indent to the description's starting point + * for long ones. + * + * @return int the integer of the set mode used. FALSE if foo + * foo could not be set. + * @throws exceptionclass [description] + * + * @access public + * @static + * @see Net_Sample::$foo, Net_Other::someMethod() + * @since Method available since Release 1.2.0 + * @deprecated Method deprecated in Release 2.0.0 + */ + function setFoo($arg1, $arg2 = 0) + { + /* + * This is a "Block Comment." The format is the same as + * Docblock Comments except there is only one asterisk at the + * top. phpDocumentor doesn't parse these. + */ + if ($arg1 == 'good' || $arg1 == 'fair') { + $this->foo = $arg1; + return 1; + } elseif ($arg1 == 'poor' && $arg2 > 1) { + $this->foo = 'poor'; + return 2; + } else { + return false; + } + } + + // }}} +} + +// }}} + +/* + * Local variables: + * tab-width: 4 + * c-basic-offset: 4 + * c-hanging-comment-ender-p: nil + * End: + */ + +?> + ]]> + </programlisting> + </para> </sect1> </chapter> http://cvs.php.net/diff.php/peardoc/ja/chapters/support.xml?r1=1.4&r2=1.5&ty=u Index: peardoc/ja/chapters/support.xml diff -u peardoc/ja/chapters/support.xml:1.4 peardoc/ja/chapters/support.xml:1.5 --- peardoc/ja/chapters/support.xml:1.4 Thu Aug 14 02:49:45 2003 +++ peardoc/ja/chapters/support.xml Mon May 24 09:36:18 2004 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="utf-8" ?> -<!-- $Revision: 1.4 $ --> -<!-- sync: 1.7 --> +<!-- $Revision: 1.5 $ --> +<!-- EN-Revision: 1.8 Maintainer: Status: ready --> +<!-- CREDITS: --> <chapter id="support"> <title>サポート</title> <simpara> - 本章は、PEARに関する質問がある場合にサポートを受ける方法を説明する - ものです。 + 本章は、PEAR に関する質問がある場合にサポートを受ける方法を説明するものです。 </simpara> <sect1 id="support.lists"> @@ -14,167 +14,211 @@ <sect2> <title>概要</title> <para> - 多くの他のオープンソースプロジェクトと同様に、サポートはメーリン - グリストを通じて行われます。現在、以下に示す4つのPEAR関連のメーリ - ングリストがあります。 + 他の多くのオープンソースプロジェクトと同様に、サポートは + メーリングリストを通じて行われます。 + 現在、PEAR 関連しては、以下に示すメーリングリストがあります(いずれも英語)。 <itemizedlist> <listitem> <para> - <link linkend="support.lists.general">Generalリスト</link> + <link linkend="support.lists.general">総合メーリングリスト + (general list)</link> </para> </listitem> <listitem> <para> - <link linkend="support.lists.dev">Developersリスト</link> + <link linkend="support.lists.dev">開発者メーリングリスト + (developers list)</link> </para> </listitem> <listitem> <para> - <link linkend="support.lists.documentation">Documentationリスト</link> + <link linkend="support.lists.documentation">文書関連メーリングリスト + (documentation list)</link> </para> </listitem> <listitem> <para> - <link linkend="support.lists.webmaster">Webmasterリスト</link> + <link linkend="support.lists.webmaster">WEB 関連メーリングリスト + (webmaster list)</link> </para> </listitem> <listitem> <para> - CVS commitリスト + CVS メーリングリスト (CVS list) + </para> + </listitem> + <listitem> + <para> + <link linkend="support.lists.core">コア開発メーリングリスト + (Core development list)</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="support.lists.qa">品質保証メーリングリスト + (QA list)</link> </para> </listitem> </itemizedlist> </para> <para> - 最初の3つのリストは、質問がある場合に助けとなるためのものです。以 - 下を読んで、どのリストが自分のニーズに合致するかを知って下さい。 - CVS commit リストは、PEARに貢献する人用です。リビジョン管理システ - ム(CVS)への全てのコミットはこのリストに送られます。 + 最初の4つのリストは、質問がある場合に助けとなるためのものです。 + 以下を読むと、どのリストが自分のニーズに合致するかがわかるでしょう。 + CVS リストは、PEARにコードを寄与する人向けです。 + リビジョン管理システム (CVS) へのすべてのコミットは、 + このリストに内容が送信されます。 + コア開発および品質保証リストは、PEAR の開発に参加したい方々のためのものです。 </para> <para> - PEARメーリングリストには、 - <ulink url="&url.pear.support;">このWebサイト</ulink>で登録できま - す。 + PEAR の各メーリングリストには、 + <ulink url="&url.pear.support;">こちらの WEB サイト</ulink>で + 登録できます。 </para> </sect2> <sect2 id="support.lists.general"> - <title>Generalメーリングリスト</title> + <title>総合メーリングリスト</title> <para> - The <ulink url="mailto:&email.pear.general">PEAR general - mailing list</ulink> is the mailing list, where you ask, if you - have a question about installing PEAR, using a certain PEAR - package etc. + PEAR <ulink url="mailto:&email.pear.general">総合メーリングリスト</ulink>は、 + PEAR のインストールや PEAR パッケージの使用に関する質問がある場合に使われる + メーリングリストです。 </para> <para> - The list is no support forum for question concerning the usage - of PHP. Please use <ulink url="mailto:php-general@lists.php.net"> - php-general@lists.php.net</ulink> instead. + PHP 自体の使用についての質問に対するサポートフォーラムではありません。 + それには <ulink url="mailto:php-general@lists.php.net"> + php-general@lists.php.net</ulink> を利用ください。 </para> - </sect2> + </sect2> <sect2 id="support.lists.dev"> - <title>Developersメーリングリスト</title> + <title>開発者メーリングリスト</title> <para> - As the name already tells you, this list is the place where the - developers of PEAR come together to make decisions, to discuss - about code and to handle things that are related to this. + 名前から判るとおり、このリストは PEAR の開発者が集まり、 + 決定を下したり、コードについての議論を行ったり、 + 関連する事項を扱ったりするためのものです。 </para> <para> - If you are no developer of PEAR itself, this list is of no real - interest for you, unless + あなたが PEAR の開発者ではない場合でも、以下の場合には + 役にたつかも知れません。 <itemizedlist> <listitem> <simpara> - you want to get to know what's going on behind PEAR + PEAR の舞台裏で起こっていることを知りたい時 </simpara> </listitem> <listitem> <simpara> - you want to contribute code to PEAR + PEAR にコードを寄与したい時 </simpara> </listitem> <listitem> <simpara> - you have found a bug in a PEAR package and want to supply a - patch for that. + ある PEAR パッケージにバグを見つけ、パッチを投稿したい時 </simpara> </listitem> </itemizedlist> </para> <para> - The adress for this list is <ulink url="mailto:&email.pear.dev"> - &email.pear.dev</ulink>. + このリストのアドレスは、<ulink url="mailto:&email.pear.dev"> + &email.pear.dev</ulink> です。 </para> </sect2> <sect2 id="support.lists.documentation"> - <title>ドキュメント作成用メーリングリスト</title> + <title>文書関連メーリングリスト</title> <para> - <ulink url="mailto:&email.pear.doc">This list</ulink> is the - place, where all the things concerning the PEAR documentation, - the manual etc. are discussed. + <ulink url="mailto:&email.pear.doc">このリスト</ulink>は、 + PEAR のドキュメントやマニュアルに関するすべての事項を議論する場所です。 </para> <para> - If you want to help out documenting PEAR packages, don't hesitate - to drop a mail there. + PEAR パッケージのドキュメントに関して何か援助をしたい場合、 + 御気楽にメールを投稿してください。 </para> </sect2> <sect2 id="support.lists.qa"> - <title>The QA mailing list</title> + <title>品質保証メーリングリスト</title> <para> - People being interested in improving the overall quality of PEAR - come together on the <ulink url="mailto:&email.pear.qa;">QA list</ulink>. + PEAR の全体的な品質の向上に興味のある者が + <ulink url="mailto:&email.pear.qa;">品質保証リスト</ulink>に参加しています。 </para> <para> - The Quality Insurance team is always seeking people that want to - help. If you are interested, just - <ulink url="&url.pear.support;">sign up</ulink> and announce - yourself on the mailing list. + 品質保証チームは、常時、援助してくれる方を探しています。 + 興味のある方は、<ulink url="&url.pear.support;">サインアップ</ulink>して、 + 本メーリングリストにアナウンスしてください。 </para> </sect2> <sect2 id="support.lists.webmaster"> - <title>Webmasterメーリングリスト</title> + <title>WEB 関連メーリングリスト</title> <para> - If you have found a problem on our website or have a question - concerning the site, you can email the guys on + PEAR の WEB サイトに問題を見つけたり、サイトに関する質問がある場合は、 <ulink url="mailto:&email.pear.webmaster;">&email.pear.webmaster; - </ulink>. + </ulink> にメールしてください。 + </para> + </sect2> + + <sect2 id="support.lists.core"> + <title>コア開発メーリングリスト</title> + <para> + <ulink url="mailto:&email.pear.core;">このリスト</ulink>は、 + PEAR の各種インフラについて議論する場です。PECL や PHP + 品質保証など PHP の他のプロジェクトの面々もメンバーとして参加しています。 + というのも、 + (PEAR インストーラや PEAR WEB サイトなどの)PEAR のインフラは、 + 他のプロジェクトにも関連しているからです。 + </para> + <para> + 特に以下のトピックを扱います。 + <itemizedlist> + <listitem> + <simpara> + PEAR WEB サイトの新機能について + </simpara> + </listitem> + <listitem> + <simpara> + PEAR インストーラの開発について + </simpara> + </listitem> + <listitem> + <simpara> + 各種の PEAR 標準の定義について + </simpara> + </listitem> + </itemizedlist> </para> </sect2> </sect1> <sect1> - <title>Webリソース</title> - + <title>WEB リソース</title> + <para> - There are a number of web sites that deal with PEAR. We have - compiled a list of them - <ulink url="&url.pear.support;">here</ulink>. If a - site is missing, you can email - <ulink url="mailto:&email.pear.webmaster;">the webmaster</ulink>. + PEAR について扱っている WEB サイトは数多く存在します。 + それらのリストを、<ulink url="&url.pear.support;">こちら</ulink>で + 作成しています。 + もし、サイトが消えている場合は、<ulink url="mailto:&email.pear.webmaster;"> + webmaster</ulink> へメールしてください。 </para> </sect1> <sect1 id="support.irc"> - <title>IRCの#PEAR</title> + <title>IRC の #PEAR</title> <para> - PEARプロジェクトには専用のIRCチャンネル#PEARがあり、<ulink - url="&url.efnet;">EFnet</ulink>で利用可能です。 - 参加して、グルーたちに合って下さい。彼らのインターネット接 - 続の料金を負担する必要はなく、一日中IRCに接続したままとすることが - できます。 + PEAR プロジェクトには専用の IRC チャンネル #PEAR があり、<ulink + url="&url.efnet;">EFnet</ulink> で利用可能です。 + 参加して、グルーたちに逢って下さい。彼らのインターネット接続の料金を + 負担する必要はなく、一日中 IRC に接続したままとすることができます。 </para> </sect1>
« previous php.pear.doc (#4084) next »