Template:NB: Difference between revisions

From VASP Wiki
No edit summary
m (Singraber moved page Template:BOX to Template:NB)
(No difference)

Revision as of 07:38, 12 October 2021

{{{2}}}

Purpose

This template draws various colored boxes which can be filled with user content.

Parameters

 {{BOX|<style>|<message>|<<firstword>>}}
  • style: One of tip,deprecated,note,warning,important, selects the box style, i.e. the color and the first word (see examples below). If style 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).
  • firstword: (optional) Overrides the default first word for any of the predefined styles.


Examples

 {{BOX|tip|This is the clever way of doing it!}}

 {{BOX|deprecated|This feature is deprecated and will be removed in the next release}}

 {{BOX|mind|You can manually set this via '''SOME_TAG'''}}

 {{BOX|warning|Never do this at home!}}

 {{BOX|important|You should really consider this!}}

 {{BOX|none|Just a box.}}

 {{BOX|warning|Really, really don't do this!|CAUTION!!!}}

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.


CAUTION!!! Really, really don't do this!