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

Template:Flag: Difference between revisions

From ModEnc
Jump to navigation Jump to search
Testing new and improved version
Crimsonum (talk | contribs)
Added missing closing p tags
 
(53 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<div style="position: relative; top: -1em; left: 0em;">
<includeonly><div style="position:relative;">
{| class="template_modbar_table gamegallery"
{| class="template_modbar_table gamegallery"
|[[Image:Game_td_{{ #ifeq: {{{td}}} | yes | yes | no }}.png|Tiberian Dawn]]
|[[Image:Game_td_{{#switch:{{{td}}}|yes|true|1=yes|no}}.png|Tiberian Dawn]]
|[[Image:Game_co_{{ #ifeq: {{{co}}} | yes | yes | no }}.png|The Covert Operations]]
|[[Image:Game_co_{{#switch:{{{co}}}|yes|true|1=yes|no}}.png|The Covert Operations]]
|[[Image:Game_ra_{{ #ifeq: {{{ra}}} | yes | yes | no }}.png|Red Alert]]
|[[Image:Game_ra_{{#switch:{{{ra}}}|yes|true|1=yes|no}}.png|Red Alert]]
|[[Image:Game_cs_{{ #ifeq: {{{cs}}} | yes | yes | no }}.png|Counterstrike]]
|[[Image:Game_cs_{{#switch:{{{cs}}}|yes|true|1=yes|no}}.png|Counterstrike]]
|[[Image:Game_am_{{ #ifeq: {{{am}}} | yes | yes | no }}.png|Aftermath]]
|[[Image:Game_am_{{#switch:{{{am}}}|yes|true|1=yes|no}}.png|Aftermath]]
|[[Image:Game_ts_{{ #ifeq: {{{ts}}} | yes | yes | no }}.png|Tiberian Sun]]
|[[Image:Game_ts_{{#switch:{{{ts}}}|yes|true|1=yes|no}}.png|Tiberian Sun]]
|[[Image:Game_fs_{{ #ifeq: {{{fs}}} | yes | yes | no }}.png|Firestorm]]
|[[Image:Game_fs_{{#switch:{{{fs}}}|yes|true|1=yes|no}}.png|Firestorm]]
|[[Image:Game_ets_{{ #ifeq: {{{ets}}} | yes | yes | no }}.png|Extended Tiberian Sun]]
|[[Image:Game_hp_{{#switch:{{{hp}}}|yes|true|1=yes|no}}.png|HyperPatch|32px]]
|[[Image:Game_ra2_{{ #ifeq: {{{ra2}}} | yes | yes | no }}.png|Red Alert 2]]
|[[Image:Game_ra2_{{#switch:{{{ra2}}}|yes|true|1=yes|no}}.png|Red Alert 2]]
|[[Image:Game_yr_{{ #ifeq: {{{yr}}} | yes | yes | no }}.png|Yuri's Revenge]]
|[[Image:Game_yr_{{#switch:{{{yr}}}|yes|true|1=yes|no}}.png|Yuri's Revenge]]
|[[Image:Game_rp_{{ #ifeq: {{{rp}}} | yes | yes | no }}.png|RockPatch]]
|[[Image:Game_ares_{{#switch:{{{ares}}}|yes|true|1=yes|no}}.png|Ares]]
|[[Image:Game_gen_{{ #ifeq: {{{gen}}} | yes | yes | no }}.png|Generals]]
|[[Image:Game_gen_{{#switch:{{{gen}}}|yes|true|1=yes|no}}.png|Generals]]
|[[Image:Game_zh_{{ #ifeq: {{{zh}}} | yes | yes | no }}.png|Zero Hour]]
|[[Image:Game_zh_{{#switch:{{{zh}}}|yes|true|1=yes|no}}.png|Zero Hour]]
|[[Image:Game_tw_{{ #ifeq: {{{tw}}} | yes | yes | no }}.png|Tiberium Wars]]
|[[Image:Game_tw_{{#switch:{{{tw}}}|yes|true|1=yes|no}}.png|Tiberium Wars]]
|[[Image:Game_kw_{{#switch:{{{kw}}}|yes|true|1=yes|no}}.png|Kane's Wrath]]
|}
|}
{|align="left" width="100%" cellspacing="0" cellpadding="0" class="template_flag" height="100%"
{|align="left" width="100%" cellspacing="0" cellpadding="0" class="template_flag" height="100%"
Line 21: Line 22:
|{{{name|{{PAGENAME}}}}}
|{{{name|{{PAGENAME}}}}}
|-
|-
|'''Files:'''
|'''File(s):'''
|{{{files|{{Categ|Rules(md).ini}}}}}
|{{{files|{{Categ|ini=rules}}}}}
|-
|-
|'''[[Help:Values|Values]]:'''
|'''Values:'''
|{{{values|ERROR - No value type set! Please [{{fullurl:{{FULLPAGENAME}}|action=edit}} edit] this page and fix the [[Template:Flag|Flag template]]! <includeonly>[[Category:Flags missing value types]]</includeonly>}}}
|{{{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>
|-{{#if:{{{special|}}}|<br />
{{!}}'''Special Values:'''
{{!}}'''Special Values:'''
{{!}}{{{special}}}
{{!}}{{{special}}}
{{!}}- }}{{#if: {{{default|}}} |<br>
{{!}}-}}{{#if:{{{default|}}}|<br />
{{!}}'''Default:'''
{{!}}'''Default:'''
{{!}}{{{default}}}
{{!}}{{{default}}}
{{!}}- }}
{{!}}-}}{{#if:{{{extver|}}}|<br />
|'''Applicable to:'''
{{!}}'''Extension Version:'''
|{{{types|{{Categ|InfantryTypes}}, {{Categ|VehicleTypes}}, {{Categ|AircraftTypes}}, {{Categ|BuildingTypes}}}}}{{ #ifeq: {{{deezire}}} | yes | <br>
{{!}}{{{extver}}}
{{!}}-}}{{#if:{{{types|}}}|<br />
{{!}}'''Applicable to:'''
{{!}}{{{types}}}|[[Category:Flags missing object types they can be applied to]]}}{{#ifeq:{{{deezire}}}|yes|<br />
{{!}}-
{{!}}-
{{!}}colspan="2" style="background-color: #FF8888"{{!}}<p style="font-size: 85%; padding: 0.1em;">'''This entry was copied from [[DeeZire's Red Alert 2 and Yuris Revenge INI Editing Guide]] 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|this]].</p> }}{{ #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:#ff8888"{{!}}<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 />
{{!}}-
{{!}}-
{{!}}'''Warning:'''
{{!}}colspan="2" style="background-color:#ff8888"{{!}}<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 />
{{!}}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.<includeonly>[[Category:Flags with import-generated subpages]]</includeonly>|}}
{{!}}-
|}</div>{{clr}}
{{!}}colspan="2" style="background-color:#ff8888"{{!}}<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 />
<includeonly>[[Category:INI Flags]]</includeonly>
{{!}}-
<noinclude>Usage:
{{!}}colspan="2" style="background-color:#ff8888"{{!}}<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 />
<pre>{{Flag
{{!}}-
|name=
{{!}}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 />
|files=
{{!}}-
|values=
{{!}}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 />
|special=
{{!}}-
|default=
{{!}}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 />
|types=
{{!}}-
|games
{{!}}style="background-color:#ff5e5e"{{!}}'''Warning:'''
}}</pre>
{{!}}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]]|}}
{| cellpadding="4" class="table_descrow" style="float: right;"
|}{{clr}}[[Category:INI_Flags]]<br /></includeonly><noinclude>
!Code
{{Doc}}</noinclude>
!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:<br>
*'''name:''' The exact name of the flag (Defaults to page name)
*'''files:''' In which files this flag can be used (Defaults to {{rules}})
*'''values:''' Possible values/[[Help:Values|value types]]
*'''special:''' Special values, if any (like -1 for unlimited)
*'''default:''' The default value for this flag
*'''types:''' Where you can use this flag (Defaults to all *Types]]
*'''games:''' In which games this flag is usable. To select a game, add a parameter in the form of code=yes to your template call, e.g. yr=yes. A list of available codes is to the right of this text.{{clr}}
==Notes==
*If there is no value for special or default, do not set anything.
*If a value begins with a - (minus), prefix it with &amp;nbsp;.
*This template is intended to be put directly at the page's beginning - no extra horizontal lines, to empty lines, nothing. Either relocate the TOC via <nowiki>__TOC__</nowiki> or disable it entirely via <nowiki>__NOTOC__</nowiki>.
<br>Template includes [[:Category:INI Flags]] automatically.
<br><br>
''See example usages [[Ammo|here]] and [[ButtonList|here]].''
</noinclude>

Latest revision as of 20:35, 3 April 2024

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

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.