Difference between revisions of "Help:Useful Templates"

Revision as of 19:52, 13 May 2006

About Templates

Templates are a way of standardizing content across the wiki. They allow information that is duplicated in several pages to be located and edited in one place. For example, the mission Talk to David Wincott can come from just about any contact, and rather than type that information over and over, it has been created in one place, Template:Mission Hollows, and can then be inserted into any contact with the text, {{Mission Hollows}}.

Templates can also accept parameters, details which change from use to use. An example of this is the Power Template. This simple template takes four parameters, and formats the information into the power entry which is used on most of the enemy pages. Since the format is kept in one place, if, in the future, and new format is decided upon, rather than go through all the enemy pages and redoing their powers, one change to the power template will make those changes in the entire wiki.

Useful Templates

The following templates can be useful in making articles in the wiki but are in no way required and subject to change at any time.

Enemy Templates

Power

This template formats an entry in an enemies power listing in a standarized way.

Format: {{Power|Bullet Image|Power name|Power Effects|Power description}}

• Bullet image is the image that is associated with the power, scaled to 22 pixels. Example: [[Image:Empathy RecoveryAura.png|22px]]
• Power Name is the name of the power.
• Power Effects would be the short description in the top part of the info window. Abbreviations should be fully spelled out.
• Power Description is the long description in the lower part of the info window. Game terms, like damage or accuracy should not be capitalized.

Player And Temporary Power Detail Box

The details on player and temporary powers is in a box with fixed width text. The following templates can be used to make it easy to line up the secondary information. In order to keep the box effect, any blank line must have a single space to it.

PowerDamage

Format: {{PowerDamage|Damage}}

• Damage is the level of damage the power does (i.e. Low, Moderate, High).

PowerRecharge

Format: {{PowerRecharge|Recharge Rate}}

• Recharge rate is the level that the power recharges at (i.e. Slow, Moderate, Long).

PowerMinLevel

Format: {{PowerMinLevel|Level}}

• Level is the minumum level (and class, if appropriate) that is needed to gain this power. This is the line which will contain the Minimum Level: heading. Additional lines must use the {{PowerSpaces}} template.

PowerDuration

Format: {{PowerDuration|Duration}}

• Duration is how long or how many charages a power has. This template is mainly used in temporary powers.

PowerEffects

Format: {{PowerEffects|Effects}}

• Effects is one line of the powers effects. This is the line which will contain the Effects: heading. Additional lines must use the {{PowerSpaces}} template.

PowerEnhancements

Format: {{PowerEnhancements|Enhancement}}

• Enhancement is one line of the what enhancements the power accepts. This is the line which will contain the Enhancement: heading. Additional lines must use the {{PowerSpaces}} template.

PowerSpaces

Format: {{PowerSpaces|Details}}

• The PowerSpaces template is used to get extra details to line up with previous lines.

Example entry

Here's an example entry from the Archer power set. Take note that on each of the two blank lines, there is a single space.

{{PowerDamage|High}}
{{PowerRecharge|Moderate}}
{{PowerMinLevel|1 (Blaster)}}
{{PowerSpaces|2 (Defender)}}}

{{PowerEffects|Ranged}}
{{PowerSpaces|Moderate Damage (Lethal)}}

{{PowerEnhancements|Reduce Endurance Cost}}
{{PowerSpaces|Enhance Range}}
{{PowerSpaces|Enhance Recharge Speed}}
{{PowerSpaces|Enhance Damage}}
{{PowerSpaces|Enhance Accuracy}}

And here's how it would appear in the wiki.

Template:PowerDamage Template:PowerRecharge Template:PowerMinLevel Template:PowerSpaces

Template:PowerEffects Template:PowerSpaces

Template:PowerEnhancements Template:PowerSpaces Template:PowerSpaces Template:PowerSpaces Template:PowerSpaces

Contact Templates

Badge Box

The BadgeBox template is most commonly used to showcase badges in a contact's mission line up.

