Template:ComponentBox/doc

This is a documentation subpage for Template:ComponentBox (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

Overview

This template is used to generate an Incarnate Component box for displaying the graphic, name, and description for a component.

Usage

There are three ways to use this template.

The first way is to specify the graphic, the component name, and the component description as thus:

{{ComponentBox|Image.png|Component Name|Description}}

The second way is to omit the description. If the description is omitted, the description will automatically be filled in from the component's article using the section titled "Description". (If there is no such section, an error occurs.)

{{ComponentBox|Image.png|Component Name}}

The third way is to omit the graphic and the description. If omitted, they will both be automatically filled in from the component's article using the section titled "Description" and the image displayed through the {{Image}} template. (If either do not exist, an error occurs.)

{{ComponentBox|Component Name}}

Additionally, you can supply the which= option to specify which of a set of disambig pages to refer to; the which= should refer to the parenthetical after the component name.

{{ComponentBox|Component Name|which=Type}}

Examples

Here is an example template call for a component, providing a custom description:

{{ComponentBox|Salvage Lens.png|Essence of the Incarnate|You could totally fry a giant, city-crushing ant with this lens.}}

This will output:

Essence of the Incarnate You could totally fry a giant, city-crushing ant with this lens.

Here is an example template call for a component, using the automatic description:

{{ComponentBox|Salvage Lens.png|Essence of the Incarnate}}

This will output:

Essence of the Incarnate A shred of power from a living Incarnate.

Here is an example template call for a component, using the automatic description and image:

{{ComponentBox|Essence of the Incarnate}}

This will output:

Essence of the Incarnate Essence of the Incarnate Component

Here is an example template call showing how to suppress the description completely:

{{ComponentBox|Salvage Lens.png|Essence of the Incarnate|3= }}

This will output:

Essence of the Incarnate