Template:Nosubst/doc

これはメタテンプレートです。記事中から直接呼び出すためのテンプレートではありません。

テンプレート中で、subst展開の結果にテンプレート呼び出しのウィキマークアップを含めるために使います。subst展開を想定していないテンプレートでは使う意味がありません。

使い方

典型的な使いかたは次のようなものです。

{{ {{{|safesubst:}}}#if:条件
  | 条件が成立したときに展開結果に含めるウィキテキスト
  | {{ {{{|subst:}}}nosubst|テンプレート名|引数1|引数2|... }}
}}

このマークアップでは、条件が成立しないとき、当テンプレートが呼び出されます。その結果はつぎのものになります。

  {{テンプレート名|引数1|引数2|... }}

つまり、展開結果は「テンプレート名」という名のテンプレートの呼び出しになりますが、このテンプレート呼び出しそのものは展開されません。これを利用して、subst展開しても展開されないテンプレートや、ほかのテンプレート呼び出しに置き換えられるテンプレートを作ることができます。

subst展開しても展開されないテンプレートを作るのは、{{ifsubst}}と組み合わせると簡単です。

{{ {{{|safesubst:}}}ifsubst
  | {{ {{{|subst:}}}nosubst|テンプレート名|{{{1|}}}|{{{2|}}}|... }}
  | ここにテンプレートの実際の内容を書く
}}

「テンプレートの引数」は8つまで指定できます。

制限事項

• 引数に指定したものはそれぞれ展開されてしまいます。
• 名前つき引数には、現在のところ対応していません。

関連テンプレート

Subst展開支援テンプレート一覧

• {{subst!}}、{{require subst}} - subst展開しないとエラーを表示。
  • {{subst only}} これらを使ったテンプレートの説明文において使用。常にsubst展開することを注意喚起する。
  • {{never subst}} 上記{{subst only}}の逆で、subst展開してはならないことを注意喚起する。
• {{issubst}} - subst展開をすると"yes"を返す。
• {{ifsubst}} - subst展開の有無を判定。
• {{nosubst}} - subst展開されるテンプレートの中で、subst展開されないテンプレートの呼び出しを作る。

関連項目

• {{tl}}、{{tlx}} - テンプレートのマークアップのしかたを文中で説明したいときは、こちらをつかってください。
• H:SUBST - subst展開のヘルプ
• en:Help:Substitution - 同英語版