このマニュアルは、DocBook XML DTD を用いて XML で書かれ、 DSSSL (Document Style and Semantics Specification Language) をフォーマットに 使用しています。HTML バージョンのフォーマットに 使用されたツールは、James Clark により書かれた Jade と Norman Walsh により書かれた The Modular DocBook Stylesheets です。

このマニュアルの基本的な構成は、過去に行われた PHP ドキュメント作成グループの 偉大な成果に基づいています。詳細については、 PHP マニュアルについて を参照してください。

ここでは、PEAR マニュアルの構成やレイアウト・表記について説明します。 このマニュアルは主に以下の 6 つの部分から構成されています。

• PEAR について

  PEAR とその機能に関する導入を示します。 たとえば、PEAR のインストールと使用方法、 サポートに関する一般的な情報、PEAR 関連して頻出する質問の回答などがあります。

• デベロッパーズガイド

  PEAR パッケージの開発／リリースについての一般的な情報を示します。

• PEAR コア コンポーネンツ

  コア PEAR クラスに関する文書を示します。 このコアなコンポーネントは、すべての PEAR クラスのベースとなっており、 PEAR ライブラリを汎用的に使用するには、その基本的理解が必要となります。 ここでは、PEAR 基底クラス、PEAR 管理、PEAR_Error オブジェクト、 システムコマンドについて記述します。 これらのクラスは、通常、すべての PHP ソース配布ファイルに付属しています。

• パッケージ

  PEAR パッケージは数多くあり、さらに、その数は日々増え続けています。 そのほとんどは、デフォルトではインストールされません。 また、ほぼすべてのパッケージについて〔その概要や関連情報が〕文書化されています。 PEAR クラスをシステムへインストールする方法に関する情報については、 インストール に関するセクションを 参照してください。

  パッケージの各クラスについての文書には、パブリックに利用可能な関数に関する 基本的な情報が示されています。さらに、導入、利用可能な定数の一覧、 パッケージの使用方法といった付加的な情報が含まれていることもあります。 パッケージのソースファイル自体にも、付加的な情報が含まれている場合があります。

  各関数の説明には以下の要素のいずれかが含まれています。

  • 概要

    関数の構造とプロトタイプ。

  • 説明

    関数の動作に関する説明。

  • パラメータ

    関数の各パラメータの型と名前。 必須なパラメータおよびオプションのパラメータを列挙します。

  • 返り値

    関数の処理が失敗せずに完了した場合の返り値。

  • 例外・エラー

    関数の処理が失敗した場合に返される PEAR_Error オブジェクト。

  • 注意

    この関数に関する追加情報。たとえば、この関数をスタティックにコールすることが できるかどうかについて。

  • 参照

    関連する関数やマニュアルのエントリへのリンク。

  • 例

    関数またはクラスの使用例。

• PEAR への貢献

  PEAR パッケージを作成するための情報が記述されています。

以下の方々に、本マニュアルのメンテナンスに協力いただいております。 この内のだれかに連絡を取りたい場合には、pear-doc@lists.php.netにメールを 書いてください。

• Edited By

  Lorenzo Alberton

• Edited By

  Gregory Beaver

• Edited By

  David Coallier

• Edited By

  Daniel Convissor

• Edited By

  David Costa

• Edited By

  Thomas V.V. Cox

• Edited By

  Michael Gauthier

• Edited By

  Christophe Gesché

• Edited By

  Ken Guest

• Edited By

  Martin Jansen

• Edited By

  Alan Knowles

• Edited By

  Clay Loveless

• Edited By

  Alexander Merz

• Edited By

  Stefan Neufeind

• Edited By

  Jon Parise

• Edited By

  Tobias Schlitt

• Edited By

  Stephan Schmidt

• Edited By

  Mika Tuupola

• Edited By

  Michael Wallner

• Edited By

  Christian Weiske

• Edited By

  Mark Wiesemann

(アルファベット順)

日本語への翻訳は、PEAR マニュアル翻訳プロジェクトにより行われています。 主な翻訳者を以下に示します。誤訳の指摘など、 訳者に連絡を取りたい場合には、日本 PHP ユーザ会の PHP-doc メーリングリスト を購読ください。

• Edited By

  Rui Hirokawa

• Edited By

  Tadashi Jokagi

• Edited By

  Soshi Kido

• Edited By

  Haruki Setoyama

• Edited By

  Shoma Suzuki

• Edited By

  Masahiro Takagi

• Edited By

  Hideyuki Shimooka

• Edited By

  Yusuke Hata