Help:Template - Revision history

Lynn: Created page with "This page is about designing templates more than using them. For details of how to use existing templates, see Help:Editing or the documentation for any template. == Including == To include a template---or any page---in another page: * `{{lb}}T{{rb}}` includes Template:T * `{{lb}}:Page name{{rb}}` includes Page name * `{{lb}}subst:T{{rb}}` or {{lb}}subst::Page name{{rb}} 2026-01-26T00:55:16Z Created page with "This page is about designing templates more than using them. For details of how to use existing templates, see Help:Editing or the documentation for any template. == Including == To include a template---or any page---in another page: * <code>{{lb}}T{{rb}}</code> includes Template:T * <code>{{lb}}<b>:</b>Page name{{rb}}</code> includes Page name * <code>{{lb}}subst:T{{rb}}</code> or <code>{{lb}}subst<b>::</b>Page name{{rb}}</c..." New page This page is about designing templates more than using them. For details of how to use existing templates, see [[Help:Editing]] or the documentation for [[Special:AllPages/Template:|any template]]. == Including == To include a template---or any page---in another page: * <code>{{lb}}T{{rb}}</code> includes [[Template:T]] * <code>{{lb}}<b>:</b>Page name{{rb}}</code> includes [[Page name]] * <code>{{lb}}subst:T{{rb}}</code> or <code>{{lb}}subst<b>::</b>Page name{{rb}}</code> are instead replaced by the current contents of [[Template:T]] or [[Page name]] * <code>{{lb}}msgnw:T{{rb}}</code> includes [[Template:T]] in <code><nowiki></code> style == If-templates == Templates have a limited condition-testing functionality. The following are based on code from the MediaWiki manuals: <dl> <dt>{{lb}}Ifn|<var>value</var>|<var>result</var>{{rb}} <dd> Yields <var>result</var> if <var>value</var> isn't blank. (Compare shell's <code>if [ -n "value" ]; then result; fi</code>) One limitation: {{lb}}ifn|2=<var>result</var>{{rb}} yields <var>result</var> (but works properly if <var>value</var> is defined and empty). <dt>{{lb}}Ifz|<var>value</var>|<var>result</var>{{rb}} <dd> Yields <var>result</var> if <var>value</var> is blank. (Compare shell's <code>if [ -z "value" ]; then result; fi</code>) <dt>{{lb}}If|<var>value</var>|<var>resultyes</var>|<var>resultno</var>{{rb}} <dd> Yields <var>resultyes</var> if <var>value</var> isn't blank; otherwise it yields <var>resultno</var>. (Compare shell's <code>if [ -n "value"]; then resultyes; else resultno; fi</code>) One limitation: {{lb}}if|2=<var>resultyes</var>{{rb}} yields <var>resultyes</var> (but works properly if <var>value</var> is defined and empty, or <var>resultno</var> is defined). <dt>{{lb}}Ifeq|<var>value</var>|<var>test</var>|<var>resultyes</var>|<var>resultno</var>{{rb}} <dd> Yields <var>resultyes</var> if <var>value</var> equals <var>test</var>; otherwise it yields <var>resultno</var>. (Compare shell's <code>if ["value" = test ]; then resultyes; else resultno; fi</code>) </dl> Now that we've upgraded to MediaWiki >= 1.19.1, though (currently at 1.26.2), we <em>would</em> be able to use {{lb}}#if:<var>value</var>|<var>result</var>|<var>resultno</var>{{rb}} and {{lb}}#ifeq:<var>value</var>|<var>test</var>|<var>resultyes</var>|<var>resultno</var>{{rb}}, which don't suffer the above limitations. Here are [http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions more details.] However, it seems that won't work until the ParserFunctions extension [[Special:Version|is enabled]]. == Template arguments == In the template's expansion markup, <code><nowiki>{{{</nowiki>1}}}</code> will expand to the first (implicitly named) argument, and <code><nowiki>{{{</nowiki>2|<var>default</var>}}}</code> will expand to the second but default to <var>default</var> if the second argument is not supplied. Note that if the template is invoked as <code>{{lb}}Foo|arg1|{{rb}}</code>, then the second argument ''has'' been supplied; here it's the empty string. Arguments can also be explicitly named/numbered, as when you invoke <code>{{lb}}Foo|bar=arg1|2={{rb}}</code>. Arguments supplied in these ways have leading and trailing whitespace trimmed. (Whitespace is preserved when arguments are only implicitly named.) To suppress expansion of an argument's contents, wrap <code>{{{<var>argument</var>}}}</code> with <code>{{lb}}#tag:nowiki|...{{rb}}</code>; see [[Template:Cat]] for an example. Inside a template's expansion markup, substrings beginning with <code></code>, <code>#</code>, <code>:</code>, or <code>;</code> are automatically prefixed by a newline. Use <code>start<nowiki>{{{</nowiki><var>dummy</var>|<b>;</b>}}}finish</code> to generate <code>start<b>;</b>finish</code>. (The empty string may be used for <var>dummy</var>.) <code>{{lb}}ns:0{{rb}}</code> expands to the empty string. If your template arguments are unexpectedly expanding as {{{1}}}, then you neglected to supply the argument; or you supplied text that the wiki markup engine is interpreting in a way you didn't expect. You can stop this from happening by surrounding the relevant text with <code><nowiki></code> tags. For example, instead of: <pre>{{Cmd|export PS1="(chroot)$PS1"}}</pre> use: <pre>{{Cmd|<nowiki>export PS1="(chroot)$PS1"</nowiki>}}</pre> A shorter alternative is to explicitly name the first argument: <pre>{{Cmd|1=export PS1="(chroot)$PS1}"}}</pre> See also [[Help:Editing#cat|the escape characters for {{lb}}Cat{{rb}}]], which can be used inside any template invocation. == Skeleton for a new template == <pre><noinclude>{{Template}} Short description. === Usage === Longer description. <pre>{{Foo|arg}}</pre> Further comments. === Example === <pre>{{Foo|arg}}</pre> will produce: {{Foo|arg}} === See also === [[:Template:Bar]] </noinclude><includeonly>EXPANSION</includeonly> </pre>