Difference between revisions of "Help:Templates"

From Data Crystal
Jump to navigation Jump to search
(Minor formatting changes and added the PSX template)
Line 2: Line 2:
  
 
One important feature of templates is their ability to take arguments. A template with no arguments is called as
 
One important feature of templates is their ability to take arguments. A template with no arguments is called as
  <nowiki>{{</nowiki>''template name''<nowiki>}}</nowiki>
+
  <nowiki>{{template_name}}</nowiki>
Note that the "Template:" part of the name is left out. To send arguments, one writes
+
Note that the "Template:" part of the name is left out. To send arguments, depending on how many the template receives, one writes
  <nowiki>{{</nowiki>''template name''|''argument1''=''value1''|''argument2''=''Some other value''<nowiki>}}</nowiki>
+
  <nowiki>{{template_name|argument_1=value_1|argument_2=value_2|...|argument_n=value_n}}</nowiki>
  
 +
==General Purpose Templates==
 
; [[:Template:Clear]] : Makes sure that the following text will not overlap any floats.
 
; [[:Template:Clear]] : Makes sure that the following text will not overlap any floats.
 
; [[:Template:Tl]] : Displays the name of a template as a link to that template.
 
; [[:Template:Tl]] : Displays the name of a template as a link to that template.
Line 13: Line 14:
 
; [[:Template:Moreinfo wikipedia]] : Makes a link to wikipedia to the page specified by the ''page'' variable given to the template.
 
; [[:Template:Moreinfo wikipedia]] : Makes a link to wikipedia to the page specified by the ''page'' variable given to the template.
  
===Type of Page Templates===
+
==Type of Page Templates==
 
These go at the top of every page of a certain type to provide a common look and categories as well as providing some basic information relating to the subject of the page.
 
These go at the top of every page of a certain type to provide a common look and categories as well as providing some basic information relating to the subject of the page.
  
Line 24: Line 25:
 
; [[:Template:Infobox hack]] : Should be at the top of all pages documenting ROM hacks. Takes many arguments, which are described on its [[Template talk:Infobox hack|talk page]].
 
; [[:Template:Infobox hack]] : Should be at the top of all pages documenting ROM hacks. Takes many arguments, which are described on its [[Template talk:Infobox hack|talk page]].
  
===Hacking Status Templates===
+
==Hacking Status Templates==
 
;[[:Template:Unhacked]] : No hacking has been preformed on this game. Accepts "name" as an argument.
 
;[[:Template:Unhacked]] : No hacking has been preformed on this game. Accepts "name" as an argument.
 
;[[:Template:Not Extensively Hacked]] : Very little hacking has been preformed on this game. Accepts "name" as an argument.
 
;[[:Template:Not Extensively Hacked]] : Very little hacking has been preformed on this game. Accepts "name" as an argument.
Line 31: Line 32:
 
;[[:Template:HackednessUnknown]] : A unknown amount of hacking has been preformed on this game. Accepts "name" as an argument.
 
;[[:Template:HackednessUnknown]] : A unknown amount of hacking has been preformed on this game. Accepts "name" as an argument.
  
===Game Series Templates===
+
==Game Series Templates==
 
; [[:Template: Final Fantasy Series]] : Should be on the bottom of all pages documenting Final Fantasy Games.
 
; [[:Template: Final Fantasy Series]] : Should be on the bottom of all pages documenting Final Fantasy Games.
 
; [[:Template: Pokémon Series]] : Should be on the bottom of all pages documenting all Pokémon Games.
 
; [[:Template: Pokémon Series]] : Should be on the bottom of all pages documenting all Pokémon Games.
Line 38: Line 39:
 
; [[:Template: Zelda Series]] : Should be on the bottom of all pages documenting Zelda Games.
 
; [[:Template: Zelda Series]] : Should be on the bottom of all pages documenting Zelda Games.
  
===Game Page Templates===
+
==Game Page Templates==
These are specialized type of page templates for game pages of different gaming systems. They contain information specific to the system like the mapper number for NES.
+
These are specialized type of page templates for game pages of different gaming systems. They contain information specific to the system.
  
 +
; [[:Template:GB]] : Should be at the top of all pages documenting [[Nintendo Game Boy|GB]] games. Takes many arguments, which are described on its [[Template talk:GBA|talk page]].
 +
; [[:Template:GBA]] : Should be at the top of all pages documenting [[Nintendo Game Boy Advance|GBA]] games. Takes many arguments, which are described on its [[Template talk:GBA|talk page]].
 +
; [[:Template:Genesis]] : Should be at the top of all pages documenting [[Sega Genesis|Genesis]] games. Takes many arguments, which are described on its [[Template talk:Genesis|talk page]].
 
; [[:Template:INES]] : Should be at the top of all pages documenting [[Nintendo Entertainment System|NES]] games. Takes many arguments, which are described on its [[Template talk:INES|talk page]].
 
; [[:Template:INES]] : Should be at the top of all pages documenting [[Nintendo Entertainment System|NES]] games. Takes many arguments, which are described on its [[Template talk:INES|talk page]].
 +
