Help:Template: Difference between revisions

From the Super Mario Wiki, the Mario encyclopedia
Jump to navigationJump to search
(→‎Code: break before finishing with this...)
Line 18: Line 18:
Make sure you know the MediaWiki syntax for a template:
Make sure you know the MediaWiki syntax for a template:


===Creating a template===
To create a template, it's needed to put the tittle starting '''Template''' and then the name of the template. Example: '''Template:Name of template'''  
To create a template, it's needed to put the tittle starting '''Template''' and then the name of the template. Example: '''Template:Name of template'''  


Add the content you want to show for the template in the edit area.  
Add the content you want to show for the template in the edit area. To insert an input, type <tt><nowiki>{{{1}}}</nowiki></tt> for the first input, <tt><nowiki>{{{2}}}</nowiki></tt> for the second, and so on. You can also specify the input by inserting a name like this <tt><nowiki>{{{name}}}</nowiki></tt>.


Once you've finished, it's possible that you have to use the coding <tt><nowiki><includeonly> </includeonly></nowiki></tt> to tag the content of the template that will be shown and <tt><nowiki><noinclude> </noinclude></nowiki></tt> to tag the rest that shouldn't be shown. Usually the Noinclude tag is used to add the template's own category and prevent to be inserted in an article.
Once you've finished, it's possible that you have to use the coding <tt><nowiki><includeonly> </includeonly></nowiki></tt> to tag the content of the template that will be shown and <tt><nowiki><noinclude> </noinclude></nowiki></tt> to tag the rest that shouldn't be shown. Usually the Noinclude tag is used to add the template's own category and prevent to be inserted in an article.


===Inserting a template===
To embed a template, simply type <tt><nowiki>{{Name of template}}</nowiki></tt> in a page.
*For an input, type '''<nowiki>{{{1}}}</nowiki>''' for the first input, '''<nowiki>{{{2}}}</nowiki>''' for the second, and so on.
**This can also be substituted with '''<nowiki>{{{value}}}</nowiki>''' or another name.
*For current page information, type '''<nowiki>{{NAMESPACE}}</nowiki>''' for the page's namespace, and '''<nowiki>{{PAGENAME}}</nowiki>''' for the page's name.
**These will be inserted and changed as the location of the template changes.


Make sure you know how to use the template once it's been created:
If the template is in any other namespace, simply type <tt><nowiki>{{namespace:Name of template}}</nowiki></tt> to use it.
*If the template is in a '''Template:''' namespace, simply type '''<nowiki>{{its name}}</nowiki>''' to use it.
 
*If the template is in any other namespace, simply type '''<nowiki>{{Namespace:its name}}</nowiki>''' to use it.
If the template has inputs, type <tt><nowiki>{{Name of template|write here to change the parameters of a template}}</nowiki></tt>
*For an input, '''<nowiki>{{{1}}}</nowiki>''', type '''<nowiki>{{its name|input 1|input 2|etc...}}</nowiki>'''.
 
*For an input, '''<nowiki>{{{value}}}</nowiki>''', type '''<nowiki>{{its name|value = input 1}}</nowiki>'''.
If the template has specified inputs, type <tt><nowiki>{{Name of template|name=The name of something}}</nowiki></tt>


To include text in the template that you don't want to show up in pages that use it, such as:
To include text in the template that you don't want to show up in pages that use it, such as:

Revision as of 01:28, November 19, 2011

This article is under construction. Therefore, please excuse its informal appearance while it is being worked on. We hope to have it completed as soon as possible.

As in several wikis, the Super Mario Wiki provides templates that help the user to browse any information quickly and efficiently.

Usage

To understand their usage, the templates existing in this Wiki are classified in this way:

  • Navigation Templates – These templates has links that are directly or indirectly related to a topic. A good example can be the {{SMG}} template that shows all the elements related to the game Super Mario Galaxy.
  • Notice Templates – These templates serve to notice readers the current state of a page. Arguably the most used templates found in this category are the {{stub}} and {{upcoming}} templates. The first describes a page or article needs to be deeply developed and the latter talks about a future project, like a new game.
  • Formatting Templates – These templates allow users to change elements of a page quickly by just adding them. Examples are the {{color}} template to change the color of the text and {{refneeded}} the add over a text that lacks a citation to make it valid.
  • Infobox Templates – These templates contain the essential information about the topic of an article. Examples are {{Character-infobox}} and {{Infobox}}.
  • Internal Link Templates – Similar to Formatting Templates, but made for the links.
  • Media Templates – These templates serve to contain media such as images, videos and audio files.
  • Project Templates – These templates are made for the internal projects of this Wiki, for example The 'Shroom and the Pipe Plaza.
  • Userbox Templates – These templates are decorative tables to describe our users in the Mariowiki. Used only for your userpages.
  • Image Maps – These templates has an image with links. By cliking on an linked area of the image, the user will be sent to the article in question.

Code

Make sure you know the MediaWiki syntax for a template:

To create a template, it's needed to put the tittle starting Template and then the name of the template. Example: Template:Name of template

Add the content you want to show for the template in the edit area. To insert an input, type {{{1}}} for the first input, {{{2}}} for the second, and so on. You can also specify the input by inserting a name like this {{{name}}}.

Once you've finished, it's possible that you have to use the coding <includeonly> </includeonly> to tag the content of the template that will be shown and <noinclude> </noinclude> to tag the rest that shouldn't be shown. Usually the Noinclude tag is used to add the template's own category and prevent to be inserted in an article.

To embed a template, simply type {{Name of template}} in a page.

If the template is in any other namespace, simply type {{namespace:Name of template}} to use it.

If the template has inputs, type {{Name of template|write here to change the parameters of a template}}

If the template has specified inputs, type {{Name of template|name=The name of something}}

To include text in the template that you don't want to show up in pages that use it, such as:

  • Instructions on how to use the template
  • A category to organize the template

Place the text in a set of <noinclude> tags at the bottom of the template page.

Substituting

For some templates, it is a better idea to take load off the server and use subst: before the template name. This substitutes the dynamic code on the page with static text. For example, {{tick}} will display as {{tick}} in the code, while {{subst:tick}} will display as [[File:wiki tick.GIF]] in the code.

Example

Here is a simple example, creating a signature for any user typing {{Sig|User}}:

If the template contains the code:
[[User:{{{1}}}|{{{1}}}]] ([[User talk:{{{1}}}|talk]] · [[Special:Contributions/{{{1}}}|edits]])
Typing {{Sig|user}} inserts this code:
[[User:User|User]] ([[User talk:User|talk]] · [[Special:Contributions/User|edits]])
Which shows on the page as:
User (talk · edits)