View source for Template:User page/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-use}}
{{Substitution| |to ensure its display on mirror sites that may not utilize this template}}
{{Auto short description}}

== Usage ==
This template is specifically intended for usage on pages within the [[Wikipedia:User pages|user space]], aiming to distinguish them from Wikipedia pages that contain [[WP:NS|encyclopedic content]] or related content (such as encyclopedic talk pages). It is recommended that it be [[WP:SUBST|substituted]] via <code><nowiki>{{subst:user page}}</nowiki></code> to ensure its display on mirror sites that may not utilize this template.

=== Parameters ===
* {{tnull|User page|2=logo=yes|3=noindex=yes}}
** {{para|logo|<var>yes</var>}} – shows the Wiki'''pedia''' logo on the left (default {{var|hidden}})
** {{para|logo2|<var>yes</var>}} - shows the Wiki'''media''' logo on the right (default {{var|hidden}})
*** ({{para|logo|<var>right</var>}} also shows the Wiki'''media''' logo on the right – {{para|logo2}} was added so that both logos could be made to appear)
** {{para|noindex|<var>yes</var>}} – when used on pages other than in User: namespace, prevents external search engines from indexing the page (default {{var|no}}). This parameter is ineffective in User: namespace, where search engines have been [[phab:T104797|prevented from indexing userspace on enwiki]] since November 2015.
** {{para|rounded|<var>yes</var>}} - makes the container's border rounded (default {{var|no}})
** {{para|border-radius|<var>15px</var>}} - changes the border radius, if <code>rounded={{var|yes}}</code> is also set (default {{var|15px}})
** {{para|border-s|<var>1</var>}} - the size of the border (default {{var|1}})
** {{para|border-c|<var>#a66200</var>}} - the color of the border (default {{var|#a66200}})
** {{para|background|<var>#fef6e7</var>}} - changes the background color (default {{var|#fef6e7}})
** {{para|style|no}} - sets the style to the default {{tl|Ombox}} style
** {{para|short|yes}} - centers and makes the template smaller

{{Userspace Disclaimers}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:User namespace templates|{{PAGENAME}}]]
[[Category:Wikipedia templates which apply NOINDEX]]

}}</includeonly>
<templatedata>
{
	"params": {
		"style": {
			"label": "Ombox style",
			"description": "Sets the style to the default {{Ombox}} style if ‘no’.",
			"example": "no",
			"type": "string",
			"suggestedvalues": [
				"no"
			]
		},
		"logo": {
			"label": "Wikipedia logo",
			"description": "Shows the Wikipedia logo on the left; assign ‘right’ to show the logo on the right.",
			"type": "line",
			"suggestedvalues": [
				"yes",
				"right"
			],
			"example": "yes"
		},
		"logo2": {
			"label": "Wikimedia logo",
			"description": "Shows the Wikimedia logo on the left; assign ‘right’ to show the logo on the right.",
			"type": "line",
			"suggestedvalues": [
				"yes",
				"right"
			]
		},
		"border-s": {
			"label": "Border thickness",
			"description": "Sets thickness of the border",
			"type": "number"
		},
		"border-c": {
			"label": "Border color",
			"description": "Sets the color of the border",
			"type": "string"
		},
		"background": {
			"label": "Background color",
			"description": "Sets the background color",
			"type": "string"
		},
		"rounded": {
			"label": "Rounded border",
			"description": "Makes the border rounded.",
			"type": "line",
			"suggestedvalues": [
				"yes"
			],
			"example": "yes"
		},
		"short": {
			"label": "Smaller version",
			"description": "Makes the template smaller and centered.",
			"example": "yes",
			"type": "string",
			"suggestedvalues": [
				"yes"
			]
		},
		"margin-style": {
			"label": "Margin style",
			"description": "Change the margin style.",
			"example": "1em auto",
			"type": "string"
		},
		"noindex": {
			"label": "Prevent search engine indexing",
			"description": "In namespaces outside the userspace, applying this prevents external search engines from indexing the page. However, its use in the userspace is inconsequential, as the indexing of userspace on enwiki has been disabled since 2015.",
			"type": "line",
			"suggestedvalues": [
				"yes"
			],
			"example": "yes"
		},
		"border-radius": {
			"label": "Rounded border's radius",
			"description": "Sets the radius of the rounded border, applicable only when 'rounded=yes' is also assigned; value must end in ‘px’.",
			"example": "20px",
			"type": "string",
			"default": "15px"
		}
	},
	"description": "This template is specifically intended for usage on pages within the user space, aiming to distinguish them from Wikipedia pages that contain encyclopedic content or related content (such as encyclopedic talk pages).",
	"format": "inline",
	"paramOrder": [
		"logo",
		"logo2",
		"style",
		"short",
		"border-s",
		"border-c",
		"background",
		"rounded",
		"border-radius",
		"margin-style",
		"noindex"
	]
}
</templatedata>