Template:Note/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.
Displays additional information which may be useful as a note to the reader.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Content for note | 1 | Add the note text | Content | required |
| Format type | type | Set to a value of 'inline' or 'block'. Adjusts the content to be in an inline (useful for lists) or block (line breaking) level element.
| String | optional |
Template to display additional information for readers in a highlighted box.
Tip
Use {{=}} or {{!}} instead of the characters "=" or "|" for equal or pipe symbols, respectively.
Use {{=}} or {{!}} instead of the characters "=" or "|" for equal or pipe symbols, respectively.
Usage
See the template's testcases:
| No parameter | |
|---|---|
| Wiki code | {{Note}}
|
| Main version | Note
{{{1}}} |
| Sandbox version | Note
{{{1}}} |
| Parameter: unnamed | |
|---|---|
| Wiki code | {{Note|Some information.}}
|
| Main version | Note
Some information. |
| Sandbox version | Note
Some information. |
| Parameter: unnamed 1, unnamed 2 | |
|---|---|
| Wiki code | {{Note|Some information in 1st parameter.|Some info in 2nd parameter}}
|
| Main version | Note
Some information in 1st parameter. |
| Sandbox version | Note
Some information in 1st parameter. |
| Parameter: unnamed 1 bullet point | |
|---|---|
| Wiki code | {{Note|* Some information in 1st parameter starting with a bullet point.<br/> * Second bullet point. }}
|
| Main version | Note
* Some information in 1st parameter starting with a bullet point. * Second bullet point. |
| Sandbox version | Note
* Some information in 1st parameter starting with a bullet point. * Second bullet point. |
| Parameter: unnamed, type=block | |
|---|---|
| Wiki code | {{Note|Some information.|type=block}}
|
| Main version | Note
Some information. |
| Sandbox version | Note
Some information. |
| Parameter: unnamed, type=inline | |
|---|---|
| Wiki code | {{Note|Some information.|type=inline}}
|
| Main version | Note: Some information. |
| Sandbox version | Note: Some information. |
| Parameter: unnamed 1, unnamed 2, type=inline | |
|---|---|
| Wiki code | {{Note|Some information in 1st parameter.|Some info in 2nd parameter|type=inline}}
|
| Main version | Note: Some information in 1st parameter. |
| Sandbox version | Note: Some information in 1st parameter. |