LoadBox

[purge]

This is the documentation page. It should be transcluded into the main template page. See Template:Documentation for more information

LoadBox Example

{{{1}}}

This template creates a box able to load content from another page.

Usage

{{LoadBox
|page=<page>
|title=<title>
|link=<link>
|float=<float>
|class=<class>
|style=<style>
|titlestyle=<titlestyle>
|contentstyle=<contentstyle>
}}

page

Specifies the wiki link text of the content to be loaded (e.g., page=Namespace:Article/subpage).

title

Specifies the identifying text to be displayed in the box, and its link target string (e.g., title=Loaded Content Title). Leaving title unspecified will generate an error message and should be corrected.

link

Specifies the page that the edit button links to. Defaults to page.

float

Optional. Specifies how the box should be positioned. The only two valid values are left, which creates a left-floated box, and none, which creates an un-floated box spanning the available width. If float is not specified, or an invalid value provided, LoadBox creates a right-floated box. Can also be overridden with the style parameter (below).

class

Optional. Specifies one or more css classes to add to the outer box.

style

Optional. Specifies additional styling code for the entire box. Its value should be a css declaration or declaration group with no surrounding braces or quotes (e.g., style=background-color: yellow;).

titlestyle

Optional. Specifies additional styling code for the title. Its value should be a css declaration or declaration group with no surrounding braces or quotes (e.g., titlestyle=background-color: yellow;).

contentstyle

Optional. Specifies additional styling code for the loaded content. Its value should be a css declaration or declaration group with no surrounding braces or quotes (e.g., contentstyle=background-color: yellow;).

Considerations

The generated box will change its size when its content is loaded by the reader. Consider using {{-}} to ensure that the box doesn't overlap or push aside other content on the page inappropriately (for example, the Usage heading above has a {{-}} before it so that the example won't overlap it when its content is loaded). Don't necessarily put {{-}} directly after LoadBox -- it may be better to put it below the content the LoadBox accompanies.

Alternatives

The preferred method for initially hiding content that won't significantly impact server load times is a table with class="collapsible", because it keeps all of an article's content in one place.

LoadBox is intended for small article fragments which could impact server load times if placed in the article directly. For large article fragments, which could actually constitute article sections, consider {{LoadPage}}.