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

Difference between revisions of "Template:Flag"

From ModEnc
Jump to: navigation, search
(Edited for Ares. Image not yet included due to upload errors.)
(Updating descriptions.)
Line 68: Line 68:
 
  {{!}}tsobsolete=
 
  {{!}}tsobsolete=
 
  {{!}}rponly=
 
  {{!}}rponly=
  {{!}}rp2only=
+
  {{!}}aresflag=
 
  {{!}}''games''
 
  {{!}}''games''
 
  }}
 
  }}
Line 83: Line 83:
 
; <code>ra2obsolete</code> : If this flag is obsolete in {{ra2}} and {{yr}}, then add this to include the Obsolete banner.
 
; <code>ra2obsolete</code> : If this flag is obsolete in {{ra2}} and {{yr}}, then add this to include the Obsolete banner.
 
; <code>tsobsolete</code> : Add this one instead of 'ra2obsolete' if the flag is obsolete in {{ts}} as well as {{ra2}} and {{yr}}
 
; <code>tsobsolete</code> : Add this one instead of 'ra2obsolete' if the flag is obsolete in {{ts}} as well as {{ra2}} and {{yr}}
; <code>rponly</code> : If this is a flag introduced in the RockPatch, add this.
+
; <code>aresflag</code> : If this is a flag introduced in [[Ares]], add this.
; <code>rp2only</code> : If this is a flag introduced in RockPatch2, add this.
 
  
 
===Parameter Codes for ''games''===
 
===Parameter Codes for ''games''===

Revision as of 14:30, 9 November 2008

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={{Categ|ini=ini-name}}, ...
|values={{values|value-type}}
|special=
|default=
|types={{Categ|section-name}}, ...
|ra2obsolete=
|tsobsolete=
|rponly=
|aresflag=
|games
}}

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:Categ, with {{{ini}}} set to the correct ini-name, should be used for consistency. Defaults to {{Categ|ini=rules}}.
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. Template:Categ should be used for consistency.
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.
ra2obsolete 
If this flag is obsolete in Red Alert 2 and Yuri's Revenge, then add this to include the Obsolete banner.
tsobsolete 
Add this one instead of 'ra2obsolete' if the flag is obsolete in Tiberian Sun as well as Red Alert 2 and Yuri's Revenge
aresflag 
If this is a flag introduced in Ares, add this.

Parameter Codes for games

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
kw Kane's Wrath

Notes

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

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