Template:SettingSummary/doc

Usage notes

 * name
 * The name of the setting without the initial $wg prefix. This is only used to sort the settings correctly in the category index and other categories the setting is used on. The name displayed at the top of the infobox is the same as the page name, minus the namespace.  E.g. for the page at Manual:$wgServerName the name will be $wgServerName.


 * nowgprefix
 * Declare this blank variable (using ) to indicate that a setting does not use the prefix $wg, and to use just $ on its own instead. Currently this only applies to the $IP setting, and is unused in the template.  It will become useful if the pages are moved so that the PAGENAME is not the name of the setting (e.g. moved to a sub-page).


 * summary
 * A short description of the setting'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 at Manual:Configuration settings and Manual:Configuration settings (alphabetical).


 * section
 * The category that this setting comes under. This is automatically made into a link to the correct section in Manual:Configuration settings, so make sure you use an existing heading (or a new heading that you may add).


 * version_min, version_deprecated, version_max
 * The version of MediaWiki the setting was introduced in (version_min), the version it was deprecated (version_deprecated) and the version it was removed in (version_max). Leave out version_max if the setting is still in use. If the setting is no longer used, this template automatically adds the  template to the top of the page.  Only include official versions - beta versions, release candidates, etc. should not be mentioned here (use the rev_introduced field if you want to give full precision).


 * rev_introduced
 * The revision this feature is introduced, only displayed if version_min is defined. Don't include the leading 'r' (i.e. use , not  )


 * rev_deprecated
 * The revision this feature was deprecated only displayed if version_deprecated is defined. Don't include the leading 'r' (i.e. use , not  )


 * rev_removed
 * The revision this feature was removed, only displayed if version_max is defined. Don't include the leading 'r' (i.e. use , not  )


 * range
 * The range of allowable values, e.g. "0 - 255", "boolean", "string containing a URL or """.


 * default
 * The default value in a clean MediaWiki installation. If this is different in different versions of the software, then such variations should be noted.


 * newvarlink
 * For obsolete settings replaced by another setting, the link to the variable page that took its place


 * newvarname
 * For obsolete settings replaced by another setting, the new setting name


 * sensitive
 * If the setting contains sensitive data such as passwords, put yes

If the 'range' or 'default' sections are more than a couple of lines long, then simply put (see below) and fill in the details in the main body of the page.