Skip to content

Commit ee9bdd2

Browse files
authored
Merge pull request EC-CUBE#147 from kiy0taka/dev/plugin-generator
プラグインジェネレータの軽微なドキュメント修正
2 parents 11c89ab + 03e0e6b commit ee9bdd2

File tree

1 file changed

+19
-20
lines changed

1 file changed

+19
-20
lines changed

pages/plugin/tutorial-generate3013.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ EC-CUBE3.0.13よりプラグインの雛形を生成するプラグインジェ
1414
## プラグインの雛形を作成する
1515

1616
### プラグインジェネレータコマンドについて
17-
プラグイン開発する際に手助けをするために[プラグイン開発用コンソールコマンド](plugin_console)というものが用意されています。 プラグインジェネレータは
17+
プラグイン開発の手助けをするために[プラグイン開発用コンソールコマンド](plugin_console)というものが用意されています。 プラグインジェネレータは
1818

1919
```
2020
php app/console plugin:develop
2121
```
2222

2323
に対して新たにパラメータを用意しています。
24-
パラメータの種類 は`--help`で確認できます。
24+
パラメータの種類は`--help`で確認できます。
2525

2626
```
2727
php app/console plugin:develop --help
@@ -43,7 +43,7 @@ php app/console plugin:develop generate
4343
`generate`コマンドを実行すると問い合わせ形式で、プラグイン作成時に必要となる情報が設定できます。
4444

4545
問い合わせ内容を以下に説明します。途中で終わらせたい場合、quitを入力してください。
46-
必須以外の箇所については何も入力せずにenterを押すとスキップします
46+
必須以外の箇所については何も入力せずにEnterを押すとスキップします
4747

4848
### プラグイン名の入力
4949
作成するプラグイン名を入力します。
@@ -55,40 +55,39 @@ php app/console plugin:develop generate
5555
------------------------------------------------------
5656
5757
[+]Please enter Plugin Name
58-
Input[1] :
58+
Input[1] :
5959
```
6060

6161
### プラグインコードの入力
6262
作成するプラグインコードを入力します。英数字のみ入力可能で1文字目は必ず半角英字の大文字で入力してください。
6363

6464
```
65-
[+]Please enter Plugin Name (only pascal case letters numbers are allowed)
66-
Input[2] :
65+
[+]Please enter Plugin Code (First letter is uppercase alphabet only. alphabet and numbers are allowed.)
66+
Input[2] :
6767
```
68-
→「Please enter Plugin Name」となっていますが正しくは「Please enter Plugin Code」の誤りです。
6968

7069
### プラグインバージョン
7170
プラグインのバージョンを入力します。
7271

7372
```
7473
[+]Please enter version (correct format is x.y.z)
75-
Input[3] :
74+
Input[3] :
7675
```
7776

7877
### 作成者
7978
ファイルヘッダに設定する作成者情報を入力します。
8079

8180
```
8281
[+]Please enter author name or company
83-
Input[4] :
82+
Input[4] :
8483
```
8584

8685
### EC-CUBE3のサポート有無
8786
EC-CUBE3.0.8以下と3.0.9以上でプラグイン機構に改修が入りました。3.0.8以下も対応するプラグインを作成する場合、`y`を入力し、古いEC-CUBE3はサポートしないのであれば `n` を入力してください。
8887

8988
```
9089
[+]Do you want to support old versions too? [y/n]
91-
Input[5] :
90+
Input[5] :
9291
```
9392

9493
### 共通イベント設定
@@ -98,7 +97,7 @@ EC-CUBE3で用意している共通イベント名を指定します。イベン
9897

9998
```
10099
[+]Please enter site events(you can find documentation here http://www.ec-cube.net/plugin/)
101-
Input[6] :
100+
Input[6] :
102101
```
103102

104103
`app`のみを入力し、enterを押します。
@@ -115,7 +114,7 @@ Input[6] : app
115114
- eccube.event.app.terminate
116115
117116
[+]Please enter site events(you can find documentation here http://www.ec-cube.net/plugin/)
118-
Input[6] :
117+
Input[6] :
119118
```
120119

121120
イベント名にappが含まれているイベントが一覧表示されます。
@@ -131,16 +130,16 @@ Input[6] : eccube.event.app.request
131130
132131
--- Press Enter to move to the next step ---
133132
[+]Please enter site events(you can find documentation here http://www.ec-cube.net/plugin/)
134-
Input[6] :
133+
Input[6] :
135134
```
136135

137136

138137
### フロント、管理イベント設定
139138
フロント、管理画面で利用しているイベントを設定します。使い方は共通イベントと同様です。
140139

141140
```
142-
[+]Please enter hook point, sample:front.cart.up.initialize
143-
Input[7] :
141+
[+]Please enter hookpoint, sample:front.cart.up.initialize
142+
Input[7] :
144143
```
145144

146145

@@ -153,13 +152,13 @@ Input[7] :
153152
[+]Plugin Name: サンプルプラグイン
154153
[+]Plugin Code: Sample
155154
[+]Version: 1.0.0
156-
[+]Author: lockon
155+
[+]Author: Lockon co,.ltd.
157156
[+]Old version support: No
158-
[+]Site events:
157+
[+]Site events:
159158
eccube.event.app.request
160-
[+]Hook points:
159+
[+]Hook points:
161160
162-
[confirm] Do you want to proceed? [y/n] :
161+
[confirm] Do you want to proceed? [y/n] :
163162
```
164163

165164

@@ -201,5 +200,5 @@ Plugin was created successfully
201200

202201

203202
EC-CUBE3.0.13未満をご利用の方にはプラグインジェネレータというプラグインの雛形を作成するプラグインもあります。
204-
そちらの説明は[こちら](plugin_tutorial-plugin-generate)を参照してください。
203+
詳細は[こちら](plugin_tutorial-plugin-generate)を参照してください。
205204

0 commit comments

Comments
 (0)