Difference between revisions of "Template:Infobox Item/effect"

Revision as of 18:47, 3 January 2013

This template offers a multiple choice for defining the effect category of an (item) article. It can also automatically categorize a page under that category.

Parameters

1. The selected effect from the following values (no parameter name and values are case insensitive):
   • none
   • grants access
   • uses magic
   • restores life
   • restores magic
   • restores both
   • stores clover
   • stores life
   • stores magic
   • stores money
   • unique
   • any other (non)empty value defaults to: unknown

• amount: The amount this item applies the above effect per use from the following values (case insensitive):
  • one
  • some
  • all
  • any other (non)empty value defaults to nothing displayed
• nocat: Whether or not to suppress categorization under the chosen category (defaults to false, which means auto categorization).

Syntax

{{Infobox Item/effect|value|amount=value}}

Examples

Commun use includes both parameters, like this:

{{Infobox Item/effect|uses magic|amount=some}}
{{Infobox Item/effect|grants access|amount=one}}
{{Infobox Item/effect|restores life|amount=some}}
{{Infobox Item/effect|stores life|amount=all}}

Uses Magic ^{[list all]} (some)

Grants Access ^{[list all]} (one)

Restores Life ^{[list all]} (some)

Stores Life ^{[list all]} (all)

You may also leave the "amount" undefined (which would not raise any maintenance task) by not specifying any valid values, so these all have the same result (no specific amount displayed):

{{Infobox Item/effect|stores magic}}
{{Infobox Item/effect|stores magic|}}
{{Infobox Item/effect|stores magic|amount=}}
{{Infobox Item/effect|stores magic|amount=seven}}
{{Infobox Item/effect|stores magic|amount=19}}
{{Infobox Item/effect|stores magic|amount=needle}}
{{Infobox Item/effect|stores magic|amount=none}}

Stores Magic ^{[list all]}

Some or most items don't have any effect, in which case the effect could specify "none", so these all have the same effect (nothing displayed, categorized under Category:Effectless items):

{{Infobox Item/effect|none}}
{{Infobox Item/effect|none|amount=}}
{{Infobox Item/effect|none|amount=some}}
{{Infobox Item/effect|none|amount=a lot}}

Lastly, there may be some items that have their own unique effect, in which case the effect could specify "unique":

{{Infobox Item/effect|unique}}

Unique ^{[list all]}

You may also leave the "effect" undefined (which would raise the Items of unknown effect maintenance task) by not specifying any valid values, so these all have the same result:

{{Infobox Item/effect}}
{{Infobox Item/effect|}}
{{Infobox Item/effect|1=}}
{{Infobox Item/effect|1=hungry}}
{{Infobox Item/effect|hungry}}
{{Infobox Item/effect|nausea}}
{{Infobox Item/effect|restores money}}

unknown ^{[list all]}

The nocat parameter may be used to suppress automatic categorization like this (any value will do):

{{Infobox Item/effect|uses magic|amount=some|nocat=true}}

This would render the same result as the first example above, but would not automatically categorize under Category:Magic using items. This feature works both on valid values and the maintenance task mentioned above.