Template:Item: Difference between revisions

From Elanthipedia
Jump to navigation Jump to search
(→‎Usage Documentation:: added new tie type. cleanup of usage and options, plus i added some examples.)
(→‎Usage Documentation:: additional cleanup/formatting.)
Line 20: Line 20:
This template is for use with non-armor, non-weapon items. Copy the following into the item page. [[Template:Weapon|Weapons]], [[Template:Armor|armor]], and [[Template:Shield|shields]] have their own separate templates, and for brawling and related equipment use [[Template:Weapon]]. For information on listing crafted equipment, consult the [[Elanthipedia:Manual_of_Style/Items#Crafted Equipment|Manual of Style]].
This template is for use with non-armor, non-weapon items. Copy the following into the item page. [[Template:Weapon|Weapons]], [[Template:Armor|armor]], and [[Template:Shield|shields]] have their own separate templates, and for brawling and related equipment use [[Template:Weapon]]. For information on listing crafted equipment, consult the [[Elanthipedia:Manual_of_Style/Items#Crafted Equipment|Manual of Style]].


===Values===
{| border="1" cellpadding="3"
{| border="1" cellpadding="3"
!Variable!!Supported Values!!Usage
!Variable!!Supported Values!!Usage
|-
|-
|name|| ||Name of the object. Only include this if the item name is different from the page name (e.g. a ''<color'' wand).
|name|| ||Name of the object. Only include this if the item name is different from the page name (e.g. a ''<color>'' wand).
|-
|-
|look||-, <text>||the description gained by {{com|LOOK}}ing at it. "-" will result in "''You see nothing unusual.''"
|look||-, <text>||The description gained by {{com|LOOK}}ing at the item. "-" will result in "''You see nothing unusual.''"
|-
|-
|noun|| ||the single word '''noun''' used to interact with it
|noun|| ||The single word '''noun''' used to interact with the item.
|-
|-
|MTag||<material>,<material>,...||Comma-separated list of materials used in the item's name and/or description.
|type||-, alchemy, anatomy chart, cambrinth, casts spell, celestial jewelry, clothing, container, creation, drink, food, gaethzen, gives light, hiding, housing, jewelry, juggle, lock, magic, ''<type>'' instrument, quest, tie, toy, tack, writing, ''<guild>'' style, ''<race>'' style||For category inclusion.
|-
|CTag||<color>,<color>,...||Comma-separated list of colors used in the item's name and/or description.
|-
|STag||<symbol>,<symbol>,...||Comma-separated list of symbols used in the item's name and/or description.
|-
|type||-, alchemy, anatomy chart, cambrinth, casts spell, celestial jewelry, clothing, container, creation, drink, food, gaethzen, gives light, hiding, housing, jewelry, juggle, lock, magic, ''<type>'' instrument, quest, tie, toy, tack, writing, ''<guild>'' style, ''<race>'' style||Comma-separated list for category inclusion.


With regard to the guild/race styles, only list them if the item has a specific use for that group, or a person ignorant of the source of the item would believe the item is styled for that guild or race.
With regard to the guild/race styles, only list them if the item has a specific use for that group, or a person ignorant of the source of the item would believe the item is styled for that guild or race.
Line 37: Line 44:
|uses||#||The number of bites, sips, drinks, waves, etc.
|uses||#||The number of bites, sips, drinks, waves, etc.
|-
|-
|weight||#||weight in stones ("-" will disable)
|weight||#||Weight in stones ("-" will disable).
|-
|-
|lsize||#||Length of the outside of object as determined with {{com|MEASURE}}. If this is a container, make sure to CLOSE before you measure.
|lsize||#||Length of the outside of object as determined with {{com|MEASURE}}. If this is a container, make sure to CLOSE before you measure.
Line 55: Line 62:
|wearloc||-, generic, eye, eyes, ear, ears, head, hair, eyebrow, nose, neck, chest, shirt, shirt-, arms, upper arm, wrist, hands, finger, back, shoulder, shoulders, abdomen, waist, belt, legs, thigh, pants, ankles, feet, tail||Where the item is worn. "-" indicates the item is not worn.
|wearloc||-, generic, eye, eyes, ear, ears, head, hair, eyebrow, nose, neck, chest, shirt, shirt-, arms, upper arm, wrist, hands, finger, back, shoulder, shoulders, abdomen, waist, belt, legs, thigh, pants, ankles, feet, tail||Where the item is worn. "-" indicates the item is not worn.
|-
|-
|maxcharge||#||maximum mana that can be held by it
|maxcharge||#||maximum mana that can be held by the item (used with cambrinth, gaethzen, etc).
|-
|-
|spellcast||spell||the spell cast by the object
|spellcast||spell||The spell cast by the item.
|-
|-
|appcost||#||The cost given by an expert ([[Trader]] preferred) appraisal. Given in [[Kronar]]s. ("-" will disable)
|appcost||#||The cost given by an expert ([[Trader]] preferred) appraisal. Given in [[Kronar]]s. ("-" will disable)
Line 65: Line 72:
|source||(source)+(source version 2)+...||Where the item comes from (e.g. <player1> and <player2>'s wedding). This should only be used with an "other" sourcetype (see above).
|source||(source)+(source version 2)+...||Where the item comes from (e.g. <player1> and <player2>'s wedding). This should only be used with an "other" sourcetype (see above).
|-
|-
|cost||# Kronars/Dokoras/Lirums||Price at preceeding store, including currency.
|cost||# Kronars/Dokoras/Lirums||Price at preceeding store, including currency. This field is optional.
|-
|-
|list|| ||A way to change how an item is listed in categories.
|list|| ||A way to change how an item is listed in categories.
Line 73: Line 80:
|htype||doors, free, knoll, tree, interior, furniture, decoration, pet, bed, misc, storage, chair, armor stand, weapon stand, fireplace, fuel, wall, wind chime, bird house||A space for listing an items housing properties. See [[Property:Housing item type]].
|htype||doors, free, knoll, tree, interior, furniture, decoration, pet, bed, misc, storage, chair, armor stand, weapon stand, fireplace, fuel, wall, wind chime, bird house||A space for listing an items housing properties. See [[Property:Housing item type]].
|}
|}

===Page Creation===
You can copy/paste below when creating a new Item: page. See [[#Values|values]] above for the values for each entry.


<pre>
<pre>
Line 78: Line 88:
|name=
|name=
|look=
|look=
|MTag=
|CTag=
|STag=
|noun=
|noun=
|type=<can be a list separated by ",">
|type=<can be a list separated by ",">
Line 98: Line 111:
}}
}}
</pre>
</pre>

{{cat|Templates}}
{{cat|Templates}}
</noinclude>
</noinclude>

Revision as of 16:40, 19 January 2016

item
Look:
Core Noun:
Weight: Unknown
Appraised Cost: Unknown
Properties:
Dimensions: ? length x ? width x ? height
Sources: Unknown

Usage Documentation:

This template is for use with non-armor, non-weapon items. Copy the following into the item page. Weapons, armor, and shields have their own separate templates, and for brawling and related equipment use Template:Weapon. For information on listing crafted equipment, consult the Manual of Style.

Values

Variable Supported Values Usage
name Name of the object. Only include this if the item name is different from the page name (e.g. a <color> wand).
look -, <text> The description gained by LOOKing at the item. "-" will result in "You see nothing unusual."
noun The single word noun used to interact with the item.
MTag <material>,<material>,... Comma-separated list of materials used in the item's name and/or description.
CTag <color>,<color>,... Comma-separated list of colors used in the item's name and/or description.
STag <symbol>,<symbol>,... Comma-separated list of symbols used in the item's name and/or description.
type -, alchemy, anatomy chart, cambrinth, casts spell, celestial jewelry, clothing, container, creation, drink, food, gaethzen, gives light, hiding, housing, jewelry, juggle, lock, magic, <type> instrument, quest, tie, toy, tack, writing, <guild> style, <race> style Comma-separated list for category inclusion.

With regard to the guild/race styles, only list them if the item has a specific use for that group, or a person ignorant of the source of the item would believe the item is styled for that guild or race.

"tie" indicates the item is a tie item.

uses # The number of bites, sips, drinks, waves, etc.
weight # Weight in stones ("-" will disable).
lsize # Length of the outside of object as determined with MEASURE. If this is a container, make sure to CLOSE before you measure.
hsize # Height of the outside of object as determined with MEASURE.
wsize # Width of the outside of object as determined with MEASURE.
ilsize # Length of the inside of container as determined with MEASURE. Ensure the container is OPEN before measuring.
ihsize # Length of the inside of container as determined with MEASURE.
iwsize # Length of the inside of container as determined with MEASURE.
csize # Weight capacity as determined with MEASURE.
wearloc -, generic, eye, eyes, ear, ears, head, hair, eyebrow, nose, neck, chest, shirt, shirt-, arms, upper arm, wrist, hands, finger, back, shoulder, shoulders, abdomen, waist, belt, legs, thigh, pants, ankles, feet, tail Where the item is worn. "-" indicates the item is not worn.
maxcharge # maximum mana that can be held by the item (used with cambrinth, gaethzen, etc).
spellcast spell The spell cast by the item.
appcost # The cost given by an expert (Trader preferred) appraisal. Given in Kronars. ("-" will disable)
sourcetype -, sold by, other Gives the appropriate display of the source of the item. When set to "-", sources are automatically handled using sloot references on the source page. Set this to "other" when manually listing a source (see below).
source (source)+(source version 2)+... Where the item comes from (e.g. <player1> and <player2>'s wedding). This should only be used with an "other" sourcetype (see above).
cost # Kronars/Dokoras/Lirums Price at preceeding store, including currency. This field is optional.
list A way to change how an item is listed in categories.
rare true, false Used to explicitly declare that an item is not commonly available at a shop or creature drop.
htype doors, free, knoll, tree, interior, furniture, decoration, pet, bed, misc, storage, chair, armor stand, weapon stand, fireplace, fuel, wall, wind chime, bird house A space for listing an items housing properties. See Property:Housing item type.

Page Creation

You can copy/paste below when creating a new Item: page. See values above for the values for each entry.

{{Item
|name=
|look=
|MTag=
|CTag=
|STag=
|noun=
|type=<can be a list separated by ",">
|uses=
|weight=
|lsize=
|hsize=
|wsize=
|ilsize=
|ihsize=
|iwsize=
|csize=
|wearloc=
|maxcharge=
|spellcast=
|appcost=
|sourcetype=
|source=
|cost=
}}