Template:Background/doc

This is a documentation subpage for Template:Background.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

This template allows you to add a background for an article.

Usage

This template is usually written in a column. To use it, insert {{Background}} on the desired page and specify the parameters under the template name in the following format:

{{Background | parameter 1 = value | parameter 2 = value }}

Parameters and Examples

Name	Description	Example	Preview
{{{file}}}	The path to the image.	| file = Hlalyx1.jpg	See Sandbox.
{{{opacity}}}	Allows you to change the opacity of the entire block. (0.05 by default)	| opacity = 0.5
{{{bgcolor}}}	Controls the background color of the block. (transparent by default)	| bgcolor = rgb(255,255,255)
{{{gradient-color}}}	Controls the color of the bottom gradient. (38,38,38 by default)	| gradient-color = 50,50,50
{{{gradient-height}}}	Controls the height of the gradient. (150px by default)	| gradient-height = 600px
{{{mode}}}	Controls the position of the background image on the page. 0 – Absolute (default): Always at the top of the page. 1 – Static: The regular position where the template occurs in the wikitext 2 – Sticky: Like static, but the image follows the user when scrolling about, until the containing block (such as a simple <div>) ends.	| mode = 1