Template:Xpdoc/doc
 |
This is a documentation subpage for (see that page for the template itself). It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
|
|
This is a documentation subpage for Template:Xpdoc (see that page for the template itself). It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
The expansion demo templates show, for documentation:
- some wikitext
- its rendering
without the need of repeating the parameters in the wikitext.
Contents
Usage
{{xpdoc|1=|2=|3=|4=|5=|6=|n1=|v1=|n2=|v2=|n3=|v3=|gives=}}
Parameters
| Parameter name | Description | Default value | required or optional?
|
|---|---|---|---|
| parameter #1 (1) | name of parser function, a colon, and the first parameter, or name of template | empty | required |
| parameter #2 (2) | the parameter after the first pipe | empty | optional |
| parameter #3 (3) | the parameter after the second pipe | empty | optional |
| parameter #4 (4) | the parameter after the third pipe | empty | optional |
| parameter #5 (5) | the parameter after the fourth pipe | empty | optional |
| parameter #6 (6) | the parameter after the fifth pipe | empty | optional |
| n1 | name of the first named parameter | empty | optional |
| v1 | value of the first named parameter | empty | optional |
| n2 | name of the second named parameter | empty | optional |
| v2 | value of the second named parameter | empty | optional |
| n3 | name of the third named parameter | empty | optional |
| v3 | value of the third named parameter | empty | optional |
| gives | text (or the empty string) to replace the arrow, e.g. gives={{!}}{{!}} to produce "||", for use in a table | → | optional |
Additional information
The template is intended to be used in the following namespaces: the Template namespace
The template is intended to be used by the following user groups: all users
Example
{{xpdoc|Creator:Vincent van Gogh}}
renders as:
{{Creator:Vincent van Gogh}} → Template:Creator:Vincent van Gogh
Localization
This template is not intended to be localized.
Notes
Naming scheme:
- o = double opening braces
- c = double closing braces
This template combines the functionality of templates listed in the Expansion demo templates on Commons with a single o and c (no nesting), but with some restrictions.
In the case of demonstrating a template, values of unnamed parameters of this template are trimmed, so Template:Xpdoc cannot be used for demonstrating the effect of spaces at the start or end of an unnamed parameter.
Examples
{{xpdoc|ISOdate|2009-04-03}} produces: "{{ISOdate|2009-04-03}} → 3 April 2009".
