Difference between revisions of "Template:Painted variants/doc"
m (→Parameters) |
m (Improve documentation) |
||
(13 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{Complex template}} |
− | |||
− | === | + | {{Hatnote|To view all painted images, see [[Paint Can#Paintable item previews]].}} |
+ | This template is used to display painted variants on pages. It can also display [[styles]]. | ||
+ | |||
+ | === Examples === | ||
+ | When used on [[Bill's Hat]]: | ||
<pre> | <pre> | ||
− | |||
{{Painted variants}} | {{Painted variants}} | ||
</pre> | </pre> | ||
+ | <div class="mw-collapsible mw-collapsed" data-expandtext="show" data-collapsetext="hide" style="width: 500px"> | ||
+ | Results in: | ||
+ | <div class="mw-collapsible-content"> | ||
+ | {{Painted variants|override=Bill's Hat}} | ||
+ | </div> | ||
+ | </div> | ||
+ | |||
+ | When used on [[Batter's Helmet]] (in conjunction with {{tl|Tabs}}): | ||
<pre> | <pre> | ||
− | == | + | {{Tabs |
− | {{Painted variants| | + | | collapsed = yes |
− | = | + | | noalign = 1 |
− | {{ | + | | width = 430px |
− | {{Painted variants| | + | | title = {{common string|Painted variants}} |
− | {{Painted variants|style= | + | | orientation = horizontal |
+ | | icon1 = {{item name|Hat and Headphones}} | ||
+ | | icon2 = {{item name|No Hat and No Headphones}} | ||
+ | | content1 = <nowiki></nowiki> | ||
+ | {{Painted variants|default=Hat and Headphones|h=0}} | ||
+ | | content2 = <nowiki></nowiki> | ||
+ | {{Painted variants|style=No Hat and No Headphones|h=0}} | ||
+ | }} | ||
</pre> | </pre> | ||
+ | |||
+ | Results in: | ||
+ | {{Tabs | ||
+ | | collapsed = yes | ||
+ | | noalign = 1 | ||
+ | | width = 430px | ||
+ | | title = {{common string|Painted variants}} | ||
+ | | orientation = horizontal | ||
+ | | icon1 = {{item name|Hat and Headphones}} | ||
+ | | icon2 = {{item name|No Hat and No Headphones}} | ||
+ | | content1 = <nowiki></nowiki> | ||
+ | {{Painted variants|default=Hat and Headphones|h=0|override=Batter's Helmet}} | ||
+ | | content2 = <nowiki></nowiki> | ||
+ | {{Painted variants|style=No Hat and No Headphones|h=0|override=Batter's Helmet}} | ||
+ | }} | ||
=== Parameters === | === Parameters === | ||
Line 23: | Line 55: | ||
:; ''style'' | :; ''style'' | ||
:: The name of the painted style being displayed in a particular instance. Calls {{tl|item name}} to display the correct translation. | :: The name of the painted style being displayed in a particular instance. Calls {{tl|item name}} to display the correct translation. | ||
+ | |||
+ | :; ''style-unpainted'' | ||
+ | :: The name of the painted style for the unpainted variant (this is not required and always defaults to whatever {{code|style}} is set to). If set to {{code|none}}, it will prevent {{code|style}} from being applied to the unpainted variants at all. Useful for medals. | ||
:; ''h'' | :; ''h'' | ||
:: If defined at all, it will hide the {{tl|main}} and 'mouseover' notes and just display the table. | :: If defined at all, it will hide the {{tl|main}} and 'mouseover' notes and just display the table. | ||
+ | |||
+ | :; ''hh'' | ||
+ | :: If defined at all, it will hide the table header containing the item name. | ||
:; ''override'' | :; ''override'' | ||
:: Override {{code|<nowiki>{{BASEPAGENAME}}</nowiki>}} and use custom name, useful for sub-pages. | :: Override {{code|<nowiki>{{BASEPAGENAME}}</nowiki>}} and use custom name, useful for sub-pages. | ||
− | :; ''names'' | + | :; ''override-unpainted'' |
+ | :: Override {{code|<nowiki>{{BASEPAGENAME}}</nowiki>}} and {{code|override}}, but only for the unpainted variants. Useful for medals. | ||
+ | |||
+ | :; ''override-prefix'' | ||
+ | :: Override the default prefix in file names ("Painted"). Particularly useful for painted items [[Team_Fortress_Wiki:Images#Naming|uploaded for use in userspaces]]. | ||
+ | |||
+ | :; ''name'' | ||
:: Overrides the style name and calls {{tl|item name}} to display the correct translation, useful for items with generic styles such as "Hat" and "No Hat". | :: Overrides the style name and calls {{tl|item name}} to display the correct translation, useful for items with generic styles such as "Hat" and "No Hat". | ||
− | [[ | + | :; ''width'' |
− | [[Category:Paint templates | + | :: Sets custom width for images inside the table. Default is 85px. |
+ | |||
+ | === Other Painted variant templates === | ||
+ | * [[Template:Painted variants full]] - Used for cosmetics that shows different colors per team even on Single color paint cans. | ||
+ | * [[Template:Painted variants unused]] - Used for items that have paintability enabled, but aren't possible to actually be painted as they aren't marked as paintable in the [[Item schema]]. | ||
+ | * [[Template:Painted variants unused full]] - Used for items that have paintability enabled, but aren't possible to actually be painted as they aren't marked as paintable in the [[Item schema]], while also including RED and BLU images for Single color paint cans. | ||
+ | * [[Template:Painted variants unused UGC]] - Used for [[United Gaming Clans|UGC Tournament Medal]] pages. Specifically, [[Tournament Medal - UGC 4vs4|4vs4]]'s unused paintability for the Season 17-18 medals, [[Tournament Medal - UGC 6vs6|6vs6]]'s unused paintability for the Season 30-31 medals and [[Tournament Medal - UGC Highlander|Highlander]]'s unused paintability for the Season 8, 28-29 Medals. | ||
+ | * [[Template:Painted variants/Title]] | ||
+ | * [[Template:Painted variants/Notes]] | ||
+ | * [[Template:Painted variants unused/Notes]] | ||
+ | |||
+ | [[Category:Template documentation]] | ||
+ | [[Category:Paint templates]] |
Latest revision as of 03:27, 12 February 2024
This template is very complex. If you have questions about this template, feel free to ask on the IRC. |
To view all painted images, see Paint Can#Paintable item previews.
This template is used to display painted variants on pages. It can also display styles.
Examples
When used on Bill's Hat:
{{Painted variants}}
Results in:
Main article: Paint Can
Mouseover cells to preview the images on a dark background. Click on the images to enlarge them.
When used on Batter's Helmet (in conjunction with {{Tabs}}
):
{{Tabs | collapsed = yes | noalign = 1 | width = 430px | title = {{common string|Painted variants}} | orientation = horizontal | icon1 = {{item name|Hat and Headphones}} | icon2 = {{item name|No Hat and No Headphones}} | content1 = {{Painted variants|default=Hat and Headphones|h=0}} | content2 = {{Painted variants|style=No Hat and No Headphones|h=0}} }}
Results in:
[show]Painted variants
- Hat and Headphones
- No Hat and No Headphones
show;hide
Parameters
- default
- If the item has a style, its 'default' style should be named here. Calls
{{item name}}
to display the correct translation.
- style
- The name of the painted style being displayed in a particular instance. Calls
{{item name}}
to display the correct translation.
- style-unpainted
- The name of the painted style for the unpainted variant (this is not required and always defaults to whatever
style
is set to). If set tonone
, it will preventstyle
from being applied to the unpainted variants at all. Useful for medals.
- h
- If defined at all, it will hide the
{{main}}
and 'mouseover' notes and just display the table.
- hh
- If defined at all, it will hide the table header containing the item name.
- override
- Override
{{BASEPAGENAME}}
and use custom name, useful for sub-pages.
- override-unpainted
- Override
{{BASEPAGENAME}}
andoverride
, but only for the unpainted variants. Useful for medals.
- override-prefix
- Override the default prefix in file names ("Painted"). Particularly useful for painted items uploaded for use in userspaces.
- name
- Overrides the style name and calls
{{item name}}
to display the correct translation, useful for items with generic styles such as "Hat" and "No Hat".
- width
- Sets custom width for images inside the table. Default is 85px.
Other Painted variant templates
- Template:Painted variants full - Used for cosmetics that shows different colors per team even on Single color paint cans.
- Template:Painted variants unused - Used for items that have paintability enabled, but aren't possible to actually be painted as they aren't marked as paintable in the Item schema.
- Template:Painted variants unused full - Used for items that have paintability enabled, but aren't possible to actually be painted as they aren't marked as paintable in the Item schema, while also including RED and BLU images for Single color paint cans.
- Template:Painted variants unused UGC - Used for UGC Tournament Medal pages. Specifically, 4vs4's unused paintability for the Season 17-18 medals, 6vs6's unused paintability for the Season 30-31 medals and Highlander's unused paintability for the Season 8, 28-29 Medals.
- Template:Painted variants/Title
- Template:Painted variants/Notes
- Template:Painted variants unused/Notes