Commit 942d5f8e by Carsten Brandt

Merge pull request #6241 from softark/docs-internals-ja-2014-11-25

docs/internals-ja/view-code-style.md -added [ci skip]
parents f4b566ea ffdb5854
課題を報告する 課題を報告する
============== ==============
あなたが報告する課題(issue)がより迅速に解決されるように、課題を作成するときには下記のガイドラインに従って下さい: あなたが報告する課題 (issue) がより迅速に解決されるように、課題を作成するときには下記のガイドラインに従って下さい。
* PHP と Yii のバージョン、オペレーティングシステムとウェブサーバのタイプ、および、ブラウザのタイプとバージョンについて、情報を提供してください; * PHP と Yii のバージョン、オペレーティングシステムとウェブサーバのタイプ、および、ブラウザのタイプとバージョンについて、情報を提供してください
* 出来れば、**完全な**エラーのコールスタックを提供して下さい。問題を説明するスクリーンショットは大いに歓迎されます。 * 出来れば、**完全な**エラーのコールスタックを提供して下さい。問題を説明するスクリーンショットは大いに歓迎されます。
* 問題を再現する手順を記述して下さい。問題を再現するコードを提供してくださるならば、なお一層良いでしょう。 * 問題を再現する手順を記述して下さい。問題を再現するコードを提供してくださるならば、なお一層良いでしょう。
......
...@@ -2,40 +2,40 @@ ...@@ -2,40 +2,40 @@
================ ================
Yii は国際的なアプリケーションと開発者にとって役に立つように、数多くの言語に翻訳されています。 Yii は国際的なアプリケーションと開発者にとって役に立つように、数多くの言語に翻訳されています。
貢献が大いに歓迎される主な領域はドキュメンテーションとフレームワークメッセージです。 貢献が大いに歓迎される主な領域はドキュメンとフレームワークメッセージです。
フレームワークメッセージ フレームワークメッセージ
------------------------ ------------------------
フレームワークは二種類のメッセージを持っています: 一つは開発者向けの例外メッセージで、これは決して翻訳されません。 フレームワークは二種類のメッセージを持っています一つは開発者向けの例外メッセージで、これは決して翻訳されません。
もう一つはエンドユーザーが実際に目にする検証エラーのようなメッセージです。 もう一つはエンドユーザーが実際に目にする検証エラーのようなメッセージです。
メッセージの翻訳を開始するためには: メッセージの翻訳を開始するためには:
1. `framework/messages/config.php` をチェックして、あなたの言語が `languages` のリストに挙っていることを確認してください。 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` を走らせます。 2. `framework` に入って、`yii message/extract messages/config.php` を走らせます。
3. `framework/messages/your_language/yii.php` のメッセージを翻訳します。ファイルは必ず UTF-8 エンコーディングを使って保存してください。 3. `framework/messages/your_language/yii.php` のメッセージを翻訳します。ファイルは必ず UTF-8 エンコーディングを使って保存してください。
4. [プルリクエスト](https://github.com/yiisoft/yii2/blob/master/docs/internals/git-workflow.md)をします。 4. [プルリクエスト](https://github.com/yiisoft/yii2/blob/master/docs/internals/git-workflow.md) をします。
あなたの翻訳を最新状態に保つために、`yii message/extract messages/config.php` を再び走らせることが出来ます。 あなたの翻訳を最新状態に保つために、`yii message/extract messages/config.php` を再び走らせることが出来ます。
れによって、変更のなかった箇所には触れることなく、自動的にメッセージを再抽出することが出来ます。 のコマンドは、変更のなかった箇所には触れることなく、自動的にメッセージを再抽出してくれます。
翻訳ファイルの中で、配列の各要素は、メッセージ(キー)と翻訳(値)をあらわします。 翻訳ファイルの中で、配列の各要素は、メッセージ(キー)と翻訳(値)をあらわします。
値が空の場合は、メッセージは翻訳されないものと見なされます。 値が空文字列の場合は、メッセージは翻訳されないものと見なされます。
翻訳が不要になったメッセージは、翻訳が一組の '@@' マークで囲まれます。 翻訳が不要になったメッセージは、翻訳が一組の '@@' マークで囲まれます。
メッセージ文字列は複数形書式とともに使うことが出来ます。 メッセージ文字列は複数形書式とともに使うことが出来ます。
詳細はガイドの [国際化](../guide-ja/tutorial-i18n.md) の節を参照してください。 詳細はガイドの [国際化](../guide-ja/tutorial-i18n.md) の節を参照してください。
ドキュメンテーション ドキュメン
-------------------- ------------
ドキュメンテーションの翻訳は `docs/<original>-<language>` の下に置きます。 ドキュメンの翻訳は `docs/<original>-<language>` の下に置きます。
ここで `<original>` は、`guide``internals` などの元の文書の名前であり、`<language>` は文書の翻訳先の言語コードです。 ここで `<original>` は、`guide``internals` などの元の文書の名前であり、`<language>` は文書の翻訳先の言語コードです。
例えば、ロシア語のガイドの翻訳は `docs/guide-ru` です。 例えば、ロシア語のガイドの翻訳は `docs/guide-ru` です。
初期の仕事が完了した後は、最新の翻訳以後に変更された元の文書の箇所を取得するために、`build` ディレクトリにある専用のコマンドを使うことが出来ます: 初期の仕事が完了した後は、最新の翻訳以後に変更されたソース文書の箇所を取得するために、`build` ディレクトリにある専用のコマンドを使うことが出来ます。
``` ```
php build translation "../docs/guide" "../docs/guide-ru" "Russian guide translation report" > report_guide_ru.html php build translation "../docs/guide" "../docs/guide-ru" "Russian guide translation report" > report_guide_ru.html
......
...@@ -12,7 +12,7 @@ Yii バージョン規約 ...@@ -12,7 +12,7 @@ Yii バージョン規約
* 不安無しのアップグレードを保証するために、100% 後方互換でなければならない。唯一の例外はセキュリティ問題で、その場合は後方互換性が破られることもある。 * 不安無しのアップグレードを保証するために、100% 後方互換でなければならない。唯一の例外はセキュリティ問題で、その場合は後方互換性が破られることもある。
* リリースのサイクルは1~2ヶ月程度。 * リリースのサイクルは1~2ヶ月程度。
* プレリリース (alpha, beta, RC) は不要。 * プレリリース (alpha, beta, RC) は不要。
* 常にマスターブランチにマージバックされるべき (少なくとも週に一回は手作業で) * 定期的に (少なくとも週に一回は手作業で) マスターブランチにマージバックされるべき
## マイナーリリース `2.X.0` ## マイナーリリース `2.X.0`
...@@ -23,7 +23,7 @@ Yii バージョン規約 ...@@ -23,7 +23,7 @@ Yii バージョン規約
* `UPGRADE-2.X.md` ファイルに記録される非後方互換な変更を含みうる。 * `UPGRADE-2.X.md` ファイルに記録される非後方互換な変更を含みうる。
* リリースのサイクルは6~8ヶ月程度。 * リリースのサイクルは6~8ヶ月程度。
* プレリリースが必要: `2.X.0-alpha`, `2.X.0-beta`, `2.X.0-rc` * プレリリースが必要: `2.X.0-alpha`, `2.X.0-beta`, `2.X.0-rc`
* 大きなニュースのリリースとマーケティングの試みを要求する。 * 大きなニュースリリースとマーケティング努力を必要とする。
## メジャーリリース `X.0.0` ## メジャーリリース `X.0.0`
......
Yii2 ビューのコードスタイル
===========================
下記のコードスタイルが Yii 2.x コアと公式エクステンションのビューファイルに用いられています。
私たちは、あなたが自分のアプリケーションにこのコードスタイルを使うことを強制するものではありません。
あなたにとってより良いコードスタイルを自由に選んでください。
```php
<?php
// 冒頭の PHP タグは全てのテンプレートファイルで不可欠。冒頭のタグに続く空行も同じく必須。
// コントローラから渡される入力変数をここで説明。
/* @var $this yii\base\View */
/* @var $form yii\widgets\ActiveForm */
/* @var $posts app\models\Post[] */
/* @var $contactMessage app\models\ContactMessage */
// 下の空行は必要。
// 名前空間に属するクラスの宣言。
use yii\helpers\Html;
use yii\widgets\ActiveForm;
// 下の空行は必要。
// コンテキストのプロパティを設定したり、コンテキストのセッターを呼んだり、その他のことをする。
$this->title = 'Posts';
?>
<!-- foreach、for などには、独立した PHP ブロックを使う方が良い -->
<?php foreach ($posts as $post): ?>
<!-- インデントのレベルに注目 -->
<h2><?= Html::encode($post['title']) ?></h2>
<p><?= Html::encode($post['shortDescription']) ?></p>
<!-- 複数の PHP ブロックが使われる場合にそなえて、`}` ではなく、`endforeach;`、`endfor;`、`endif;` などを使う -->
<?php endforeach; ?>
<!-- ウィジェットの宣言は複数のコード行に分かれても良いし、分かれなくても良い -->
<?php $form = ActiveForm::begin([
'options' => ['id' => 'contact-message-form'],
'fieldConfig' => ['inputOptions' => ['class' => 'common-input']],
]); ?>
<!-- インデントのレベルに注目 -->
<?= $form->field($contactMessage, 'name')->textInput() ?>
<?= $form->field($contactMessage, 'email')->textInput() ?>
<?= $form->field($contactMessage, 'subject')->textInput() ?>
<?= $form->field($contactMessage, 'body')->textArea(['rows' => 6]) ?>
<div class="form-actions">
<?= Html::submitButton('Submit', ['class' => 'common-button']) ?>
</div>
<!-- ウィジェットの終了の呼び出しは、独立した PHP タグを持つべき -->
<?php ActiveForm::end(); ?>
<!-- 末尾の改行文字は必須 -->
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment