Difference between revisions of "Help:Templates"

Revision as of 09:52, 2 December 2014

So you want to know how to use templates? You're in the right place.

First off, to use a template you insert it's name in {{curly brackets}}. Most templates ask for parameters which are passed as so: {{eg|first argument|second|foo=named argument}}. You see the foo= part? That's a named argument, and is used for special parameters, such as the infobox field names.

Information boxes

The {{infobox}} templates are shown at the right-hand corner of articles, the display important facts and statistics which are common to group of articles. They are placed at the start of the article, and show a list of information down the right side of the article.

{{book}} includes information on the publisher and ISBN of a book
{{character}} includes information regarding the character
{{place}} information on a place, region, or building.
Full list of Infoboxes

Navigation boxes

Navboxes are footer templates that are placed at the bottom of a page to allow people to find related content.

{{cosmere}} inserts a table of links relating to Adonalsium and the Cosmere at large
{{books}} inserts a table of books and series' by Brandon Sanderson
{{Elantris}} contains major articles about Elantris
{{Mistborn}} has stuff about the Mistborn series
- {{Mistborn trilogy 1}}, {{Mistborn Adventures}} or {{Mistborn adventure game}} should be included on pages relaitng to those series
- {{Metallic arts}} inserts a table of the magics found on Scadrial
{{Stormlight}} is the best place to start looking at stuff from The Stormlight Archive
{{Warbreaker}} has lots of links about Warbreaker and Nightblood
Full list of Navbars

{{holder}} indicates the holder of a title or other thing, and possible predecessors and successors.

Link macros

{{demonym}} returns the correct demonym for a place
{{toponym}} returns correct toponyms

Citation templates

The following templates can be used to easily add references to different resources

{{17s ref}} will link to the 17th Shard forum
{{article ref}} will link to
{{bws ref}} link to any page on Brandon's site
{{book ref}} adds a chapter summary reference
{{annotation ref}} will link to an annotation on Brandon's site using the same parameters as {{book ref}}
{{epigraph ref}} links to the epigraph list
{{file ref}} easily link to a file uploaded to the coppermind
{{map ref}} link to a specific map on the coppermind
{{glossary ref}} link to a glossary section
{{qa ref}} refer to a Theoryland Interview Database question/answer
{{url ref}} link to a general url
{{tor ref}} link to a page on tor.com
{{tweet ref}} link to a tweet on twitter
{{wp ref}} refer to a wikipedia article

{{ref}} should be used to generate extra links to other named references

Editorial notations

These templates are used to

{{cite}} requests that someone insert a citation about the fact preceding it.
{{clarify}} asks someone edit the page to clear up ambiguous statements
{{disputed}} warn the reader that a fact may be incorrect or unverified

Navigation aids

These templates insert boxes or emphasised phrases that help users navigate the wiki correctly.

{{for}} helps users distinguish between similarly titled articles.

Notices

{{Notice}} templates insert boxes that alert users to information regarding the page its self.

{{attention}} requests that users edit it
{{copyright}} ask the user not to copy the content on the article
{{theory}} stipulates that the article or section should not be considered canon
{{spoilers}} warns users about new material they may not have read yet
{{delete}} and {{Move}} indicate possible administrative action
{{stub}} can be used to signify that an article is unfinished
{{complete}} should be used at the bottom of short articles when there is nothing more to add.

Other Templates

{{b}} converts an acronym or malformed book title into the correctly formatted title.
{{columns}} allows you to format a list (the first parameter) into count columns.
{{quote}} surrounds the first parameter as a block quote, with the second parameter as a source.

@@ Line 6: / Line 6: @@
 == Information boxes ==
-The {{t|Infobox}} templates are shown at the right-hand corner of articles, the display important facts and statistics which are common to group of articles. They are placed at the start of the article, and show a list of information down the right side of the article.
+The {{t|infobox}} templates are shown at the right-hand corner of articles, the display important facts and statistics which are common to group of articles. They are placed at the start of the article, and show a list of information down the right side of the article.
-* {{t|Book}} includes information on the publisher and ISBN of a book
+* {{t|book}} includes information on the publisher and ISBN of a book
-* {{t|Character}} includes information regarding the character
+* {{t|character}} includes information regarding the character
-* {{t|Place}} information on a place, region, or building.
+* {{t|place}} information on a place, region, or building.
-* [[:Category:Infoboxes|Full list of Infoboxes]]
+* [[:Category: Infoboxes|Full list of Infoboxes]]
 == Navigation boxes ==
 Navboxes are footer templates that are placed at the bottom of a page to allow people to find related content.
