ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.

Template:Flag

From ModEnc
Revision as of 23:08, 22 May 2008 by Vinifera7 (talk | contribs) (Attention ModEnc editors! For increased consistency, please review updated usage notes!)
Jump to navigation Jump to search

This template generates a standardized flag header.

Usage

A separate flag header should be used for each context the flag is used in. Distinct contexts include files and sections where flag usage differs. For example, Template:TTL is used in rules(md).ini for SuperWeaponTypes, sound(md).ini for VocTypes, and eva(md).ini for VoxTypes. This ensures that contextual flag usage is documented with accuracy.

This template includes Category:INI Flags automatically.

{{Flag
|name=
|files={{ini|ini-name|catinc=yes}}
|values={{values|value-type}}
|special=
|default=
|types=
|games
}}
Code Game Code Game
td Tiberian Dawn co The Covert Operations
ra Red Alert cs Counterstrike
am Aftermath ts Tiberian Sun
fs Firestorm ets Extended Tiberian Sun
ra2 Red Alert 2 yr Yuri's Revenge
rp RockPatch gen Generals
zh Zero Hour tw Tiberium Wars

Copy-paste the code above and fill out the parameters as follows:

name
The exact name of the flag. Defaults to {{PAGENAME}}.
files
Which file the flag can be used in. Template:Ini, with the catinc parameter set to yes, should be used for consistency. Defaults to {{ini|rules|catinc=yes}}.
values
Possible values the flag accepts. Template:Values should be used for consistency.
special
Special values, if any. For example, −11 is a special value for Template:TTL. This parameter is optional2.
default
The default value for the flag. This parameter is optional2.
types
The sections the flag pertains to.
games
Which games the flag is parsed in. To select a game, add a parameter in the form of code=yes. For example, yr=yes indicates that the flag is parsed in Yuri's Revenge. A list of available codes is to the right of this text.

Notes

1 For negative numbers, − should be used for the sign instead of a hyphen.

2 If there is no explicit value, do not set this parameter.