テンプレート:Module link/doc
 | これはテンプレート:Module linkの解説サブページです。 使用方法、カテゴリ、およびその他テンプレートページ自体に含まれない情報を収容しています。 |
 | Luaモジュールを使用しています: |
{{ml}} は、{{#invoke}} パーサー関数 を使って、モジュール名を中括弧付きリンクとして、実際に呼び出すのではなくコードとして表示するためのテンプレートです。主な用途は解説やドキュメント中で、モジュール名を実行せずに参照したい場合です。また、関数名やパラメーターを示す用途にも対応しています。
使用例
[編集]| コード | 結果 | 備考 |
|---|---|---|
{{ml|Example}}
|
{{#invoke:Example|function}} | 関数名なしの使用。実行可能な呼び出しにはなりません。 |
{{ml|Example|hello}}
|
{{#invoke:Example|hello}} | 関数名を指定した使用法。 |
{{ml|Example|count_fruit|4=bananas=10|5=kiwis=5}}
|
{{#invoke:Example|count_fruit|bananas=10|kiwis=5}} | 関数名と複数パラメーターを指定した使用法。 |
{{ml|Example|count_fruit|Fred|bananas{{=}}10|apples{{=}}5}}
|
{{#invoke:Example|count_fruit|Fred|bananas=10|apples=5}} | 関数名とパラメーターを指定し、{{=}} を使って等号を挿入する例。 |
{{ml|Example}}
|
{{#invoke:Example}} | 関数名を省略した例。 |
TemplateData
[編集]このテンプレートは、{{#invoke}} パーサー関数でモジュール名がどのようにコードとして使われるかを示すために、中括弧付きリンクとしてモジュール名を表示します。主に解説やドキュメント用です。
| パラメーター | 説明 | 型 | 状態 | |
|---|---|---|---|---|
| module name | 1 | 名前空間 “Module:” を除いたモジュール名。名前空間は自動的に追加されます | 文字列 | 必須 |
| function name | 2 | モジュール内で呼び出す関数名 | 文字列 | 必須 |
| parameter 1 | 3 | 最初のパラメーターの名前（および値）。等号を入れる場合は {{=}} を使用します | 文字列 | 省略可能 |
| parameter 2 | 4 | 2番目のパラメーターの名前（および値）。等号を入れる場合は {{=}} を使用します | 文字列 | 省略可能 |
| parameter 3 | 5 | 3番目のパラメーターの名前（および値）。等号を入れる場合は {{=}} を使用します | 文字列 | 省略可能 |
関連項目
[編集]- {{tl}} - テンプレート向けの同種テンプレート。
テンプレート:Template-linking templates