Template:BadgeBox

From Unofficial Homecoming Wiki
Revision as of 04:43, 29 June 2012 by imported>Sekoia (using #lsth instead of DPL to grab description)
Jump to navigation Jump to search
[edit] [purge] Documentation

Overview

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

Usage

Badge data is automatically filled in from the badge article. {{Badge display}} on the badge page provides the data. A combination of {{Image}} and a section with heading "Description" also works, but is deprecated.

{{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. Or, you can supply the link= option to specify the exact page title.

{{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.

{{BadgeBox|Badge Name|left=number}}

Additionally, you can supply the monument= option to add additional information after the description, for instance the monument coordinates.

{{BadgeBox|Badge Name|monument=text}}

Limitation

If the data comes from a section with heading "Description", BadgeBox will work only once per badge per page. If you call BadgeBox for the same badge twice on one page, the second BadgeBox will have a page link instead of the description.

If the data comes from {{Badge display}}, this limitation doesn't apply.

Examples

Basic use

{{BadgeBox|Law Enforcer}}
[[
Image Unavailable
|link=|alt=Badge]]
[[{{{link}}}|Law Enforcer]]

Which parameter

Pulls data from a badge article with a parenthetical disambiguation after the title, e.g., the historical Terminator Badge (AE) vs the current Terminator Badge.

{{BadgeBox|Terminator|which=AE}}
{{BadgeBox|Terminator}}
"[[Has image" contains a listed "[" character as part of the property label and has therefore been classified as invalid.|link=|alt=Badge]]
[[{{{link}}}|Terminator]]
[[
Image Unavailable
|link=|alt=Badge]]
[[{{{link}}}|Terminator]]

Link parameter

Pulls data from a badge article with the exact page name specified.

{{BadgeBox|Silent Sentinel}}
{{BadgeBox|link=Silent Sentinel Badge}}
[[
Image Unavailable
|link=|alt=Badge]]
[[{{{link}}}|Silent Sentinel]]
[[

Extension:DynamicPageList3 (DPL3), version 3.4.6: Error: No selection criteria found! You must use at least one of the following parameters: category, namespace, titlematch, linksto, uses, createdby, modifiedby, lastmodifiedby, or their 'not' variants

|link=|alt=Badge]]
[[{{{link}}}|{{{1}}}]]

Left parameter

Gives a smaller badge more space, to align with a large badge.

{{BadgeBox|left=78|Top Dog}}
{{BadgeBox|Atlas Tour Guide}}
Image Unavailable
"[[Has image" contains a listed "[" character as part of the property label and has therefore been classified as invalid.|link=|alt=Badge]]
[[{{{link}}}|Atlas Tour Guide]]

Monument parameter

{{BadgeBox|Intellectual|monument=* [[Intellectual Badge#Monument 1|Monument 1]] {{coords|2381|0|-1251}}}}
"[[Has image" contains a listed "[" character as part of the property label and has therefore been classified as invalid.|link=|alt=Badge]]
[[{{{link}}}|Intellectual]]