Help:TemplatesEdit This Page

From FamilySearch Wiki

(Difference between revisions)
(form)
 
m (added link)
 
(24 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{PD Help Page}}
+
{{Help article}}  
If you have standard texts you want to include on several pages, the MediaWiki template feature comes into play.
+
  
==Creation==
+
<br> If you have standard texts you want to include on several pages, the MediaWiki template feature comes into play.  
Templates are standard wiki pages whose content is designed to be [[wikipedia:Transclusion|transcluded]] (embedded) inside other pages. Templates follow a convention that the name is prefixed with "<code>Template:</code>", assigning it to that namespace. Therefore you can [[Help:Starting a new page|create them like any other wiki page]].
+
  
==Usage==
+
=== Creation  ===
Templates are wiki pages which can be used in other pages in three ways:
+
  
*<code><nowiki>{{Name}}</nowiki></code> 'transcludes' (i.e. includes a copy of) the content of the template (stored in the page <nowiki>[[Template:Name]]</nowiki>) whenever the page containing the template transclusion is fetched and displayed; i.e. if the template is later changed, the displayed transcluding page will automatically change too
+
Templates are standard wiki pages whose content is designed to be [[Help:Transclusion|transcluded]] (embedded) inside other pages. Templates follow a convention that the name is prefixed with "<code>Template:</code>", assigning it to that namespace. Therefore you can [[Help:How to create an article|create them like any other wiki page]].  
*<code><nowiki>{{subst:Name}}</nowiki></code> replaces that string with the contents of the template, in the source of the transcluding page, when you save that page; the copy of the template contents can then be edited normally (and separately from the original in the template page). To '''''Note''''': don't use this if you are looking to continually propagate changes from the source template to the page(s) that references it.
+
*<code><nowiki>{{msgnw:Name}}</nowiki></code> includes the template in a form that displays it as raw wiki syntax (the way <code><nowiki>&lt;nowiki&gt;</nowiki></code> does) when the page containing it is fetched.
+
  
In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:
+
=== Usage  ===
  
*<code><nowiki>{{Template:Pagename}}</nowiki></code>  includes <code><nowiki>[[Template:Pagename]]</nowiki></code>
+
Templates are wiki pages which can be used in other pages in three ways:  
*<code><nowiki>{{Foo:Pagename}}</nowiki></code>      includes <code><nowiki>[[Foo:Pagename]]</nowiki></code>
+
*<code><nowiki>{{:Pagename}}</nowiki></code>          includes <code><nowiki>[[Pagename]]</nowiki></code>
+
**<code><nowiki>{{subst::Pagename}}</nowiki></code>    replaces itself with the contents of <code><nowiki>[[Pagename]]</nowiki></code>
+
  
If no such namespace exists, the full title is assumed to be a template:
+
*<code><nowiki>{{Name}}</nowiki></code> 'transcludes' (i.e. includes a copy of) the content of the template (stored in the page <nowiki>[[Template:Name]]</nowiki>) whenever the page containing the template transclusion is fetched and displayed; i.e. if the template is later changed, the displayed transcluding page will automatically change too
 +
*<code><nowiki>{{subst:Name}}</nowiki></code> replaces that string with the contents of the template, in the source of the transcluding page, when you save that page; the copy of the template contents can then be edited normally (and separately from the original in the template page). To '''''Note''''': don't use this if you are looking to continually propagate changes from the source template to the page(s) that references it.
 +
*<code><nowiki>{{msgnw:Name}}</nowiki></code> includes the template in a form that displays it as raw wiki syntax (the way <code><nowiki><nowiki></nowiki></code> does) when the page containing it is fetched.
  
*<code><nowiki>{{Foo:Bar}}</nowiki></code>            includes <code><nowiki>[[Template:Foo:Bar]]</nowiki></code>
+
In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:  
  