-*{{t|Cosmere}} inserts a table of links relating to [[Adonalsium]] and the [[Cosmere]] at large
+*{{t|cosmere}} inserts a table of links relating to [[Adonalsium]] and the [[Cosmere]] at large
-*{{t|Books}} inserts a table of books and series' by [[Brandon Sanderson]]
+*{{t|books}} inserts a table of books and series' by [[Brandon Sanderson]]
 *{{t|Elantris}} contains major articles about ''[[Elantris (book)|Elantris]]''
 *{{t|Mistborn}} has stuff about the ''[[Mistborn series]]''
@@ Line 28: / Line 28: @@
 *{{t|holder}} indicates the holder of a title or other thing, and possible predecessors and successors.
-== Link macros ==
+== [[:Category: Link macros|Link macros]] ==
 *{{t|demonym}} returns the correct [[Wikipedia: demonym|demonym]] for a place
 *{{t|toponym}} returns correct [[Wikipedia: toponym|toponyms]]
-== Citation templates ==
+== [[:Category: Reference templates|Citation templates]] ==
+The following templates can be used to easily add references to different resources
-{{t|Ref}} generates a reference which may use one of the below templates to generate it's content.
-**{{t|annotation}} links to a specific annotation
+* {{t|17s ref}} will link to the 17th Shard forum
-*{{t|tor}} links to a page on {{Tor|link=}}
+* {{t|article ref}} will link to
-*{{t|17s}} links to a topic on the {{17s|link=}}
+* {{t|bws ref}} link to any page on Brandon's site
-*{{t|twg}} links to a topic on the {{twg|link=}}
+* {{t|book ref}} adds a chapter summary reference
-*{{t|chapter}} links to a book or a specific chapter, page or section of a book
+* {{t|annotation ref}} will link to an annotation on Brandon's site using the same parameters as {{t|book ref}}
+* {{t|epigraph ref}} links to the epigraph list
+* {{t|file ref}} easily link to a file uploaded to the coppermind
+* {{t|map ref}} link to a specific map on the coppermind
+* {{t|glossary ref}} link to a glossary section
+* {{t|qa ref}} refer to a [[Theoryland Interview Database]] question/answer
+* {{t|url ref}} link to a general url
+* {{t|tor ref}} link to a page on tor.com
+* {{t|tweet ref}} link to a tweet on twitter
+* {{t|wp ref}} refer to a wikipedia article
+* {{t|ref}} should be used to generate extra links to other named references
 == Editorial notations ==
 These templates are used to
-*{{t|Cite}} requests that someone insert a citation about the fact preceding it.
+*{{t|cite}} requests that someone insert a citation about the fact preceding it.
-*{{t|Clarify}} asks someone edit the page to clear up ambiguous statements
+*{{t|clarify}} asks someone edit the page to clear up ambiguous statements
-*{{t|Disputed}} warn the reader that a fact may be incorrect or unverified
+*{{t|disputed}} warn the reader that a fact may be incorrect or unverified
 == Navigation aids==
 These templates insert boxes or emphasised phrases that help users navigate the wiki correctly.
-*{{t|For}} helps users distinguish between similarly titled articles.
+*{{t|for}} helps users distinguish between similarly titled articles.
 == [[:Category:Notices|Notices]] ==
 {{t|Notice}} templates insert boxes that alert users to information regarding the page its self.
-*{{t|Attention}} requests that users edit it
+*{{t|attention}} requests that users edit it
-*{{t|Copyright}} ask the user not to copy the content on the article
+*{{t|copyright}} ask the user not to copy the content on the article
-*{{t|Theory}} stipulates that the article or section should not be considered canon
+*{{t|theory}} stipulates that the article or section should not be considered canon
-*{{t|Spoilers}} warns users about new material they may not have read yet
+*{{t|spoilers}} warns users about new material they may not have read yet
-*{{t|Delete}} and {{t|Move}} indicate possible administrative action
+*{{t|delete}} and {{t|Move}} indicate possible administrative action
-*{{t|Stub}} can be used to signify that an article is unfinished
+*{{t|stub}} can be used to signify that an article is unfinished
-*{{t|Complete}} should be used at the bottom of short articles when there is nothing more to add.
+*{{t|complete}} should be used at the bottom of short articles when there is nothing more to add.
 == Other Templates ==
-*{{t|B}} converts an acronym or malformed book title into the correctly formatted title.
+*{{t|b}} converts an acronym or malformed book title into the correctly formatted title.
-*{{t|Columns}} allows you to format a list (the first parameter) into <code>count</code> columns.
+*{{t|columns}} allows you to format a list (the first parameter) into <code>count</code> columns.
-*{{t|Quote}} surrounds the first parameter as a block quote, with the second parameter as a source.
+*{{t|quote}} surrounds the first parameter as a block quote, with the second parameter as a source.