View source for NeoDex:Templates

{{shortcut|[[ND:TMPS]]}}{{policy}}

'''Templates''' are special pages on the NeoDex that can be made to appear on any page - transclusion.  This is useful for when the same message has to be repeated on several pages, or to help break up pages like the [[Main Page]] for easier editing.

If a template is modified, all the pages carrying that template will update to the new version. 

==Using a template==
Templates exist in a special '''''Template:''''' namespace, much like this article exists in the '''''NeoDex:''''' namespace. This sets it apart from an actual article. If you want to link to a template, then you do so as you would any wikilink by enclosing ''Template:'' followed by the name of the article in double square brackets. 

To make a template appear on a page, you type the name of the template encased in double curly brackets - '''<nowiki>{{ ... }}</nowiki>'''. You do not include the ''Template:'' part of the name - for example, to import the protected (see below) template at [[Template:Protected]], you would type '''<nowiki>{{Protected}}</nowiki>'''. 

The first character of a template is not case sensitive, so '''<nowiki>{{protected}}</nowiki>''' and '''<nowiki>{{Protected}}</nowiki>''' will reference the same template. The rest of the characters are case sensitive, however, so '''<nowiki>{{pRoTeCtEd}}</nowiki>''' will reference a different template.

Some templates have variables, where you can fill in relevant details when you reference them. The lists below note where variables exist, how you complete them and with what. Variables are filled in by, after a template name, placing a vertical bar ('''|'''), then the variable name, then an equals sign, and then what the variable contains. To fill another variable, type another vertical bar, then it's variable name, an equals, and then what the variable should contain. 

On certain templates, numerical variables are used and the variable name can be omitted, providing the information is entered in the correct order. 

==Creating a Template==
''...to be added...''

==Article Status Templates==
These templates appear at the top of an article to denote something about it's status, rather than to provide any information about the subject of the article or what collections of articles it is involved in.  

===Construction===
<div align="center">
{|style="background-color:#ffffff;width:350px;height:80px;border:0;" cellpadding="0" cellspacing="0"
!style="width:80px;height:80px;" colspan="1" rowspan="2"|[[Image:Jubjub red sad.gif]]
!style="width:270px;height:10px;font-size:8pt;text-align:center;" colspan="1" rowspan="1"|This page is <span style="color:#d42815;">under construction</span>
|-
!style="width:270px;height:70px;font-size:8pt;text-align:center;background-color:#dddddd" colspan="1" rowspan="1"|<div style="vertical-align:middle">{{{reason}}}</div>
|}
</div>

[[Template:Construction]] is used to denote that a page needs some work. It is more specific that a stub (see below) in that it gives a list of tasks that need completing on the page. 

The Construction template includes the Under Construction category, so that when added to a page, the page is added to this category also. 

To add the Construction template to a document, use the following code:

'''<nowiki>{{construction|reason=}}</nowiki>'''

With the '''reason''' variable being filled with the reason why a page is under construction. 

----

===Currentevent===
{{currentevent}}

[[Template:Currentevent]] is used to denote that the page's subject is a current event, so is prone to rapid updates, delays, and changes as the event progresses. 

To add the Currentevent template to a document, use the following code:

'''<nowiki>{{currentevent}}</nowiki>'''

With no variables. 

----

===Deletion===
<div align="center">

{|style="width:500px;height:80px;" cellpadding="0" cellspacing="0"
!style="width:80px;height:80px;" rowspan="2" colspan="1"|[[Image:Deletionbin.gif]]
!style="width:420px;height:10px;background-color:#dfdfdf;font-size:10pt;"|This article has been nominated for DELETION:
|-
!style="width:420px,height:70px;background-color:#eaeaea;font-size:8pt;"|It may be redundant, unreferenced, or not sufficiently important for an article of its own. Discuss on the relevant talk page.<br /><span style="font-size:7pt;">Note: This template should not be used to tag articles created for vandalism purposes, etc.</span>
|}
</div>

[[Template:Deletion]] is used to note that an article had been nominated for deletion. A discussion of its pending removal will be found on the discussion page. 

