cvs: peardoc /ja/guide/developers contributing.xml packagedef.xml release.xml

From: Date: Wed, 28 Apr 2004 09:56:05 +0000
Subject: cvs: peardoc /ja/guide/developers contributing.xml packagedef.xml release.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-3755@lists.php.net to get a copy of this message
haruki Wed Apr 28 05:56:05 2004 EDT Modified files: /peardoc/ja/guide/developers contributing.xml packagedef.xml release.xml Log: sync with en

http://cvs.php.net/diff.php/peardoc/ja/guide/developers/contributing.xml?r1=1.5&r2=1.6&ty=u Index: peardoc/ja/guide/developers/contributing.xml diff -u peardoc/ja/guide/developers/contributing.xml:1.5 peardoc/ja/guide/developers/contributing.xml:1.6 --- peardoc/ja/guide/developers/contributing.xml:1.5 Sat Mar 20 00:21:08 2004 +++ peardoc/ja/guide/developers/contributing.xml Wed Apr 28 05:56:05 2004 @@ -1,23 +1,23 @@ <?xml version="1.0" encoding="utf-8" ?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- EN-Revision: 1.18 Maintainer: haruki Status: ready --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. --> <chapter id="developers.contributing"> - <title>コードの寄与</title> + <title>コードを寄与する</title> <titleabbrev>コードの寄与</titleabbrev> <para> - PEARは、<ulink url="http://www.opensource.org/">オープンソース</ulink> + PEAR は、<ulink url="http://www.opensource.org/">オープンソース</ulink> 志向の開発者コミュニティーによって運営されています。 - ですから、誰でも、本PEARプロジェクトにコードを寄与することができます。 - それは、新しいパッケージの作成でも、 + ですから、誰でも、本プロジェクトにコードを寄与することができます。 + まったく新しいパッケージの作成でも、 既存のパッケージに対する改良であってもかまいません。 しかしながら、 PEARでは、パッケージの品質を非常に高いレベルに保持することも目標としています。 - そのため、コードの寄与には、以下に示す要求事項があります。 + そのため、コードの寄与にあたっては、以下に示す要求事項があります。 </para> <sect1 id="developers.contributing.requirements"> @@ -43,7 +43,7 @@ 標準コーディング規約というものが良いものかどうかについては 多くの議論がありましたが、 絶対に必要なものであるとの決定に達しました。 - さらに議論しても意義はありません。 + さらに議論する意義はありません。 </para> </listitem> @@ -56,20 +56,21 @@ 拡張可能で新しい機能を将来に容易に追加できるものであるべき、 と言うことを、常に意識に留めておいてください。 現在のコードとの後方互換性を破壊すること無しに - 機能の拡張が容易でない場合は、より良い設計の実装を、 - パッケージをPEARへ投稿する前に考えてみるべきです。 + 機能の拡張が容易でない場合は、 + パッケージを PEAR へ投稿する前に、 + より良い設計の実装について考えてみるべきです。 </para> <para> それに関連しては、 オブジェクト指向プログラミングの基礎をよく理解することが有用でしょう。 - PHPは完全なオブジェクト指向のサポートには至っていませんが、 + PHP は、完全なオブジェクト指向のサポートには至っていませんが、 その知識はあなたのパッケージのコードを 拡張可能な状態に保つ助けとなるでしょう。 オブジェクト指向プログラミングについては、 - WEB上にたいへん多くのリソースがありますし、 + WEB 上にたいへん多くのリソースがありますし、 読書の楽しみを満たしてくれる多くの本も見つけられるでしょう。 - ただしお勧めは、 - サンによる<ulink url="&url.java;">JAVAのホームページ</ulink> + お勧めは、 + サンによる <ulink url="&url.java;">JAVA のホームページ</ulink> に記載された <ulink url="&url.java.oo;"> オブジェクト指向プログラミングの概念 @@ -87,7 +88,7 @@ <para> コードには、 次の形式の内のいずれかの適切なドキュメントが付属している - <emphasis>必要</emphasis>があります。 + <emphasis>必要</emphasis> があります。 <itemizedlist> <listitem> <simpara> @@ -101,9 +102,9 @@ </listitem> </itemizedlist> - ドキュメントをDocbook XMLで書き、マークアップが適切なら、 + ドキュメントを Docbook XML で書き、マークアップが適切なら、 そのドキュメントは、あなたが今読まれている - 公式<ulink url="&url.pear.manual;">PEARマニュアルl</ulink>に + 公式 <ulink url="&url.pear.manual;">PEAR マニュアルl</ulink>に 簡単に付け加えることが出来ます。 </para> @@ -111,20 +112,20 @@ <para> 2003年8月以降、 <ulink url="&url.phpdocumentor;">phpDocumentor</ulink>は、 - コード中に書かれたAPIのドキュメントや + コード中に書かれた API のドキュメントや 外部チュートリアル文書を、 - PEARで使用するXML DocBookに変換すること出来ます。 + PEAR で使用する XML DocBookに変換すること出来ます。 PhpDocumentor バージョン 1.2.2以降が必要です。 - インストールは、 - <literal>pear install phpDocumentor</literal>としてください。 + インストールするには、 + <literal>pear install phpDocumentor</literal> としてください。 ソースコードから出力を作成するには - XML:DocBook/peardoc2:defaultコンバータを使ってください。 - 出力は、言語はenやfrなどで、 + XML:DocBook/peardoc2:default コンバータを使ってください。 + 出力は、言語は en や fr などで、 直接<literal>peardoc/lang/package</literal> ディレクトリに生成されます。 </para> <para> - 注意して欲しいのは、APIドキュメントだけでは十分ではないことです。 + 注意して欲しいのは、API ドキュメントだけでは十分ではないことです。 さらに、使用例や使用法についてのチュートリアルも必要です。 <link linkend="developers.contributing.docs">ドキュメントの書き方</link> @@ -135,7 +136,7 @@ <listitem> <simpara> - .phptもしくは + .phpt もしくは <link linkend="package.php.phpunit">PHPUnit</link> 形式による回帰テスト </simpara> @@ -143,15 +144,15 @@ バグによるフラストレーションを経験していない開発者はいません。 それはプログラミングにおける紛れも無い真実ですが、 幸運にも、バグを捕まえ消滅させ復活を防ぐためのシステムが存在します。 - 回帰テストをすべての安定版リリースに含めるべきです。 + すなわち、回帰テストをすべての安定版リリースに含めるべきです。 というのも、 - もしバグが発生した場合に、パッケージのデバグを助けるために - ユーザが実行できるようにするためです。 - .phpt形式の回帰テストの例として、 + もしバグが発生した場合に、パッケージのデバグの助けとなるよう、 + ユーザがそれを実行できるようにするためです。 + .php t形式の回帰テストの例として、 PFC <link linkend="package.database.db">DB</link> パッケージがあります。 - PHPUnitのテストの例としては、 - <link linkend="package.authentication.auth">Auth</link>を + PHPUnit のテストの例としては、 + <link linkend="package.authentication.auth">Auth</link> を ご覧ください。 </para> </listitem> @@ -161,16 +162,16 @@ 寄与者(つまり<quote>あなた</quote>)は、 パッケージのサポートを行う意思があり、 ほんの少しのバグ修正でも次バージョンを - リリースすることを厭わないこと。 + リリースすることを厭わない </simpara> <simpara> もし長期にわたるメンテナンスを行うつもりが無ければ、 コードを寄与しても意義はほとんどありません。 - PEARは、 - PHPパッケージの標準リポジトリであって、多くの責任が伴います。 + PEAR は、 + PHP のパッケージの標準リポジトリであって、多くの責任が伴います。 メンテナンスとは、いくつかある <ulink url="&url.pear.support;">メーリングリスト</ulink> - においてサポートを提供する以上のことを意味します。 + においてサポートを提供する以上のことを意味しています。 </simpara> <simpara> バグ修正を行うだけでなく、 @@ -181,7 +182,7 @@ バグ修正が行われた新バージョンを 定期的にリリースすることも期待されます。 もし、長期間に渡ってパッケージのメンテナンスが出来なくなった場合には、 - PEAR開発者メーリングリストにアナウンスし、 + PEAR 開発者メーリングリストにアナウンスし、 別の仮リードメンテナを任命するか、 パッケージが一時的にメンテナンスされない旨を皆に文書で知らせるかして、 さらに可能ならば、 @@ -192,7 +193,7 @@ <simpara> リードメンテナが以後メンテナンスする意思がなく、 リードメンテナを引き継ぐ人もいない場合は、 - コードがPEARから削除されることがあります。 + コードが PEAR から削除されることがあります。 </simpara> </warning> </listitem> @@ -209,7 +210,7 @@ <listitem> <simpara>適切なパッケージ名称の命名</simpara> <simpara> - 新パッケージをPEARに寄与するにあたっての最重要な務めの内の1つは、 + 新パッケージを PEAR に寄与するにあたっての最重要な務めの内の1つは、 パッケージに適切な名称をつけることです。 </simpara> <para> @@ -217,7 +218,7 @@ <literal>&lt;カテゴリ&gt;_&lt;名前&gt;</literal> となります。 <literal>&lt;カテゴリ&gt;</literal>は、 - PEARにあるカテゴリの既定義のリストから選ぶべきです + PEAR にあるカテゴリの既定義のリストから選ぶべきです (例、<quote>HTTP</quote>, <quote>Net</quote>, <quote>HTML</quote>)。 2番目の部分は、パッケージの名前です @@ -232,20 +233,20 @@ で太字で表示されています。 もし、パッケージが既存のカテゴリに当てはまらない場合は、 メーリングリストで新カテゴリの作成を依頼することも可能です。 - (PEARとしては、 + (PEAR としては、 新カテゴリの作成は、あまり行いたくはありませんが。) </para> <para> 上記の構文とは異なりますが、パッケージ名に 複数のカテゴリ名を含むこともできます。 - 例えば、<literal>HTML_Template_PHPLIB</literal>を挙げると、 - その複数のカテゴリは、パッケージ<literal>PHPLIB</literal>が、 - <literal>Template</literal>カテゴリに含まれ、 - さらに<literal>HTML</literal>カテゴリにも含まれることを示します。 + 例えば、<literal>HTML_Template_PHPLIB</literal> を挙げると、 + その複数のカテゴリは、パッケージ <literal>PHPLIB</literal> が、 + <literal>Template</literal> カテゴリに含まれ、 + さらに<literal>HTML</literal> カテゴリにも含まれることを示します。 この命名の仕組みは、 - HTMLで動作しないが他の技術では動作するテンプレートシステムが - PEARに存在しえるようにするために必要となっています。 + HTML で動作しないが他の技術では動作するテンプレートシステムが + PEAR に存在しえるようにするために必要となっています。 (複数の<quote>category</quote>が使われる場合はたいへん稀です。) </para> @@ -284,7 +285,7 @@ <para> 投票は誰でも出来ますが、 - PEARコミュニティーの(提案者以外の、PEARのWEBアカウントを持つ) + PEAR コミュニティーの(提案者以外の、PEAR の WEB アカウントを持つ) アクティブメンバーの投票だけがカウントされます。 投票に際しては、 最終的に選択したパッケージ名が明示されていることが求められます。 @@ -293,9 +294,9 @@ 投票は合計されます。 ここで合計とは、-1の票は、+1の票を相殺してしまうことを意味します。 しかし常に、-1の票は、重大なものと考えられ、 - 拒否権を保持する<ulink url="&url.pear.group;">PEARグループ</ulink>が + 拒否権を保持する <ulink url="&url.pear.group;">PEAR グループ</ulink>が ケースバイケースの決定をすることになるかもしれません。 - (将来的には、そのような状況ではPEAR QAチームがPEARグループを + (将来的には、そのような状況では PEAR QA チームが PEAR グループを 補助することになるだろうということも考えられています。) ですので、 -1の票は必ずその決定について説明するコメントを @@ -323,7 +324,7 @@ </simpara> <para> - 現在、PEARに関連するアカウントは2タイプあります。 + 現在、PEAR に関連するアカウントは2タイプあります。 <orderedlist> <listitem> @@ -331,11 +332,11 @@ <para> このアカウントは、 - PEARでパッケージをリリースしたい場合、常に必要となるものです。 + PEAR からパッケージをリリースしたい場合、常に必要となるものです。 このアカウントを使って、 アップロードしたり新リリースを出したりするために必要な <ulink - url="&url.pear;">pear.php.net</ulink>のインフラにアクセスします。 + url="&url.pear;">pear.php.net</ulink> のインフラにアクセスします。 </para> </listitem> @@ -343,49 +344,49 @@ <simpara>PHP CVS アカウント</simpara> <para> - <ulink url="&url.cvs;">CVS</ulink>でコードを管理したければ、 - <ulink url="&url.php.cvs;">cvs.php.net</ulink>上の - PEAR <abbrev>CVS</abbrev>モジュールにアクセスする - CVSアカウントを申請できます。 + <ulink url="&url.cvs;">CVS</ulink> でコードを管理したければ、 + <ulink url="&url.php.cvs;">cvs.php.net</ulink> 上の + PEAR <abbrev>CVS</abbrev> モジュールにアクセスする + CVS アカウントを申請できます。 これにより、 他のユーザがあなたのコードに寄与することが容易になります。 </para> <para> - もしCVSリポジトリをすでにどこか別のところ + もし CVS リポジトリをすでにどこか別のところ (例えば、<ulink url="&url.sourceforge;">SourceForge</ulink>) に持っているか、 - CVSでコードを管理したくなければ、 - PHP CVSアカウントは必要ありません。 + CVS でコードを管理したくなければ、 + PHP CVS アカウントは必要ありません。 しかしながら、新リリースを出す前に、 - コードに適用したバグ修正をユーザが試して見ることが出来るように、 + コードに適用したバグ修正をユーザが試してみることができるように、 なんらかの公開リポジトリを使うことが強く求められます。 </para> </listitem> </orderedlist> </para> <para> - pear.php.netアカウントにサインアップするには、 + pear.php.net アカウントにサインアップするには、 <ulink - url="&url.pear.account.new;">PEARアカウント申請ページ</ulink>に行き、 + url="&url.pear.account.new;">PEAR アカウント申請ページ</ulink>に行き、 書式を埋めてください。 - <ulink url="&url.pear.group;">PEARグループ</ulink>が申請を受け取り、 + <ulink url="&url.pear.group;">PEAR グループ</ulink>が申請を受け取り、 申請が適切であれば、アカウントが開かれます。 電子メールで通知されます。 パッケージをダウンロードするには - pear.php.netアカウントは必要ないことに注意してください。 + pear.php.net アカウントは必要ないことに注意してください。 </para> <para> - PHP CVSアカウントは、「<ulink + PHP CVS アカウントは、「<ulink url="&url.php.cvs.new;">こちら</ulink>」でサインアップしてください。 - PHP CVSアカウントは、PHPグループで承認が行われます。 + PHP CVS アカウントは、PHP グループで承認が行われます。 </para> </listitem> <listitem> <simpara>パッケージの登録</simpara> <simpara> 寄与の手続きがうまく進み、 - pear.php.netアカウントを取得したら、最後は、パッケージの登録です。 + pear.php.net アカウントを取得したら、最後は、パッケージの登録です。 パッケージの登録は、 パッケージの最初のバージョンのリリースを意味するのではなく、 PEARパッケージのデータベースに基本的な情報を @@ -414,92 +415,11 @@ <sect1 id="developers.contributing.docs"> <title>ドキュメントの書き方の実際</title> <titleabbrev>ドキュメントの書き方</titleabbrev> - <para> - このマニュアルについての章では、 - どのようにしてドキュメントを論理的に構成するかについて述べます。 - peardocの標準に基づく - ドキュメント構成方法の詳細を扱うものではありません。 - peardoc形式でのドキュメントファイルのオーサリングについて学ぶには、 - 「<ulink - url="&url.php.cvs.peardoc.authoring;">こちら</ulink>」のPHPのCVSを - ご覧ください。 - </para> - <para> - パッケージのドキュメントを作成する場合、 - いくつかの基本的ルールに従うことで、 - 良いドキュメントを作成できます。 - </para> - <para> - <orderedlist> - <listitem> - <para> - 初めは、パッケージによってある問題が解決される、ということです。 - その問題とは、いったい何でしょうか? - エンドユーザがその問題について考えてはいないことは何か、 - ということを考慮するように - してみてください。 - (エンドユーザは、その問題が解決すべきことだとは、 - 考えてないかもしれません。) - 例えば、テンプレートのパッケージは、 - コードからのデザインの分離、 - ビジネスロジックからの - ディスプレイロジックの分離という問題を解決するものです。 - 可能ならば、初心のプログラマが理解できるような用語で説明してください。 - </para> - </listitem> - <listitem> - <para> - 次は、 - どのような独自の方法でパッケージはその問題を解決しているか、です。 - ほとんどのドキュメントが、これを欠いています。 - 例えば、テンプレートエンジンは数多くあり、 - それぞれが同じ問題を解決しようとしていますが、 - 同じ方法では行っていません。 - ブロックベースのテンプレートエンジンは - ロジックをまったく持っていませんが、 - Smartyのようなテンプレートは - まったく新しいテンプレート言語を定義しています。 - テンプレートをコンパイルするものもありますし、 - 行わないものもあります。 - 何が、あなたのパッケージの特徴でしょうか? - コードをまったく見ていない人が、問題の解決の方法について - 良く理解できますか? - </para> - </listitem> - <listitem> - <para> - 最終的には、 - パブリックにアクセスできるパッケージのすべての項目について、 - 完全にドキュメントを作成する必要があります。 - パッケージが再利用可能なクラスであるなら、 - ユーザが使うであろう全メソッドについて - ドキュメント化すべきです。 - パッケージにパブリックにアクセスできる定数があれば、 - それらの意味と使用方法について述べてください。 - ユーザが使わなければならないインターフェイス、例えば、 - データベースDSNやアプリケーションのコマンドラインの引数、 - 設定ファイルでの定数、その他すべての非コードな要素について、 - ドキュメントを作成してください。 - </para> - </listitem> - <listitem> - <para> - 単純なものと複雑なもの、少なくとも2つのコード例を書いてください。 - 当然ですが、PEARパッケージは使ってもらうためにあるので、 - ユーザに使用方法を示してください! :) - </para> - </listitem> - <listitem> - <para> - 最後は、ドキュメントを校正してください。 - 可能なら、あなたのプロジェクトに親しんでいない他の誰かに、 - ドキュメントを見てもらってください。 - あなたが見落としていた考えを捕らえてくれるかもしれません。 - おそらく、これが最も重要なステップでしょう。 - </para> - </listitem> - </orderedlist> - </para> + <simpara> + ドキュメントの書き方については、こちらの<link + linkend="developers.documentation">セクション</link>を + 参照してください。 + </simpara> </sect1> </chapter> http://cvs.php.net/diff.php/peardoc/ja/guide/developers/packagedef.xml?r1=1.6&r2=1.7&ty=u Index: peardoc/ja/guide/developers/packagedef.xml diff -u peardoc/ja/guide/developers/packagedef.xml:1.6 peardoc/ja/guide/developers/packagedef.xml:1.7 --- peardoc/ja/guide/developers/packagedef.xml:1.6 Sat Mar 20 00:21:08 2004 +++ peardoc/ja/guide/developers/packagedef.xml Wed Apr 28 05:56:05 2004 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="utf-8" ?> -<!-- $Revision: 1.6 $ --> -<!-- EN-Revision: 1.14 Maintainer: haruki Status: ready --> +<!-- $Revision: 1.7 $ --> +<!-- EN-Revision: 1.19 Maintainer: haruki Status: ready --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. @@ -10,13 +10,13 @@ <titleabbrev><filename>package.xml</filename></titleabbrev> <sect1 id="developers.packagedef.intro"> - <title>パッケージ定義ファイル<filename>package.xml</filename>の解説</title> + <title>パッケージ定義ファイル <filename>package.xml</filename> の解説</title> <titleabbrev>解説</titleabbrev> <simpara> - パッケージ定義ファイル<filename>package.xml</filename>は、 - その名が示す通り、あるPEARパッケージについてのすべての情報が記載された - 整形式のXMLファイルです。 + パッケージ定義ファイル <filename>package.xml</filename> は、 + その名が示す通り、ある PEAR パッケージについてのすべての情報が記載された + 整形式の XML ファイルです。 </simpara> <simpara> この章では、パッケージ定義の使用可能な要素について述べ、 @@ -25,8 +25,8 @@ <simpara> <link linkend="package.pear.pear-packagefilemanager">PEAR_PackageFileManager</link> - パッケージを使えば、package.xmlの作成が容易になります。 - 下記の様に、いつものコマンドでPEAR_PackageFileManagerのインストールが可能です。 + パッケージを使えば、package.xml の作成が容易になります。 + 下記の様に、いつものコマンドで PEAR_PackageFileManager のインストールが可能です。 </simpara> <para> @@ -41,8 +41,8 @@ <title>使用可能な要素</title> <para> - <filename>package.xml</filename>のトップレベル要素は - <literal>&lt;package version="1.0"&gt;</literal>です。 + <filename>package.xml</filename> のトップレベル要素は + <literal>&lt;package version="1.0"&gt;</literal> です。 副要素として使用可能なものは下記の通り。 </para> @@ -211,7 +211,7 @@ <para> <example> - <title>基本的な<filename>package.xml</filename></title> + <title>基本的な <filename>package.xml</filename></title> <programlisting role="xml"> <![CDATA[ <?xml version="1.0" encoding="ISO-8859-1" ?> @@ -249,7 +249,7 @@ </example> </para> <para> - この<filename>package.xml</filename>は、必要な要素をすべて含んでおり、 + この <filename>package.xml</filename> は、必要な要素をすべて含んでおり、 テンプレートとして使用できます。この例をあなたのパッケージに適用するには、 多くの場合、タグ間の文字データを変更するだけです。 </para> @@ -277,10 +277,13 @@ <file>Currency.php</file> <file>Stocks.php</file> </dir> - <dir name="examples"> - <file role="text">README.txt</file> - <file role="php">NASDAQ.php</file> - <file role="php">DAX.php</file> + <dir name="docs" role="doc"> + <file>README.txt</file> + <file>tutorial.txt</file> + <dir name="examples" role="doc"> + <file role="php">NASDAQ.php</file> + <file role="php">DAX.php</file> + </dir> </dir> </dir> </filelist> @@ -293,8 +296,8 @@ <para> この例から解るように、便利な機能があります。パッケージ中に 同じタイプのファイルだけを含むディレクトリがある場合、 - role属性を<literal>&lt;dir&gt;</literal>タグに記述することで、 - 個別の<literal>&lt;file&gt;</literal>タグにいちいち記述しないですみます。 + role 属性を <literal>&lt;dir&gt;</literal> タグに記述することで、 + 個別の <literal>&lt;file&gt;</literal> タグにいちいち記述しないですみます。 </para> <para> 本章で得た知識に基づいて、 @@ -308,7 +311,7 @@ <sect2> <title>ファイルの役割</title> <para> - &lt;file&gt;タグ中の<literal>role</literal>属性は、 + &lt;file&gt; タグ中の <literal>role</literal> 属性は、 ファイルのタイプが何であるか、および、 どの位置にインストールされるか、を定義します。 <table> @@ -332,7 +335,7 @@ <row> <entry>ext</entry> <entry>拡張モジュール。ダイナミックライブラリ</entry> - <entry>PHP拡張モジュールのディレクトリ、または + <entry>PHP 拡張モジュールのディレクトリ、または <constant>PHP_PEAR_EXTENSION_DIR</constant> で定義されたディレクトリ</entry> </row> @@ -358,14 +361,14 @@ <row> <entry>script</entry> <entry>パッケージ関連シェルスクリプト群</entry> - <entry>PHPバイナリディレクトリ、または + <entry>PHP バイナリディレクトリ、または <constant>PHP_PEAR_BIN_DIR</constant> で指定されたディレクトリ。</entry> </row> <row> <entry>src and extsrc</entry> - <entry>C または C++ iのソースコード</entry> + <entry>C または C++ のソースコード</entry> <entry>直接はコピーされない - 拡張もジュールの構築に使用されます。</entry> </row> @@ -382,11 +385,11 @@ <para> PEARパッケージマネージャは、 種々のシステム特性のチェックをサポートしています。 - それらシステム特性への依存性を<literal>&lt;dep&gt;</literal>で定義します。 + それらシステム特性への依存性を <literal>&lt;dep&gt;</literal> で定義します。 <example> - <title>依存性のある<filename>package.xml</filename></title> + <title>依存性のある <filename>package.xml</filename></title> <simpara> - 次の例は、PHP4.3.0以降および<classname>XML_Parser</classname>1.0に対する + 次の例は、PHP 4.3.0以降および <classname>XML_Parser</classname> 1.0に対する 依存性を記述する方法を示しています。 </simpara> <programlisting role="xml"> @@ -396,7 +399,7 @@ [...] </release> <deps> - <dep type="php" rel="ge">4.3.0</dep> + <dep type="php" rel="ge" version="4.3.0" /> <dep type="pkg" rel="has" version="1.0">XML_Parser</dep> </deps> </package> @@ -407,9 +410,9 @@ <sect3> <title><literal>type</literal>属性</title> <para> - 下記にしめす<literal>type</literal>をサポートしています: + 下記にしめす <literal>type</literal> をサポートしています: <table> - <title>typeの値</title> + <title>type の値</title> <tgroup cols="4"> <thead> <row> @@ -431,14 +434,14 @@ <row> <entry>ext</entry> <entry>拡張モジュール</entry> - <entry>特定のPHP拡張モジュールに依存</entry> + <entry>特定の PHP 拡張モジュールに依存</entry> <entry><quote>curl</quote></entry> </row> <row> <entry>php</entry> <entry>PHP</entry> - <entry>特定のPHPバージョンに依存</entry> + <entry>特定の PHP バージョンに依存</entry> <entry><quote>4.2</quote></entry> </row> @@ -461,14 +464,14 @@ <row> <entry>sapi</entry> <entry>サーバAPI</entry> - <entry>特定のサーバAPIに依存</entry> + <entry>特定のサーバ API に依存</entry> <entry><quote>Apache</quote></entry> </row> <row> <entry>zend</entry> <entry>Zend</entry> - <entry>特定のZend APIバージョンに依存</entry> + <entry>特定の Zend API バージョンに依存</entry> <entry><quote>2</quote></entry> </row> </tbody> @@ -478,7 +481,7 @@ </para> <warning> <simpara> - パッケージ定義ファイルのDTDでは他のタイプもサポートするようになっていますが、 + パッケージ定義ファイルの DTD では他のタイプもサポートするようになっていますが、 まだ実際にサポートされるにいたっていません。 </simpara> </warning> @@ -505,7 +508,7 @@ <entry>has</entry> <entry>保持</entry> <entry> - 現状のシステムが要求された特性を保持している。version属性は必須ではありません。 + 現状のシステムが要求された特性を保持している。version 属性は必須ではありません。 </entry> <entry>pkg, ext, php, prog, os, sapi, zend</entry> </row> @@ -514,7 +517,7 @@ <entry>eq</entry> <entry>合致</entry> <entry> - 現状のシステム特性がversion属性値と合致している。 + 現状のシステム特性が version 属性値と合致している。 </entry> <entry>pkg, ext, php, prog, os, sapi, zend</entry> </row> @@ -523,7 +526,7 @@ <entry>lt</entry> <entry>未満</entry> <entry> - 現状のシステム特性がversion属性値より小さい。 + 現状のシステム特性が version 属性値より小さい。 </entry> <entry>pkg, ext, php, zend</entry> </row> @@ -532,7 +535,7 @@ <entry>le</entry> <entry>以下</entry> <entry> - 現状のシステム特性がversion属性値以下である。 + 現状のシステム特性が version 属性値以下である。 </entry> <entry>pkg, ext, php, zend</entry> </row> @@ -541,7 +544,7 @@ <entry>gt</entry> <entry>より大きい</entry> <entry> - 現状のシステム特性がversion属性値より大きい。 + 現状のシステム特性が version 属性値より大きい。 </entry> <entry>pkg, ext, php, zend</entry> </row> @@ -550,7 +553,7 @@ <entry>ge</entry> <entry>以上</entry> <entry> - 現状のシステム特性がversion属性値以上である。 + 現状のシステム特性が version 属性値以上である。 </entry> <entry>pkg, ext, php, zend</entry> </row> @@ -560,28 +563,28 @@ </table> <para> 他の値を定義していない場合、 - <literal>Has</literal>が使用されます。 + <literal>Has</literal> が使用されます。 </para> </sect3> <sect3> - <title><literal>version</literal>属性</title> + <title><literal>version</literal> 属性</title> <para> - <literal>version</literal>は、 + <literal>version</literal> は、 比較に使用されるバージョンを定義します。 </para> </sect3> <sect3> - <title><literal>optional</literal>属性</title> + <title><literal>optional</literal> 属性</title> <para> - <literal>optional</literal>属性は、 + <literal>optional</literal> 属性は、 あるパッケージに完全に依存しているのではなく、 そのパッケージをインストールすることで機能が拡張される場合に使用します。 - 使用可能な値は、&quot;yes&quot;および&quot;no&quot;です。 - <literal>optional</literal>属性が指定されない場合は、 + 使用可能な値は、&quot;yes&quot; および &quot;no&quot; です。 + <literal>optional</literal> 属性が指定されない場合は、 完全に依存している事とされます。 - <literal>optional=&quot;yes&quot;</literal>を使用した場合、次のような + <literal>optional=&quot;yes&quot;</literal> を使用した場合、次のような インストールメッセージが出力されます。 </para> <para> http://cvs.php.net/diff.php/peardoc/ja/guide/developers/release.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/ja/guide/developers/release.xml diff -u peardoc/ja/guide/developers/release.xml:1.3 peardoc/ja/guide/developers/release.xml:1.4 --- peardoc/ja/guide/developers/release.xml:1.3 Sat Mar 20 00:21:08 2004 +++ peardoc/ja/guide/developers/release.xml Wed Apr 28 05:56:05 2004 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="utf-8" ?> -<!-- $Revision: 1.3 $ --> -<!-- EN-Revision: 1.13 Maintainer: haruki Status: ready --> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.14 Maintainer: haruki Status: ready --> <chapter id="developers.release"> <docinfo> <author> @@ -19,8 +19,8 @@ <para> 新しいリリースを行うためには、そのリリースが所属するパッケージが - PEAR開発者によって承認されており、 - また、有効なPEARウェブサイトアカウントを所持していることが必要です。 + PEAR 開発者によって承認されており、 + また、有効な PEAR ウェブサイトアカウントを所持していることが必要です。 この2つの条件についての情報は、 <link linkend="developers.contributing">コードの寄与</link>の章に 記載されています。 @@ -30,9 +30,9 @@ <sect1 id="developers.release.validating"> <title>パッケージ定義ファイルの検証</title> <para> - 次に、パッケージ定義ファイル(<filename>package.xml</filename>)の妥当性を + 次に、パッケージ定義ファイル (<filename>package.xml</filename>) の妥当性を 検証します。 - <command>pear package-validate package.xml</command>コマンドの実行により + <command>pear package-validate package.xml</command> コマンドの実行により 検証できます。 エラーや警告があれば修正したうえで、次のステップに進んでください。 </para> @@ -51,10 +51,10 @@ ことができます。パッケージのトップディレクトリで、 次のコマンドを実行してください。 <command>pear package</command> - リリースのTarballが作成され、後でそれを新リリースのアップロードに使用します。 + リリースの Tarball が作成され、後でそれを新リリースのアップロードに使用します。 <note> <para> - リリースのTarballを作成するには、PHPにzlib拡張のビルドが + リリースの Tarball を作成するには、PHP に zlib 拡張のビルドが 必要なことに注意してください。 </para> </note> @@ -62,7 +62,7 @@ <para> 次に、<command>pear install <filename>&lt;ファイル&gt;</filename></command> - (ファイルは今作成したtarball)を実行し、 + (ファイルは今作成した tarball) を実行し、 パッケージをローカルにインストールしてみるべきです。 これにより、パッケージ定義ファイルが、妥当なだけでなく 有効な情報が記述されていることも確認できます。 @@ -75,21 +75,21 @@ <para> 本ステージで何か悪いところがあれば修正・再パッケージ・再テストを 行ってください。 - すべてがOKならば、次へ進んでください。 + すべてが OK ならば、次へ進んでください。 </para> </sect1> <sect1 id="developers.release.web"> - <title>Webインターフェイスを利用してパッケージをリリース</title> + <title>Web インターフェイスを利用してパッケージをリリース</title> <para> - まず、PEARのwebサイトに、与えられたアカウント(第1ステップ参照)を使って + まず、PEAR の webサイトに、与えられたアカウント(第1ステップ参照)を使って ログインしてください。 </para> <para> - ついに、パッケージをリリースできます。再びこの便利なwebインターフェイスを + ついに、パッケージをリリースできます。再びこの便利な web インターフェイスを 使用して行なわれます。 - <ulink url="&url.pear.package.upload;">&url.pear.package.upload;</ulink>にある + <ulink url="&url.pear.package.upload;">&url.pear.package.upload;</ulink> にある フォームを使用してください。 </para>
« previous php.pear.doc (#3755) next »