Template:Descriptions/Store/Documentation

From Zelda Wiki, the Zelda encyclopedia

Purpose

Stores official descriptions of a subject, for use by Template:Descriptions.

Usage

{{Descriptions/Store
|game= 
|descriptionType= 
|subject= 
|context= 
|image= 
|subjectDisplayName= 
|description= 
}}
ParameterStatusDescription
gamerequiredA game code from Data:Franchise.
descriptionTyperequiredThe type of description, e.g. Inventory.
subjectrequiredA wiki article name referring to the subject being described.
contextoptionalIf the given subject has multiple descriptions of the same type in game, use this field to describe when the given description appears.
imageoptionalA wiki file name referring to the image that accompanies the description, if applicable.
subjectDisplayNameoptionalThe name of the subject as displayed alongside the description. Defaults to subject.
descriptionrequiredThe description of the subject.

No description.

Template parameters

ParameterDescriptionTypeStatus
gamegame

A game code from [[Data:Franchise]].

Stringrequired
descriptionTypedescriptionType

The type of description, e.g. <code>Inventory</code>.

Stringrequired
subjectsubject

A wiki article name referring to the subject being described.

Page namerequired
contextcontext

If the given subject has multiple descriptions of the same <code>type</code> in <code>game</code>, use this field to describe when the given description appears.

Contentoptional
imageimage

A wiki file name referring to the image that accompanies the description, if applicable.

Page nameoptional
subjectDisplayNamesubjectDisplayName

The name of the subject as displayed alongside the description. Defaults to <code>subject</code>.

Contentoptional
descriptiondescription

The description of the subject.

Contentrequired
This is the documentation page, it should be transcluded into the main template page. See here for more information.