Template:Portal box placard/doc
![]() | This is a documentation subpage for Template:Portal box placard. It may contain usage information, categories and other content that is not part of the original template page. |
![]() | This template is rated as alpha. It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
![]() | This template uses TemplateStyles: |
Usage
This template is designed to be used in Portals (Portal Boxes). <syntaxhighlight lang="wikitext">
</syntaxhighlight>
Examples:
<syntaxhighlight lang="wikitext">
</syntaxhighlight> "res-width" and "caption" are optional. <syntaxhighlight lang="wikitext">
</syntaxhighlight>
Box with full resolution image and caption
More complex example with Flexboxes Template
Bouldering is a form of free climbing that is performed on small rock formations or artificial rock walls without the use of ropes or harnesses. While bouldering can be done without any equipment, most climbers use climbing shoes to help secure footholds, chalk to keep their hands dry and to provide a firmer grip, and bouldering mats to prevent injuries from falls. Unlike free solo climbing, which is also performed without ropes, bouldering problems (the sequence of moves that a climber performs to complete the climb) are usually less than six metres (20 ft) tall. Traverses, which are a form of boulder problem, require the climber to climb horizontally from one end to another. Artificial climbing walls allow boulderers to climb indoors in areas without natural boulders. In addition, bouldering competitions take place in both indoor and outdoor settings. (Full article...)
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%.
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.
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
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
1 | 1 | no description | File | required |
res-width | res-width | no description | Unknown | optional |
caption | caption | no description | Unknown | optional |