View source for Template:Portal box placard/doc

{{documentation subpage}}
{{Template rating|alpha}}
{{Uses TemplateStyles|Template:Portal box placard/styles.css}}
== Usage ==
This template is designed to be used in Portals (Portal Boxes).
<pre>{{Portal box placard|1=<file>|res-width=<width-in-px>|caption=<caption>}}</pre>


'''Examples:'''
<pre>{{Portal box placard|1=File:Santa Catalina Mountains Banner.jpg|res-width=1024px|caption=test caption}}</pre>
"res-width" and "caption" are optional.
<pre>{{Portal box placard|1=File:Santa Catalina Mountains Banner.jpg}}</pre>



{{Box-header/25|Box with full resolution image and caption}}
{{Portal box placard|1=File:Catalonia 2016 Zout Fotografie (196 van 196) (32589506286) crop.jpg|caption=test caption}}
{{Box-footer | [[Nonsense|See also...]] }}

<div style="width:50%;">
{{Box-header/25|Smaller box with full resolution and no caption}}
{{Portal box placard|1=File:Catalonia 2016 Zout Fotografie (196 van 196) (32589506286) crop.jpg}}
{{Box-footer | [[Nonsense|See also...]] }}
</div>

<div style="width:50%;">
{{Box-header/25|Same box with res-width set to 1000px}}
{{Portal box placard|1=File:Catalonia 2016 Zout Fotografie (196 van 196) (32589506286) crop.jpg|res-width=1000px}}
{{Box-footer | [[Nonsense|See also...]] }}
</div>

<div style="width:50%;">
{{Box-header/25|Same box with res-width set to 200px}}
{{Portal box placard|1=File:Catalonia 2016 Zout Fotografie (196 van 196) (32589506286) crop.jpg|res-width=200px}}
{{Box-footer | [[Nonsense|See also...]] }}
</div>

<div style="width:50%;">
{{Box-header/25|Same box with res-width set to 20px}}
{{Portal box placard|1=File:Catalonia 2016 Zout Fotografie (196 van 196) (32589506286) crop.jpg|res-width=20px}}
{{Box-footer | [[Nonsense|See also...]] }}
</div>

== More complex example with Flexboxes Template ==

{{Box-header/25| [[Sport climbing]]}}
<div style="margin-top:6px;">
{{Flex columns
|1 =
{{Box-header/26 | [[Lead climbing]]}}
{{Portal box placard|1=File:Climbing World Championships 2018 Lead Qual Bergant 03.jpg|res-width=1000px}}
{{Transclude lead excerpt| Lead climbing | paragraphs=1 | files=0}}
{{Box-footer | [[Lead climbing|Read More...]]}}
|2 =
{{Box-header/26| [[Bouldering]]}}
{{Portal box placard|1=File:Climbing World Championships 2018 Boulder Final Garnbret (BT0A8388).jpg|res-width=1000px}}
{{Transclude lead excerpt| Bouldering | paragraphs=1 | files=0}}
{{Box-footer | [[Bouldering|Read More...]]}}
|3 =
{{Box-header/26| [[Speed climbing]]}}
{{Portal box placard|1=File:Climbing World Championships 2018 Speed Semifinals (BT0A6386).jpg|res-width=1000px}}
{{Transclude lead excerpt| Speed climbing | paragraphs=1 | files=0}}
{{Box-footer | [[Speed climbing|Read More...]]}}
|4 =
{{Box-header/26| [[Ice climbing]]}}
{{Portal box placard|1=File:2016 UIAA Ice Climbing World Tour Cheongsong - 16.jpg|res-width=1000px}}
{{Transclude lead excerpt|Ice climbing | paragraphs=1 | files=0}}
{{Box-footer | [[Ice climbing|Read More...]]}}
}}
</div>
{{Box-footer}} 

==What is the point of the res-width?==
Big images take a long time to load and take up bandwidth. So please don't embed 8k high resolution images without setting a reasonable res-width, especially if you use a box that is smaller than 100%.<br />
For instance if your box takes up 25% of the available space, then 1000px is definitely more than enough. And it will probably still look fine with less, even on 4k monitors.<br />
Even for full width boxes, more than 3840px does not make much sense (as of 2019. Things might change in the future).

==This is similar to [[Template:Portal image banner]]? ==
Yes, but this...
* ...does not use any Lua
* ...allows you to set a resolution width
* ...has a more consistent margin on top and left/right
* ...does not offer image carousels
* ...does not place any text below the image
* ...does not crop the image

Maybe at some point both can be merged.

==See also==
{{Portal templates navbox}}
<templatedata>
{
	"params": {
		"1": {
			"type": "wiki-file-name",
			"required": true
		},
		"res-width": {},
		"caption": {}
	}
}
</templatedata>