; [[:Template:PSX]] : Should be at the top of all pages documenting [[Sony PlayStation|PSX]] games. Takes many arguments, which are described on its [[Template talk:PSX|talk page]].
 
; [[:Template:SNES]] : Should be at the top of all pages documenting [[Super Nintendo Entertainment System|SNES]] games. Takes many arguments, which are described on its [[Template talk:SNES|talk page]].
 
; [[:Template:SNES]] : Should be at the top of all pages documenting [[Super Nintendo Entertainment System|SNES]] games. Takes many arguments, which are described on its [[Template talk:SNES|talk page]].
; [[:Template:Genesis]] : Should be at the top of all pages documenting [[Sega Genesis|Genesis]] games. Takes many arguments, which are described on its [[Template talk:Genesis|talk page]].
 
; [[:Template:GBA]] : Should be at the top of all pages documenting [[Nintendo Game Boy Advance|GBA]] games. Takes many arguments, which are described on its [[Template talk:GBA|talk page]].
 
; [[:Template:GB]] : Should be at the top of all pages documenting [[Nintendo Game Boy|GB]] games. Takes many arguments, which are described on its [[Template talk:GBA|talk page]].
 

Revision as of 14:32, 18 September 2010

Templates are special pages which reduce the need for writing the same thing multiple times. For general information on creating and using templates, see Meta-Wiki's page on templates. This page will list and explain the templates available on this wiki. Full information on a given template can be found on its talk page.

One important feature of templates is their ability to take arguments. A template with no arguments is called as

{{template_name}}

Note that the "Template:" part of the name is left out. To send arguments, depending on how many the template receives, one writes

{{template_name|argument_1=value_1|argument_2=value_2|...|argument_n=value_n}}

General Purpose Templates

Template:Clear
Makes sure that the following text will not overlap any floats.
Template:Tl
Displays the name of a template as a link to that template.
Template:Stub
Put at the bottom of a page to mark it as lacking in content. The page will be put into Category:Stubs.
Template:Unwritten
Same as stub, only it marks it as lacking of anything at all. The page will instead be put into a sub-category of Category:Stubs named Category:Unwritten.
Template:Unpopulated
Basicly Template:Stub or Template:Unwritten, only dealing with lists. The page will be added into a sub-category of Category:Stubs named Category:Unwritten.
Template:Moreinfo wikipedia
Makes a link to wikipedia to the page specified by the page variable given to the template.

Type of Page Templates

These go at the top of every page of a certain type to provide a common look and categories as well as providing some basic information relating to the subject of the page.

Template:Rommap
Should be at the top of every ROM map. Takes the argument game, which should be a wiki-link to the game which the page is a ROM map for.
Template:Rammap
Should be at the top of every RAM map. Takes the argument game, which should be a wiki-link to the game which the page is a RAM map for.
Template:TBL
Should be at the top of every Text Table. Takes the argument game, which should be a wiki-link to the game which the page is a Text Table for.
Template:Notes
Should be at the top of every Notes Page. Takes the argument game, which should be a wiki-link to the game which the page is a Notes Page for.
Template:Infobox table
Should be at the top of all pages documenting data tables. Takes many arguments, which are described on its talk page.
Template:Infobox utility
Should be at the top of all pages documenting ROM hacking utilities. Takes many arguments, which are described on its talk page.
Template:Infobox hack
Should be at the top of all pages documenting ROM hacks. Takes many arguments, which are described on its talk page.

Hacking Status Templates

Template:Unhacked
No hacking has been preformed on this game. Accepts "name" as an argument.
Template:Not Extensively Hacked
Very little hacking has been preformed on this game. Accepts "name" as an argument.
Template:Hacked
A moderate amount of hacking has been preformed on this game. Accepts "name" as an argument.
Template:Extensively Hacked
A great deal of hacking has been preformed on this game. Accepts "name" as an argument.
Template:HackednessUnknown
A unknown amount of hacking has been preformed on this game. Accepts "name" as an argument.

Game Series Templates

Template: Final Fantasy Series
Should be on the bottom of all pages documenting Final Fantasy Games.
Template: Pokémon Series
Should be on the bottom of all pages documenting all Pokémon Games.
Template: Super Mario Series
Should be on the bottom of all pages documenting Super Mario Games.
Template: Megaman Series
Should be on the bottom of all pages documenting Megaman Games.
Template: Zelda Series
Should be on the bottom of all pages documenting Zelda Games.

Game Page Templates

These are specialized type of page templates for game pages of different gaming systems. They contain information specific to the system.

Template:GB
Should be at the top of all pages documenting GB games. Takes many arguments, which are described on its talk page.
Template:GBA
Should be at the top of all pages documenting GBA games. Takes many arguments, which are described on its talk page.
Template:Genesis
Should be at the top of all pages documenting Genesis games. Takes many arguments, which are described on its talk page.
Template:INES
Should be at the top of all pages documenting NES games. Takes many arguments, which are described on its talk page.
Template:PSX
Should be at the top of all pages documenting PSX games. Takes many arguments, which are described on its talk page.
Template:SNES
Should be at the top of all pages documenting SNES games. Takes many arguments, which are described on its talk page.