diff --git a/docs/guide-ja/README.md b/docs/guide-ja/README.md new file mode 100644 index 0000000..ef111fe --- /dev/null +++ b/docs/guide-ja/README.md @@ -0,0 +1,201 @@ +Yii 2.0 公式ガイド +================== + +このチュートリアルは [Yii ドキュメンテーション規約](http://www.yiiframework.com/doc/terms/) の下に +リリースされています。 + +All Rights Reserved. + +2014 (c) Yii Software LLC. + + +前書き +------ + +* [Yii について](intro-yii.md) +* [バージョン 1.1 からのアップグレード](intro-upgrade-from-v1.md) + + +始めよう +-------- + +* [Yii をインストールする](start-installation.md) +* [アプリケーションを走らせる](start-workflow.md) +* [ハローと言う](start-hello.md) +* [フォームを扱う](start-forms.md) +* [データベースを扱う](start-databases.md) +* [Gii でコードを生成する](start-gii.md) +* [この先を見る](start-looking-ahead.md) + + +アプリケーションの構造 +---------------------- + +* [概要](structure-overview.md) +* [エントリースクリプト](structure-entry-scripts.md) +* [アプリケーション](structure-applications.md) +* [アプリケーションコンポーネント](structure-application-components.md) +* [コントローラ](structure-controllers.md) +* [モデル](structure-models.md) +* [ビュー](structure-views.md) +* [モジュール](structure-modules.md) +* [フィルター](structure-filters.md) +* [ウィジェット](structure-widgets.md) +* [アセット](structure-assets.md) +* [エクステンション](structure-extensions.md) + + +リクエストの処理 +---------------- + +* [概要](runtime-overview.md) +* [ブートストラッピング](runtime-bootstrapping.md) +* [ルーティング](runtime-routing.md) +* [リクエスト](runtime-requests.md) +* [レスポンス](runtime-responses.md) +* [セッションとクッキー](runtime-sessions-cookies.md) +* [URL の解析と生成](runtime-url-handling.md) +* [エラー処理](runtime-handling-errors.md) +* [ログ](runtime-logging.md) + + +鍵となる概念 +------------ + +* [コンポーネント](concept-components.md) +* [プロパティ](concept-properties.md) +* [イベント](concept-events.md) +* [ビヘイビア](concept-behaviors.md) +* [設定](concept-configurations.md) +* [エイリアス](concept-aliases.md) +* [クラスのオートロード](concept-autoloading.md) +* [サービスロケータ](concept-service-locator.md) +* [依存性注入コンテナ](concept-di-container.md) + + +データベースの取り扱い +---------------------- + +* [データアクセスオブジェクト](db-dao.md): データベースへの接続、基本的なクエリ、トランザクション、および、スキーマ操作 +* [クエリビルダ](db-query-builder.md): シンプルな抽象レイヤを使ってデータベースに対してクエリを行う +* [アクティブレコード](db-active-record.md): アクティブレコード ORM、レコードの読み出しと操作、リレーションの定義 +* [マイグレーション](db-migrations.md): チーム開発環境においてデータベースにバージョンコントロールを適用 +* **TBD** [Sphinx](db-sphinx.md) +* **TBD** [Redis](db-redis.md) +* **TBD** [MongoDB](db-mongodb.md) +* **TBD** [ElasticSearch](db-elasticsearch.md) + + +ユーザからのデータ取得 +---------------------- + +* [フォームを作成する](input-forms.md) +* [入力を検証する](input-validation.md) +* [ファイルをアップロードする](input-file-upload.md) +* **TBD** [複数モデルのためのデータ取得](input-multiple-models.md) + + +データの表示 +------------ + +* [データの書式設定](output-formatter.md) +* **TBD** [ページネーション](output-pagination.md) +* **TBD** [並べ替え](output-sorting.md) +* [データプロバイダ](output-data-providers.md) +* [データウィジェット](output-data-widgets.md) +* [クライアントスクリプトを使う](output-client-scripts.md) +* [テーマを使う](output-theming.md) + + +セキュリティ +------------ + +* [認証](security-authentication.md) +* [権限](security-authorization.md) +* [パスワードを扱う](security-passwords.md) +* **TBD** [Auth クライアント](security-auth-clients.md) +* **TBD** [最善の慣行](security-best-practices.md) + + +キャッシュ +---------- + +* [概要](caching-overview.md) +* [データキャッシュ](caching-data.md) +* [断片キャッシュ](caching-fragment.md) +* [ページキャッシュ](caching-page.md) +* [HTTP Caching](caching-http.md) + + +RESTful ウェブサービス +---------------------- + +* [クイックスタート](rest-quick-start.md) +* [リソース](rest-resources.md) +* [コントローラ](rest-controllers.md) +* [ルーティング](rest-routing.md) +* [レスポンスの書式設定](rest-response-formatting.md) +* [認証](rest-authentication.md) +* [速度制限](rest-rate-limiting.md) +* [バージョン管理](rest-versioning.md) +* [エラー処理](rest-error-handling.md) + + +開発ツール +---------- + +* [デバッグツールバーとデバッガ](tool-debugger.md) +* [Gii を使ってコードを生成する](tool-gii.md) +* **TBD** [API ドキュメンテーションを生成する](tool-api-doc.md) + + +テスト +------ + +* [概要](test-overview.md) +* [テスト環境の構築](test-environment-setup.md) +* [ユニットテスト](test-unit.md) +* [機能テスト](test-functional.md) +* [承認テスト](test-acceptance.md) +* [フィクスチャ](test-fixtures.md) + + +スペシャルトピック +------------------ + +* [アドバンストアプリケーションテンプレート](tutorial-advanced-app.md) +* [アプリケーションを一から構築する](tutorial-start-from-scratch.md) +* [コンソールコマンド](tutorial-console.md) +* [コアのバリデータ](tutorial-core-validators.md) +* [国際化](tutorial-i18n.md) +* [メール](tutorial-mailing.md) +* [パフォーマンスチューニング](tutorial-performance-tuning.md) +* **TBD** [共有ホスト環境](tutorial-shared-hosting.md) +* [テンプレートエンジン](tutorial-template-engines.md) +* [サードパーティのコードを扱う](tutorial-yii-integration.md) + + +ウィジェット +------------ + +* GridView: link to demo page +* ListView: link to demo page +* DetailView: link to demo page +* ActiveForm: link to demo page +* Pjax: link to demo page +* Menu: link to demo page +* LinkPager: link to demo page +* LinkSorter: link to demo page +* [Bootstrap ウィジェット](widget-bootstrap.md) +* [Jquery UI ウィジェット](widget-jui.md) + + +ヘルパー +-------- + +* [概要](helper-overview.md) +* **TBD** [ArrayHelper](helper-array.md) +* **TBD** [Html](helper-html.md) +* **TBD** [Url](helper-url.md) +* **TBD** [Security](helper-security.md) + diff --git a/docs/internals-ja/git-workflow.md b/docs/internals-ja/git-workflow.md index 181ae18..8a82e90 100644 --- a/docs/internals-ja/git-workflow.md +++ b/docs/internals-ja/git-workflow.md @@ -24,7 +24,7 @@ git remote add upstream git://github.com/yiisoft/yii2.git ### 3. あなたが取り組んでいる問題が、修正するために著しい努力を要求するものである場合は、それに対する issue が作成されていることを確認する -全ての新機能とバグ修正は、議論とドキュメンテーションのための単一の参照ポイントを提供するために、それに結びつく issue を持たなければなりません。 +全ての新機能とバグ修正は、議論とドキュメンテーションのための単一の参照ポイントを提供するために、それに結びつく issue を持つべきです。 数分間時間を取って、既存の issue リストに目を通し、あなたが寄稿しようとしている問題に合致するものが無いかどうか調べてください。 もし issue リストにすでに挙っているのを見つけた場合は、その issue にコメントを残して、あなたがその項目について取り組もうとしていることを示してください。 あなたが取り組もうとしている問題に合致する既存の issue が見つからなかった場合は、新しい issue を作成してください。単純な修正であれば、直接にプルリクエストをしてください。 @@ -38,14 +38,14 @@ git remote add upstream git://github.com/yiisoft/yii2.git git fetch upstream ``` -すべての新しい寄稿について、最新のコードに対して作業することを確実にするために、この作業から開始しなければなりません。 +すべての新しい寄稿において、最新のコードに対して作業することを確実にするために、この作業から開始すべきです。 ### 5. 現在の Yii のマスターブランチに基いて、あなたの寄稿のための新しいブランチを作成する > これは非常に重要です。なぜなら、master ブランチを使うと、あなたのアカウントからは一つ以上のプルリクエストを送信することが出来なくなるからです。 -独立したバグ修正や変更は、各々、それ自身のブランチに入れなければなりません。 -ブランチの名前は内容を説明するものであり、あなたのコードが関係する issue の番号で始まるものでなければなりません。 +独立したバグ修正や変更は、各々、それ自身のブランチに入れるべきです。 +ブランチの名前は説明的なものにし、あなたのコードが関係する issue の番号で始まるようにしてください。 特定の issue を修正するものでない場合は、番号を省略してください。 例えば: @@ -64,8 +64,8 @@ git checkout -b 999-name-of-your-branch-goes-here ### 7. CHANGELOG を更新する CHANGELOG ファイルを編集して、あなたの修正を追加します。 -新しい行は、ファイル冒頭の "Work in progress" 見出しの下に挿入しなければなりません。 -チェンジログの行は、下記のどちらかのように書かなければなりません: +新しい行は、ファイル冒頭の "Work in progress" 見出しの下に挿入してください。 +チェンジログの行は、下記のどちらかのように書いてください: ``` Bug #999: バグ修正の内容説明 (あなたの名前) @@ -73,7 +73,7 @@ Enh #999: 機能拡張の内容説明 (あなたの名前) ``` `#999` は `Bug` または `Enh` が示している issue 番号です。 -チェンジログはタイプ(`Bug`, `Enh`)によってグループ化され、issue 番号順に並ばなければなりません。 +チェンジログはタイプ(`Bug`, `Enh`)によってグループ化し、issue 番号順に並べます。 非常に小さな修正、すなわち、タイポやドキュメンテーションの修正については、CHANGELOG を更新する必要はありません。 @@ -101,7 +101,7 @@ git pull upstream master ``` このステップは、プルリクエストを出す前にあなたのブランチが最新のコードを持っていることを確実にするためのものです。 -もし何かマージ衝突がある場合は、ここでそれを修正してから再度変更をコミットしなければなりません。 +もし何かマージ衝突がある場合は、ここでそれを修正してから再度変更をコミットすべきです。 こうすると、Yii 開発チームがワンクリックであなたの変更をマージすることが確実に出来るようになります。 ### 10. 衝突をすべて解消したら、あなたのコードを github にプッシュする diff --git a/docs/internals-ja/translation-workflow.md b/docs/internals-ja/translation-workflow.md index a39507c..6954c7f 100644 --- a/docs/internals-ja/translation-workflow.md +++ b/docs/internals-ja/translation-workflow.md @@ -14,7 +14,7 @@ Yii は国際的なアプリケーションと開発者にとって役に立つ� 1. `framework/messages/config.php` をチェックして、あなたの言語が `languages` のリストに挙っていることを確認してください。 もし挙っていなければ、あなたの言語をそこに追加します(リストをアルファベット順に保つことを忘れないでください)。 - 言語コードの形式は、例えば `ru` や `zh-CN` のように、[IETF言語タグ](http://ja.wikipedia.org/wiki/IETF%E8%A8%80%E8%AA%9E%E3%82%BF%E3%82%B0) に従わなくてはなりません。 + 言語コードの形式は、例えば `ru` や `zh-CN` のように、[IETF言語タグ](http://ja.wikipedia.org/wiki/IETF%E8%A8%80%E8%AA%9E%E3%82%BF%E3%82%B0) に従うべきです。 2. `framework` に入って、`yii message/extract messages/config.php` を走らせます。 3. `framework/messages/your_language/yii.php` のメッセージを翻訳します。ファイルは必ず UTF-8 エンコーディングを使って保存してください。 4. [プルリクエスト](https://github.com/yiisoft/yii2/blob/master/docs/internals/git-workflow.md)をします。