Template:Item/doc

From Realm 52
Revision as of 01:09, 18 November 2023 by Mkludt (talk | contribs)
Jump to navigation Jump to search

The Item template is for use in any article about a mundane item, magic item, or item enhancement within Realm 52.

Usage

Karthos' Little Green Book
A little green book that is owned by Karthos The Green
Item Information
Weight1/2 lb
ValuePriceless
RarityCommon
MagicalNon-magical
TypeBook
Owner
Karthos The Green



{{Suppress categories|
{{Infobox
 |name         = <text>
 |bodystyle    =
 |titlestyle   = 
 |abovestyle   = background:#a67c00;
 |subheaderstyle =
 |above        = <text>
 |imagestyle   = 
 |captionstyle = 
 |image        = [[File:image.jpg | 400 px]]
 |caption      = <text>
 |headerstyle  = background:#bf9b30;
 |labelstyle   = background:#ffdc73;
 |datastyle    = 
 |header1 = Basic Information
 | label2 = Race
 | data2 = <text>
 | label3 = Class
 | data3 = <text>
 | label4 = Age
 | data4 = <text>
 | label5 = Sex
 | data5 = <text>
 | label6 = Weight
 | data6 = <text>
 | label7 = Height
 | data7 = <text>
 | label8 = Alignment
 | data8 = <text>
 
 |header9 = Location
 | data10 = <text>
 | data11 = [[File:image.jpg | 400 px]]

 |header12 = Organizations
 | data13 = <text>

 |belowstyle = background:#bf9b30;
 |below      =  <optional text>
}}
}}

An example is shown to the right.


Parameters

All parameters (except "name") are optional. If left undefined, they will not appear.

Basic Information

image
The name of an image file. No link is required, but [[File:]] and [[Image:]] links should still work for backward compatibility.
caption
A description of the image, if the image is of something beyond just the what the name of the article implies (such as someone wielding the item). This field will be automatically italicized.
caption2
(Not shown above.) A second caption field that allows formatting, if necessary.
name
The proper name of the item or quality.
othernames
Any other proper names the item may have (whether in different cultures, languages, or editions).
nicknames
Any nicknames or slang names the item may have.
type
The type of item or quality (e.g. ring, weapon quality, armor, etc.).
creator
If this is a unique item, who was its creator?
location
If this item is created or sold by a specific vendor, or in a specific location, include that information here.
basicrefs
You may use this to put <ref> tags in the header so they don't clutter up the data area.

Rules Information

school
The school of the aura of a magic item, as listed in the source entry (for instance, winged boots have a transmutation aura, which can be sensed by way of detect magic). Disciplines of psionic auras and other magic systems may also go here.
level
List the caster level required to enchant the item.
value
The estimated value of this item in gold pieces, as listed in the source entry. The estimated value itself is an estimation of the market price (given that it is reasonable), not the cost of creation. For example, a powerful item may have a reasonable market price of 90,000 gp, but costs about half that price to make. In that case, the market price should be given in the infobox (the creation cost may also have a source entry, but is not used in the infobox). In addition, a merchant may hugely increase the price of their goods beyond the true market value. Also in that case, the the reasonable market price is used in the infobox. Everything else concerning the cost or value belongs in the article text.
rules
The edition of the D&D rules that this enhancement, enchantment, or item uses.

In the case of the item being included in multiple editions of the game, use the following edition-specific parameters. These can be used in lieu of the above four parameters.

value1e
The value of the item in 1st-edition D&D. Gold piece values can be placed here, e.g., "20,000 gp".
weight1e
The weight of the item in 1st-edition D&D.
school2e
The school of the aura of a magic item, as described above, in 2nd-edition D&D
level2e
The level of the item in 2nd-edition D&D.
value2e
The value of the item in 2nd-edition D&D.
weight2e
The weight of the item in 2nd-edition D&D.
school3e
The school of the aura of a magic item, as described above, in 3rd- and 3.5-edition D&D
casterlevel3e
The caster level of the aura of a magic item, as described above.
itemlevel3e
The item level of an item in 3.5-edition D&D (as introduced in the Magic Item Compendium and later 3.x sourcebooks.)
value3e
The value of the item in 3rd- and 3.5-edition D&D.
weight3e
The weight of the item in 3rd- and 3.5-edition D&D.
level4e
The level of an item in 4th-edition D&D. If the item has multiple possible levels, then list the lowest with a plus sign, as it appears in the source entry. For example, "4+".
value4e
The value of the item in 4th-edition D&D. If the item has multiple possible levels and values, then use a {{Plain table}}. For example, write {{plain table|Lvl 5|100 gp|Lvl 10|1,000 gp|Lvl 15|100,000 gp|Lvl 20|1,000,000 gp}} to produce:

Template:Plain table

weight4e
The weight of the item in 4th-edition D&D.
rarity5e
Rarity of the item in 5th-edition D&D. Values are Common, Uncommon, Rare, Very rare, Artifact Legendary and Unique. If the item comes has varieties that are different rarities, you can separate them by commas or use a {{Split table}} to make a nicely formatted list. A category will be automatically generated for each rarity in the list that it finds.
attunement5e
Some objects in 5th-edition require attunement before they can be fully used. Use Required here if the item can be attuned by anyone. If it is limited somehow, briefly describe the limitation, e.g., Dwarf only or Cleric only. Leave blank if the item does not require attunement.
school5e
The school of the aura of a magic item, as described above, in 5th-edition D&D
level5e
The level of the item in 5th-edition D&D.
value5e
The value of the item in 5th-edition D&D.
weight5e
The weight of the item in 5th-edition D&D.
refs1e, refs2e, refs3e, refs4e, refs5e
These parameters are used to put <ref> tags in the subtitle ("Rules Information") rather than have them clutter up value tables or appear in odd places in the infobox. Usually, all the item information comes from one source, but more can be added here as needed.

Sentient Items

The following parameters may be used for sentient or intelligent items from any edition. Setting any of these will place the page in Category:Sentient items unless nocat is used to suppress this feature.

communication
If the item is sentient, indicate how it communicates here. For example, "Telepathically", "Verbally," etc. (without the quotes).
languages
If the item communicates in some way, indicate which languages it knows.
alignment
If the item is sentient and has an alignment, indicate so here.
sentientrefs
You can place <ref> tags in the subtitle to avoid cluttering the data entries.
nocat
(Not shown above.) Set this to "true" to suppress the auto-generated category.