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
(Should fix the link colour this time...)
(Adding support for HyperPatch.)
Line 8: Line 8:
 
|[[Image:Game_ts_{{#switch:{{{ts}}}|yes|true|1=yes|no}}.png|Tiberian Sun]]
 
|[[Image:Game_ts_{{#switch:{{{ts}}}|yes|true|1=yes|no}}.png|Tiberian Sun]]
 
|[[Image:Game_fs_{{#switch:{{{fs}}}|yes|true|1=yes|no}}.png|Firestorm]]
 
|[[Image:Game_fs_{{#switch:{{{fs}}}|yes|true|1=yes|no}}.png|Firestorm]]
 +
|[[Image:Game_hp_{{#switch:{{{hp}}}|yes|true|1=yes|no}}.png|HyperPatch]]
 
|[[Image:Game_ra2_{{#switch:{{{ra2}}}|yes|true|1=yes|no}}.png|Red Alert 2]]
 
|[[Image:Game_ra2_{{#switch:{{{ra2}}}|yes|true|1=yes|no}}.png|Red Alert 2]]
 
|[[Image:Game_yr_{{#switch:{{{yr}}}|yes|true|1=yes|no}}.png|Yuri's Revenge]]
 
|[[Image:Game_yr_{{#switch:{{{yr}}}|yes|true|1=yes|no}}.png|Yuri's Revenge]]
Line 46: Line 47:
 
{{!}}colspan="2" style="background-color:#8A2BE2"{{!}}<p style="font-size:100%; padding:0.1em">'''[[Image:Game_rp_yes.png]]{{co|This flag is part of the |white}}<b>[[RockPatch]]</b>. [[Category:RockPatch Flags]]}}{{#ifeq:{{{aresflag}}}|yes|<br />
 
{{!}}colspan="2" style="background-color:#8A2BE2"{{!}}<p style="font-size:100%; padding:0.1em">'''[[Image:Game_rp_yes.png]]{{co|This flag is part of the |white}}<b>[[RockPatch]]</b>. [[Category:RockPatch Flags]]}}{{#ifeq:{{{aresflag}}}|yes|<br />
 
{{!}}-
 
{{!}}-
{{!}}colspan="2" style="background-color:#0E2765"{{!}}<p style="font-size:100%; padding:0.1em;color:#E0E8FB">'''[[Image:Game_ares_yes.png]]This flag is part of <b>[[Ares|{{Co|Ares|white}}]]</b>. Do not use it without Ares installed. [[Category:Ares Flags]]}}{{#ifexpr:{{#ifexist:{{PAGENAME}}_I|1|0}} or {{#ifexist:{{PAGENAME}}_II|1|0}} or {{#ifexist:{{PAGENAME}}_III|1|0}} or {{#ifexist:{{PAGENAME}}_IIII|1|0}}|<br />
+
{{!}}colspan="2" style="background-color:#0E2765"{{!}}<p style="font-size:100%; padding:0.1em;color:#E0E8FB">'''[[Image:Game_ares_yes.png]]This flag is part of <b>[[Ares|{{Co|Ares|white}}]]</b>. Do not use it without Ares installed. [[Category:Ares Flags]]}}{{#ifeq:{{{hpflag}}}|yes|<br />
 +
{{!}}-
 +
{{!}}colspan="2" style="background-color:#F0C420"{{!}}<p style="font-size:100%; padding:0.1em">'''[[Image:Game_hp_yes.png]]This flag is part of <b>[[HyperPatch]]</b>. Do not use it without HyperPatch installed. [[Category:HyperPatch Flags]]}}{{#ifexpr:{{#ifexist:{{PAGENAME}}_I|1|0}} or {{#ifexist:{{PAGENAME}}_II|1|0}} or {{#ifexist:{{PAGENAME}}_III|1|0}} or {{#ifexist:{{PAGENAME}}_IIII|1|0}}|<br />
 
{{!}}-
 
{{!}}-
 
{{!}}style="background-color:#ff5e5e"{{!}}'''Warning:'''
 
{{!}}style="background-color:#ff5e5e"{{!}}'''Warning:'''
Line 68: Line 71:
 
  {{!}}rponly=
 
  {{!}}rponly=
 
  {{!}}aresflag=
 
  {{!}}aresflag=
 +
{{!}}hpflag=
 
  {{!}}''games''
 
  {{!}}''games''
 
  }}
 
  }}
Line 84: Line 88:
 
; <code>rponly</code> : If this is a flag introduced in the RockPatch, add this.
 
; <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>aresflag</code> : If this is a flag introduced in [[Ares]], add this.
 +
; <code>hpflag</code> : If this flag is introduced by [[HyperPatch]], add this.
  
 
===Parameter Codes for ''games''===
 
===Parameter Codes for ''games''===
Line 110: Line 115:
 
|<code>fs</code>
 
|<code>fs</code>
 
|{{fs}}
 
|{{fs}}
 +
|-
 +
|<code>hp</code>
 +
|{{hp}}
 
|-
 
|-
 
|<code>ra2</code>
 
|<code>ra2</code>

Revision as of 16:32, 18 April 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=
|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.
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.