To add the Deletion template to a document, use the following code:

'''<nowiki>{{deletion}}</nowiki>'''

With no variables. 

----

===Lowercase===
{{lowercase}}

[[Template:Lowercase]] is used when an article's name does not start with an uppercase letter, but technical restrictions means it must in the title of an article. 

It should not be used because a word ''could'' be spelt with a lowercase character, only if it ''must''. 

To add the Lowercase template to a document, use the following code:

'''<nowiki>{{lowercase|}}</nowiki>'''

After the vertical bar, the correct title should be written.  

----

===Merge===
{{merge}}

[[Template:Merge]] is used when it has been suggested an article be merged with another, because of its overlapping themes, or because it is duplicated. Details can be found on the appropriate discussion page. The merge template should appear on both articles involved in the merge. 

To add the Merge template to a document, use the following code:

'''<nowiki>{{merge|}}</nowiki>'''

After the vertical bar, the title of the other article (which it is suggested will merge into the article bearing the template or the article bearing the template be merged into) should be written. 

----

===PastFeatured===
{|style="height:33px;width:223px;background-color:transparent;color:#000000;" cellpadding="0" cellspacing="0" align="center"
!style="width:33px;"|[[Image:starmuffinmini.png]]
!style="width:190px;font-size:8pt;letter-spacing:2px;text-align:left;"|<p style="margin-top:2px;margin-left:5px;margin-right:0px;margin-bottom:-5px;">''Former Featured Article''</p><p style="margin-top:3px;margin-left:4px;margin-right:0px;margin-bottom:0px;font-weight:normal;font-size:7pt;letter-spacing:0px;font-family:Verdana;">( [[NeoDex:Featured Articles|list of featured articles]] )</p>
|}

[[Template:PastFeatured]] is displayed on all pages that were [[NeoDex:Featured Articles|featured articles]], to mark their achievement. 

To add the PastFeatured template to a document, use the following code:

'''<nowiki>{{PastFeatured}}</nowiki>'''

With no variables. 

----

===Policy===
{{policy}}

[[Template:Policy]] is used only on official policy pages, in conjunction to the page being protected. 

The Policy template is added with the following code:

'''<nowiki>{{policy}}</nowiki>'''

With no variables. 

----

===Protected===
{{protected}}

[[Template:Protected]] is used to mark when a page has been [[NeoDex:Protected page|protected]].

To add the Protected template to a document, use the following code: 

'''<nowiki>{{protected}}</nowiki>'''

With no variables. 

----

===ZeroTolerance===
{{ZeroTolerance}}

[[Template:ZeroTolerance]] is used to mark a page that has been designated a zero tolerance zone. This means that vandalism will be dealt with swiftly and with high punishments. 

The ZeroTolerance template is added with the following code:

'''<nowiki>{{ZeroTolerance}}</nowiki>'''

With no variables.

==Collection Templates==

These templates are added to the bottom of an article, above the article's categories, to show members of a similar family of, or a collection of related, articles. 

===Faerie===
{{faerie}}

[[Template:Faerie]] lists and links to all [[Faeries]] in [[Neopia]] and categorises them by their involvement in Neopia. It should be included at the end of every article about a Faerie or a class of Faeries. 

To add the Faerie template to a document, use the following code:

'''<nowiki>{{faerie}}</nowiki>'''

With no variables.  

----

===NQ2===
{{nQ2}}

[[Template:NQ2]] lists and links to the party members and the boss characters by Act for [[NeoQuest II]]. It should be included at the end of all NQII character articles.

To add the NQ2 template to a document, use the following code:

'''<nowiki>{{nQ2}}</nowiki>'''

With no variables. 

----

===TNT===
{{TNT}}

[[Template:TNT]] lists and links to all the members of [[The Neopets Team]]. It should be included at the end of the article pages of all TNT staff members. 

To add the TNT template to a document, use the following code:

'''<nowiki>{{TNT}}</nowiki>'''

With no variables.  

----

===Wheels===

{{wheels}}

