listrefプラグイン

Last-modified: Wed, 21 Aug 2019 10:08:20 JST (30d)
Top > listrefプラグイン

概要

キーワードをリストとして記述した設定文書を参照し、キーワードに対応する内容を出力します。

書式

&listref(設定文書名,キーワード);
  • 設定文書名:
    参照する設定文書のページ名を指定します。設定文書は以下の階層で作成します。
    :config/plugin/listref/設定文書名
    ※設定文書は、https:// WikiのURL/index.php?cmd=config_listから作成することも可能です。
  • キーワード:
    設定文書にリストとして記述したキーワードを指定します。
    datarefプラグインをキーワードに用いることも可能です。

設定文書

以下のような形式でキーワードと出力内容をペアで記述します。

-キーワードA
出力内容A
-キーワードB
&ref(example.jpg);
-複数行
1行目
2行目
3行目
-default
準備中
  • 出力内容は複数行設定できます。
  • 出力内容にインラインプラグインは使用できますが、ブロックプラグイン使用できません
  • default項目は、listrefで指定されたキーワードが設定文書内で設定されていない場合にdefaultの内容が出力されます。
    上記設定文書の例では「準備中」出力されることとなります。
  • defalutの出力内容に「pass-through」を指定すると、設定文書に該当キーワードが存在しない場合にlistrefのパラメータとして用いられた値がそのまま出力されます。
  • defaultの設定が無い状態で定義されていないキーワードが指定されるとエラーとなります。
  • listrefの多重呼び出しはできません。

使用例

使用例1

  • 設定文書例
    :config/plugin/listref/サンプル設定1
    -キーワードA
    表示内容A
    -キーワードB
    &ref(:config/plugin/listref/サンプル設定1/example.jpg);
    -複数行
    1行目
    2行目
    3行目
    -default
    準備中
  • 呼び出し例
    &listref(サンプル設定1,キーワードA);
    &listref(サンプル設定1,キーワードB);
    &listref(サンプル設定1,複数行);
    &listref(サンプル設定1,キーワードX);//サンプル設定1で定義されていないため、defaultの「準備中」が出力されます。
  • 実行結果
    表示内容A
    example.jpg
    1行目
    2行目
    3行目
    準備中

使用例2(pass-throughの例)

  • 呼び出し例
    &listref(サンプル設定2,キーワードA);
    &listref(サンプル設定2,キーワードX);//サンプル設定2で定義されておらず、defaultがpass-throughのため「キーワードX」の文字が出力されます。
  • 実行結果
    表示内容A
    キーワードX