Template:Misc item page: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
No edit summary
m (blank the template example code, since all parameter documentation can already be found on this page.)
Line 58: Line 58:
This template generates entire pages for individual items of the following types: [[Ammunition]], [[Books]], [[Camp Supplies#Food]], [[Camp Supplies#Drinks]], [[Potions]], [[Scrolls]], [[Consumables]], and other [[Miscellaneous|Miscellaneous Items]]. For Weapons, see [[:Template:WeaponPage]]. For Equipment, see [[:Template:EquipmentPage]].
This template generates entire pages for individual items of the following types: [[Ammunition]], [[Books]], [[Camp Supplies#Food]], [[Camp Supplies#Drinks]], [[Potions]], [[Scrolls]], [[Consumables]], and other [[Miscellaneous|Miscellaneous Items]]. For Weapons, see [[:Template:WeaponPage]]. For Equipment, see [[:Template:EquipmentPage]].


Following is an example of usage with all possible template parameters shown. This describes a completely made-up potion.
'''See the bottom of this page for template parameter explanations. If you're ever unsure what to type, simply leave a parameter empty (don't remove it, as this may confuse other wiki editors).'''
 
Copy example values exactly as listed, including capitalization and plurals, if any. If you're ever unsure what to type, simply leave the parameter empty.


<pre>
<pre>
{{MiscItemPage
{{MiscItemPage
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| image = Potion of Poison Resistance Icon.png
| image =  
| description = {{uncommon|Potion of Stuff}} is an uncommon [[Potions|Potion]] that grants +1 to Stuff until the next [[Long Rest]]. <!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. -->
| description =  
| quote = The in-game flavour text in the item's tooltip.
| quote = The in-game flavour text in the item's tooltip.
| book text = <!-- The text of the book. Leave EMPTY for non-books - use "quote" parameter for all other item types. -->
| book text =  
| type = Potions <!-- Item type. Choose one of: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, Misc -->
| type =  
| camp supplies = <!-- Number of Camp Supplies. Leave EMPTY for all except Food and Drinks. -->
| camp supplies =  
| single use = <!-- "yes" if item is consumed on use (Ammunition, Consumables, Potions, Scrolls, some Drinks, and some Misc Items); otherwise leave BLANK. -->
| single use =  
| rarity = uncommon <!-- Choose from: common, uncommon, rare, very rare, legendary, story -->
| rarity =  
| weight kg = 0.5
| weight kg =  
| weight lb = 1.1
| weight lb =  
| price = 100
| price =  
| usage cost = bonus action <!-- The cost to use the item. Choose from: action, bonus action - or leave EMPTY for non-consumable items. -->
| usage cost =  
| effect = <!-- The effect(s) of the item when used or consumed. Leave EMPTY for non-consumable items. -->
| effect =  
* Stuff +1 until next [[Long Rest]]
| where to find =  
| where to find = <!-- Describe where and how to obtain the item. -->
This is a made-up item. You cannot obtain it anywhere in the game.
}}
}}
</pre>
</pre>


See here for the result of the above: [[Template:MiscItemPage/Example]]
Examples of template usage for various types of items: [[Template:MiscItemPage/Example]], [[Template:MiscItemPage/AmmunitionExample]], [[Template:MiscItemPage/BooksExample]], [[Template:MiscItemPage/FoodExample]], [[Template:MiscItemPage/ScrollsExample]]
 
Additional examples for other items types: [[Template:MiscItemPage/AmmunitionExample]], [[Template:MiscItemPage/BooksExample]], [[Template:MiscItemPage/FoodExample]], [[Template:MiscItemPage/ScrollsExample]]


[[Category:Page Generating Templates]] [[Category:Item Page Templates]]
[[Category:Page Generating Templates]] [[Category:Item Page Templates]]


Auto-generated TemplateData follows from this point on.
TemplateData documentation follows from this point on.


----
----

Revision as of 21:37, 2 August 2023

This template generates entire pages for individual items of the following types: Ammunition, Books, Camp Supplies#Food, Camp Supplies#Drinks, Potions, Scrolls, Consumables, and other Miscellaneous Items. For Weapons, see Template:WeaponPage. For Equipment, see Template:EquipmentPage.

See the bottom of this page for template parameter explanations. If you're ever unsure what to type, simply leave a parameter empty (don't remove it, as this may confuse other wiki editors).

{{MiscItemPage
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| image = 
| description = 
| quote = The in-game flavour text in the item's tooltip.
| book text = 
| type = 
| camp supplies = 
| single use = 
| rarity = 
| weight kg = 
| weight lb = 
| price = 
| usage cost = 
| effect = 
| where to find = 
}}

Examples of template usage for various types of items: Template:MiscItemPage/Example, Template:MiscItemPage/AmmunitionExample, Template:MiscItemPage/BooksExample, Template:MiscItemPage/FoodExample, Template:MiscItemPage/ScrollsExample

TemplateData documentation follows from this point on.


This template generates entire pages for individual items of the following types: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, and other Miscellaneous Items. For Weapons, see Template:WeaponPage. For Equipment, see Template:EquipmentPage.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
imageimage

The filename of the image/icon associated with this item.

Example
Potion of Fire Resistance Icon.png
Filesuggested
descriptiondescription

This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy.

Example
{{uncommon|Potion of Stuff}} is an uncommon [[Potions|Potion]] that grants +1 to Stuff.
Contentrequired
quotequote

The in-game flavour text in the item's tooltip.

Contentsuggested
book textbook text

The text within the book. Leave EMPTY for non-books - use "quote" parameter for tooltip flavour text.

Contentsuggested
where to findwhere to find

Describe where and how to obtain the item.

Example
Looted from [[NPC]] in [[Location]].
Contentsuggested
typetype

Item type. Choose one of: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, Misc

Suggested values
Ammunition Books Food Drinks Potions Scrolls Consumables Misc
Stringrequired
camp suppliescamp supplies

Number of Camp Supplies. Leave EMPTY for all except Food and Drinks.

Numbersuggested
rarityrarity

Rarity of the item. Choose from: common, uncommon, rare, very rare, legendary, story

Suggested values
common uncommon rare very rare legendary story
Default
common
Auto value
common
Stringrequired
weight kgweight kg

Weight of the item in kilograms

Numberrequired
weight lbweight lb

Weight of the item in pounds

Numberrequired
priceprice

Price/value of the item. When two values are listed on the tooltip, use the crossed out "true" value, not the adjusted buy/sell price.

Numberrequired
effecteffect

The effect(s) of the item when used or consumed. Leave EMPTY for non-consumable items.

Example
* Grants +1 to [[Stuff]] until next [[Long Rest]]
Contentsuggested
usage costusage cost

The cost to use the item. Choose from: action, bonus action - or leave EMPTY for non-consumable items.

Suggested values
action bonus action
Stringsuggested
single usesingle use

"yes" if item is consumed on use (Ammunition, Consumables, Potions, Scrolls, some Drinks, and some Misc Items); otherwise leave BLANK.

Suggested values
yes
Stringsuggested