Jump to content

Template:Maintenance script/doc

From mediawiki.org

Template used on maintenance scripts' documentation pages, to provide summary information about them and add them to Category:Maintenance scripts.

Copy and paste template

[edit]
{{Maintenance script
|name = 
|location = 
}}

Usage notes

[edit]

Card that describes information of a maintenance script in core.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

The full, properly-capitalized name of the script. This is used to sort the scripts correctly in the maintenance scripts category and other categories the setting is used on, and to change the displayed name of the page.

Example
CheckUsernames.php
Stringrequired
Locationlocation

The path to the script from the root MediaWiki directory. Defaults to /maintenance/.

Default
/maintenance/
Stringoptional