Difference between revisions of "Template:Gametip/doc"

Revision as of 22:27, 4 July 2007

The Gametip template creates a text box containing a general tip for the game. Tips can be Hero-specific, Villain-specific, or generic.

{{Gametip | Game=game_id | Tip=tip_text}}

where:

game_id

Indicates whether the tip is specific to Heroes, specific to Villains, or generic.

For Hero-specific tips, set this value to "hero".
For Hero-specific tips, set this value to "vill".
For Hero-specific tips, set this value to "both". (This is also the default format.)

tip_text

The text of the game tip.

{{Gametip|Game=hero|Tip=This will create a Hero-specific game tip.}}

{{{tip}}}

{{Gametip|Game=vill|Tip=This will create a Villain-specific game tip.}}

{{{tip}}}

@@ Line 1: / Line 1: @@
-{{Gametip|Game=hero|Tip=a blue box for hero specific tips}}
+The Gametip template creates a text box containing a general tip for the game.  Tips can be Hero-specific, Villain-specific, or generic.
-{{Gametip|Game=vill|Tip=a red box for villain specific tips}}
-{{Gametip|Game=both|Tip=a gray box for tips that apply to both}}
-(I need more documentation here, but I'm not done fine-tuning yet.)
+==Syntax==
+'''<nowiki>{{</nowiki>Gametip | Game='''''game_id''''' | Tip='''''tip_text'''''<nowiki>}}</nowiki>
+where:
+'''game_id'''
+: Indicates whether the tip is specific to Heroes, specific to Villains, or generic.
+:* For Hero-specific tips, set this value to "'''hero'''".
+:* For Hero-specific tips, set this value to "'''vill'''".
+:* For Hero-specific tips, set this value to "'''both'''".  (This is also the default format.)
+'''tip_text'''
+: The text of the game tip.
+==Examples==
+<nowiki>{{Gametip|Game=hero|Tip=This will create a Hero-specific game tip.}}</nowiki>
+{{Gametip|Game=hero|Tip=This will create a Hero-specific game tip.}}
+<nowiki>{{Gametip|Game=vill|Tip=This will create a Villain-specific game tip.}}</nowiki>
+{{Gametip|Game=vill|Tip=This will create a Villain-specific game tip.}}
+<nowiki>{{Gametip|Game=both|Tip=This will create a generic game tip.}}</nowiki>
+{{Gametip|Game=both|Tip=This will create a generic game tip.}}