Help:Templates

From MeritBadgeDotOrg

Revision as of 17:30, September 2, 2007 by RWSmith (Talk | contribs)
Jump to: navigation, search

Contents

An introduction to templates

In MediaWiki, a template is a page which can be inserted into another page via a process called transclusion.

Except where otherwise specified herein, the following resources should be referenced for guidance in creating templates on MeritBadgeDotOrg:

The template namespace is the namespace with prefix "Template:". A page in this namespace is called a template. The contents of such a page is designed to be useful for insertion in other pages (transclusion, creating a compound document).

Usage

Templates are useful for any text for which one wants a copy in two or more pages, and there is no need for each copy to be edited independently to adapt it to the page it is in. Since parameters can be used, versions may to that extent even be different, and parameter values can be edited independently for each. Templates are not only convenient, but they can also "force" a useful uniformity.

Ambiguity of a reference to "this page"

If a page is included in another page, a reference to "this page" on the included page is ambiguous. Use noinclude or includeonly tags depending on what is meant. Alternatively, mention the page name explicitly, without using {{PAGENAME}}.

Location

  • All MeritBadgeDotOrg templates must reside in the "Template:" namespace.
  • Personal user templates, however, should reside in User:"Username"/Template/"Template name"

Prefixing templates from "external" wikia

Templates on the central Wikia work in the separate Wikia projects, provided that the prefix "wikia:" is used, see shared templates on wikia. (Please note that these external Wikia projects are NOT hosted and managed by the Wikimedia Foundation.) --Please do not attempt this! All templates running on MeritBadgeDotOrg must reside on MeritBadgeDotOrg.

Transclustions in templates

Transclusion across projects, hence changing contents from a central place, is only possible:

  • for content in the form of an image on Commons, to any page,
  • for editable content on an image page on Commons, including content transcluded from other pages on Commons, to the corresponding local image pages, if there is no local image with the same name. --Porting images from WikiCommons into templates on MeritBadgeDotOrg is perfectly acceptable.

Template substitutions

Template Talk

The talk page of a composition page is used to talk about the composition and the page in general, and could in addition be a composite page of the talk pages of the component pages.

Noinclude and includeonly

  • Anything between <noinclude> and </noinclude> will be processed and displayed only when the page is being viewed directly; it will not be included or substituted. *The converse is <includeonly>. Text between <includeonly> and </includeonly> will be processed and displayed only when the page is being included.

Tagging Templates

For the time being, all templates on MeritBadgeDotOrg should include the following tag (preferably, at the bottom of the template):

<<noinclude>[[Category:Templates|{{PAGENAME}}]]</noinclude>

This will add all templates to the template category.

If you are interested in helping out with or colaborating on Templates, please do so on the Help_talk:Templates page.

Tagging Shortcuts

The Shortcut template also contains the following:

<<includeonly>[[Category:Shortcuts|{{PAGENAME}}]]</includeonly>

This will add all shortcuts (that reference the Shortcut template) to the Shortcut category.

If you are interested in helping out with or colaborating on Shortcuts, please do so on the Help_talk:Shortcuts page.

See also

Internal

External

Wikipedia:Template messages

Personal tools
language