Help:Making a new message box

From Lisgar's AVA
Jump to navigationJump to search

A message box is an easy way to mark a page for a problem, message, or warning. They supply standard, reusable messages that are convenient for any message that could appear on many pages in mostly the same way.

Read up on using Template:Mbox, the base template used for all message boxes. You need to know how to use templates to understand this help page.

Where to place your message box

Reusable boxes

If your message box is useful in multiple pages, create a template for it under the name Template:Mbox/%YOUR_TEMPLATE_NAME% so that others can find existing message boxes easily. The page for the main Mbox contains a listing of all of its subpages, so making your template there would create a link to it automatically in Mbox. This way, we can prevent redundant message boxes and maintain a directory of message boxes to place in pages.

Reusable message boxes could be, for example, one that alerts that the page is too short, one that says the page needs updating, or one that warns the reader to be careful.

Single-use boxes

If your message box has only one use, write it in the page where it should go. In that page, insert the Mbox template and fill out any necessary details.

Single-use message boxes could be for very specific notices about a very specific page, messages that would no longer apply in the future (under construction), or cases where making a template for the message makes no sense.

Colour and image

If a colour and image are not specified, the colour will be #3465a4 and the image will be of a white speech bubble.

If you do provide a colour and image (which you really should), preferably keep the image a pure white icon and keep the colour a darkish hue that isn't too similar to other message boxes. This maintains the style used by the logo of white-on-dark highlighting, and contrasts the bright surroundings of the page.

Message

The message appears bold, and larger than the other text in the message box. Use this space to concisely explain what your message box is saying.

A good message would be, This page is disorganized.
Damn it, we need to sort this page out is not a good message.

Description

The description explains exactly what the message is for, how the issue can be solved, or what to do. This can either be written directly into the message box, or, if using a template, could be left as a variable, to be filled out when your message box is used.

Direct writing

Use this if your message box is single-use, or if your template should say the same thing every time.

   | desc=Reorganize the paragraphs into proper headings so this is less confusing to read.

Variable description

Use this if you are making a template and whoever uses your template should insert their own description.

In your template:

   | desc={{{organize_reason}}}

When used in a page:

   {{mytemplate
   | organize_reason=Reorganize the paragraphs into proper headings so this is less confusing to read.

Joke

This part is optional. By default, it doesn't appear. If you do add a joke, it will appear under the description, in italics. Use this to add a humourous remark about your message box for extra flavour.