模板:ExtensionHook/zh
外观
模板文档
复制粘贴模板
For more information about attaching hooks, see Manual:Hooks.
For examples of other extensions using this hook, see Category:MyHook extensions/zh.
{{ExtensionHook
|name = MyHook
|version =
|gerrit =
|removed =
|summary =
|args = $x, $y
|extension =
|source =
|sourcefunction =
|sourceclass =
|newvarname =
|newvarlink =
|nocatdesc =
}}
用法注释
- name
- 钩子名称。 这通常与子页面名称相同。
- version
- The version of MediaWiki this hook was first introduced in.
- rev
- SVN revision in which this hook was first introduced. If this parameter is given, it will link to the appropriate CodeReview page (e.g. r115794).
- gerrit
- Gerrit change number in which this hook was first introduced. If this parameter is given, it will link to the appropriate Gerrit changeset page (e.g., Gerrit change 5)
- removed
- If the hook has been removed, the version of MediaWiki that it was removed in.
- deprecated
- If the hook has been deprecated (but not removed), the version of MediaWiki that it was deprecated in.
- summary
- A short description of the hook's purpose.
- More detailed descriptions are desirable, and should be added to the main page content.
- If you update the short description, please also update the two tables on Manual:Hooks.
- args
- The arguments, as used at the top of the function.
- extension
- Extension name where hook is called; for when the source is not in the MediaWiki core code repository.
- source
- Location (file name) which calls this hook in the code. Further locations can be added via source2...source10.
- sourcefunction
- Name of the function which calls this hook. Another can be added via sourcefunction2.
- sourceclass
- Name of the class which calls this hook.
- newvarname
- 当设置好removed或者deprecated时,请使用{{Removed}}或者{{Deprecated}}
- newvarlink
- 当设置好removed或者deprecated时,请使用{{Removed}}或者{{Deprecated}}
- templatemode
- Set to nocats if hook documentation should not appear in standard MediaWiki Categories.
- By default, using this template places the documentation page into categories:
- MediaWiki钩子
- MediaWiki中添加的钩子...
- There are times when it is undesirable to automatically categorise the hook documentation. Examples would include when documenting a hook in an extension, or when documenting the template itself.
- nocatdesc
- If a hook is removed completely from MediaWiki version by setting
yes, it will not show up the category description.