Template:Infobox Key Item/Doc
From HorizonXI Wiki
This is the documentation for {{Infobox Key Item}}. It is transcluded into the template page.
Example
- For examples of using the template, visit the Examples sub-page.
Usage
Syntax
Full
- All available parameters with comments.
{{Infobox Key Item | name = <!-- The exact name as it appears on the KI. If left empty, the page name will be used. --> | image = | description = <!-- The description as it appears on the KI. --> | quest = <!-- Used in Quest(s) --> | mission = <!-- Used In Mission --> | bcnm = <!-- Used In BCNM --> | obtained = <!-- Obtained --> | drops-from = <!-- NM or other mob that drops the KI --> | location = <!-- The zone where the KI is obtained --> | zones = <!-- MAPS ONLY: Contains Zone(s) --> | armor set = <!-- CLAIM SLIPS: Used to Redeem --> | effects = <!-- ATMA ONLY: The effects of the Atma when infused. --> | notes = <!-- Any other notes --> <!-- Type indicators --> | is-temp = <!-- Y = Temporary Key Item --> | is-perm = <!-- Y = Permanent Key Item --> | is-claim = <!-- Y = Claim Slip --> | is-map = <!-- Y = Magical Map --> | is-abyssite = <!-- Y = Abyssite --> | is-atma = <!-- Y = Atma --> <!-- Categories to use other than "Key Items" or the flags above --> | sub-category = | sub-category2 = | sub-category3 = | sub-category4 = }}
Claim Slips
{{Infobox Key Item | name = | image = | description = | armor set = | notes = | is-claim = Y }}
Magical Maps
{{Infobox Key Item | name = | image = | description = | obtained = | location = | zones = | notes = | is-map = Y }}
Abyssite
{{Infobox Key Item | name = | image = | description = | obtained = | drops-from = | location = | notes = | is-abyssite = Y }}
Atma
{{Infobox Key Item | name = | image = | obtained = | drops-from = | location = | effects = | notes = | is-atma = Y }}
Parameters
- Any parameters that are not applicable to the article may be removed.
- When unknown, leave the parameter in with a blank value so that others may fill it in.
Template Parameters
Name | Req? | Description |
---|---|---|
name | N | Name of the item as it appears in the game. If left empty, the page name will be used. |
image | Y | Image file name. If empty, {{Keyitem-image-stub}} will be used. |
description | Y | Description of the item as it appears in the game. If the is-atma parameter is provided, this will automatically be filled. |
quest | N | Link to the quest(s) the item is used in. |
mission | N | Link to the mission the item is used in. |
bcnm | N | Link to the BCNM the item is required to gain access to. |
obtained | * | Freeform information on how to obtain the item. If the is-claim parameter is provided, this will automatically be filled. If is-atma is provided, this becomes required. If is-atma and dropped-from are provided, this will be filled. |
drops-from | N | NM or other monster that drops the item. Providing a value will make location required. |
location | * | Zone where the item or drops-from mob is found. If drops-from is provided, this becomes required. |
zones | * | MAPS ONLY: The zone(s) contained in the map. If is-map is provided, this becomes required. |
armor set | * | CLAIM SLIPS: The armor set the slip is redeemed for. If is-claim is provided, this becomes required. |
effects | * | ATMAS ONLY: The effects of the Atma when infused. Format: '''[[<effect>]]'''[+,-]:[Minor/Major/Superior] (<amt>[%]), '''[[<effect>]]'''[+,-]:[Minor/Major/Superior] (<amt>[%]) Example: '''[[MP]]'''+:Superior (30%), '''[[MND]]'''+:Major (30), '''[[Enmity]]'''-:Major (30) |
notes | N | Freeform notes about the item, such as more details about obtaining it and what it's used for. If is-claim or is-atma is provided, a note will be added in addition to any provided here. |
is-temp | N | Non-empty value = Temporary Key Item. |
is-perm | N | Non-empty value = Permanent Key Item. |
is-claim | N | Non-empty value = Claim Slip. This will set is-temp, add a note and make armor set required. |
is-map | N | Non-empty value = Magical Map. This will set is-perm and make zones required. |
is-abyssite | N | Non-empty value = Abyssite. This will set is-temp. |
is-atma | N | Non-empty value = Atma. This will set is-temp and description, add a note, and make obtained and effects required. |
sub-category# | N | Any additional categories to add that are not generated by the other parameters. |