Permanently protected template

Template:SettingSummary

From MediaWiki.org
Jump to navigation Jump to search
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎español • ‎français • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎čeština • ‎български • ‎македонски • ‎русский • ‎العربية • ‎中文 • ‎日本語 • ‎한국어
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
Template documentation

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 = 
}}

Usage

A card describing the information of a given configuration setting from MediaWiki core.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

The name of the setting without the initial $wg prefix.

Stringoptional
Version introducedversion_min

The version of MediaWiki the setting was introduced in

Stringsuggested
Version deprecatedversion_deprecated

The version of MediaWiki it was deprecated

Stringoptional
Version removedversion_max

The version of MediaWiki it was removed

Stringoptional
New variable linknewvarlink

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

Pageoptional
New variable namenewvarname

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

Unknownoptional
Sensitive datasensitive

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

Booleanoptional
Type of settingsection

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

Stringoptional
Summarysummary

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

Unknownoptional
SVN revision introducedrev_introduced

The SVN revision where this feature is introduced, only displayed if ''version_min'' is defined. Don't include the leading 'r'

Example
1509
Numberoptional
Gerrit commit ID introducedsha_introduced

same as rev_*, but for Git commit IDs.

Unknownoptional
Gerrit changeset ID introducedchange_introduced

same as rev_*, but for Gerrit changeset IDs. Only works if the respective sha_* parameter is set as well.

Unknownoptional
SVN revision deprecatedrev_deprecated

The SVN revision where this feature was deprecated only displayed if ''version_deprecated'' is defined. Don't include the leading 'r'

Example
1509
Numberoptional
Gerrit commit ID deprecatedsha_deprecated

same as rev_*, but for Git commit IDs.

Unknownoptional
Gerrit changeset ID deprecatedchange_deprecated

same as rev_*, but for Gerrit changeset IDs. Only works if the respective sha_* parameter is set as well.

Unknownoptional
SVN revision removedrev_removed

The SVN revision where this feature was removed, only displayed if ''version_max'' is defined. Don't include the leading 'r'

Example
1509
Numberoptional
Gerrit commit ID removedsha_removed

same as rev_*, but for Git commit IDs.

Unknownoptional
Gerrit changeset ID removedchange_removed

same as rev_*, but for Gerrit changeset IDs. Only works if the respective sha_* parameter is set as well.

Unknownoptional
Range of allowable valuesrange

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

Unknownoptional
Default valuedefault

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

Unknownrequired

Related categories