Template:MediaWikiHook/doc

Usage notes

 * name
 * The name of the hook. This is usually the same name as the sub-page.


 * 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'll link to the appropriate CodeReview page (i.e. Special:Code/MediaWiki/1).


 * gerrit
 * Gerrit change number in which this hook was first introduced. If this parameter is given, it'll link to the appropriate Gerrit changeset page (i.e. Gerrit change 1).


 * 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.


 * source
 * A list of locations in the code that call this hook.


 * sourcefunction
 * A list of functions in the code that call this hook.


 * sourceclass
 * A list of classes in the code that call this hook. The classes should correspond to the functions. E.g. sourceclass should correspond to sourcefunction; sourceclass2 should correspond to sourcefunction2.


 * templatemode
 * Set to nocats if hook documentation should not appear in standard MediaWiki Categories.
 * By default, using this temmplate places the documentation page into categories:
 * MediaWiki hooks
 * Hooks added in MediaWiki . ..
 * There are times when it is undesirable to automatically categorize the hook documentation. Examples would include when documenting a hook in an extension, or when documenting the template itself.