Editing Template:If preview/doc

{{Documentation subpage}}
{{High-use}}
{{Lua|Module:If preview}}

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

== Usage ==
<code><nowiki>{{If preview|value if being previewed|value if not being previewed}}</nowiki></code>

<code><nowiki>{{If preview|1=value if being previewed|2=value if not being previewed}}</nowiki></code>

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.
{|class=wikitable
!Code
!Example
!Value when previewed
!Value when saved
|-
|<code><nowiki>{{If preview|Yes|No}}</nowiki></code><br/><code><nowiki>{{If preview|1=Yes|2=No}}</nowiki></code>
|{{If preview|Yes|No}}<br/>{{If preview|1=Yes|2=No}}
|Yes
|No
|-
|<code><nowiki>{{If preview|Red}}</nowiki></code><br/><code><nowiki>{{If preview|1=Red}}</nowiki></code>
|{{If preview|Red}}<br/>{{If preview|1=Red}}
|Red
|
|-
|<code><nowiki>{{If preview||Blue}}</nowiki></code><br/><code><nowiki>{{If preview|2=Blue}}</nowiki></code>
|{{If preview||Blue}}<br/>{{If preview|2=Blue}}
|
|Blue
|}

==See also==
* {{Tl|Preview warning}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:If-then-else templates]]

}}</includeonly><noinclude>
</noinclude>