Difference between revisions of "Template:BadgeBox/doc"

Latest revision as of 06:31, 29 June 2012

Overview

This template is used to generate a badge box for displaying the badge graphic, badge name, and badge description for a badge.

Usage

There are three ways to use this template.

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

{{BadgeBox|Image.png|Badge Name|Description}}

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

{{BadgeBox|Image.png|Badge Name}}

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

{{BadgeBox|Badge Name}}

Note that some badges have a different graphic and/or a different description for heroes and villains. Most badges will work fine automatically (once set up), but some may require additional parameters to get the exact effect you want.

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 badge name.

{{BadgeBox|Badge Name|which=Type}}

Additionally, you can specify a width for the left using left=. You should provide a number, which will be treated as a width in pixels. This allows a series of badge boxes to line up well.

Limitation

BadgeBox may only be used once per badge if you're going to let it auto-detect the description. If you call the same badge twice on one page, the second one will get a page link instead of the description. (However, we shouldn't have multiple BadgeBoxes for a single badge on a page anyway.)

Examples

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

{{BadgeBox|badge_stature_03.png|Plague Stopper|Custom description.}}

This will output:

Plague Stopper Custom description.

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

{{BadgeBox|badge_stature_03.png|Plague Stopper}}

This will output:

Plague Stopper You were key in stopping a plague from overtaking Paragon City.

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

{{BadgeBox|Apex}}

This will output:

Apex Apex tracked Dr. Vahzilok down to this location, but interference from the Circle of Thorns prevented him from capturing the mad scientist.

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

{{BadgeBox|Badge tourist 01.png|Apex|3= }}

This will output:

Apex

Here are some examples with the which= option:

{{BadgeBox|Resolute|which=Vet}}

{{BadgeBox|Badge vr months generic.png|Resolute|which=Veteran}}

{{BadgeBox|Badge vr months generic.png|Resolute|Custom description.|which=Veteran}}

This will output:

Resolute Hero For 75 months in City of Heroes you will earn an additional 10% Prestige from defeating enemies. Villain For 75 months in City of Heroes you will earn an additional 10% Prestige from defeating enemies.

Resolute Hero Against all odds you've withstood the challenges that have been thrown your way and came out on top. This badge has been granted to you for earning twenty six Reward Tokens. Villain Against all odds you've withstood the challenges that have been thrown your way and came out on top. This badge has been granted to you for earning twenty six Reward Tokens.

Resolute Custom description.

Here is an example using the left= option:

{{BadgeBox|left=130|Enhancer}}

{{BadgeBox|left=130|Vendor}}

This will output:

Enhancer You've sold 50 Enhancements on the Auction House.

Vendor You've sold 10 items on the Auction House.