Template:Note/doc
This template formats an input text in a standardized "note" style.
Usage
All parameters are optional, except the first.
{{ note | <note text> | small = y/yes | paren = y/yes | block = y/yes | before = <text in front of the note> }}
- First unnamed parameter
Text to format.
- small
Reduces the size of the text, useful where space is an issue, e.g. in infobox templates.
- paren
Encloses the text in parentheses. The same result can be achieved by simply adding the parentheses to the first unnamed parameter, but this is to be avoided, as some languages may use different characters for parenthesis, and the template will automatically pick the correct ones.
- block
Displays the text in a <div>
instead of in a <span>
, so the text will be in its own paragraph rather than inline.
- before
Text to display directly in front of the note text. It will be formatted as well, but will not be included in the parentheses from $paren
.
Examples
Code | Result |
---|---|
{{note|some note}} |
some note |
{{note|some note|paren=y}} |
(some note) |
item {{note|note|paren=y|before=some }} |
item some (note) |
some {{note|some block note|paren=y|block=y}} text |
some (some block note) text
|
some {{note|some small note|paren=y|small=y}} text |
some (some small note) text |
{{note|(really hidden content)}} |
(really hidden content) |
Options
This template supports options through {{options}} template. All valid options are listed below, see {{options}} for usage and other infomation.
See Template:note/initOptions for the initial options setting of this template.
Name | Alias | Initial Value | Value Mapping[1] | Note |
---|---|---|---|---|
small | (empty) | yes → y on → y n → (empty) no → (empty) off → (empty) | ||
paren | (empty) | yes → y on → y n → (empty) no → (empty) off → (empty) | ||
block | (empty) | yes → y on → y n → (empty) no → (empty) off → (empty) |
- ↑ Values with mapping will be stored and loaded as mapped value. Other values without mapping will be stored and loaded as-is.