Template:SettingSummary
| MediaWiki settings: SettingSummary | |
|---|---|
| Please edit this page to enter a summary. |
|
| Introduced in version: | Unknown |
| Removed in version: | Still in use |
| Allowed values: | Unspecified |
| Default value: | Unspecified |
| Other settings: Alphabetical | By function | |
 | This template is used on approximately 8,000 pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
 | This template uses TemplateStyles: |
| TNT | This template uses Module:TNT for localisation: |
Copy and paste template
{{SettingSummary
|name =
|summary =
|section =
|version_min =
|rev_introduced =
|sha_introduced =
|change_introduced =
|version_deprecated =
|rev_deprecated =
|sha_deprecated =
|change_deprecated =
|version_max =
|rev_removed =
|sha_removed =
|change_removed =
|range =
|default =
|newvarlink =
|newvarname =
|sensitive =
}}
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools.
SettingSummary
A card describing the information of a given configuration setting from MediaWiki core.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Name | name | The name of the setting without the initial $wg prefix. | String | optional |
| Version introduced | version_min | The version of MediaWiki the setting was introduced in. | String | suggested |
| Introduced in SVN revision | rev_introduced | Requires "version_min" to be set also. Omit any leading "r".
| Number | deprecated |
| Introduced in Git commit hash | sha_introduced | Requires "version_min" to be set also. | String | optional |
| Introduced in Gerrit change number | change_introduced | Requires "version_min" and "sha_introduced" to be set as well. | Number | optional |
| Version deprecated | version_deprecated | The version of MediaWiki it was deprecated. | String | optional |
| Deprecated in SVN revision | rev_deprecated | Requires "version_deprecated" to be set also. Omit any leading "r".
| Number | deprecated |
| Deprecated in Git commit hash | sha_deprecated | Requires "version_deprecated" to be set also. | String | optional |
| Deprecated in Gerrit change number | change_deprecated | Requires "version_deprecated" and "sha_deprecated" to be set well. | Number | optional |
| Version removed | version_max | The version of MediaWiki it was removed. | String | optional |
| Removed in SVN revision | rev_removed | Requires "version_max" to be set. Omit any leading "r".
| Number | deprecated |
| Removed in Git commit hash | sha_removed | Requires "version_max" to be set. | String | optional |
| Removed in Gerrit change number | change_removed | Requires "version_max" and "sha_removed" to be set. | Number | optional |
| New variable link | newvarlink | For obsolete settings replaced by another setting, the link to the variable page that took its place. | Page name | optional |
| New variable name | newvarname | For obsolete settings replaced by another setting, the new setting name. | Unknown | optional |
| Sensitive data | sensitive | If the setting contains sensitive data such as passwords, put "yes". | String | optional |
| Type of setting | 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). | String | optional |
| Summary | 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)". | Unknown | optional |
| Range of allowable values | range | The range of allowable values, e.g. "0 - 255", "boolean", "string containing a URL or """. The following values (under "Suggested values") will be automatically translated.
| String | suggested |
| Default value | 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.
| Content | required |