Template:Ombox/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:Ombox (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

This is the {{ombox}} or other pages message box meta-template.

It is used to build message box templates for pages of the types: User, Wikipedia, MediaWiki, Template, Help, Portal and any new future namespaces. That is, page types not covered by {{ambox}}, {{tmbox}}, {{imbox}} or {{cmbox}}. Thus it should not be used for boxes for articles, talk pages, image pages or category pages.

This template works exactly like {{imbox}} and uses the same parameters, see full documentation there.

[edit] Suggested style standard

The styles of "other pages" message boxes and the usage of this template is currently being standardised and discussed on the talk page of this template. Thus don't use this meta-template for real message boxes yet, but feel free to use it for testing. Discussions that lead to the creation of this template is available at the talk page of imbox.

[edit] Other pages message box types

These are the colours and styles that this meta-template currently produces. When this template is used to build actual message boxes they should contain the same (long) texts as before, with links to explanations and they can use more specific images than the default images shown here.

type=speedy – Speedy deletion templates.
type=delete – Deletion templates.
type=content – Major warnings and problems, such as {{high-use}}.
type=style – Minor warnings and problems. {{intricate}} should perhaps use this type.
type=notice – Notices and messages of any kind, both permanent and temporary. Such as {{guideline}} and {{how-to}}.
type=move – Merge, split, rename and transwiki messages and proposals.
type=protection – Protection templates such as {{pp-protected}} when shown on "other pages".

To discuss these boxes and to see or make other examples go to the talk page.

[edit] Examples

Some examples using the "notice" style:

This page documents an English Wikipedia guideline. It is a generally accepted standard that editors should follow, though it should be treated with common sense and the occasional exception. When editing this page, please ensure that your revision reflects consensus. When in doubt, discuss on the talk page.
Shortcut:
WP:SHORT
This page in a nutshell: This template is used to build message boxes for all pages that are not articles, talk pages, image pages or category pages.

[edit] Technical details

This template currently uses hard coded styles. Later it will use CSS classes enabling it to be skinned.

For more technical details see the talk page. Since this template works almost exactly like {{imbox}}, {{ambox}} and {{cmbox}} their talk pages and related pages might also contain more details.

[edit] See also

There are several meta-templates in the mbox family:

  • {{ambox}} – For article message boxes.
  • {{tmbox}} – For talk page message boxes.
  • {{imbox}} – For image page message boxes.
  • {{cmbox}} – For category message boxes.
  • {{ombox}} – For other pages message boxes.
  • {{mbox}} – Has namespace detection, for message boxes that are used on several types of pages and thus need to change style depending on what page they are used on.