Template:Alternative/doc
Appearance
This is a documentation subpage for Template:Alternative. It may contain usage information, categories and other content that is not part of the original template page. |
This template should always be substituted (i.e., use {{subst:Alternative}} ). |
Usage
[edit]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
[edit]- 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
[edit]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 receive:
Bob said "goodbye."
See also
[edit]- The similar {{barnalt}} template.