Help:Template

From Homestar Runner Wiki

Current revision as of 20:30, 14 February 2009

Wiki users can create and use templates. A template is a bit of code which any user can insert into any page of the wiki, to create a larger displayed piece of text which can be specialized for that inclusion. The template is created with both static text and variables such as "inputs" and "values". Here's the basics on how to create and use templates.

[edit] Creating a template

The template messages page contains a partial list of existing templates. Please check that page to be sure your idea for a template has not been done yet.

[edit] Usage

First, consider what the template would be used for. What would its purpose be? Some common uses are:

• A navigation template
• A notice template

[edit] Syntax

Make sure you know the MediaWiki syntax for a template:

• For an input, type {{{1}}} for the first input, {{{2}}} for the second, and so on. The user of the template will need to know which order the items should be listed when using the template.
  • In a more complicated template, where one might not easily remember the order of which input is which, this can be substituted with {{{value}}} or another more meaningful name, like {{{name}}} or {{{old page}}}. These can be used in any order, unlike numeric values.
• For current page information, type {{NAMESPACE}} for the page’s namespace, and {{PAGENAME}} for the page’s name. If you want both, type {{FULLPAGENAME}}.
  • These will be inserted and changed as the location of the template changes.

[edit] Including text in a template

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.

[edit] Text that will only be included in the target page

To include text in the pages that use the template, but not the template page itself, such as:

• A category relevant to the page in question, but not the template itself.
• Special Formatting text meant only for the page in question.

Place the text in a set of <includeonly> tags around the text in question.

[edit] Using a template

Make sure you know how to use the template once it’s been created:

• If the template is in a Template: namespace, simply type {{templatename}} to use it.
• If the template is in any other namespace, simply type {{Namespace:templatename}} to use it.

To add custom inputs to the rendering of the template, follow these simple instructions.

• For an input {{{1}}} or {{{2}}} etc., type {{templatename|input_1|input_2|etc...}}.
• For an input {{{value}}}, type {{templatename|value = input_for_value}}.

[edit] Substituting text for template

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, just typing {{tick}} will result in {{tick}} being added to the code, while typing {{subst:tick}} will result in, say, [[Image:wiki tick.GIF]] (or whatever the template's results are) being added to the code. Both will appear the same to the reader, but the latter one does not call up the template every time.

[edit] Example

Here is a simple example, creating a signature for any user typing {{Sig|User}}. (Note: This already exists as Template:user. There's no need to recreate this template again, this is just an example.)

First, let's say we want to have the result take the form "User (talk · edits)" where we link each word to the user's userpage, his talk page, and his contributions listing respectively.

As the user is putting their user name in as input 1, we can create a link to their userpage this way:

[[User:{{{1}}}|{{{1}}}]]

Similarly, a link to their talk page can be done like this:

[[User talk:{{{1}}}|talk]]

The way to do a link to the user's contributions is:

[[Special:Contributions/{{{1}}}|edits]]

So if the template contains the code:

[[User:{{{1}}}|{{{1}}}]] ([[User talk:{{{1}}}|talk]] · [[Special:Contributions/{{{1}}}|edits]])

then 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)

[edit] Shortcuts

Many commonly-used templates have shortcut versions which you can use. Here is a partial list.

• {{delete}} - {{d}}
• {{tobediscussed}} - {{tbd}}, {{tobedeleted}}, {{talktobedeleted}}, {{ttbd}}, {{merge}}, {{m}}, {{move}}, {{redirect}}, {{r}} (these were formerly separate functions that have since been combined)
• {{plainlinks}} - {{p}} or {{pl}}
• {{tl}} - {{t}} (for links to template pages)

[edit] See Also

• Category:HRWiki Templates - A categorized listing of all templates available for use in this wiki.