Jump to content

Template:Notice

From NixOS Wiki

Template Documentation [edit source| uses| help]

This template is used for producing notices that display important information outside of the flow of a normal wiki page. They are especially useful in grabbing the reader's attention and ensuring the information within is read before anything else. This is how a notice might look like:

Here is some text that is important enough to be read first, before anything else on this page. By being structurally separate from the normal content flow, your eyes are likely to have noticed it first, leading you to be reading these lines right now.

Usage

There are two "big" kinds of notices: big and small. The big notices are the default, and they stand out from the surrounding content. An example of one is the notice above, at the beginning of the documentation. Simply use the Notice template in order to include one:

{{Notice|Here is some text that is important enough to be read first, before anything else on this page. By being structurally separate from the normal content flow, your eyes are likely to have noticed it first, leading you to be reading these lines right now.}}

Big notices can also include icons, which generally should be widely-supported unicode characters. For example, here is a notice about saving electricity:

↯︎
Remember to switch off all electric equipment when leaving the room!

Displaying such a notice can be done by setting the icon parameter:

{{Notice|icon=↯|Remember to switch off all electric equipment when leaving the room!}}

The small ones flow more naturally within their content, thus are recommended for displaying text that is not meant to break the reading flow of a page. You can include an incon in these, but doing so is discouraged; if you need an icon in your notice, you almost definitely need a big one. For example:

Use small notices to convey information that shouldn't interrupt the reading flow.

You can create a small notice by passing yes to the small parameter:

{{Notice|small=yes|Use small notices to convey information that shouldn't interrupt the reading flow.}}