Template:APIOverviewBox/documentation

Template Documentation

This template creates a fixed-sized, clickable <div> box. Use this template to create a navigational grid on a wiki page.

Usage

The template has three required parameters:

1 = The name of the wiki page to link to.

2 = The title of the box.

3 = The description for the box.

To use the template, copy and paste the following code to your page, then define the parameters.

{{APIOverviewBox
|1|2
|3
}}

Example 1

The following code sample shows a box that links to the main page of ReliaWiki (called "Main_Page").

{{APIOverviewBox
|Main_Page|Box Title
|Text to describe the box.
}}

The output of this code is as follows. Clicking anywhere within the box will take you to the main page of ReliaWiki:

{{{title}}}

{{{links}}}

Example 2

To create a 2 x 2 grid, wrap each row of boxes in a <div> "wrapper" that clears all floating elements on both sides.

<!--- Row 1 --->
<div style="clear:both;">
{{APIOverviewBox
|Main_Page|Box Title 1
|Text to describe the box.
}}

{{APIOverviewBox
|Main_Page|Box Title 2
|Text to describe the box.
}}
</div>

<!--- Row 2 --->
<div style="clear:both;">
{{APIOverviewBox
|Main_Page|Box Title 3
|Text to describe the box.
}}

{{APIOverviewBox
|Main_Page|Box Title 4
|Text to describe the box.
}}
</div>

The output is as follows:

{{{title}}}

{{{links}}}

{{{title}}}

{{{links}}}

{{{title}}}

{{{links}}}

{{{title}}}

{{{links}}}