Difference between revisions of "Template:Alternative/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Mclay1
m (alternate → alternative per WP:COMMONALITY)
blackwiki>Mclay1
m (update)
Line 6: Line 6:
 
==== Parameters ====
 
==== Parameters ====
 
*'''Default''': The information to be displayed when the <code>alt</code> parameter is omitted or set to anything but yes.
 
*'''Default''': The information to be displayed when the <code>alt</code> parameter is omitted or set to anything but yes.
*'''Alternate''': The information to be used when the <code>alt</code> parameter is set to yes.
+
*'''Alternative''': The information to be used when the <code>alt</code> parameter is set to yes.
 
==== Examples ====
 
==== Examples ====
 
In order to use this template, it must be substed into another. For this example, that will be [[Template:Alternative/example]]. First, one would type the following code into that page:
 
In order to use this template, it must be substed into another. For this example, that will be [[Template:Alternative/example]]. First, one would type the following code into that page:
<pre>Bob said "{{subst:alternative|default=hello|alternate=goodbye}}."</pre>
+
<pre>Bob said "{{subst:alternative|default=hello|alternative=goodbye}}."</pre>
 
After the page is saved, the page's code would read:
 
After the page is saved, the page's code would read:
 
<pre>Bob said "{{#ifeq:{{{alt}}}|yes|goodbye|hello}}."</pre>
 
<pre>Bob said "{{#ifeq:{{{alt}}}|yes|goodbye|hello}}."</pre>

Revision as of 13:34, 23 December 2010

This template must be substituted.

Usage

This template is used to add an alternative option to an existing template. Once this template is used, the alternative option will be available by setting the alt parameter equal to yes. (|alt=yes).

Parameters

  • Default: The information to be displayed when the alt parameter is omitted or set to anything but yes.
  • Alternative: The information to be used when the alt parameter is set to yes.

Examples

In order to use this template, it must be substed into another. For this example, that will be Template:Alternative/example. First, one would type the following code into that page:

Bob said "{{subst:alternative|default=hello|alternative=goodbye}}."

After the page is saved, the page's code would read:

Bob said "{{#ifeq:{{{alt}}}|yes|goodbye|hello}}."

Then, when transcluding that page without the alt option (typed as {{Alternative/example}}), the following text would be displayed:

Bob said "hello."

Or, when transcluding with alt=yes (typed as {{Alternative/example|alt=yes}}, one would recieve:

Bob said "goodbye."

See also

  • The similar {{barnalt}} template.