Template:Notice/doc
This is a documentation subpage for Template:Notice It contains usage information, categories and other content that is not part of the original template page. |
This is the {{notice}} message box.
When used in books, this message box should only be used for important comments about the page that cannot be shown using a more specific template. Less important comments should as usual be put as text on the page's talk page instead.
This message box can also be used on other pages, such as on the top of talk or project pages. There it can be used in a more relaxed way.
This box automatically changes style depending on what kind of page it is shown on. That is, it uses the standardised message box styles for the different types of pages.
Books
editThis is how this box looks on book (main space) pages. Here is a code example:
{{notice|Include text here.}}
Which renders like this:
Include text here. |
An optional header text can be added. Like this:
{{notice|header=Header text|Include text here.}}
Which renders like this:
Header text Include text here. |
The message box can also take an image parameter, but that is discouraged when the box is used in books. See example further down for how to use that parameter.
Talk pages
editThis is how this box looks on any talk page. That is, pages that start with "Talk:", "User talk:", "File talk:" and so on. Here's the basic box again:
{{notice|Include text here.}}
Which renders like this:
Include text here. |
The header parameter works on talk pages too. But there is one parameter that only works on talk pages, the small parameter. Like this:
{{notice|small=yes|header=Header text|Include text here.}}
Header text Include text here. |
As you can see, "small=yes" causes a smaller right floating box with a smaller image and smaller text size.
Let's try the image parameter too. Like this:
{{notice|small=yes|image=Stop hand nuvola.svg |header=Header text|Include text here.}}
Header text Include text here. |
File and category pages
editThis is how this box looks on file pages:
Include text here. |
This is how this box looks on category pages:
Include text here. |
Other pages
editThis is how this box looks on most other pages, such as pages that start with "User:", "Wikibooks:", "Help:" and so on.
{{notice|Include text here.}}
Which renders like this:
Include text here. |
The box can also take an image parameter. Like this:
{{notice|image=Stop hand nuvola.svg|Include text here.}}
Which renders like this:
Include text here. |
The header and image parameters can of course be used at the same time.
External links
editIn most cases, external links can be used in the template without any complications. However, links containing an equal sign ( = ) are not read properly, because everything on the left of the equal sign is interpreted as a parameter name. This is the suggested work-around:
{{notice|1=Following this parameter, an equal sign in an external link will be read properly.}}
See also
editThere are several meta-templates in the mbox family:
- {{ambox}} – For article message boxes.
- {{tmbox}} – For talk page message boxes.
- {{imbox}} – For file (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.
Closely related meta-templates:
- {{fmbox}} – For header and footer message boxes.