Template:Mbox

From stencil.wiki
Revision as of 17:31, 14 December 2024 by Robertbaxter (talk | contribs)

Lightweight message box (maybe notice box) to implement top-off page warnings needed on some pages. It allows some color flags/styling to distinguish boxes from each other, but primarily only offers a title and body text.

Usage

This box should be used within message-specific templates (e.g. Template:Class template) which parse their own inputs into the display fields of the message box.

Plain boxes can be called with {{mbox}} while providing text and an optional title—they will auto-size to the width of their contents, and wrap text at full width. They can include markup and full wiki-text (including transcluding other templates).

{{mbox|text=Sample message text in a plain box.}}
Sample message text in a plain box.
{{mbox|title=Sample ''styled'' title|text=A plain box with a title and '''some markup''' in the text and other templates like {{Ink chip|Plum}} or [[links]].}}
Sample styled title
A plain box with a title and some markup in the text and other templates like Plum or links.

Styling

The main differentiation provided is in a 10px color bar on the left side of the box, which can be set with color_bar. Both the background and border styles can be set, as well as a CSS class for the box or custom style. The max-width is provided at 80%, but can be set with max_width.

{{mbox|text=Sample message text in a plain box.|color_bar=#BB76CF}}
Orchid box
A box with an orchid side bar.

TemplateData

A simple message box. This template is meant to implement specific message boxes, not to be invoked directly.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Titletitle

Header text to be used at the top of the box—this will be displayed in bold.

Stringsuggested
Texttext

The body text of the message box.

Stringrequired
Color barcolor_bar

The color used for the left side bar of the box—no bar is displayed if left blank. Embedded in the "border-left" CSS property.

Stringoptional
Classclass

Custom class to add to the table.

Stringsuggested
Backgroundbackground

Background color for the box (neutral grey if not specified). Embedded in the "background" CSS property.

Stringoptional
Borderborder

Border style for the box. Embedded in the "border" CSS property.

Stringoptional
Max widthmax_width

The max width for the message box (should be percentage based).

Default
80%
Stringoptional
Stylestyle

Additional CSS styles embedded at the end of the inline styles for the box

Stringoptional