Template:Enum value/doc

This is one of three helper templates for displaying enum values on anarticle. The templates {{Enum top}}, {{Enum value}}, and {{Enum bottom}} must always be used together to build a full table of values.

Usage

{{Enum top}}
{{Enum field|name|value|description}}
{{Enum bottom}}

Example

{{Enum top}}
{{Enum value|FGS_FirstClue|0x1}}
{{Enum value|FGS_HalfClues|0x2}}
{{Enum value|FGS_AllClues|0x4}}
{{Enum value|FGS_FirstVault|0x8}}
{{Enum value|FGS_SecondVault|0x10}}
{{Enum bottom}}

Name	Value	Description
FGS_FirstClue	0x1
FGS_HalfClues	0x2
FGS_AllClues	0x4
FGS_FirstVault	0x8
FGS::SecondVault	0x10

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Enum value

Used to indicate an enum value in an article.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
name	name 1	Name of the enum value	String	suggested
value	value 2	Numerical value	Number	suggested
description	description 3	Any notes on the enum value	String	optional

See also

• {{Enum top}}
• {{Enum bottom}}
• {{Struct field}}