Template:Floatbox/doc
This is a documentation subpage for Template:Floatbox. It contains usage information, categories and other content that is not part of the original template page. |
The Template:Floatbox is a markup template to float the contents of parameter {1} as a box to show along the right-side boxes on a page, such as alongside an infobox.
- Usage: {{floatbox|text here}}
- {{floatbox|{{Commons category|xxxx}} }}
- {{floatbox|'''Link Boxes'''|margins=0px 20px 6px 0}}
Some of the link-boxes might have an option "align=float" to use instead, but otherwise, this template can be used. A stack of link-boxes can be floated by listing all of them as parameter {1}. Note the following example, with 3 boxes to float:
Infobox Line 1 Line 2 Line 3 Line 4 Line 5 Line 6 Line 7 Line 8 Line 9 |
- {{floatbox|{{Commons category|xxxx}} }}
The floated-box area will allow other text to wrap (to the left side), rather than blocking the fill/wrap of text below that point. Note, however, that the floated area will be as wide as the widest box within, so that text wrapped outside the area cannot fill any whitespace gaps inside the floatbox area.
Multiple use of Floatbox will cause each to float beside the others, in reverse order, right-to-left, across the page, such as the 3 instances: {{floatbox|'''XX'''}}{{floatbox| '''YY'''}}{{floatbox|'''ZZ'''}}:
XX |
YY |
ZZ |
Each box will float, left-ward, across the page. There is no limit to the number of multiple floatboxes used, and they will wrap to additional lines, so that all can fit across and down the page.
Parameters
The parameters include:
- style=xxxx - to include additional style options
- margins=1px 2px 3px 4px - to set margins around the area
(margins are listed clockwise: top right bottom left).
Those parameters are optional, but parameter 1 is required.
Examples
Some other examples are floating bolded text (not a photo):
Link Boxes |
- {{floatbox|'''Link Boxes'''|margins=0px 20px 6px 0}}
Floatbox can also be used to float 1 or more images across a page.
- {{floatbox|[[Image:Mona Lisa, by Leonardo da Vinci, from C2RMF retouched.jpg|30px]]}}{{floatbox|[[Image:Mona Lisa, by Leonardo da Vinci, from C2RMF retouched.jpg|30px]]}}
It might take some experience to learn how the box area floats, in combination with various images or WP:Wikitables on a page. The operation of Template:Floatbox is very quick, using the <table> feature of the HTML markup language.
Related pages
- Template:Fake image - to show an empty image box where an image would fit.
- Template:Stack - also stacks images but not aligned to top of boxes