Badge time.png   The Paragon Wiki Archive documents the state of City of Heroes/Villains as it existed on December 1, 2012.

Difference between revisions of "Template:BadgeBox/doc"

From Paragon Wiki Archive
Jump to: navigation, search
m (Template:BadgeBox/Doc moved to Template:BadgeBox/doc: Renaming documentation page to work with {{Documentation}})
m (updating for {{documentation}}, adding cat)
Line 1: Line 1:
__NOTOC__
+
{{documentation subpage}}__NOTOC__
 
==Overview==
 
==Overview==
 
This template is used to generate a badge box for displaying the badge graphic, badge name, and badge description for a badge.
 
This template is used to generate a badge box for displaying the badge graphic, badge name, and badge description for a badge.
Line 46: Line 46:
 
This will output:
 
This will output:
 
{{BadgeBox|badge_stature_03.png|Plague Stopper|3= }}
 
{{BadgeBox|badge_stature_03.png|Plague Stopper|3= }}
 +
<includeonly>
 +
[[Category:Templates]]
 +
</includeonly>

Revision as of 06:49, 20 February 2008

This is a documentation subpage for Template:BadgeBox (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 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.

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:

Badge stature 03.png 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:

Badge stature 03.png 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|Plague Stopper}}

This will output:

Plague Stopper

Plague Stopper Badge


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

{{BadgeBox|badge_stature_03.png|Plague Stopper|3=&nbsp;}}

This will output:

Badge stature 03.png Plague Stopper