モジュール:Template invocation/doc

これはモジュール:Template invocationの解説サブページです。
使用方法、カテゴリ、およびその他モジュールページ自体に含まれない情報を収容しています。

参照読み込みのウィキテキストを生成するメタモジュールです。

使い方

まず、モジュールを読み込みます。

local mTemplateInvocation = require('Module:Template invocation')

これにより、下記の関数が利用できるようになります。

mTemplateInvocation.name(title)

参照読み込みで使用するページ名を取得する関数です。テンプレート名前空間の場合は名前空間名を除去して、標準名前空間の場合は冒頭にコロン（:）をつけて、それ以外の場合はページ名をそのままで返します。titleには文字列かmw.titleのオブジェクトを渡せます。

mTemplateInvocation.invocation(name, args, format)

この関数は参照読み込みのウィキテキストを生成します。

引数：

name - 参照読み込みで使用するページ名。たとえば、Template:Reflistの場合は「Reflist」を、ジョン・ウィルクスの場合は「:ジョン・ウィルクス」を入力します。name関数の返り値をそのまま入力できます。
args - 参照読み込みの引数をテーブルで渡します。テーブルに含まれる引数名と引数値には文字列と数字を受け付けます。
format - 出力形式。未指定の場合はウィキテキストをそのまま返し、「nowiki」を指定した場合はパイプなどの符号が文字参照に置換されます。