Template:NB
{{{2}}} |
Purpose
This template draws various colored boxes which can be filled with user content. Should be used to replace instances of N.B.: or similar.
Parameters
{{NB|<style>|<message>|<<indent>>|<<firstword>>}}
style
: One oftip,deprecated,mind,warning,important
, selects the box style, i.e. the color and the first word (see examples below). Ifstyle
is not any of the words in the list, a black box without first word is drawn.message
: The content of the box (after the first word).indent
: (optional) Allows to indent the whole box with regular colon sign. Use multiple ":" signs to get any level of indentation. Can be left empty if no indentation is needed butfirstword
is required. Any other character than ":" may produce unexpected results!firstword
: (optional) Overrides the default first word for any of the predefined styles.
Examples
Regular usage
Without optional arguments these boxes are available:
{{NB|tip|This is the clever way of doing it!}} {{NB|deprecated|This feature is deprecated and will be removed in the next release}} {{NB|mind|You can manually set this via '''SOME_TAG'''}} {{NB|warning|Never do this at home!}} {{NB|important|You should really consider this!}} {{NB|none|Just a box.}}
will produce
Tip: This is the clever way of doing it! |
Deprecated: This feature is deprecated and will be removed in the next release |
Mind: You can manually set this via SOME_TAG |
Warning: Never do this at home! |
Important: You should really consider this! |
Just a box. |
Special features
Replacing the first word while sticking to the warning
color scheme (note the empty third argument):
{{NB|warning|Really, really don't do this!||CAUTION!!!}}
CAUTION!!! Really, really don't do this! |
Indenting with default first word:
{{NB|tip|This is indented one level.|:}} {{NB|tip|This is indented two levels.|::}}
Tip: This is indented one level.
Tip: This is indented two levels.
Note that using an indented box within a list requires the text after the box to be indented manually:
* First item {{NB|tip|Second item is also great!|:}} :Some more text belonging to first item * Second item
- First item
Tip: Second item is also great!
- Some more text belonging to first item
- Second item
Unfortunately, when using numbered lists the item counter is reset when a box is inserted and requires manual setting of the start value with the li value
tag:
# Option A {{NB|warning|Option B should be avoided!|:}} :Some more text belonging to first option # <li value="2"> Option B
- Option A
Warning: Option B should be avoided!
- Some more text belonging to first option
- Option B