Template:Background/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<noinclude>{{doc|0}}</noinclude>__NOTOC__
{{Doc/subpage}}__NOTOC__
This template allows you to add a background for an article.
This template allows you to add a background for an article.


Line 9: Line 9:
! width="13%" | Preview
! width="13%" | Preview
|-
|-
| align="center" | {{Code|{{Param|b1}}}}
| align="center" | {{Code|{{Param|file}}}}
| The path to the image.
| The path to the image.
| {{CodeBlock|<nowiki>{{Background
| {{CodeBlock|<nowiki>{{Background
| [[File:Hlalyx1.jpg]]
| file = Hlalyx1.jpg
}}</nowiki>}} {{CodeBlock|<nowiki>{{Background
| https://cdn.akamai.steamstatic.com/half-life.com/images/alyx/screens/halflife_alyx_2.jpg
}}</nowiki>}}
}}</nowiki>}}
| align="center" | Preview is not possible
| align="center" | Preview is not possible
|-
|-
| align="center" | {{Code|{{Param|bopacity}}}}
| align="center" | {{Code|{{Param|opacity}}}}
| Allows you to change the opacity of the entire block.
| Allows you to change the opacity of the entire block.
({{Code|style=1|select=1|0.05}} by default)
({{Code|style=1|select=1|0.05}} by default)
Line 24: Line 22:
| align="center" | Preview is not possible
| align="center" | Preview is not possible
|-
|-
| align="center" | {{Code|{{Param|bbgcolor}}}}
| align="center" | {{Code|{{Param|bgcolor}}}}
| Controls the background color of the block.
| Controls the background color of the block.
({{Code|style=1|select=1|transparent}} by default)
({{Code|style=1|select=1|transparent}} by default)
Line 30: Line 28:
| align="center" | Preview is not possible
| align="center" | Preview is not possible
|-
|-
| align="center" | {{Code|{{Param|bgradient-color}}}}
| align="center" | {{Code|{{Param|gradient-color}}}}
| Controls the color of the bottom gradient.
| Controls the color of the bottom gradient.
({{Code|style=1|select=1|38,38,38}} by default)
({{Code|style=1|select=1|38,38,38}} by default)
Line 36: Line 34:
| align="center" | Preview is not possible
| align="center" | Preview is not possible
|-
|-
| align="center" | {{Code|{{Param|bgradient-height}}}}
| align="center" | {{Code|{{Param|gradient-height}}}}
| Controls the height of the gradient.
| Controls the height of the gradient.
({{Code|style=1|select=1|150px}} by default)
({{Code|style=1|select=1|150px}} by default)
Line 42: Line 40:
| align="center" | Preview is not possible
| align="center" | Preview is not possible
|-
|-
| align="center" | {{Code|{{Param|mode}}}}
| Controls the position of the background image on the page.
* <code>0</code> &ndash; Absolute ''(default)'': Always at the top of the page.
* <code>1</code> &ndash; Static: The regular position where the template occurs in the wikitext
* <code>2</code> &ndash; Sticky: Like static, but the image follows the user when scrolling about, until the containing block (such as a simple <code>&lt;div&gt;</code>) ends.
| {{CodeBlock|<nowiki>{{Background|mode=1}}</nowiki>}}
| align="center" | Preview is not possible
|}
|}
<includeonly>{{sandbox other||
[[Category:Templates]]
}}</includeonly>

Latest revision as of 04:48, 24 April 2025

Edit-copy.png
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}}} The path to the image.
{{Background | file = Hlalyx1.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