Template:SettingSummary/doc

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.

Template parameters

This template prefers block formatting of parameters.

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
Version deprecated	version_deprecated	The version of MediaWiki it was deprecated	String	optional
Version removed	version_max	The version of MediaWiki it was removed	String	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	Boolean	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
SVN revision introduced	rev_introduced	The SVN revision where this feature is introduced, only displayed if ''version_min'' is defined. Don't include the leading 'r' Example 1509	Number	optional
Gerrit commit ID introduced	sha_introduced	same as rev_*, but for Git commit IDs.	Unknown	optional
Gerrit changeset ID introduced	change_introduced	same as rev_*, but for Gerrit changeset IDs. Only works if the respective sha_* parameter is set as well.	Unknown	optional
SVN revision deprecated	rev_deprecated	The SVN revision where this feature was deprecated only displayed if ''version_deprecated'' is defined. Don't include the leading 'r' Example 1509	Number	optional
Gerrit commit ID deprecated	sha_deprecated	same as rev_*, but for Git commit IDs.	Unknown	optional
Gerrit changeset ID deprecated	change_deprecated	same as rev_*, but for Gerrit changeset IDs. Only works if the respective sha_* parameter is set as well.	Unknown	optional
SVN revision removed	rev_removed	The SVN revision where this feature was removed, only displayed if ''version_max'' is defined. Don't include the leading 'r' Example 1509	Number	optional
Gerrit commit ID removed	sha_removed	same as rev_*, but for Git commit IDs.	Unknown	optional
Gerrit changeset ID removed	change_removed	same as rev_*, but for Gerrit changeset IDs. Only works if the respective sha_* parameter is set as well.	Unknown	optional
Range of allowable values	range	The range of allowable values, e.g. "0 - 255", "boolean", "string containing a URL or """. Suggested values array boolean float integer string	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. Example {{phpi|$foobar}}	Content	required