Format: {{BadgeBox|Icon|Badge Name|Badge Text}}

• Icon is the image associated with the badge.
• Badge Name is the name of the badge.
• Badge Text is the text assocaiated with the badge.

Contact Overview

This template standardize the starting overview line of a hero or villain contact, as well as automatically placing them in the categories sorted by level range, by zone, by origin, and whether they are a Respec, tailor, or store contact.

For more information, see Template talk:Contact Overview.

Format: {{Contact Overview|City=|Zone=|Coord=|Pronoun=|HoodYN=N|Hood=|OriginYN=N|Origin=|LevelYN=N|Level=}}

• City = Either an H for hero, or a V for Villain. The letter must be capitalized. Any other item will cause unexpected results (most likey a {{Template:Contact CityX}} result, in which X is whatever the mistake was).
• HoodYN = Either a Y if the contact is located in a specific neighborhood, or an N if the contact is not in a specific neighborhood. The letter must be capitalized. Any other item will cause unexpected results.
• Hood = Name of the neighborhood the contact is in. This data is only used if HoodYN is Y and is otherwise ignored.
• Zone = Zone the contact is in. In the previous contact template, this needed to be a link. In this case, it must not be a link.
• Coord = The contacts coordinates.
• OriginYN = There are several options on this parameter. It must be one of the following letters, capitalized, or there will be unexpected results in the article
  • Y There is a known origin for this contact, and it will be specified in the Origin parameter.
  • N This contact either doesn't have an origin, or the origin is unknown. This will place the contact in the Unspecified Origin Contacts category.
  • R This contact is a Respecification Trial contact and will be noted as such in the overview text. It will also place the contact in the Respecification Trial Contact category.
  • S This contact is a Store contact and will be noted as such in the overview text. It will also place the contact in the Store Contacts category.
  • T This contact is a Tailor and will be noted as such in the overview text. It will also place the contact in the Tailor Contacts category.
• Origin = The contact's origin. This should be one of the following: Magic, Mutation, Natural, Science, Technology. The first letter should be capitalized, but it may work if it is not. This data is only used if OriginYN is Y and is otherwise ignored.
• Pronoun = The pronoun that describes the contact of his, her or its. It needs to be lower case.
• LevelYN = Either a Y if the level range this contact deals with is known or an N if it is unknown. The letter must be capitalized. Any other item will cause unexpected results.
• Level = The level range that this contact works with. It should be in the format of NumberDashNumber (no spaces).

PowerBox

The PowerBox template is most commonly used to showcase temporary powers in a contacts mission line up. It uses a similar format as the Power template for enemies.

Format: {{Power|Icon=Image|Name=Power name|Effect=Power Effects|Desc=Power description}}

• Icon is the image that is associated with the power. Unlike the Power template, all that is needed is the name of the icon.
• Name is the name of the power.
• Effect would be the short description in the top part of the info window. Abbreviations should be fully spelled out.
• Desc is the long description in the lower part of the info window. Game terms, like damage or accuracy should not be capitalized.

Formatting

Here are some templates that can help with formatting.

Clr

This template is used in conjuction with an image. It will force any data that comes after it to start below the bottom edge of an image.

Format: {{clr}}

• Clr has no parameters.

Divbox

This template will display a centered box with a centered title and content in it.

Format: {{Divbox|color|title|content}}

Available colors at this time are: amber, black, bloodred, blue, brown, forest, gray, green, navy, none, orange, purple, red, white, and yellow. The box appears as follows:

TOCright

This template will place a floating table of contents on the right side of the article, allowing text to flow around it, rather than on the left with text below it. It should not be used anyplace that __ToC__ is used.

Format: {{TOCright}}

• TOCRight has no parameters.

WiP

This template is used to indicate that a page is very raw and in need of work, i.e. it's a Work in Progress. It'll place text on the page indicating it's status, and add the article to the Work in Progress category, making it easy to find articles that need to be worked on.

Format: {{wip}}

• WiP has no parameters.