Help:Templates
From OS-Tan Collections Wiki
div style=color:#000000; border:solid 1px #A8A8A8; padding:0.5em 1em 0.5em 0.7em; margin:0.5em 0.5em 0.5em 0.5em; background-color:#FFFFFF;font-size:95%; vertical-align:middle;
| Important note: When you edit this page, you agree to release your contribution into the Public domain. If you don't want this or can't do this because of license restrictions, please don't edit. This page is one of the Public Domain Help Pages, which can be freely copied into fresh wiki installations and/or distributed with MediaWiki software; see Help:Contents for an overview of all pages. |
noinclude/noinclude If you have standard texts you want to include on several pages, the MediaWiki template feature comes into play (like the tag above which is included in the pages of the Help namespace).
Contents |
Creating a template
Template names are prefixed with codeTemplate:/code, you create them like any other wiki page.
Using a template
Templates are wiki pages which can be used in other pages in three ways:
- codenowikiTemplate:Name/nowiki/code includes the current content of the page nowikiTemplate:Name/nowiki.
- codenowiki{{subst:Name}}/nowiki/code inserts the content of the page nowikiTemplate:Name/nowiki when you save your text.
- codenowiki[[:Template:Name]]/nowiki/code includes the template in raw wiki syntax, like codenowikilt;nowikigt;/nowiki/code does
Using parameters in templates
div style=float:right
| bgcolor=#A7C1F2 noinclude/noinclude colspan=2 align=center |Template with numbered parameters | |
|
prenowiki A little thank you...br smallfor {{{1}}}.br hugs, {{{2}}}/small /nowiki/pre | |
| bgcolor=#A7C1F2 noinclude/noinclude|You type | bgcolor=#A7C1F2 noinclude/noinclude|You get |
| codenowikiA little thank you...br
smallfor {{{reason}}}.br hugs, {{{signature}}}/small/nowiki/code |
A little thank you...br smallfor {{{reason}}}.br hugs, {{{signature}}}/small |
| bgcolor=#A7C1F2 noinclude/noinclude colspan=2 align=center |with named parameters | |
|
prenowiki A little thank you...br smallfor {{{reason}}}.br hugs, {{{signature}}}/small /nowiki/pre | |
| bgcolor=#A7C1F2 noinclude/noinclude|You type | bgcolor=#A7C1F2 noinclude/noinclude|You get |
| prenowikiA little thank you...br
smallfor all.br hugs, ~~~/small/nowiki/pre |
A little thank you...br smallfor all.br hugs, Kiso/small |
/div You can define parameters in templates either numbered as codenowiki{{{1}}}/nowiki/code or named codenowiki{{{param}}}/nowiki/code.
Example: you want a little thank you note you can put other users on their talk page with a reason and your signature. In the Template:Thankyou you enter your text.
When using the template on a page, you fill in the parameter values, separated by a pipe char (|): codenowikiA little thank you...br smallfor {{{reason}}}.br hugs, {{{signature}}}/small/nowiki/code or - if you have used named parameters codenowikiA little thank you...br smallfor all.br hugs, ~~~/small/nowiki/code. The advantage of using named parameters in your template is that they are flexible in order. It also makes the template easier to understand if you have many parameters. If you want to change the order of numbered parameters, you have to mention them explicitly: codenowikiA little thank you...br smallfor {{{reason}}}.br hugs, {{{signature}}}/small/nowiki/code.
Control template inclusion
You can control template inclusion by the use of codenowikinoinclude/nowiki/code and codenowikiincludeonly/nowiki/code tags.
Anything between codenowikinoinclude/nowiki/code and codenowiki/noinclude/nowiki/code will be processed and displayed only when the page is being viewed directly, not included.
Possible applications are:
- Categorising templates
- Interlanguage links to similar templates in other languages
- Explanatory text about how to use the template
The converse is codenowikiincludeonly/nowiki/code. Text between codenowikiincludeonly/nowiki/code and codenowiki/includeonly/nowiki/code will be processed and displayed only when the page is being included. The obvious application is to add all pages containing a given template to a category.
Note that the usual update problems apply -- if you change the categories inside a template, the categories of the referring pages won't be updated until those pages are edited.
Making templates useful
For templates to be effective users need to find them and be able to use them. Wiki are not user friendly when it comes to finding, using and working with templates. A simple technique is to have a usage on the template page. For example div style=display:table; width:auto;pre
Usage
Allows to establish a link to a subject: Template:NameOfTemplate /pre/div
The user can simply copy and paste the template to establish a new page that is similar to other pages. The example demonstrated is trival true, however a working example that demonstrates how templates can be used in complex situations to save time, accuracy and help categories pages on specialty topics more easily. see working example here
Also creating a Category:Template on your wiki to put your templates together may also be useful for editors along with links to this page will greatly improve productivity. example wiki category page
See Also
- Template uses
External links
| Template:Click | MetaWiki: Help:Template |
noinclude/noinclude /pre/div
Template
onlyincludediv class=LanguageLinks table width=100% style=clear: both; border: 1px solid #aaaaaa; border-collapse: collapse; padding: 0.2em; margin: 0; font-size: 85%; margin: 0 1px; tr valign=top style=background: #EEF3E2 td style=width: 25px; padding-left: 0.5em;File:Geographylogo.png/td td style=width: 10px; white-space: nowrap; padding: 4px 1em 0 0.5em; border-right: 1px solid #aaaaaa;Languages:nbsp;/tdtd style=padding: 1px 1em 0; background: #F6F9ED; English Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang Template:Languages/Lang /td/tr/table/div/onlyinclude
Syntax
nowikiPageName/nowiki
- PageName (optional) - the name of the page to display language links for. If omitted then the English version of the current page is used. This parameter can normally be omitted, as it is only required if you want to link to a page other than the one you place the template on, which is very uncommon. If this parameter is used on a sub-page make sure you supply the root name, not the full page name (e.g. on MediaWiki/fr you would need to use codenowikiMediaWiki/nowiki/code and not codenowikiMediaWiki/fr/nowiki/code).
Usage
The template should only be placed on pages that exist in more than one language, and it should be placed in the same location on each translation of the page.
The English version of a page is always the main version, with all other languages as sub-pages, named using the appropriate language code (see below).
For example, on the Main Page you would include the text codenowiki{{{Languages}}}/nowiki/code, both on Main Page itself, and on each of its language sub-pages. The template automatically creates links to any language sub-pages that exist, e.g. ttMain Page/jatt, ttMain Page/fr/tt, and ignores non-existant languages.
See Project:Language policy for further details about translating pages.
Supported languages
This shows you the name of each language's sub-page (using Main Page as an example). Other languages may be added easily as necessary. Please use the appropriate prefix, as used on Wikipedia when adding a new language. Please do not add languages for which no pages exist yet, as this will increase the time needed to include the template without adding any benefit (languages are only displayed to the user when the relevant page exists).
The link on the language names goes to the Wikipedia in that language. If no Wikipedia in your language exists, do not add pages in that language to MediaWiki.org! This wiki is not the place for language advocacy - please go through the correct channels, and once your language has a Wikipedia then please return to add content here.
| Page Name | Language |
|---|---|
| Main Page | English |
| Main Page/br | Breton |
| Main Page/de | German |
| Main Page/es | Spanish |
| Main Page/fi | Finnish |
| Main Page/fr | French |
| Main Page/it | Italian |
| Main Page/id | Indonesian |
| Main Page/he | Hebrew |
| Main Page/ja | Japanese |
| Main Page/ko | Korean |
| Main Page/no | Norwegian |
| Main Page/pl | Polish |
| Main Page/pt | Portugese |
| Main Page/ru | Russian |
| Main Page/sq | Albanian |
| Main Page/yue | Cantonese |
| Main Page/zh | Chinese |
| Main Page/zh-hans | Chinese (Simplified) |
| Main Page/zh-hant | Chinese (Traditional) |
Example
Here is how the language bar looks on the MediaWiki page: Template loop detected: Template:Languages
