Help:Template - Revision history

Dubiousjim: Update note about ParserFunctions

2017-05-30T11:25:11Z

Update note about ParserFunctions

← Older revision		Revision as of 11:25, 30 May 2017
Line 38:		Line 38:
	</dl>		</dl>

	Now that we've upgraded to MediaWiki >= 1.19.1, though (currently at 1.21.1), we <em>~~should~~</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.] ~~When I try these, though~~, ~~I find~~ that ~~they still don~~'t work~~. Maybe these parser function hooks~~ [~~http://wiki.alpinelinux.org/wiki/~~Special:Version ~~would need to be explicitly~~ enabled.]		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 ==		== Template arguments ==

Dubiousjim: Protected "Help:Template": Site interface ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2017-05-30T08:08:44Z

Protected "Help:Template": Site interface ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 08:08, 30 May 2017
(No difference)

Dubiousjim: /* If-templates */

2015-01-17T13:53:39Z

If-templates

← Older revision		Revision as of 13:53, 17 January 2015
Line 12:		Line 12:

	== If-templates ==		== If-templates ==
	Templates ~~used to~~ have a limited condition-testing functionality. The following ~~were~~ based on code from the MediaWiki manuals:		Templates have a limited condition-testing functionality. The following are based on code from the MediaWiki manuals:

	<dl>		<dl>
Line 38:		Line 38:
	</dl>		</dl>

	Now that we've upgraded to MediaWiki 1.19.1, though, we <em>should</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.] When I try these, though, I find that they still don't work. Maybe these parser ~~functions~~ [http://wiki.alpinelinux.org/wiki/Special:Version need to be explicitly enabled.]		Now that we've upgraded to MediaWiki >= 1.19.1, though (currently at 1.21.1), we <em>should</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.] When I try these, though, I find that they still don't work. Maybe these parser function hooks [http://wiki.alpinelinux.org/wiki/Special:Version would need to be explicitly enabled.]

	== Template arguments ==		== Template arguments ==

Dubiousjim: /* If-templates */ #if and #ifeq in fact not yet available

2012-09-23T10:58:39Z

If-templates: #if and #ifeq in fact not yet available

← Older revision		Revision as of 10:58, 23 September 2012
Line 38:		Line 38:
	</dl>		</dl>

	Now that we've upgraded to MediaWiki 1.19.1, though, we ~~can~~ 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].		Now that we've upgraded to MediaWiki 1.19.1, though, we <em>should</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.] When I try these, though, I find that they still don't work. Maybe these parser functions [http://wiki.alpinelinux.org/wiki/Special:Version need to be explicitly enabled.]

	== Template arguments ==		== Template arguments ==

Dubiousjim: /* If-templates */ add link to #if and #ifeq

2012-09-23T10:53:10Z

If-templates: add link to #if and #ifeq

← Older revision		Revision as of 10:53, 23 September 2012
Line 12:		Line 12:

	== If-templates ==		== If-templates ==
	Templates have a limited condition-testing functionality. The following were based on code from the MediaWiki manuals:		Templates used to have a limited condition-testing functionality. The following were based on code from the MediaWiki manuals:

	<dl>		<dl>
Line 38:		Line 38:
	</dl>		</dl>

			Now that we've upgraded to MediaWiki 1.19.1, though, we can 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].

	== Template arguments ==		== Template arguments ==

Dubiousjim: /* Template arguments */ see also escape chars

2012-03-24T12:34:55Z

Template arguments: see also escape chars

← Older revision		Revision as of 12:34, 24 March 2012
Line 64:		Line 64:

	<pre>{{Cmd\|1=export PS1="(chroot)$PS1}"}}</pre>		<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 ==		== Skeleton for a new template ==

Dubiousjim: /* Template arguments */ unexpected {{{1}}}s

2012-03-24T12:32:01Z

Template arguments: unexpected {{{1}}}s

← Older revision		Revision as of 12:32, 24 March 2012
Line 53:		Line 53:
	<code>{{lb}}ns:0{{rb}}</code> expands to the empty string.		<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>

	== Skeleton for a new template ==		== Skeleton for a new template ==

Dubiousjim: change to Help:Editing

2012-03-24T12:15:26Z

change to Help:Editing

← Older revision		Revision as of 12:15, 24 March 2012
Line 1:		Line 1:
	This page is about designing templates more than using them. For details of how to use existing templates, see [[~~Project~~:~~Markup syntax\|Markup syntax~~]] or the documentation for [[Special:AllPages/Template:\|any template]].		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]].

