The Sims Wiki:Project Message template standardization/Manual of style

Project Message template standardization
Main page talk Manual of style talk Project Members

In addition to The Sims Wiki:Manual of Style, message templates should follow these style guidelines.

Keep appearance small.

Using scaled-down images, borders of only a few pixels, limited width settings and the 'small' code on text. No one likes looking at huge clunky boxes. Smaller message templates also make them easier to ignore for regular users.

Keep information and text short.

Use as few words as possible while still communicating the full message without room for common misunderstandings. Use links to other pages to clarify meaning if neccesary.

Avoid bright colors.

Except on borders if they are kept small. Powerful colors can be good for framing message templates. While powerful colors are not so easy on the eye if used as backgrounds or if used extensively.

Simplicity

Limit the template to as few components as possible. A standard 'image, title, text' format is preferred.

Keep practicality in mind.

It's no good if a message template suddenly breaks or looks awkward when irregular images are used. It needs to be compatible with all varieties of images and arrangements of text eg. bullet point lists.

Ensure customizeability.

When coding a message template, make sure it can be customized. Images changes, colors switched and the layout of the template altered if need be.

Mind code complexity

Make sure that the code is not too cluttered in order for other users to quickly gain insight into the template.

Naming

Avoid abbreviations and numbers when naming a message template. Make it easy and logical to find.

Compatibility

Using code that is compatible with standard browsers (IE, Firefox, Chrome, Opera) is preferred. Eg. three-digit hex codes (#EEE) does not show up in Opera.