===Parameters===
+
*<code><nowiki>{{Template:Pagename}}</nowiki></code> includes <code><nowiki>[[Template:Pagename]]</nowiki></code>
 +
*<code><nowiki>{{Foo:Pagename}}</nowiki></code> includes <code><nowiki>[[Foo:Pagename]]</nowiki></code>
 +
*<code><nowiki>{{:Pagename}}</nowiki></code> includes <code><nowiki>[[Pagename]]</nowiki></code>
 +
**<code><nowiki>{{subst::Pagename}}</nowiki></code> replaces itself with the contents of <code><nowiki>[[Pagename]]</nowiki></code>
 +
 
 +
If no such namespace exists, the full title is assumed to be a template:
 +
 
 +
*<code><nowiki>{{Foo:Bar}}</nowiki></code> includes <code><nowiki>[[Template:Foo:Bar]]</nowiki></code>
 +
 
 +
==== Parameters ====
 
<div style="float:right; margin:8px;">
 
<div style="float:right; margin:8px;">
{| {{Prettytable}}
+
{|
 
|-
 
|-
|{{Hl2}} colspan="2" align="center" |'''Template with numbered parameters'''
+
| colspan="2" align="center" | '''Template with numbered parameters'''
 
|-
 
|-
| colspan="2" |
+
| colspan="2" | <pre>  
<pre><nowiki>  
+
'''A little thank you...'''&lt;br /&gt;
'''A little thank you...'''<br />
+
&lt;small&gt;for {{{1}}}.&lt;br /&gt;
<small>for {{{1}}}.<br />
+
hugs, {{{2}}}&lt;/small&gt;
hugs, {{{2}}}</small>
+
</pre>
</nowiki></pre>  
+
 
|-
 
|-
|{{Hl2}}|'''You type'''
+
| '''You type'''  
|{{Hl2}}|'''You get'''
+
| '''You get'''
 
|-
 
|-
|<code><nowiki>{{Thankyou|all your hard work|Joe}}</nowiki></code>
+
| <code><nowiki>{{Thankyou|all your hard work|Joe}}</nowiki></code>  
|
+
|  
{{Thankyou|all your hard work|Joe}}
+
{{Thankyou|all your hard work|Joe}}  
 +
 
 
|-
 
|-
|{{Hl2}} colspan="2" align="center" |'''with named parameters'''
+
| colspan="2" align="center" | '''with named parameters'''
 
|-
 
|-
| colspan="2" |
+
| colspan="2" | <pre>  
<pre><nowiki>  
+
'''A little thank you...'''&lt;br /&gt;
'''A little thank you...'''<br />
+
&lt;small&gt;for {{{reason}}}.&lt;br /&gt;
<small>for {{{reason}}}.<br />
+
hugs, {{{signature}}}&lt;/small&gt;
hugs, {{{signature}}}</small>
+
</pre>
</nowiki></pre>  
+
 
|-
 
|-
|{{Hl2}}|'''You type'''
+
| '''You type'''  
|{{Hl2}}|'''You get'''
+
| '''You get'''
 
|-
 
|-
|<pre><nowiki>{{Thankyou
+
| <pre>{{Thankyou
|reason=all your hard work
+
&#124;reason=all your hard work
|signature=Joe}}</nowiki></pre>
+
&#124;signature=Joe}}</pre>  
|
+
|  
{{Thankyou|all your hard work|Joe}}
+
{{Thankyou|all your hard work|Joe}}  
 +
 
 
|}
 
|}
</div>
+
</div>  
You can define parameters in templates either numbered as <code><nowiki>{{{1}}}</nowiki></code> or named <code><nowiki>{{{param}}}</nowiki></code>. Please note that there are a set of three curly braces (<code><nowiki>{{{</nowiki></code> and <code><nowiki>}}}</nowiki></code>) around each parameter. This is different than normal template name usage.
+
<br> You can define parameters in templates either numbered as <code><nowiki>{{{1}}}</nowiki></code> or named <code><nowiki>{{{param}}}</nowiki></code>. Please note that there are a set of three curly braces (<code><nowiki>{{{</nowiki></code> and <code><nowiki>}}}</nowiki></code>) around each parameter. This is different than normal template name usage.  
  
'''Example:''' You want a little thank you note you can put on the talk page of other users. It will contain a reason and your signature. You could create [[Template:Thankyou]] to enter your text, as in the example in the table.
+
'''Example:''' You want a little thank you note you can put on the talk page of other users. It will contain a reason and your signature. You could create [[Template:Thankyou]] to enter your text, as in the example in the table.  
  
When using the template on a page, you fill in the parameter values, separated by a pipe char (|): <code><nowiki>{{Thankyou|all your hard work|Joe}}</nowiki></code>. For named parameters use "name=value" pairs separated by a pipe char:   <code><nowiki>{{Thankyou|reason=all your hard work|signature=Joe}}</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: <code><nowiki>{{Thankyou|2=Joe|1=all your hard work}}</nowiki></code>.
+
When using the template on a page, you fill in the parameter values, separated by a pipe char (|): <code><nowiki>{{Thankyou|all your hard work|Joe}}</nowiki></code>. For named parameters use "name=value" pairs separated by a pipe char: <code><nowiki>{{Thankyou|reason=all your hard work|signature=Joe}}</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: <code><nowiki>{{Thankyou|2=Joe|1=all your hard work}}</nowiki></code>.  
  
You can also provide default values for parameters, i.e. values that are going to be used if no value is provided for a parameter. For example, <code><nowiki>{{{reason|all your hard work}}}</nowiki></code> would result in ''"all your hard work"'' if no value was provided for the parameter <tt>reason</tt>.
+
You can also provide default values for parameters, i.e. values that are going to be used if no value is provided for a parameter. For example, <code><nowiki>{{{reason|all your hard work}}}</nowiki></code> would result in ''"all your hard work"'' if no value was provided for the parameter <tt>reason</tt>.  
  
===Control template inclusion===
+
==== Control template inclusion ====
You can control template inclusion by the use of <code><nowiki><noinclude></nowiki></code> and
+
<code><nowiki><includeonly></nowiki></code> tags.
+
  
Anything between <code><nowiki><noinclude></nowiki></code> and <code><nowiki></noinclude></nowiki></code> will be processed and
+
You can control template inclusion by the use of <code><nowiki><noinclude></nowiki></code> and <code><nowiki><includeonly></nowiki></code> tags.  
displayed only when the template's page is being viewed directly.
+
  
Possible applications are:
+
Anything between <code><nowiki><noinclude></nowiki></code> and <code><nowiki></noinclude></nowiki></code> will be processed and displayed only when the template's page is being viewed directly.
* Categorising templates
+
* Interlanguage links to similar templates in other languages
+
* Explanatory text about how to use the template
+
  
The converse is <code><nowiki><includeonly></nowiki></code>. Text between <code><nowiki><includeonly></nowiki></code> and <code><nowiki></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 [[Help:Categories|category]], without putting the template itself into that category.
+
Possible applications are:  
  
'''Note:''' when you change the categories applied by a template, the categorization of the pages that use that template may not be updated until some time later: this is handled by the {{mediawiki|Manual:Job queue|job queue}}.
+
*Categorising templates
 +
*Interlanguage links to similar templates in other languages
 +
*Explanatory text about how to use the template
  
===Organizing templates===
+
The converse is <code><nowiki><includeonly></nowiki></code>. Text between <code><nowiki><includeonly></nowiki></code> and <code><nowiki></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 [[Help:Categories|category]], without putting the template itself into that category.
For templates to be effective, users need to find them and be able to use them. A simple technique is to include an example on the template page.
+
 
For example:
+
{{Note|When you change the categories applied by a template, the categorization of the pages that use that template may not be updated until some time later: this is handled by the {{mediawiki|Manual:Job queue|job queue}}.}}
<div style="display:table; width:auto;"><pre>
+
 
<noinclude>
+
==== Documentation  ====
 +
 
 +
Documentation for users, together with the template's categories are normally placed after the template code, inside "noinclude" tags. It is normally necessary to put the opening "noinclude" tag immediately after the end of the code, with no intervening spaces or newlines, to avoid transcluding unwanted whitespace.
 +
 
 +
In the case of complex templates, the documentation (together with categories and wikilinks) is often kept on a separate [[Help:Subpages|subpage]] of the template page (named "Template:XXX/doc"). This also applies to many [[Help:Protected pages|protected]] templates (to allow the information to be edited by non-administrators). This is achieved by placing the {{tl|Documentation}} template after the main template code (within "noinclude" tags). If the "/doc" subpage does not exist, a link will then appear enabling it to be created.
 +
 
 +
==== Organizing templates ====
 +
 
 +
For templates to be effective, users need to find them and be able to use them. A simple technique is to include an example on the template page. For example:  
 +
<div style="width: auto; display: table"><pre>&lt;noinclude&gt;
 
== Usage ==
 
== Usage ==
 
Allows to establish a link to a subject:
 
Allows to establish a link to a subject:
<nowiki>{{NameOfTemplate|Term1+Term2+Term3}}</nowiki>
+
{{NameOfTemplate|Term1+Term2+Term3}}
</noinclude>
+
&lt;/noinclude&gt;
</pre></div>
+
</pre></div>  
 +
Then, an editor can simply copy and paste the example to create a similar page.
 +
 
 +
== Copying from one wiki to another  ==
 +
 
 +
Templates often require [http://meta.wikimedia.org/wiki/Help:CSS CSS] or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates:
 +
 
 +
=== If you have import rights on the new wiki  ===
 +
 
 +
#Go to [[Special:Export]] on the original wiki. Enter the name of the template in the big text box, check "Include templates" and click Export. This will download a .xml file.
 +
#Go to [[Special:Import]] on the new wiki and upload the .xml file.
 +
#Look for CSS classes (like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy them to "MediaWiki:Common.css" on the new wiki.
 +
#If the template uses [[Help:Magic words#Parser_functions|ParserFunctions]], you have to install the {{mediawiki|Extension:ParserFunctions|ParserFunctions extension}}.
 +
 
 +
=== If you don't have import rights on the new wiki  ===
 +
 
 +
#Copy the template text to the new wiki; link to the original page in the edit summary for attribution.
 +
#Edit the template on the new wiki, and look through the list of templates at the bottom. The ones in red will also need to be copied from the original wiki to the new wiki. You may have to repeat this process multiple times before all dependency templates have been recognized and copied.
 +
#Look for CSS classes (like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy them to "MediaWiki:Common.css" on the new wiki.
 +
#If the template uses [[Help:Magic words#Parser_functions|ParserFunctions]], you must install the {{mediawiki|Extension:ParserFunctions|ParserFunctions extension}}.
 +
 
 +
== See also  ==
  
Then, an editor can simply copy and paste the example to create a similar page.
+
*[[FamilySearch Wiki:Maintenance Templates|FamilySearch Wiki:Maintenance Templates]] - a graphical list of maintenance template codes and the boxes they generate.
 +
*[[Help:External searches]] – a template special use case example  
 +
*[[Help:Magic words]] – fancy stuff you may find in some templates
 +
*[[Help:Parser functions in templates]]
 +
*[[FamilySearch Wiki:Substitution]]
 +
*[[FamilySearch Wiki:Transclusion]]
 +
*{{meta|Help:Template}} – contains a much more thorough manual on how exactly templates function
 +
*{{meta|Help:Embed page}} – embedding pages from [[Help:Namespaces|namespaces]] other than <code>Template:</code>.
  
==Copying from one wiki to another==
+
{{Contributor Help badge
Templates often require [http://meta.wikimedia.org/wiki/Help:CSS CSS] or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates:
+
| link = https://familysearch.org/ask/  
 +
| name = Get Help}}
  
=== If you have import rights on the new wiki ===
+
<br><br>{{Translation needed|es|Ayuda:Plantillas}}  
# Go to [[Special:Export]] on the original wiki. Enter the name of the template in the big text box, check "Include templates" and click Export. This will download a .xml file.
+
# Go to [[Special:Import]] on the new wiki and upload the .xml file.
+
# Look for CSS classes (like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy them to "MediaWiki:Common.css" on the new wiki.
+
# If the template uses [[Help:Extension:ParserFunctions|ParserFunctions]], you have to install the {{mediawiki|Extension:ParserFunctions|ParserFunctions extension}}.
+
  
=== If you don't have import rights on the new wiki ===
+
{{Contributor help-navbox}} {{Editing help}}  
# Copy the template text to the new wiki; link to the original page in the edit summary for attribution.
+
# Edit the template on the new wiki, and look through the list of templates at the bottom. The ones in red will also need to be copied from the original wiki to the new wiki. You may have to repeat this process multiple times before all dependency templates have been recognized and copied.
+
# Look for CSS classes (like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy them to "MediaWiki:Common.css" on the new wiki.
+
# If the template uses [[Help:Extension:ParserFunctions|ParserFunctions]], you must install the {{mediawiki|Extension:ParserFunctions|ParserFunctions extension}}.
+
  
==See also==
+
{{H-langs|es=Ayuda:Plantillas|en=Help:Templates}}
*[[Help:External searches]] – a template special use case example
+
*[[Help:Magic words]] – fancy stuff you may find in some templates
+
*[[Help:Parser functions in templates]]
+
*{{meta|Help:Template}} – contains a much more thorough manual on how exactly templates function
+
*{{meta|Help:Embed page}} – embedding pages from [[Help:namespaces|namespaces]] other than <code>Template:</code>.
+
  
[[Category:Help|{{PAGENAME}}]]
+
[[Category:Templates]] [[Category:Help|{{PAGENAME}}]]
[[Category:Template]]
+
{{Languages|Help:Templates}}
+

Latest revision as of 22:47, 14 November 2013

Help-content.png This help article will guide you as you edit in the Wiki. See Contributor Help for more help articles.



If you have standard texts you want to include on several pages, the MediaWiki template feature comes into play.

Contents

Creation

Templates are standard wiki pages whose content is designed to be transcluded (embedded) inside other pages. Templates follow a convention that the name is prefixed with "Template:", assigning it to that namespace. Therefore you can create them like any other wiki page.

Usage

Templates are wiki pages which can be used in other pages in three ways:

  • {{Name}} 'transcludes' (i.e. includes a copy of) the content of the template (stored in the page [[Template:Name]]) whenever the page containing the template transclusion is fetched and displayed; i.e. if the template is later changed, the displayed transcluding page will automatically change too
  • {{subst:Name}} replaces that string with the contents of the template, in the source of the transcluding page, when you save that page; the copy of the template contents can then be edited normally (and separately from the original in the template page). To Note: don't use this if you are looking to continually propagate changes from the source template to the page(s) that references it.
  • {{msgnw:Name}} includes the template in a form that displays it as raw wiki syntax (the way <nowiki> does) when the page containing it is fetched.

In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:

  • {{Template:Pagename}} includes [[Template:Pagename]]
  • {{Foo:Pagename}} includes [[Foo:Pagename]]
  • {{:Pagename}} includes [[Pagename]]
    • {{subst::Pagename}} replaces itself with the contents of [[Pagename]]

If no such namespace exists, the full title is assumed to be a template:

  • {{Foo:Bar}} includes [[Template:Foo:Bar]]

Parameters

Template with numbered parameters
 
'''A little thank you...'''<br />
<small>for {{{1}}}.<br />
hugs, {{{2}}}</small>
You type You get
{{Thankyou|all your hard work|Joe}}
Example sunflower image
A little thank you...
for all your hard work.
hugs, Joe


with named parameters
 
'''A little thank you...'''<br />
<small>for {{{reason}}}.<br />
hugs, {{{signature}}}</small>
You type You get
{{Thankyou
|reason=all your hard work
|signature=Joe}}
Example sunflower image
A little thank you...
for all your hard work.
hugs, Joe



You can define parameters in templates either numbered as {{{1}}} or named {{{param}}}. Please note that there are a set of three curly braces ({{{ and }}}) around each parameter. This is different than normal template name usage.

Example: You want a little thank you note you can put on the talk page of other users. It will contain a reason and your signature. You could create Template:Thankyou to enter your text, as in the example in the table.

When using the template on a page, you fill in the parameter values, separated by a pipe char (|): {{Thankyou|all your hard work|Joe}}. For named parameters use "name=value" pairs separated by a pipe char: {{Thankyou|reason=all your hard work|signature=Joe}}. 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: {{Thankyou|2=Joe|1=all your hard work}}.

You can also provide default values for parameters, i.e. values that are going to be used if no value is provided for a parameter. For example, {{{reason|all your hard work}}} would result in "all your hard work" if no value was provided for the parameter reason.

Control template inclusion

You can control template inclusion by the use of <noinclude> and <includeonly> tags.

Anything between <noinclude> and </noinclude> will be processed and displayed only when the template's page is being viewed directly.

Possible applications are:

  • Categorising templates
  • Interlanguage links to similar templates in other languages
  • Explanatory text about how to use the template

The converse is <includeonly>. Text between <includeonly> and </includeonly> 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, without putting the template itself into that category.

Documentation

Documentation for users, together with the template's categories are normally placed after the template code, inside "noinclude" tags. It is normally necessary to put the opening "noinclude" tag immediately after the end of the code, with no intervening spaces or newlines, to avoid transcluding unwanted whitespace.

In the case of complex templates, the documentation (together with categories and wikilinks) is often kept on a separate subpage of the template page (named "Template:XXX/doc"). This also applies to many protected templates (to allow the information to be edited by non-administrators). This is achieved by placing the {{Documentation}} template after the main template code (within "noinclude" tags). If the "/doc" subpage does not exist, a link will then appear enabling it to be created.

Organizing templates

For templates to be effective, users need to find them and be able to use them. A simple technique is to include an example on the template page. For example:

<noinclude>
== Usage ==
Allows to establish a link to a subject:
{{NameOfTemplate|Term1+Term2+Term3}}
</noinclude>

Then, an editor can simply copy and paste the example to create a similar page.

Copying from one wiki to another

Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates:

If you have import rights on the new wiki

  1. Go to Special:Export on the original wiki. Enter the name of the template in the big text box, check "Include templates" and click Export. This will download a .xml file.
  2. Go to Special:Import on the new wiki and upload the .xml file.
  3. Look for CSS classes (like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy them to "MediaWiki:Common.css" on the new wiki.
  4. If the template uses ParserFunctions, you have to install the ParserFunctions extension.

If you don't have import rights on the new wiki

  1. Copy the template text to the new wiki; link to the original page in the edit summary for attribution.
  2. Edit the template on the new wiki, and look through the list of templates at the bottom. The ones in red will also need to be copied from the original wiki to the new wiki. You may have to repeat this process multiple times before all dependency templates have been recognized and copied.
  3. Look for CSS classes (like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy them to "MediaWiki:Common.css" on the new wiki.
  4. If the template uses ParserFunctions, you must install the ParserFunctions extension.

See also

Help-content.png Questions?
Visit the Get Help to receive help with contributing to the Wiki.





  • This page was last modified on 14 November 2013, at 22:47.
  • This page has been accessed 4,619 times.