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
m (HP image is a bit too big... let's see if this works.)
(Adding a field to be used with Ares and HP flags stating what version(s) the flag can be used in. Might come in handy.)
Line 33: Line 33:
 
{{!}}'''Default:'''
 
{{!}}'''Default:'''
 
{{!}}{{{default}}}
 
{{!}}{{{default}}}
 +
{{!}}-}}{{#if:{{{extver|}}}|<br />
 +
{{!}}'''Extension Version:'''
 +
{{!}}{{{extver}}}
 
{{!}}-}}{{#if:{{{types|}}}|<br />
 
{{!}}-}}{{#if:{{{types|}}}|<br />
 
{{!}}'''Applicable to:'''
 
{{!}}'''Applicable to:'''
Line 66: Line 69:
 
  {{!}}special=
 
  {{!}}special=
 
  {{!}}default=
 
  {{!}}default=
 +
{{!}}extver=
 
  {{!}}types={{Categ{{!}}''section-name''}}, ...
 
  {{!}}types={{Categ{{!}}''section-name''}}, ...
 
  {{!}}ra2obsolete=
 
  {{!}}ra2obsolete=
Line 82: Line 86:
 
; <code>special</code> : Special values, if any. For example, &minus;1{{fnl|1}} is a special value for {{f|Ammo|link}}. This parameter is optional{{fnl|2}}.
 
; <code>special</code> : Special values, if any. For example, &minus;1{{fnl|1}} is a special value for {{f|Ammo|link}}. This parameter is optional{{fnl|2}}.
 
; <code>default</code> : The default value for the flag. This parameter is optional{{fnl|2}}.
 
; <code>default</code> : The default value for the flag. This parameter is optional{{fnl|2}}.
 +
; <code>extver</code> : What version of the appropriate EXE extension (Ares or HyperPatch) is required before this flag can be used. This parameter should only be used if <code>rponly</code>, <code>aresflag</code> or <code>hpflag</code> is set to yes.
 
; <code>types</code> : The sections the flag pertains to. [[Template:Categ]] should be used for consistency.
 
; <code>types</code> : The sections the flag pertains to. [[Template:Categ]] should be used for consistency.
 
; <code>''games''</code> : Which games the flag is parsed in. To select a game, add a parameter in the form of <code>''code''=yes</code>. For example, <code>yr=yes</code> indicates that the flag is parsed in {{yr}}.
 
; <code>''games''</code> : Which games the flag is parsed in. To select a game, add a parameter in the form of <code>''code''=yes</code>. For example, <code>yr=yes</code> indicates that the flag is parsed in {{yr}}.

Revision as of 18:59, 10 August 2010

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, Type 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=
|extver=
|types={{Categ|section-name}}, ...
|ra2obsolete=
|tsobsolete=
|rponly=
|aresflag=
|hpflag=
|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 Ammo. This parameter is optional2.
default 
The default value for the flag. This parameter is optional2.
extver 
What version of the appropriate EXE extension (Ares or HyperPatch) is required before this flag can be used. This parameter should only be used if rponly, aresflag or hpflag is set to yes.
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
rponly 
If this is a flag introduced in the RockPatch, add this.
aresflag 
If this is a flag introduced in Ares, add this.
hpflag 
If this flag is introduced by HyperPatch, 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
hp HyperPatch
ra2 Red Alert 2
yr Yuri's Revenge
ares Ares
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.