Template:If preview/doc

Documentation

[purge]

This is a template that helps other templates determine if they are being previewed or not, and do or display different things accordingly.

Usage

{{If preview|value if being previewed|value if not being previewed}}

{{If preview|1=value if being previewed|2=value if not being previewed}}

The first parameter is returned if the page is being previewed, otherwise the second parameter will be returned. Either parameter may be empty.

Examples

Preview this page to see the effect of previewing on the 'Example' column.

Code	Example	Value when previewed	Value when saved
{{If preview|Yes|No}} {{If preview|1=Yes|2=No}}	No No	Yes	No
{{If preview|Red}} {{If preview|1=Red}}		Red
{{If preview||Blue}} {{If preview|2=Blue}}	Blue Blue		Blue

See also

• {{Preview warning}}

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.