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.

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

Parameters and Examples

Name	Description	Example	Preview
`{{{file}}}` or `{{{url}}}`	The path to the image.	{{Background \| file = Hlalyx1.jpg }} {{Background \| url = https://cdn.akamai.steamstatic.com/half-life.com/images/alyx/screens/halflife_alyx_2.jpg }}	Preview is not possible
`{{{opacity}}}`	Allows you to change the opacity of the entire block. (0.05 by default)	{{Background\|opacity=0.5}}	Preview is not possible
`{{{bgcolor}}}`	Controls the background color of the block. (transparent by default)	{{Background\|bgcolor=rgb(255,255,255)}}	Preview is not possible
`{{{gradient-color}}}`	Controls the color of the bottom gradient. (38,38,38 by default)	{{Background\|gradient-color=50,50,50}}	Preview is not possible
`{{{gradient-height}}}`	Controls the height of the gradient. (150px by default)	{{Background\|gradient-height=600px}}	Preview is not possible
`{{{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.	{{Background\|mode=1}}	Preview is not possible