Template:Template Parameter/doc
From Gentoo Wiki
Jump to:navigation
Jump to:search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.
Single template parameter for documentation purposes.
Parameters
| Parameter name | Required? | Default value | Description |
|---|---|---|---|
Anonymous parameter 1 |
Yes | (n/a) | Parameter name |
Anonymous parameter 2 |
Yes | (n/a) | Parameter description |
required |
No | no |
Set to yes if the parameter is required
|
default |
No | (n/a) | Default value |
Usage
See the template's testcases:
| Unnamed parameters with values foo and bar | ||||
|---|---|---|---|---|
| Wiki code | {{Template Parameter|foo|bar}}
| |||
| Main version | foo |
No | (n/a) | bar |
| Sandbox version | foo |
No | (n/a) | bar |
| Unnamed parameters with value foo and bar and named parameter required | ||||
|---|---|---|---|---|
| Wiki code | {{Template Parameter|foo|bar|required=yes}}
| |||
| Main version | foo |
Yes | (n/a) | bar |
| Sandbox version | foo |
Yes | (n/a) | bar |
| Unnamed parameters with value foo and bar and named parameters required and default | ||||
|---|---|---|---|---|
| Wiki code | {{Template Parameter|foo|bar|required=yes|default=baz}}
| |||
| Main version | foo |
Yes | baz |
bar |
| Sandbox version | foo |
Yes | baz |
bar |
Incorrect
| No parameter | ||||
|---|---|---|---|---|
| Wiki code | {{Template Parameter}}
| |||
| Main version | {{{1}}} |
No | (n/a) | (description missing) |
| Sandbox version | {{{1}}} |
No | (n/a) | (description missing) |
| Unnamed parameter with value foo | ||||
|---|---|---|---|---|
| Wiki code | {{Template Parameter|foo}}
| |||
| Main version | foo |
No | (n/a) | (description missing) |
| Sandbox version | foo |
No | (n/a) | (description missing) |