cvs: peardoc /ja preface.xml

hirokawa Mon Feb 23 18:38:53 2004 EDT Modified files: /peardoc/ja preface.xml Log: sync with en.

http://cvs.php.net/diff.php/peardoc/ja/preface.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/ja/preface.xml diff -u peardoc/ja/preface.xml:1.2 peardoc/ja/preface.xml:1.3 --- peardoc/ja/preface.xml:1.2 Tue Jun 3 19:04:07 2003 +++ peardoc/ja/preface.xml Mon Feb 23 18:38:53 2004 @@ -1,5 +1,6 @@ <?xml version="1.0" encoding="utf-8" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> +<!-- EN-Revision: 1.7 Maintainer: hirokawa Status: ready --> <preface id="preface"> <title>はじめに</title> @@ -7,7 +8,7 @@ <abstract> <simpara> <acronym>PEAR</acronym> は、the PHP Extension and Application - Repositoryです。 + Repositoryを意味します。 </simpara> </abstract> @@ -17,9 +18,9 @@ 本マニュアルは、<ulink url="&url.docbook.xml;">DocBook XML DTD</ulink>を用いて<acronym>XML</acronym>で書かれ、 <ulink url="&url.dsssl;"><acronym>DSSSL</acronym></ulink> - (Document Style and Semantics Specification Language)をフォーマッ - トに使用しています。<acronym>HTML</acronym>バージョンのフォーマッ - トに使用されたツールは、<ulink url="&url.jclark;">James + (Document Style and Semantics Specification Language)をフォーマッ + トに使用しています。<acronym>HTML</acronym>バージョンのフォーマッ + トに使用されたツールは、<ulink url="&url.jclark;">James Clark</ulink>により書かれた<ulink url="&url.jade;">Jade</ulink>と <ulink url="&url.nwalsh;">Norman Walsh</ulink>により書かれた <ulink url="&url.dbstyle;">The Modular DocBook Stylesheets</ulink> @@ -27,16 +28,18 @@ </para> <para> - 本マニュアルは、過去に行われたPHPドキュメント作成グループの偉大な - 成果に基づいています。 + 本マニュアルの基本的な構成は、過去に行われたPHPドキュメント作成グループの + 偉大な成果に基づいています。詳細については、 + <ulink url="&url.php.manual.about;">PHPマニュアルについて</ulink> + を参照して下さい。 </para> </sect1> <sect1 id="structure"> <title>本マニュアルの構成</title> <para> - このマニュアルは5つの部分から構成されます。必要な情報をできるだけ - 早くみつけるために以下の説明を一読下さい。 + 本手引きは、PEARマニュアルで使用される構成、レイアウト、表記について + 説明するものです。このマニュアルは主に以下の6つの部分から構成されます。 </para> <para> <itemizedlist> @@ -45,25 +48,30 @@ <link linkend="about-pear">PEARについて</link> </para> <para> - PEARのインストールおよび使用方法に関する一般的な情報。 - PEARに関する知識がない場合には、このセクションから読み始めると - 良いでしょう。 + 本節には、PEARとその機能に関する導入が記述されています。 + 記述されているのは、インストールとPEARの使用法、サポートに関する一般的な情報 + と、PEAR関連のFAQに関する回答です。 </para> </listitem> <listitem> <para> - <link linkend="core">コアコンポーネンツ</link> + <link linkend="guide-developers">開発者への手引き</link> + </para> + <para> + PEARパッケージを開発／リリースする際の一般的な情報。 </para> + </listitem> + <listitem> <para> - このセクションには、PEARの管理および使用に関連する基礎的なPEAR - クラスに関するドキュメントが記述されています。 - PEARのユーザとしては、基底クラス - &class.pear; および &class.pear-error; オブジェクトのドキュメン - トを見ておくべきでしょう。 + <link linkend="core">コアコンポーネンツ</link> </para> <para> - ここに記述されたクラスは、全ての標準的なPHPディストリビューショ - ンに含まれています。 + 本節には、コアPEARクラスに関する文書が記述されています。 + コアコンポーネントは、全てのPEARクラスのベースであり、 + PEARライブラリを汎用的に使用することを可能にするものです。 + ここでは、&class.pear ベース、PEAR管理、&class.pear-error;を使用した + エラー処理、オブジェクト、システムコマンドについて記述されています。 + これらのクラスは、一般的な全てのPHPソース配布ファイルに付属しています。 </para> </listitem> <listitem> @@ -71,31 +79,27 @@ <link linkend="packages">パッケージ</link> </para> <para> - 本節は、通常の各PEARパッケージに関するドキュメントをカバーして - います。その多くは、おそらく、使用するシステムにデフォルトでイ - ンストールされていません。 - インストール方法に関しては、 - <link linkend="installation">インストールの章</link> を参照して - 下さい。 - </para> - <para> - パッケージリファレンスページには、少なくとも利用可能なpublic関 - 数に関するドキュメントが含まれています。 - 加えて、そのクラスの一般的な使用方法に関する導入セクション - (<parameter>'Introduction'</parameter>)や、 - このパッケージにより提供される定数に関するセクション - (<parameter>'Constants'</parameter>) が含まれています。 - いくつかのリファレンスには、 - <parameter>'Example'</parameter>パートが含まれており、 - より大規模で複雑な例が記述されています。 + 多くのPEARパッケージが存在し、その数は日々増え続けています。 + ほぼ全てのパッケージは文書化されていますが、多くはデフォルトでは + インストールされていません。 + PEARクラスのシステムへのインストール方法に関する情報については、 + <link linkend="installation">インストールに関する章</link>を + 読むようにして下さい。 + </para> + <para> + 各クラスに関する文書には、外部から利用可能なパッケージの関数に関する + 文書が含まれています。これらには、導入、利用可能な定数の一覧、 + パッケージの使用方法といった付加的な情報が含まれていることもあります。 + 付加的な情報は、パッケージのソースファイル自体にも含まれている + 場合があります。 </para> <para> - 関数の説明は、以下のパートより構成されます。 + 各関数の説明には以下の要素の一部または全てが含まれています。 <itemizedlist> <listitem> - <para>Synopsis</para> + <para>概要</para> <para> - 関数の構造を示します。 + 関数の構造とプロトタイプを示します。 </para> </listitem> <listitem> @@ -107,7 +111,8 @@ <listitem> <para>パラメータ</para> <para> - 必須またはオプションのパラメータを記述します。 + 関数の各パラメータの説明をその型と名前と共に示します。 + 必須およびオプションのパラメータが共に記述されます。 </para> </listitem> <listitem> @@ -126,7 +131,8 @@ <listitem> <para>注意</para> <para> - この関数に関する追加情報。 + この関数に関する追加情報。例としては、この関数は静的にコールすることが + できるというものがあります。 </para> </listitem> <listitem> @@ -138,7 +144,7 @@ <listitem> <para>例</para> <para> - 簡単な関数の例。 + 関数またはクラスの使用例 </para> </listitem> </itemizedlist> @@ -164,6 +170,25 @@ </itemizedlist> </para> </sect1> + + <sect1 id="authors"> + <title>著者とコントリビュータ</title> + <titleabbrev>著者</titleabbrev> + + <para> + 以下のリストには、本文書の維持を支援してくれている人のリストが含まれています。 + あなたがこの一人に連絡をとりたい場合には、<ulink + url="mailto:&email.pear.doc;">&email.pear.doc;</ulink>にメールを + 書いて下さい。 + </para> + + &authors.list; + + <simpara> + (アルファベット順) + </simpara> + </sect1> + </preface> <!-- Keep this comment at the end of the file