View source for Template:Xpd/doc

{{Documentation subpage}}
The [[help:expansion demo templates|expansion demo templates]] (see [http://meta.wikimedia.org/w/index.php?title=Special%3APrefixIndex&prefix=xpd&namespace=10]) show, for documentation:
*some wikitext
*its rendering
*a link to ExpandTemplates applied to the wikitext; thus it shows:
**The expanded wikitext.
**The rendering of this expanded wikitext

{{tim|xpd}} selects one of the following four templates based on the number of unnamed parameters
*{{tim|xpd0}} - simplified version of {{tim|xpdoc}}
*{{tim|xpd1}} - simplified version of {{tim|xpdopec}}
*{{tim|xpd2}} - simplified version of {{tim|xpdopepec}}
*{{tim|xpd3}} - simplified version of {{tim|xpdopepepec}}

==Separator parameter==

The default separator is "gives". With <tt>gives=<nowiki>{{!}}{{!}}</nowiki></tt> to get "||" for use in a table, the same separator is used before the ExpandTemplates link.

Example:

<pre>
{| class="wikitable"
!wikitext!!result!!ExpandTemplates
|-
|{{xpd|CURRENTDAY|gives={{!}}{{!}}}}
|-
|{{xpd|1=#expr:2+2|gives={{!}}{{!}}}}
|-
|{{xpdn|#expr: 4*|#expr:not 0|>3|gives={{!}}{{!}}}}
|}
</pre>

gives

{| class="wikitable"
!wikitext!!result!!ExpandTemplates
|-
|{{xpd|CURRENTDAY|gives={{!}}{{!}}}}
|-
|{{xpd|1=#expr:2+2|gives={{!}}{{!}}}}
|-
|{{xpdn|#expr: 4*|#expr:not 0|>3|gives={{!}}{{!}}}}
|}

==Quotes==
The quotation marks are needed to see spaces and newlines at the start and end of the result:

{{xpd|T ast}}

In other expand demo templates they are also needed to see spaces and newlines at the start and end of the wikitext, and to get a result independent of whether it starts on a line due to parameter {{{gives}}}.

==Limitations==
This Template:Xpd is a simplified version of some [[help:expansion demo templates|expansion demo templates]]. If necessary use the proper extended version.

===Named parameters and parameter values with equals signs===
Named parameters are not supported. Neither are equals signs in parameter values of the template or parser function demonstrated. 

Examples:
*<nowiki>{{xpd|1x| p{{=}}q }}</nowiki> gives {{xpd|1x| p{{=}}q }} - wrong result due to the template call in the parameter; is corrected by substitution and putting nowiki tags in the lefthand side (see below), giving {&#123;<code>1x<b>&#124;</b><nowiki> p{{=}}q</nowiki> </code>&#125;} gives {{1x| p{{=}}q }} [{{fullurl:special:ExpandTemplates|input=%7B%7B{{urlencode:1x{{!}} p{{=}}q } }}%7D}}].
*<nowiki>{{xpd|1x|2= p=q }}</nowiki> gives {{xpd|1x|2= p=q }} - wrong result because the lefthand side would be expanded interpreting p as named parameter, while the righthand side shows the result if the unnamed parameter of 1x has the given value; use <nowiki>{{xpdopec|1x|1|3= p=q }}</nowiki> giving {{xpdopec|1x|1|3= p=q }} or <nowiki>{{xpdnp|1x|1n=1|1v= p=q }}</nowiki> giving {{xpdnp|1x|1n=1|1v= p=q }} (spaces and newlines are trimmed).
*<nowiki>{{xpd|t np|q=s}}</nowiki> gives: {{xpd|t np|q=s}} ("q=s" is ignored); instead, use <nowiki>{{xpdopec|t np|q|s}}</nowiki> giving {{xpdopec|t np|q|s}} or <nowiki>{{xpdnp|t np|1n=q|1v=s}}</nowiki> giving {{xpdnp|t np|1n=q|1v=s}}.

Even in the case of a parser function called with a parameter containing an equals sign the template for named parameters should be used:
*<nowiki>{{xpd|#if:x|p=q}}</nowiki> gives: {{xpd|#if:x|p=q}} ("p=q" is ignored); instead, use  <nowiki>{{xpdnp|#if:x|1n=p|1v=q}}</nowiki> giving {{xpdnp|#if:x|1n=p|1v=q}}.

==Spaces and newlines==
If parameters start or end with a space or newline, these are preserved. Even if the left-hand side, as mentioned, does not show the raw wikitext of the parameters but the rendering, the right-hand side gives the correct result.

Example with two newlines, hence also the left-hand side is correct:

{{xpdc|xpd|t2| p |

q

}}
----
Example without consecutive spaces inside a parameter value, hence also the left-hand side is correct:

"{{xpdc|xpd|concat| p | q }}"

==Substitution==
*<nowiki>{{subst:xpd|substnp=subst:|tc}}</nowiki> gives the wikitext <nowiki>{{xpd0|tc}}</nowiki> 
*<nowiki>{{subst:xpd|substnp=subst:|t1|p}}</nowiki> gives the wikitext <nowiki>{{xpd1|t1|p}}</nowiki> 
*<nowiki>{{subst:xpd|substnp=subst:|t2|p|q}}</nowiki> gives the wikitext <nowiki>{{xpd2|t2|p|q}}</nowiki> 
*<nowiki>{{subst:xpd|substnp=subst:|concat|p|q|r}}</nowiki> gives the wikitext <nowiki>{{xpd3|concat|p|q|r}}</nowiki>

Note that except in the case of long and complicated parameters, adding the number of parameters after "xpd" is easier than adding "subst:" and "|substnp=subst:".

With substitution of xpd1 etc. and putting nowiki tags around the list of parameters the left hand side is given literally without conversions, see also above.



==See also==
*[[mw:Module:Xpd]]
*{{tim|xpsoc}} - simplified version
*{{tim|xpd0}} - simplified version of {{tim|xpdoc}}
*{{tim|xpd1}} - simplified version of {{tim|xpdopec}}
*{{tim|xpd2}} - simplified version of {{tim|xpdopepec}}
*{{tim|xpd3}} - simplified version of {{tim|xpdopepepec}}
*{{tim|xpdt1}} for table row templates
*{{tim|xpdnp}} for named parameters
*[http://meta.wikimedia.org/w/index.php?title=Special%3APrefixIndex&from=Xpd&namespace=10 Xpd templates]

*{{tim|tlx}} - produces just the template call, with the template name linked to the template, but not the result, e.g. {{xpd|tlx|t2|b|c}}

*{{tiw|en|Xpd}}
*{{tiw|no|Xpd}}

<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Expand demo templates|xpd]]

</includeonly>