模板:ExtensionHook/ja
外观
模板文档
コピー&ペースト用テンプレート
For more information about attaching hooks, see Manual:Hooks.
For examples of other extensions using this hook, see Category:MyHook extensions/ja.
{{ExtensionHook
|name = MyHook
|version =
|gerrit =
|removed =
|summary =
|args = $x, $y
|extension =
|source =
|sourcefunction =
|sourceclass =
|newvarname =
|newvarlink =
|nocatdesc =
}}
使用法の注記
- name
- フックの名前。 これは通常、下位ページと同じ名前です。
- version
- このフックが最初に導入された MediaWiki バージョン。
- rev
- このフックが最初に導入された SVN リビジョン。 このパラメーターが指定されている場合、適切な CodeReview ページ (例: r115794) にリンクされます。
- gerrit
- このフックが最初に導入された Gerrit change 番号。 このパラメーターを指定すると、適切な Gerrit 変更セット ページにリンクされます (例: Gerrit 変更 5)
- removed
- フックが除去された場合は、それが除去された際の MediaWiki のバージョン。
- deprecated
- フックが廃止予定になった (ただし除去はされていない) 場合、廃止予定になった際の MediaWiki バージョン。
- summary
- フックの使用目的の短い説明。
- より詳細な説明が望ましいため、メイン ページの本文に追加する必要があります。
- 短い説明を更新する場合は、Manual:Hooks の 2 つの表も更新してください。
- args
- 関数の上部で使用される引数。
- extension
- Extension name where hook is called; for when the source is not in the MediaWiki core code repository.
- source
- コード内でこのフックを呼び出す場所 (ファイル名)。さらに場所を source2...source10 で追加できます。
- sourcefunction
- このフックを呼び出す関数の名前。sourcefunction2 でもう 1 つ追加できます。
- sourceclass
- このフックを呼び出すクラスの名前。
- newvarname
- removed または deprecated が設定されている場合、{{Removed}} または {{Deprecated}} によって使用されます。
- newvarlink
- removed または deprecated が設定されている場合、{{Removed}} または {{Deprecated}} によって使用されます。
- templatemode
- フックの説明文書を標準の MediaWiki カテゴリに表示しない場合は、nocats に設定します。
- 既定では、このテンプレートを使用すると、説明文書ページがカテゴリに追加されます:
- MediaWiki フック
- MediaWiki に追加されたフック...
- フックの説明文書を自動的にカテゴリ化 (カテゴリに追加) することが望ましくない場合があります。 その例には、拡張機能のフックを文書化する場合、テンプレート自体を文書化する場合が含まれます。
- nocatdesc
yesを設定すると、フックが完全にMediaWikiバージョンから除去された場合に、そのカテゴリの説明に表示されません。
Template data