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= }}
Parameter | Status | Description |
---|---|---|
game | required | A game code from Data:Franchise. |
descriptionType | required | The type of description, e.g. Inventory . |
subject | required | A wiki article name referring to the subject being described. |
context | optional | If the given subject has multiple descriptions of the same type in game , use this field to describe when the given description appears. |
image | optional | A wiki file name referring to the image that accompanies the description, if applicable. |
subjectDisplayName | optional | The name of the subject as displayed alongside the description. Defaults to subject . |
description | required | The description of the subject. |
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
game | game | A game code from [[Data:Franchise]]. | String | required |
descriptionType | descriptionType | The type of description, e.g. <code>Inventory</code>. | String | required |
subject | subject | A wiki article name referring to the subject being described. | Page name | required |
context | context | 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. | Content | optional |
image | image | A wiki file name referring to the image that accompanies the description, if applicable. | Page name | optional |
subjectDisplayName | subjectDisplayName | The name of the subject as displayed alongside the description. Defaults to <code>subject</code>. | Content | optional |
description | description | The description of the subject. | Content | required |
This is the documentation page, it should be transcluded into the main template page. See here for more information.