Template:Background/doc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| (11 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{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. | ||
==Parameters and Examples== | == Parameters and Examples == | ||
{| class=standard-table width=100% | {| class="standard-table" width="100%" | ||
! Name | ! width="15%" | Name | ||
! Description | ! width="30%" | Description | ||
! Example | ! Example | ||
! | ! width="13%" | Preview | ||
|- | |- | ||
| align=center | {{Code|{{ | | align="center" | {{Code|{{Param|file}}}} | ||
| The path to the image. | | The path to the image. | ||
| {{CodeBlock|<nowiki>{{ | | {{CodeBlock|<nowiki>{{Background | ||
| file = Hlalyx1.jpg | |||
}}</nowiki>}} | }}</nowiki>}} | ||
| align=center | Preview is not possible | | align="center" | Preview is not possible | ||
|- | |- | ||
| align=center | {{Code|{{ | | 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) | ||
| {{CodeBlock|<nowiki>{{Background|opacity=0.5}}</nowiki>}} | | {{CodeBlock|<nowiki>{{Background|opacity=0.5}}</nowiki>}} | ||
| align=center | Preview is not possible | | align="center" | Preview is not possible | ||
|- | |- | ||
| align=center | {{Code|{{ | | 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) | ||
| {{CodeBlock|<nowiki>{{Background|bgcolor=rgb(255,255,255)}}</nowiki>}} | | {{CodeBlock|<nowiki>{{Background|bgcolor=rgb(255,255,255)}}</nowiki>}} | ||
| align=center | Preview is not possible | | align="center" | Preview is not possible | ||
|- | |- | ||
| align=center | {{Code|{{ | | 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) | ||
| {{CodeBlock|<nowiki>{{Background|gradient-color=50,50,50}}</nowiki>}} | | {{CodeBlock|<nowiki>{{Background|gradient-color=50,50,50}}</nowiki>}} | ||
| align=center | Preview is not possible | | align="center" | Preview is not possible | ||
|- | |- | ||
| align=center | {{Code|{{ | | 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) | ||
| {{CodeBlock|<nowiki>{{Background|gradient-height=600px}}</nowiki>}} | | {{CodeBlock|<nowiki>{{Background|gradient-height=600px}}</nowiki>}} | ||
| 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> – Absolute ''(default)'': Always at the top of the page. | |||
* <code>1</code> – Static: The regular position where the template occurs in the wikitext | |||
* <code>2</code> – Sticky: Like static, but the image follows the user when scrolling about, until the containing block (such as a simple <code><div></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
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.
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. | Preview is not possible | |
| {{{opacity}}} | Allows you to change the opacity of the entire block.
(0.05 by default) |
Preview is not possible | |
| {{{bgcolor}}} | Controls the background color of the block.
(transparent by default) |
Preview is not possible | |
| {{{gradient-color}}} | Controls the color of the bottom gradient.
(38,38,38 by default) |
Preview is not possible | |
| {{{gradient-height}}} | Controls the height of the gradient.
(150px by default) |
Preview is not possible | |
| {{{mode}}} | Controls the position of the background image on the page.
|
Preview is not possible |