Template:Flag: Difference between revisions

Latest revision as of 15:23, 13 April 2025

Template Documentation [View] [Edit] [History] [Help] [Refresh]

This document transclude from Template:Flag/doc.

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, −1¹ is a special value for Ammo. This parameter is optional².
`default`	The default value for the flag. This parameter is optional².
`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

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

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

@@ Line 1: / Line 1: @@
-'''Flag:''' {{{name}}}<br>
+<includeonly><div style="position:relative;">
-'''Values:''' {{{values}}}<br>
+{| class="template_modbar_table gamegallery"
-'''Special Values:''' {{{special}}}<br>
+|[[Image:Game_td_{{#switch:{{{td}}}|yes|true|1=yes|no}}.png|Tiberian Dawn]]
-'''Default:''' {{{default}}}<br>
+|[[Image:Game_ra_{{#switch:{{{ra}}}|yes|true|1=yes|no}}.png|Red Alert]]
-'''Works in Game(s):''' {{{games}}}<br>
+|[[Image:Game_ts_{{#switch:{{{ts}}}|yes|true|1=yes|no}}.png|Tiberian Sun]]
-----<br>
+|[[Image:Game_fs_{{#switch:{{{fs}}}|yes|true|1=yes|no}}.png|Firestorm]]
+|[[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]]
+|}
+{|align="left" width="100%" cellspacing="0" cellpadding="0" class="template_flag" height="100%"
+|-
+|'''Flag:'''
+|{{{name|{{PAGENAME}}}}}
+|-
+|'''File(s):'''
+|{{{files|{{Categ|ini=rules}}}}}
+|-
+|'''Values:'''
+|{{{values|ERROR &ndash; No value types set! Please <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit}} edit]</span> this page and fix the [[Template:Flag|Flag template]]![[Category:Flags missing value types]]}}}
+|-{{#if:{{{special|}}}|<br />
+{{!}}'''Special Values:'''
+{{!}}{{{special}}}
+{{!}}-}}{{#if:{{{default|}}}|<br />
+{{!}}'''Default:'''
+{{!}}{{{default}}}
+{{!}}-}}{{#if:{{{extver|}}}|<br />
+{{!}}'''Extension Version:'''
+{{!}}{{{extver}}}
+{{!}}-}}{{#if:{{{types|}}}|<br />
+{{!}}'''Applicable to:'''
+{{!}}{{{types}}}|[[Category:Flags missing object types they can be applied to]]}}{{#ifeq:{{{deezire}}}|yes|<br />
+{{!}}-
+{{!}}colspan="2" style="border: 3px solid #ff0000;{{!}}<p style="font-size:85%; padding:0.1em;">'''This entry was copied from {{theguide}} for the sake of completeness. As it is not our intention to rip off [[DeeZire]]'s work, this article is subject to a re-write and update with the latest community knowledge.'''</p><p style="font-size:x-small; padding:0.1em;">For further information, please read [[ModEnc:Inclusion of DeeZire's Red Alert 2 and Yuris Revenge INI Editing Guide|Inclusion of The Guide]].</p>}}{{#ifeq: {{{xgamer}}}|yes|<br />
+{{!}}-
+{{!}}colspan="2" style="border: 3px solid #ff0000"{{!}}<p style="font-size:85%; padding:0.1em;">'''This entry was copied from [[Red Alert 2 ART.INI Guide|XGamer's Red Alert 2 ART.INI Guide]] for the sake of completeness. As it is not our intention to rip off [[XGamer]]'s work, this article is subject to a re-write and update with the latest community knowledge.'''</p><p style="font-size:x-small; padding:0.1em;">For further information, please read [[ModEnc:Inclusion of XGamer's ART.INI Guide|Inclusion of ART.INI Guide]].</p>}}{{#ifeq:{{{ra2obsolete}}}|yes|<br />
+{{!}}-
+{{!}}colspan="2" style="border: 3px solid #ff0000"{{!}}<p style="font-size:85%; padding:0.1em;">'''[[Image:Cc_cnrdelete-all.png]]Logic related to {{tt|{{PAGENAME}}}}, as a whole or in part, is ''obsolete'' in {{ra2}} and/or {{yr}}.</p>[[Category:Obsolete]]}}{{#ifeq:{{{tsobsolete}}}|yes|<br />
+{{!}}-
+{{!}}colspan="2" style="border: 3px solid #ff0000"{{!}}<p style="font-size:85%; padding:0.1em;">'''[[Image:Cc_cnrdelete-all.png]]Logic related to {{tt|{{PAGENAME}}}}, as a whole or in part, is ''obsolete'' in {{ts}}, {{ra2}} and/or {{yr}}.</p>[[Category:Obsolete]]}}{{#ifeq:{{{rponly}}}|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>.</p>[[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.</p>[[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|32px]]This flag is part of <b>[[HyperPatch]]</b>. Do not use it without HyperPatch installed.</p>[[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:#ff8888"{{!}}One or more numbered subpages exist: {{ #ifexist: {{PAGENAME}}_I|[[{{PAGENAME}} I]]|}}{{ #ifexist: {{PAGENAME}}_II|, [[{{PAGENAME}} II]]|}}{{ #ifexist: {{PAGENAME}}_III|, [[{{PAGENAME}} III]]|}}{{ #ifexist: {{PAGENAME}}_IIII|, [[{{PAGENAME}} IIII]]|}}. These should be merged into ''this'' page. [[Category:Flags with import-generated subpages]]|}}
+|}{{clr}}[[Category:INI_Flags]]<br /></includeonly><noinclude>
+{{Doc}}</noinclude>