Template:Image frame

From Minecraft Wiki
Jump to: navigation, search
[view | edit | history | purge]Documentation
<templatedata>
	"params": {
		"align": {
			"label": "Alignment",
			"description": "\"left\" and \"right\" float the image to that side. \"center\" centres the image, and \"none\" left-aligns it without floating.",
			"type": "string",
			"default": "right"
		},
		"width": {
			"label": "Width",
			"description": "The width of the image within the frame, in pixels (though do not add \"px\" to the width e.g., use width=175 and not width=175px).",
			"type": "number",
			"default": "Automatic, based on content",
			"suggested": true
		},
		"pos": {
			"label": "Caption position",
			"description": "Where to put the caption. Valid values: top, bottom.",
			"type": "string",
			"default": "bottom"
		},
		"innerstyle": {
			"label": "Inner frame style",
			"description": "Plain [[CSS]] to apply to the inner frame. Use with care. Examples: <code>text-align: center;</code>, <code>background: #ccc;</code>.",
			"type": "string"
		},
		"content": {
			"label": "Content",
			"description": "Content of the main section (generally images).",
			"type": "content",
			"required": true
		},
		"border": {
			"label": "Border",
			"description": "Border of the main section (generally images).",
			"type": "content",
			"required": false,
			"default": "yes"
		},
		"link": {
			"label": "Link",
			"description": "Link for the \"Enlarge\" link in the caption (in the future, may also be used as the link for the image field inside the frame, though it would probably require an additional height parameter).",
			"type": "wiki-page-name"
		},
		"link_text": {
			"label": "Alternative link text",
			"description": "Alternative text used for the link for the \"Enlarge\" link in the caption, usually displayed as tooltip.",
			"type": "string"
		},
		"linkoverride": {
			"label": "Link override",
			"description": "Completely replaces the 'info' link.",
			"type": "line"
		},
		"caption": {
			"label": "Caption",
			"type": "content"
		},
		"mode": {
			"label": "Mode",
			"description": "Display mode of the main section, input <code>scrollable</code> will make the content scroling if the content is longer than viewport.",
			"type": "string"
		},
		"max-width": {
			"label": "Maximum width",
			"description": "The maximum width of the image within the frame, in pixels (though do not add \"px\" to the width e.g., use max-width=350 and not max-width=350px), valid only in scrollable mode.",
			"type": "number",
			"default": "100%",
			"suggested": true
		},
		"dir": {
			"label": "Direction",
			"description": "Use the value \"rtl\" to make the right side of the image the initial visible portion inside the scroll frame, valid only in scrollable mode.",
			"type": "string"
		}
	},
	"description": "This template creates a frame like those surrounding images. This template can be used to put two or more images into a frame together, or as a wrapper for more complicated templates like {{tl|superimpose}}.\n\n<noexport><br/><code>{{Image frame|width=|content=|caption=|link=|align=|pos=|mode=|max-width=|dir=}}</code></noexport>",
	"paramOrder": [
		"content",
		"width",
		"align",
		"pos",
		"innerstyle",
		"link",
		"link_text",
		"linkoverride",
		"caption",
		"border",
		"mode",
		"max-width",
		"dir"
	]
}
</templatedata>

Examples

By filling out the parameters as follows, the result will be as shown below the code.

{{Image frame|width=200|content=[[File:Baby Gold Rabbit.png|100px]][[File:Disambig color.svg|100px]]
|caption=Example usage|align=center}}
Baby Gold Rabbit JE2 BE2.pngDisambig color.svg
Example usage
{{Image frame|width=200|content=[[File:Baby Gold Rabbit.png|100px]][[File:Disambig color.svg|100px]]
|caption=Example usage|align=center|pos=top}}
Example usage
Baby Gold Rabbit JE2 BE2.pngDisambig color.svg
[view | edit | history | purge]The above documentation is transcluded from Template:Image frame/doc.