[[Template:Wheels]] lists and links to all the Wheel games in Neopia. It should be included at the end of the game pages of the wheels. 

To add the Wheels template to a document, use the following code:

'''<nowiki>{{wheels}}</nowiki>'''

With no variables. 

----

===NQ1===
<br clear="all" />
{| class="collapsible collapsed" style="border: 5px solid #ffaa00;width:85%; -moz-border-radius-topright: 18px; -moz-border-radius-topleft: 18px; -moz-border-radius-bottomright: 18px; -moz-border-radius-bottomleft: 18px; background-color:#ffaa00; color:#000000;" align="center" cellspacing="0"
!style="text-align:center;background-color:transparent;color:#ffeeaa;"|'''NeoQuest I'''
|-
| style="background-color:#ffeeaa; text-align:center; font-size: 8pt; color: #000000; -moz-border-radius-topright: 12px; -moz-border-radius-topleft: 12px; -moz-border-radius-bottomright: 12px; -moz-border-radius-bottomleft: 12px;"|'''General'''<br />[[NeoQuest I]] '''�''' [[NeoQuest Hero|Hero]] '''�''' [[List of locations in NeoQuest I|Locations]] '''�''' [[List of NeoQuest I Enemies|Enemies]]
|- 
|cellpadding="0" height="3" style="background-color: transparent; color:#000000; font-size:2px;"|&nbsp;
|-
| style="background-color:#ffeeaa; text-align:center; font-size: 8pt; color: #000000; -moz-border-radius-topright: 12px; -moz-border-radius-topleft: 12px; -moz-border-radius-bottomright: 12px; -moz-border-radius-bottomleft: 12px;"|'''Bosses'''<br />[[Xantan|Xantan the Foul]] '''�''' [[Kreai]] '''�''' [[Gors the Mighty]] '''�''' [[Rollay Scaleback]] '''�''' [[Archmagus of Roo]] '''�''' [[Guardian of Fire Magic]] '''�''' [[Guardian of Ice Magic]] '''�''' [[Guardian of Shock Magic]] '''�''' [[Guardian of Spectral Magic]] '''�''' [[Guardian of Life Magic]] '''�''' [[Faleinn]] '''�''' [[Jahbal]] '''�''' [[Mastermind]] '''�''' [[Xantan|Xantan Reborn]]
|}

[[Template:NQ1]] lists and links to the main character's article and all the bosses in the game. It should be included at the end of every NQ1 related article.

To add the NQ1 template to a document, use the following code:

'''<nowiki>{{NQ1}}</nowiki>'''

With no variables.

----

