Editing Template:Avatar/doc

Outputs a user's avatar or profile picture. It pulls the image (via [[Special:CargoTables/users|Cargo]]) from the user's infobox.

== Usage ==
<code>&#123;&#123;avatar|''user's name or ID (required)''|size=''default: 100px''|format=''"frameless" or "border frameless" or "frame" or "thumb" or (nothing)''|horizontal= |vertical= |link= |alt= |class= |caption= }}</code>

* Using an ID is recommended, as names are more likely to change. If using a name, it must match the name at the very top of the user's infobox. If using an ID, it must match the first ID in the Discord ID field of the infobox.
* The default size of the image is 100px wide. To change this, set the size parameter to either (width)px, x(height)px, or (width)x(height)px. For example: <code>|size=200x200px</code>
* To make the image a thumbnail image (the type that is usually used in articles), set the format parameter to <code>thumb</code>.
* All of the named parameters just implement image options. For more info on how to use image options, check out [[mediawikiwiki:Help:Images#Rendering a single page|the MediaWiki image guide]].
* For a detailed explanation of all parameters, check out the TemplateData section below.

=== Examples ===
<code><nowiki>{{avatar|833403765461745704}}</nowiki></code> (which is [[Candy]]'s ID) outputs:
{{avatar|833403765461745704}}

<code><nowiki>{{avatar|244964867843424276 |size=120x120px |format=thumb |horizontal=right |caption=Saucy's avatar}}</nowiki></code> outputs:
{{avatar|244964867843424276 |size=120x120px |format=thumb |horizontal=right |caption=Saucy's avatar}}
<br/>

== TemplateData ==
<templatedata>
{
	"params": {
		"1": {
			"label": "user",
			"description": "The name or Discord ID of the user. ID is recommended, as names are more likely to change. If using a name, it must match the name at the very top of the user's infobox. If using an ID, it must match the first ID in the Discord ID field of the infobox.",
			"example": "833403765461745704",
			"type": "string",
			"required": true
		},
		"size": {
			"description": "The size of the image. To set only the width, use (width)px. To set only the height, use x(height)px. To set the width and height, use (width)x(height)px.",
			"example": "200x200px",
			"type": "string",
			"default": "100px",
			"suggested": true
		},
		"format": {
			"description": "How the rendered image is formatted and embedded in the page. Most images in article body texts have the \"thumb\" format. Leave this undefined for basic image behavior. Must be one of: thumb, frameless, border frameless, frame, (undefined)",
			"type": "string",
			"suggestedvalues": [
				"thumb",
				"frameless",
				"border frameless",
				"frame"
			],
			"default": "(default image behavior)",
			"suggested": true
		},
		"horizontal": {
			"label": "horizontal alignment",
			"description": "Controls the horizontal alignment of the image within text. Must be one of: left, right, center, none, (undefined)",
			"type": "string",
			"suggestedvalues": [
				"left",
				"right",
				"center",
				"none"
			],
			"default": "(default alignment)"
		},
		"vertical": {
			"label": "vertical alignment",
			"description": "Controls the vertical alignment of a non-floating inline image with the text before or after the image. Must be one of: baseline, sub, super, top, text-top, middle, bottom, text-bottom, (undefined)",
			"type": "string",
			"suggestedvalues": [
				"baseline",
				"sub",
				"super",
				"top",
				"text-top",
				"middle",
				"bottom",
				"text-bottom"
			],
			"default": "middle"
		},
		"link": {
			"description": "Sets what page to take you (either internal or external) when you click on the image.",
			"type": "wiki-page-name",
			"default": "(the image file itself)"
		},
		"alt": {
			"description": "The alt text of the image. Used to describe the image for screenreaders or when the browser cannot load the image.",
			"type": "content"
		},
		"class": {
			"description": "The HTML classes that the <img> element will have.",
			"type": "string"
		},
		"caption": {
			"description": "The caption that appears under the image. Only appears if the format parameter is set to \"frame\" or \"thumb\".",
			"type": "content",
			"suggested": true
		},
		"default": {
			"description": "What to output if no image could be found.",
			"type": "string",
			"default": "(no image found)"
		}
	},
	"description": "Outputs a user's avatar or profile picture. It pulls the image from the user's infobox.",
	"paramOrder": [
		"1",
		"size",
		"format",
		"horizontal",
		"vertical",
		"link",
		"alt",
		"class",
		"caption",
		"default"
	]
}
</templatedata>
<includeonly>
[[Category:Templates that query Cargo]]
</includeonly>