View source for Template:Notice/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE, AND INTERWIKIS TO WIKIDATA -->

==Usage==
This is the {{tl|notice}} message box.

This template should be used '''sparingly''' in articles, and should only be used for '''important''' comments about the article that cannot be shown using a more specific template. Less important comments should as usual be put as text on the article'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.

=== Articles ===

This is how this box looks on article (main space) pages. Here is a code example:

<pre>
{{notice|Include text here.}}
</pre>

Which renders like this: 

{{Notice|demospace=main|Include text here.}}

The box can be titled with an optional '''header (heading)''', like this:

<pre>
{{notice|header=Header text|Include text here.}}
</pre>

or 

<pre>
{{notice|heading=Header text|Include text here.}}
</pre>

Which renders like this: 

{{notice|demospace=main|header=Header text|Include text here.}}

The message box can also take an '''image''' parameter, but that is discouraged when the box is used in articles. See example further down for how to use that parameter.

=== Talk pages ===

This is how this box looks on any talk page. That is, pages that start with "Talk:", "User talk:", "Image talk:" and so on. Here's the basic box again:

<pre>
{{notice|Include text here.}}
</pre>

Which renders like this: 

{{notice|demospace=talk|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:

<pre>
{{notice|small=yes|header=Header text|Include text here.}}
</pre>

{{notice|demospace=talk|small=yes|header=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.
<br clear=all>
Let's try the '''image''' parameter too. Like this:

<pre>
{{notice|small=yes|image=Stop hand nuvola.png
  |header=Header text|Include text here.}}
</pre>

{{notice|demospace=talk|small=yes|image=Stop hand nuvola.png|header=Header text|Include text here.}}
<br clear=all>

=== Image and category pages ===

This is how this box looks on image pages:

{{notice|demospace=image|Include text here.}}

This is how this box looks on category pages:

{{notice|demospace=category|Include text here.}}

=== Other pages ===

This is how this box looks on most other pages, such as pages that start with "User:", "Wikipedia:", "Help:" and so on. 

<pre>
{{notice|Include text here.}}
</pre>

Which renders like this: 

{{notice|Include text here.}}

The box can also take an '''image''' parameter. Like this:

<pre>
{{notice|image=Stop hand nuvola.png|Include text here.}}
</pre>

Which renders like this: 

{{notice|image=Stop hand nuvola.png|Include text here.}}

The '''header''' and '''image''' parameters can of course be used at the same time.

=== Using external links ===

In 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:

<pre>
{{notice|1=Following this parameter, an equal sign in an external link will be read properly.}}
</pre>

=== Adding shortcuts (or images to the right side) ===

To add shortcuts, images, or other templates to the right side of the image, the following syntax can be used:

<pre>
{{notice|Include text here.|imageright = IMAGE OR TEMPLATE }}
</pre>

For example, the following has the [[:File:Wiki letter w.png]] picture included into it:

 <nowiki>{{notice|Include text here.|imageright = [[File:Wiki letter w.png|40px]] }}</nowiki>

Which renders like this:

{{notice|Include text here.|imageright = [[File:Wiki letter w.png|40px]] }}

The following has the {{Tl|Shortcut}} template included into it, with a link to [[You]] and [[Me]]:

 <nowiki>{{notice|Include text here.|imageright =</nowiki> {{Tlx|Shortcut|You|Me}} <nowiki>}}</nowiki>

Which renders like this:

{{notice|Include text here.|imageright = {{Shortcut|You|Me}} }}

====Alternate shortcut option====

Alternately, instead of using the "imageright" parameter to input shortcuts, the "shortcut" parameter (as well as "shortcut2", "shortcut3", "shortcut4", and "shortcut5") can be used '''instead''' of "imageright". The following syntax can be used to add shortcuts:

 <nowiki>{{notice|title=Include text here.|shortcut = Me | shortcut2 = You | shortcut3 = Them | shortcut4 = Us | shortcut5 = Everyone}}</nowiki>

Which renders like this:

{{notice|title=Include text here.|shortcut = Me | shortcut2 = You | shortcut3 = Them | shortcut4 = Us | shortcut5 = Everyone}}

'''''Technical note''''': if both the "imageright" and the "shortcut" parameters are used, '''only''' the image/template in the "imageright" template will display. Here is an example of syntax with the "imageright" and "shortcut" parameters:

 <nowiki>{{notice|title=Include text here.|imageright = [[File:Wiki letter w.png|40px]] |shortcut = Me | shortcut2 = You | shortcut3 = Them | shortcut4 = Us | shortcut5 = Everyone}}</nowiki>

Which renders like this:

{{notice|title=Include text here.|imageright = [[File:Wiki letter w.png|40px]] |shortcut = Me | shortcut2 = You | shortcut3 = Them | shortcut4 = Us | shortcut5 = Everyone}}

== See also ==
* {{tl|consensus}} – for topics based around reaching consensus
* {{tl|warning}} – for important warnings
* {{tl|blackboxwarning}} – for extreme situations
* {{tl|caution}} – for messages indicating serious problems
* {{tl|ambox}} – article message boxes of any type; there is comprehensive documentation of its different options

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- CATEGORIES HERE, THANKS -->

[[Category:Talk header templates|{{PAGENAME}}]]
[[Category:Notice and warning templates|{{PAGENAME}}]]

}}</includeonly>