Dubiousjim: Expand/reorganize

2012-03-24T11:20:53Z

Expand/reorganize

← Older revision		Revision as of 11:20, 24 March 2012
Line 1:		Line 1:
	This page is ~~more~~ about designing templates than using them. For details of how to use existing templates, see [[Project:Markup syntax]] or the documentation for [[Special:AllPages/Template:\|any template]].		This page is about designing templates more than using them. For details of how to use existing templates, see [[Project:Markup syntax\|Markup syntax]] or the documentation for [[Special:AllPages/Template:\|any template]].


			== Including ==
	To include a template---or any page---in another page:		To include a template---or any page---in another page:

	* <code>{{lb}}T{{rb}}</code> includes [[Template:T]]		* <code>{{lb}}T{{rb}}</code> includes [[Template:T]]
	* <code>{{lb}}:Page name{{rb}}</code> includes [[Page name]]		* <code>{{lb}}<b>:</b>Page name{{rb}}</code> includes [[Page name]]
	* <code>{{lb}}subst:T{{rb}}</code> or <code>{{lb}}subst::Page name{{rb}}</code> are instead replaced by the current contents of [[Template:T]] or [[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		* <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 were based on code from the MediaWiki manuals:		Templates have a limited condition-testing functionality. The following were based on code from the MediaWiki manuals:

	* {{lb}}Ifn\|value\|result{{rb}} ~~works like shell's~~ <~~code~~>if ~~[ -n "~~value~~" ]; then result; fi~~</~~code~~>		<dl>
	* {{lb}}Ifz\|value\|result{{rb}} works like shell's <code>if [ -z "value" ]; then result; fi</code>		<dt>{{lb}}Ifn\|<var>value</var>\|<var>result</var>{{rb}}
	* {{lb}}If\|~~value\|resultyes\|resultno~~{{rb}} ~~works like shell's~~ <~~code~~>~~if [ -n "value"]; then resultyes; else resultno; fi~~</~~code~~>		<dd>
	* {{lb}}Ifeq\|value\|test\|resultyes\|resultno{{rb}} works ~~like shell's~~ <~~code~~>~~if ["~~value~~" = test ]; then resultyes; else resultno; fi~~</~~code~~>		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}}
	<~~nowiki~~>{{~~</nowiki>if~~\|<var>value</var>\|<var>~~then~~</var>\|<~~var~~>~~else~~</var>~~}} yields <var>then~~</var> if <var>value</var> ~~isn't~~ blank~~; otherwise it yields <var>else</var>~~.		<dd>
	~~One limitation: <nowiki>{{~~<~~/nowiki~~>if~~\|2=<var>then</var>}} yields <var>~~then</~~var~~> ~~(but works properly if <var>value</var> is defined and empty, or <var>else</var> is defined~~).		Yields <var>result</var> if <var>value</var> is blank.
			(Compare shell's <code>if [ -z "value" ]; then result; fi</code>)

	<~~nowiki~~>{{</~~nowiki~~>~~ifz~~\|<var>value</var>\|<var>~~result~~</var>}} yields <var>~~result~~</var> if <var>value</var> is ~~blank~~.		<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).

	<~~nowiki~~>{{</~~nowiki~~>~~ifn~~\|<var>~~value~~</var>\|<var>~~result~~</var>~~}} yields~~ <var>~~result~~</var> if <var>~~value~~</var> ~~isn't blank.~~		<dt>{{lb}}Ifeq\|<var>value</var>\|<var>test</var>\|<var>resultyes</var>\|<var>resultno</var>{{rb}}
	~~One limitation:~~ <~~nowiki~~>{{</~~nowiki~~>~~ifn\|2=~~<var>~~result~~</var>}} yields <var>~~result~~</var> (~~but works properly if~~ <~~var~~>value</~~var~~> ~~is defined and empty~~).		<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>

	~~<nowiki>{{</nowiki>ifeq\|<var>value</var>\|<var>test</var>\|<var>then</var>\|<var>else</var>}} yields <var>then</var> if <var>value</var> equals <var>test</var>; otherwise it yields <var>else</var>.~~
	~~=====~~


			== 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.

	Skeleton for a new template:		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.



			== Skeleton for a new template ==

	<pre><noinclude>{{Template}}		<pre><noinclude>{{Template}}
Line 58:		Line 81:
	</pre>		</pre>



	~~=== Misc ===~~
	~~<pre>~~
	~~markup ... {{{1}}} {{{2\|default}}} ...~~


	~~{{T\|1=a=alpha\|reason=...}}~~
	~~{{{1\|default}}}~~
	~~{{{reason}}}~~

	~~Explicitly named/numbered args are trimmed, to preserve whitespace have to use implicitly numbered args.~~
	~~Inside a template, substrings beginning with "*", "#", ":", or ";" are automatically prefixed by a~~
	~~newline. Use `a{{{dummy\|;}}}b` to generate `a;b`. (`dummy` could be the empty string.)~~

	~~Use {{ns:0}} for empty string.~~
	~~</pre>~~

	~~[[Template:Cat]] uses <nowiki>{{#tag:nowiki\|...}}</nowiki> around its <nowiki>{{{2}}}</nowiki>.~~


	[[Category:Wiki]]		[[Category:Wiki]]

Dubiousjim: Cancelled REDIRECT, added content

2012-03-24T10:46:01Z

Cancelled REDIRECT, added content

← Older revision		Revision as of 10:46, 24 March 2012
Line 1:		Line 1:
	#~~REDIRECT~~ [[~~Alpine Linux~~ Wiki ~~templates~~]]		This page is more about designing templates than using them. For details of how to use existing templates, see [[Project:Markup syntax]] or the documentation for [[Special:AllPages/Template:\|any template]].


			To include a template---or any page---in another page:

			* <code>{{lb}}T{{rb}}</code> includes [[Template:T]]
			* <code>{{lb}}:Page name{{rb}}</code> includes [[Page name]]
			* <code>{{lb}}subst:T{{rb}}</code> or <code>{{lb}}subst::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


			Templates have a limited condition-testing functionality. The following were based on code from the MediaWiki manuals:

			* {{lb}}Ifn\|value\|result{{rb}} works like shell's <code>if [ -n "value" ]; then result; fi</code>
			* {{lb}}Ifz\|value\|result{{rb}} works like shell's <code>if [ -z "value" ]; then result; fi</code>
			* {{lb}}If\|value\|resultyes\|resultno{{rb}} works like shell's <code>if [ -n "value"]; then resultyes; else resultno; fi</code>
			* {{lb}}Ifeq\|value\|test\|resultyes\|resultno{{rb}} works like shell's <code>if ["value" = test ]; then resultyes; else resultno; fi</code>

			======
			<nowiki>{{</nowiki>if\|<var>value</var>\|<var>then</var>\|<var>else</var>}} yields <var>then</var> if <var>value</var> isn't blank; otherwise it yields <var>else</var>.
			One limitation: <nowiki>{{</nowiki>if\|2=<var>then</var>}} yields <var>then</var> (but works properly if <var>value</var> is defined and empty, or <var>else</var> is defined).

			<nowiki>{{</nowiki>ifz\|<var>value</var>\|<var>result</var>}} yields <var>result</var> if <var>value</var> is blank.

			<nowiki>{{</nowiki>ifn\|<var>value</var>\|<var>result</var>}} yields <var>result</var> if <var>value</var> isn't blank.
			One limitation: <nowiki>{{</nowiki>ifn\|2=<var>result</var>}} yields <var>result</var> (but works properly if <var>value</var> is defined and empty).

			<nowiki>{{</nowiki>ifeq\|<var>value</var>\|<var>test</var>\|<var>then</var>\|<var>else</var>}} yields <var>then</var> if <var>value</var> equals <var>test</var>; otherwise it yields <var>else</var>.
			=====




			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>



			=== Misc ===
			<pre>
			markup ... {{{1}}} {{{2\|default}}} ...


			{{T\|1=a=alpha\|reason=...}}
			{{{1\|default}}}
			{{{reason}}}

			Explicitly named/numbered args are trimmed, to preserve whitespace have to use implicitly numbered args.
			Inside a template, substrings beginning with "*", "#", ":", or ";" are automatically prefixed by a
			newline. Use `a{{{dummy\|;}}}b` to generate `a;b`. (`dummy` could be the empty string.)

			Use {{ns:0}} for empty string.
			</pre>

			[[Template:Cat]] uses <nowiki>{{#tag:nowiki\|...}}</nowiki> around its <nowiki>{{{2}}}</nowiki>.


			[[Category:Wiki]]