モジュール:Unsubst/doc

{{Citation needed}} や {{Refimprove}} などのメンテナンステンプレートは、subst展開されるべきではありません。この問題を回避する方法のひとつは、テンプレートを「展開しても再びテンプレート呼び出しの形で残す」ように作ることです。このモジュールはその処理を実装します。

インフォボックスや、パラメーターがブロック形式で記述されるその他のテンプレートでは、Module:Unsubst-infobox を使用してください。

使い方

テンプレートを自己subst展開するようにするには、既存のテンプレートコード全体を以下のように囲みます：

{{SAFESUBST:<noinclude />#invoke:Unsubst||$B=

 [ ... 既存のテンプレートコード ... ]

}}

subst展開されていない状態で表示されるウィキテキストは $B に指定します。#invoke に渡された他のすべてのパラメーターは、生成されるテンプレート呼び出しにデフォルト値として含まれます。これらのデフォルトパラメーターの値として __DATE__ を使用すると、展開されたテンプレート呼び出しにはその時点の月と年が挿入されます。

テンプレートの中には、<noinclude> タグはあるが、それに対応する閉じタグ </noinclude> が存在しないものもあります。そのような場合は、閉じタグを }} の直前に追加する必要があります。

上級オプション

{{SAFESUBST:<noinclude />#invoke:Unsubst||$params=[パラメーター一覧]|$aliases=[エイリアス一覧]|$flags=[フラグ]|$B=

 [ ... 既存のテンプレートコード ... ]

}}

Lua の制限により、subst展開時にはパラメーターの順序がランダムになることがあります。$params を指定することで、テンプレートパラメーターの順序をカンマ区切りで明示できます（例：egg,bacon,sausage,cheese,spam）。数値付きのパラメーターは他のパラメーターより前に記述してください。残りのパラメーターは末尾に追加されます。

パラメーターのエイリアスは $aliases に指定できます（$params には含めないでください）。各エイリアスとその置換先は エイリアス>置換先 の形式で記述し、それらをカンマで区切ります（例：œuf>egg,melt>cheese）。このオプションは $params なしでも使用可能です。

$flags ではモジュールの挙動を細かく制御できます。カンマ区切りで指定でき、使用可能なフラグは次のとおりです： - override: 呼び出し元の #invoke: 側のパラメーターを優先 - keep-whitespace: 無名パラメーターの前後の空白を除去しない - remove-empty: 空のパラメーターを削除

これらのパラメーターにはパーサ関数を使用することもでき、より複雑なオプション指定が可能です（パーサ関数、テンプレート、モジュール呼び出しは SAFESUBST:<noinclude /> を使ってください）。

$template-name パラメーターを使うと、展開後のテンプレート名を任意の名前に置き換えることができます。

使用例

テンプレート「Template:Example」に以下のコードが含まれているとします：

{{SAFESUBST:<noinclude />#invoke:Unsubst||foo=bar |date=__DATE__ |$B=

 [ ... テンプレート本体 ... ]

}}

次のように展開されます：

元の呼び出し	展開結果
{{subst:example}}	{{Example|date=6月 2026|foo=bar}}
{{subst:example|foo=X}}	{{Example|date=6月 2026|foo=X}}
{{subst:example|baz=X}}	{{Example|baz=X|date=6月 2026|foo=bar}}
{{subst:example|date=January 2001}}	{{Example|date=January 2001|foo=bar}}