Template:Descriptions Table

From Zelda Wiki, the Zelda encyclopedia
Jump to navigation Jump to search

Purpose

An alternative to Template:Data Table/Descriptions capable of conveying multiple descriptions of a given subject and the contexts in which these descriptions appear. Descriptions are stored into the Descriptions Cargo table and used by description templates.

Usage

Required ParametersAll Parameters
{{Descriptions Table
|game= 
|descriptionSource= 
|subjectColumnName= 
|-
|
|
|
}}
{{Descriptions Table
|caption= 
|collapse= 
|game= 
|descriptionSource= 
|subjectColumnName= 
|descriptionColumnName= 
|contextOptional= 
|contextHidden= 
|imageType= 
|imageSize= 
|-
|
|
|
}}
ParameterRequired?Description
caption
OptionalA table caption.
collapse
OptionalCorresponds to the collapse parameter of Template:Data Table.
game
RequiredA game code.
descriptionSource
RequiredA name identifying the source of the descriptions, e.g. Inventory.
subjectColumnName
RequiredThe text to use for the first column, which contains the subjects of the descriptions.
descriptionColumnName
OptionalThe text to use for the column containing the description transcript. Defaults to Description.
contextOptional
OptionalWhen set to true, this prevents Template:When from being added for missing context.[a]
contextHidden
OptionalWhen set to true, this hides context values from the resulting table, while still storing them for use by Template:Descriptions.[a]
imageType
Optional

Corresponds to the fileType argument of the [Image] data table tag.

If both imageType and imageSize parameters are omitted, no image is added to the subject column.

imageSize
Optional

Corresponds to the fileSize argument of the [Image] data table tag.

If both imageType and imageSize parameters are omitted, no image is added to the subject column.

1 to N
(rows)
RequiredA 3-tuple:
  1. The page name of the wiki article on the subject being described. This can be a synonym redirect if the term used in the description is not the latest series term.
  2. A transcript of the description.
  3. Context information that describes where or when the above description appears.[b]
A fourth value can also be added which sets the section value of Template:Descriptions/Store.[a]

No description.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
captioncaption

A table caption.

Contentoptional
collapsecollapse

Corresponds to the <code>collapse</code> parameter of [[Template:Data Table]].

Contentoptional
gamegame

A [[:Category:Game codes|game code]].

Contentoptional
descriptionSourcedescriptionSource

A name identifying the source of the descriptions, e.g. <code>Inventory</code>.

Contentoptional
subjectColumnNamesubjectColumnName

The text to use for the first column, which contains the subjects of the descriptions.

Contentoptional
descriptionColumnNamedescriptionColumnName

The text to use for the column containing the description transcript. Defaults to <code>Description</code>.

Contentoptional
contextOptionalcontextOptional

When set to <code>true</code>, this prevents [[Template:When]] from being added for missing context.<span class="zw-list-note zw-list-note--alpha">[a]</span>

Contentoptional
contextHiddencontextHidden

When set to <code>true</code>, this hides context values from the resulting table, while still storing them for use by [[Template:Descriptions]].<span class="zw-list-note zw-list-note--alpha">[a]</span>

Contentoptional
imageTypeimageType

<p>Corresponds to the <code>fileType</code> argument of the <kbd>[Image]</kbd> [[Template:Data Table#Tags|data table tag]].</p><p>If both <code>imageType</code> and <code>imageSize</code> parameters are omitted, no image is added to the subject column.</p>

Contentoptional
imageSizeimageSize

<p>Corresponds to the <code>fileSize</code> argument of the <kbd>[Image]</kbd> [[Template:Data Table#Tags|data table tag]].</p><p>If both <code>imageType</code> and <code>imageSize</code> parameters are omitted, no image is added to the subject column.</p>

Contentoptional
  1. 1.0 1.1 1.2 At the time of writing, these parameters are used exclusively for Fi#Fi's Descriptions. See the source comments of the Fi page for more information.
  2. Context is only needed when there are multiple descriptions of the same subject that appear in different contexts. If a subject has multiple descriptions, context information is required for all except the first one. If context information is missing for such entries, Template:When is added to the entry. Context is not required for the first description as it is often implied by the contexts of the other entries.

Examples

InputOutputCategories added
{{Descriptions Table
|game= TP
|descriptionSource= Midna
|subjectColumnName= Enemy
|-
| Darknut
| [First description]
|-
| Darknut
| [Second description]
| When asked again
}}
EnemyDescription
[First description]
When asked again:
[Second description]
With images
{{Descriptions Table
|caption= Outfit Comments
|collapse= true
|game= TFH
|descriptionSource= Stylish Woman
|subjectColumnName= Outfit
|descriptionColumnName= Comment
|imageSize= 100x100px
|imageType= Render
|-
| Bear Minimum
| [Description]
|-
| Big Bomb Outfit
| [Description]
|-
| Boomeranger
| [Description]
}}
Outfit Comments
OutfitComment
[Description]
[Description]
[Description]
{{Descriptions Table
|game= TP
|descriptionSource= Midna
|subjectColumnName= Enemy
|-
| Darknut
| First description
<!-- Context not required -->
|-
| Darknut
| Second description
| <!-- Lacking context (third cell empty) -->
|-
| Darknut 
| Third description
<!-- Lacking context (third cell omitted) -->
}}
EnemyDescription
First description
Second description
Third description
The above documentation is transcluded from Template:Descriptions Table/Documentation. (edit | history)