Template:MediaWikiHook/doc

{	"params": { "templatemode": { "description": "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 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.", "label": "Template mode" },		"name": { "description": "The name of the hook. This is usually the same name as the sub-page.", "label": "Name" },		"version": { "description": "The version of MediaWiki this hook was first introduced in.", "suggested": true, "label": "Version" },		"removed": { "description": "If the hook has been removed, the version of MediaWiki that it was removed in.", "type": "string", "label": "Version removed" },		"newvarname": { "label": "New variable name", "description": "For removed or deprecated hooks, the name of the hook that should be used instead" },		"newvarlink": { "label": "New variable link", "description": "For removed or deprecated hooks, the link to the hook that should be used instead" },		"deprecated": { "description": "If the hook has been deprecated (but not removed), the version of MediaWiki that it was deprecated in.", "label": "Version deprecated" },		"rev": { "label": "SVN revision introduced", "description": "SVN revision in which this hook was first introduced. If this parameter is given, it'll link to the appropriate CodeReview page (e.g. rSVN1)." },		"gerrit": { "description": "Gerrit change number in which this hook was first introduced. If this parameter is given, it'll link to the appropriate Gerrit changeset page (e.g. Gerrit change 1)", "suggested": true, "label": "Gerrit changeset" },		"summary": { "description": "A short description of the hook's purpose. More detailed descriptions are desirable, and should be added to the main page content.", "required": true, "label": "Summary" },		"args": { "description": "The arguments, as used at the top of the function.", "required": true, "label": "Arguments" },		"extension": { "label": "Extension" },		"source": { "description": "Location (file name/path not including ) which calls this hook in the code. Further locations can be added via source2...source10.", "suggested": true, "label": "File source" },		"source2": { "label": "File source 2" },		"source3": { "label": "File source 3" },		"source4": { "label": "File source 4" },		"source5": { "label": "File source 5" },		"source6": { "label": "File source 6" },		"source7": { "label": "File source 7" },		"source8": { "label": "File source 8" },		"source9": { "label": "File source 9" },		"source10": { "label": "File source 10" },		"sourcefunction": { "description": "Name of the function which calls this hook. Another can be added via sourcefunction2.", "suggested": true, "label": "Function source" },		"sourceclass": { "description": "Name of the class which calls this hook.", "suggested": true, "label": "Class source" },		"sourcefunction2": { "label": "Function source 2" },		"removed-msg": { "label": "Message for removed hook", "description": "If it is not suitable to use either the \"newvarname\" or the \"newvarlink\" template parameter, use this parameter. This parameter can be used to explain why it was removed, or for example, explain why there is no suitable replacement.", "type": "string" },		"deprecated-msg": { "label": "Message for deprecated hook", "description": "If it is not suitable to use either the \"newvarname\" or the \"newvarlink\" template parameter, use this parameter. This parameter can be used to explain why it was removed, or for example, explain why there is no suitable replacement.", "type": "string" }	},	"format": "block", "description": "A card which describes the information of a MediaWiki-registered hook.", "paramOrder": [ "templatemode", "name", "version", "removed", "removed-msg", "deprecated", "deprecated-msg", "newvarname", "newvarlink", "rev", "gerrit", "summary", "args", "extension", "source", "source2", "source3", "source4", "source5", "source6", "source7", "source8", "source9", "source10", "sourcefunction", "sourcefunction2", "sourceclass" ] }