Template:Alert/doc

This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage.

This template uses TemplateStyles: Template:​Alert​/styles.css

This documentation is for a draft template. It is incomplete and may not be in active development. If possible, editors are encouraged to help with its development. In the meantime, editors should avoid using this template across the Xenharmonic Wiki, except for testing.

The Alert template is a metatemplate which is used to create alerts, also known as callouts or admonitions, to call attention to critical information. It is intended to be used in other templates for messages which are expected to be used on multiple pages.

Usage

The template accepts three parameters:

• type: Defines the color of the left border; the type should be chosen according to context, not for aesthetic reasons. Types are described in the next section.
• text: Message to be displayed in the box.
• icon: Icon to be displayed in the box, if provided. Icons appear on the left side of the message box.
• icon size: Size of the icon displayed. Default is 60px.

Types and examples

Alert of note type.

Alert of tip type.

Alert of warning type.