===NQ2locations===
<div align="center">
{| id="toc" class="collapsible collapsed" style="border: 5px solid #ffeeaa; width:85%; -moz-border-radius-topright: 18px; -moz-border-radius-topleft: 18px; -moz-border-radius-bottomright: 18px; -moz-border-radius-bottomleft: 18px; background-color:#ffeeaa; color:#000000;" align="center" cellspacing="0
! style="text-align:center;background-color:transparent;color:#ffaa00;"| '''NeoQuest II Locations'''
|-
| style="background-color:#ffaa00; text-align:center; font-size: 8pt; color: #000000; -moz-border-radius-topright: 12px; -moz-border-radius-topleft: 12px; -moz-border-radius-bottomright: 12px; -moz-border-radius-bottomleft: 12px;"|
'''Act One ([[Meridell]]):'''<br />
[[Trestin Village]] � [[Dark Cave]] � [[White River City]] � [[Underground Cave]] �  [[Lost Island]] � [[Mysterious Tower]] � [[Lakeside]] � [[Lost City of Phorofor]] � [[Tower on The Hill]] � [[Seaside]] � [[Castle of Meridell]] � [[Ramtor's Tower]]

'''Act Two ([[Terror Mountain]]):'''<br />
[[Chia Oscuro]] � [[Damp Smelly Cave]] � [[Caves of Terror]] � [[Mountainside Inn]] � [[Happy Valley (NeoQuest II)|Happy Valley]] � [[Adventurers' Camp]] � [[Lost Caves]] � [[Mountain Top]]

'''Act Three ([[Lost Desert]]):'''<br />
[[Sakhmet (NeoQuest II)|Sakhmet]] � [[Temple of the Sky]] � [[Ruined Temple]] � [[Waset Village]] � [[Valley of Kings]] � [[Palace of Ancient Kings]] � [[Akhten-Ka]] � [[Zakharukh's Pyramid]]

'''Act Four ([[Haunted Woods]]):'''<br />
[[Shadow Gulch]] � [[Von Roo's Castle]] � [[Cave of Dark Things]] � [[Balthazar's Grove]] � [[Happy Fun Non-Haunted House]] � [[Nox's Fortress]] � [[Hubrid's Mountain Range]] � [[Esophagor's Swamp]]

'''Act Five ([[Faerieland]]):'''<br />
[[Northern Watchtower]] � [[The Underclouds]] � [[Cumulonimbus]] � [[Village of Cirrus]] � [[Faerie City (NeoQuest II)|Faerie City]] � [[Faerie Palace]]
|}
</div>

[[Template:NQ2locations]] lists and links to all the locations in [[NeoQuest II]]. It should be included at the end of every NQII location article. 

To add the NQ1 template to a document, use the following code:

'''<nowiki>{{NQ2locations}}</nowiki>'''

With no variables.

==Infobox Templates==

Infoboxes are templates designed to standardise how certain information is displayed, such as a [[Battledome]] character's statistics or information about a [[game]]. 

===BattleInfo===
{{BattleInfo}}

[[Template:BattleInfo]] is used to display the statistics of a 1-Player Battledome Challenger. It usually appears under the heading ''Battledome'' on a characters' page. 

To add the BattleInfo template to a document, use the following code:

'''<nowiki>{{BattleInfo|</nowiki><br />'''
'''|<br />'''
'''|<br />'''
'''|<br />'''
'''|<br />'''
'''|<br />'''
'''|8=<br />'''
'''|9=<br />'''
'''|10=<br />'''
}}<br />'''

The first variable to be entered into the template is the name of the Battledome character - the reason this is not automatically drawn from the article's name is because the character does not necessarily use the same name. 

The second variable is the location of the character's opponent pic, preferably uploaded onto the NeoDex.  The third variable is the date that the opponent was released in the battledome.  The fourth is the character's difficult rating, the fifth the number of HP they start with, the sixth the increment of the number of HP per win. The seventh variable is arena in which the character is fought, and ''8'' is the location of where the challenger is found. A URL link should be included if possible - the reason that the variable name is stated in this case is so that URLs can include equals signs without breaking. In the case of an automatic challenger, the phrase ''Automatic Challenger'' should be used instead.  "9" is Neopets' description of the challenger.

The tenth option is for the name of which arena the challenger fights in. It controls the colour scheme of the border. It should either be ''island'', ''space'', ''water'', ''stone'', ''snow'', ''tyrannian'' or ''battle''. If it is unspecified, it will default to ''battle''. See also this [[Template_talk:BattleInfo#Option_.238|worked example of 10th option using ''snow'']].

----

===Infobox Game===
{{Infobox Game}}

[[Template:Infobox Game]] is used to show basic information about a flash game. It should appear at the top of the article.

To add the Infobox Game template to a page, use the following code:

'''<nowiki>{{Infobox Game|GameImage=</nowiki><br />'''
'''|GameID=<br />'''
'''|World=<br />'''
'''|Categories=}}'''

In this template, the ''GameImage'' variable should hold the name of the Click-to-Play image of the game in question, uploaded to the NeoDex. The double square brackets and the namespace ''Image:'' is not needed. For naming conventions, see the [[NeoDex:Image use policy]].

The ''GameID'' variable should hold the identification number of a game. On the game's URL, this is the number at the end, after ''?game_id=''. The template uses this number to get the correct links to the High Score and game pages.

The ''World'' variable should be filled in with what world the game takes place in, and the ''categories'' variable needs the list of categories a game is allocated under, in the order they are displayed on the game page.
<br clear=all>

----

===Infobox NeoQuest===
{{Infobox NeoQuest}}

[[Template:Infobox NeoQuest]] is intended to display information about the NPCs in the game [[NeoQuest I]]. 

A description of how to use it along with two worked examples can be seen at [[Template talk:Infobox NeoQuest#Manual|the manual on the template's talk page]]. 

<br clear="all" />

----

===Infobox RetiredGame===
{{Infobox RetiredGame}}

[[Template:Infobox RetiredGame]] is used, like the Infobox Game template, to show information about a flash game, but this template is designed specifically for a retired game. It should be included in the History section of the replacement game where it talks about the past version, or on the article about the retired game itself if no replacement exists. 

To add the Infobox RetiredGame template to a page, use the following code: 

'''<nowiki>{{Infobox RetiredGame|GameImage=</nowiki>'''
'''|RetiredGame='''<br />
'''|GameID='''<br />
'''|World='''<br />
'''|Categories='''<br />
'''|GG_Y/N='''<br />
'''|Replacement=}}'''

The majority of the variables in this template work like their counterparts in the Infobox Game template above. The additions are: the ''RetiredGame'' variable, where the name of the retired game is entered (this is not drawn automatically as frequently information on retired games should be included with their successor); the ''GG_Y/N'' variable, which should hold "Yes" or "No" to indicate whether the game is available in the [[Game Graveyard]] or not; and the ''Replacement'' variable, which should hold the name of its successor, if applicable, "N/A", if not. 

If the game was retired before the new Game Room system was adopted, the old categories should be used in the ''Categories'' variable.
<br clear=all>

----

===NQ2Boss===
{{NQ2Boss}}

[[Template:NQ2Boss]] is used to display information about the boss enemies in [[NeoQuest II]]. 

To add the NQ2Boss template to a page, use the following code:

'''<nowiki>{{NQ2Boss|</nowiki>'''<br />
'''|'''<br />
'''|'''<br />
'''|'''<br />
'''|'''<br />
'''|'''<br />
'''|'''<br />
'''|}}'''<br />

The first variable to be entered into the template is the name of the boss character, then the URL or NeoDex Image code for the boss's picture. The third variable is the location of the box, and the next three variables are the boss [[HP]] on Normal, Evil and Insane modes. The seven variable should contain any special abilities the boss has, and the last should contain the reward for the party on beating the boss.

==Repetition Templates== 
These templates are used for when a certain section of text appears on multiple pages with some variations, such as names, for denoting a specific event or characteristic the character or object was involved in or possesses. These help ensure that the pages remain consistent. 

===BTY===
{{BTY}}

The BTY template is used to added [[Better Than You]] contestant information to a character's page.  The BTY info should be placed under a "Better Than You" heading on the character's article. One BTY template should be used each time that that character is featured on Better Than You.  This means that the BTY template may be used multiple time on the same page.  (See [[Scrap]] for an example.)

'''<nowiki>{{BTY|1|2|3|4|5}}</nowiki>'''

Where...

1 = Date the contestant was released<br>
2 = Contestant's quote<br>
3 = Game the contestant played<br>
4 = Score to beat<br>
5 = Prize for winning

===IPnote===
''...to be added...''

===Petpetinfo===
''...to be added...''

==Other Templates==

There are a some templates that don't fit into the above categories, but are still useful and are used. 

===Shortcut===
{{shortcut}}
<br clear="all" />
[[Template:Shortcut]] is used to display the shortcut redirect to a particular article on the ''NeoDex:'' namespace (i.e. policy pages). 

It is added with the following code:

'''<nowiki>{{shortcut|}}</nowiki>'''

With the variable after the vertical bar being the article shortcut, wikilinked - e.g., for this page, ''<nowiki>[[ND:TMPS]]</nowiki>''. If more than one shortcut exists, they can be added in the same variable, separated by <nowiki><br /></nowiki> line breaks, ''not'' added into a second shortcut template. 

===Stub===
''See also: [[Help:Stub]]''

''...to be added...''

===Spoiler===
''...to be added...''

[[category:Help]]