Xpd/doc
From Joomla! Documentation
< Template:Xpd
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Xpd.
This Template:xpd (talk, backlinks, edit) (expansion demo) shows the call of a variable, parser function or template and its result, for documentation.
Usage[edit]
- {{xpd|left side|up to 3 additional parameters}}
Please note that for parser functions the first parameter belongs to the left side before "|".
Examples[edit]
without additional parameters:
{{xpd|tc}} | {{tc }} gives in
|
{{xpd|CURRENTDAY}} | {{CURRENTDAY }} gives 12
|
{{xpd|#expr:2*3}} | {{#expr:2*3 }} gives 6
|
{{xpd|1=#expr:2+2=5}} | {{#expr:2+2=5 }} gives 0
|
{{xpd|1=#expr:2+2=4}} | {{#expr:2+2=4 }} gives 1
|
{{xpd|urlencode:!}} | {{urlencode:! }} gives %21
|
{{xpd|uc:abc}} | {{uc:abc }} gives ABC
|
{{subst:xpd|uc:Upper Case|subst=subst:}} substitutes {{ subst:uc:Upper Case
}} gives UPPER CASE
See Help:Substitution for several caveats wrt subst=subst:.
Note that, as always, a parameter containing "=" has to be explicitly named by putting, in this case, "1=" in front.
Template:xpdn (talk, backlinks, edit) can be used in the case of an expression in double braces which itself includes a pair of double braces (simple nested expressions). Use "|" for the inner "{{" and, if there is code after it, also for "}}".
{{xpdn|#expr:24*|CURRENTDAY}} | {{ #expr:24* {{ CURRENTDAY }} }} gives 288
|
{{xpdn|#expr:24*|CURRENTDAY|-24}} | {{ #expr:24* {{ CURRENTDAY }}-24 }} gives 264
|
{{xpdn|#expr:4*|#expr:not 0| >3}} | {{ #expr: 4* {{ #expr:not 0 }} >3 }} gives 1
|
{{xpdn|urlencode:|DIRMARK}} | {{ urlencode: {{ DIRMARK }} }} gives %E2%80%8E
|
Examples with additional parameters (no nesting possible):
{{xpd|#ifeq: 1.00|+1|okay}} | {{#ifeq: 1.00|+1|okay }} gives okay
|
{{xpd|#ifeq: this|that||false|s=is}} | {{#ifeq: this|that||false }} is false
|
{{xpd|t|b}} | {{t|b }} gives start>b<end
|
{{xpd|t2|b|c}} | {{t2|b|c }} gives parameter 1 is ( b ) , parameter 2 is ( c )
|
In the case of one or more named parameters, write all parameter definitions from that as value of the appropriate parameter number, e.g. to pass 'wikt=abc' as 2nd argument assign it to '2=' using:
- {{xpd|t link|2=wikt=abc|3=}} gives "{{
t link|wikt=abc|
}} gives wikt=abc"
Optional substitution with subst=subst: is not supported. The xpd templates show what another template actually does, and not what it did some time ago.
Separator parameter[edit]
The default separator of template code and its result is "gives", use s== or similar to get "=" etc.
- Usage:
- {{xpd|left side|up to 3 additional parameters|s=separator}}
- {{xpdn|left side|nested part and optional last part|s=separator}}
Examples with separator parameter:
{{xpd|CURRENTDAY|s=is}} | {{CURRENTDAY }} is 12
|
{{xpd|1=#expr:2+2|s==}} | {{#expr:2+2 }} = 4
|
{{xpdn|#expr:4*|#expr:not 0| >3 | yields}} | {{ #expr: 4* {{ #expr:not 0 }} >3 }} yields 1
|