プラグインのコメントアウトによる管理画面への自動代入
プラグインを管理画面から登録する際、先頭のコメントアウトに書式に従って記述することで、登録する際に必要な情報を自動的に代入してくれます。
例えば次のコメントアウトを管理画面のプラグインコードに入力したとします。
/**
* プラグインABC
*
* これはリソース保存時に～を自動的に処理するプラグインです。
*
* @category plugins
* @version 1.0.0
* @license GNU General Public License (GPL), https://www.gnu.org/licenses/gpl-3.0.html
* @author ShanaBrian
* @internal @properties &ids=処理する対象のリソースID;text;123
* @internal @modx_category Custom
* @internal @events OnBeforeDocFormSave,OnDocFormSave
*/こうすると、管理画面では次のように自動的に挿入されます。
「メイン」タブ
メインタブにある"プラグイン名"項目は、"プラグインABC"を代入します。
「設定」タブ
設定タブにある"プラグイン設定"項目は、@internal @propertiesプロパティの値、&ids=処理する対象のリソースID;text;123を代入します。
プロパティの値は&ID名=ラベル;形式;初期値;という書式で記述します。
複数指定する場合は&ID名=ラベル;形式;初期値; &ID名=ラベル;形式;初期値;という感じで、そのまま続けて記述します。
形式は次の値が指定可能です（ただし対応していない形式もあります）。
| 設定値 | 説明 | 書式 |
|---|---|---|
| text | 単一行入力の項目です。 | &ID=ラベル;形式;初期値; |
| string | 文字列の項目です。 | &ID=ラベル;形式;初期値; |
| textarea | 複数行入力の項目です。 | &ID=ラベル;形式;初期値; |
| list | リストの項目です。 | &ID=ラベル;形式;選択肢（カンマ区切り）;初期値; |
| textareamini | ※ 不明 | ※ 不明 |
| url | URLの入力項目です。 | ※ 不明 |
| image | 画像を選択する項目です。 | ※ 不明 |
| file | ファイルを選択する項目です。 | ※ 不明 |
| dropdown | ドロップダウンリストの項目です。 | ※ 不明 |
| checkbox | チェックボックスの項目です。 | ※ 不明 |
「システムイベント」タブ
システムイベントタブにある項目は、"@internal @events"プロパティの値、"OnBeforeDocFormSave"と"OnDocFormSave"に一致する項目にチェックが付きます。
@internal @eventsプロパティはカンマ区切りで指定することで、複数のイベントを指定することができます。
「プロパティ」タブ
プロパティタブにある"カテゴリー"項目は、"@internal @modx_category"プロパティに一致する項目が選択されます。
IDではなく名称そのままの名前で指定します。
プロパティタブにある"説明"項目は、"@version"プロパティと説明文の"これはリソース保存時に～を自動的に処理するプラグインです。"を結合した値が代入されます。
バージョンはstrongタグに半角スペースを付けた値で代入されます。