ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.
Template:Flag: Difference between revisions
Jump to navigation
Jump to search
Nighthawk200 (talk | contribs) Slight update to the template. |
Updated templates |
||
Line 41: | Line 41: | ||
{{!}}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 /> | {{!}}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 /> | ||
{{!}}- | {{!}}- | ||
{{!}}colspan="2" style="background-color:#ff8888"{{!}}<p style="font-size:85%; padding:0.1em;">'''[[Image:Cc_cnrdelete-all.png]]Logic related to {{ | {{!}}colspan="2" style="background-color:#ff8888"{{!}}<p style="font-size:85%; padding:0.1em;">'''[[Image:Cc_cnrdelete-all.png]]Logic related to {{f|{{PAGENAME}}}}, as a whole or in part, is ''obsolete'' in {{ra2}} and/or {{yr}}.[[Category:Obsolete]]}}{{#ifeq:{{{tsobsolete}}}|yes|<br /> | ||
{{!}}- | {{!}}- | ||
{{!}}colspan="2" style="background-color:#ff8888"{{!}}<p style="font-size:85%; padding:0.1em;">'''[[Image:Cc_cnrdelete-all.png]]Logic related to {{ | {{!}}colspan="2" style="background-color:#ff8888"{{!}}<p style="font-size:85%; padding:0.1em;">'''[[Image:Cc_cnrdelete-all.png]]Logic related to {{f|{{PAGENAME}}}}, as a whole or in part, is ''obsolete'' in {{ts}}, {{ra2}} and/or {{yr}}.[[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>. [[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 /> | ||
Line 54: | Line 54: | ||
==Usage== | ==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, {{ | 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, {{f|Type|link}} is used in {{ini|rules}} for [[SuperWeaponTypes]], {{ini|sound}} for [[VocTypes]], and {{ini|eva}} for [[VoxTypes]]. This ensures that contextual flag usage is documented with accuracy. | ||
This template includes [[:Category:INI Flags]] automatically. | This template includes [[:Category:INI Flags]] automatically. | ||
Line 77: | Line 77: | ||
; <code>files</code> : Which file the flag can be used in. [[Template:Categ]], with <nowiki>{{{ini}}}</nowiki> set to the correct ''ini-name'', should be used for consistency. Defaults to <code><nowiki>{{Categ|ini=rules}}</nowiki></code>. | ; <code>files</code> : Which file the flag can be used in. [[Template:Categ]], with <nowiki>{{{ini}}}</nowiki> set to the correct ''ini-name'', should be used for consistency. Defaults to <code><nowiki>{{Categ|ini=rules}}</nowiki></code>. | ||
; <code>values</code> : Possible [[Help:Values|values]] the flag accepts. [[Template:Values]] should be used for consistency. | ; <code>values</code> : Possible [[Help:Values|values]] the flag accepts. [[Template:Values]] should be used for consistency. | ||
; <code>special</code> : Special values, if any. For example, −1{{fnl|1}} is a special value for {{ | ; <code>special</code> : Special values, if any. For example, −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>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. |
Revision as of 06:42, 27 November 2009
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= |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.
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 |
ares
|
Ares |
gen
|
Generals |
zh
|
Zero Hour |
tw
|
Tiberium Wars |
kw
|
Kane's Wrath |
Notes
1 ↑ For negative numbers, −
should be used for the sign instead of a hyphen.
2 ↑ If there is no explicit value, do not set this parameter.