すべてのテンプレート・タグのリファレンスの参照 (MTMLReferenceプラグイン)

PowerCMS X はモデルの構成やモデルのカラム、リレーションといった各種設定によってダイナミック・タグが動的にシステムに登録され利用できるようになります。ですのでテンプレート・タグ( MTML )のリファレンスはそれぞれの環境によって異なるため、管理画面内ですべてのテンプレート・タグを参照できるようにするものが MTMLReferenceプラグインです。

以下のページにインストール直後の初期状態のリファレンスを掲載しています。

利用方法

プラグイン設定画面で「MTMLReference」プラグインを有効化します。ツールメニューに「タグリファレンス」が追加されますので、そこからタグリファレンスの画面に遷移します。タグ名での絞り込み検索が可能です。

MTMLReferenceの画面(スクリーンショット)

プラグインでタグを作成する際のリファレンスへの追加方法

プラグインで作成したタグについては、ドキュメントがない場合は「(プラグイン名)プラグインが提供するブロックタグです。」と表示されます。ドキュメントを追加するには JSONファイルを以下のパスに設置してください。

  • plugin/PluginName/docs/tag_reference.json

日本語へのローカライズはそのプラグインの localeファイルに翻訳フレーズを登録してください。

  • plugin/PluginName/locale/ja.json

以下の例は「CookieUtilities」プラグインの tag_reference.json です。

{
    "ifcookie" : {
        "description" : "Evaluate a block when the specified cookie is set.",
        "attributes" : {
            "name" : "The name of the cookie.",
            "key" : "Set the value of get cookie to variable(default value is 'cookie_val').",
            "(note)" : "Tag attributes for comparison of mt:if tag can be used."
        }
    },
    "getcookie" : {
        "description" : "Get the cookie's value.",
        "attributes" : {
            "name" : "The name of the cookie."
        }
    },
    "getenv" : {
        "description" : "Get the server environment(Superglobals).",
        "attributes" : {
            "name" : "The name of the environment.",
            "kind" : "'SERVER', 'COOKIE', 'ENV', 'REQUEST', 'POST', 'GET' or 'SESSION'."
        }
    },
    "setcookie" : {
        "description" : "Set the cookie value. When using https access, the secure flag is automatically assigned.",
        "attributes" : {
            "name" : "The name of the cookie.",
            "value" : "The value of the cookie.",
            "path" : "The path on the server in which the cookie will be available on(default value is '/').",
            "expires" : "The time the cookie expires(default value is '86400' *the value of environment variable 'sess_timeout').",
            "httponly" : "When specified the cookie will be made accessible only through the HTTP protocol(The cookie won't be accessible by JavaScript).",
            "reload" : "Reload the page after setting the cookie."
        }
    },
    "clearcookie" : {
        "description" : "Clear the cookie.",
        "attributes" : {
            "name" : "The name of the cookie.",
            "reload" : "Reload the page after clear the cookie."
        }
    },
    "clearallcookies" : {
        "description" : "Clear the all cookies.",
        "attributes" : {
            "reload" : "Reload the page after clear the cookies."
        }
    }
}