Template:Notice/doc

{{#ifeq:doc |doc

    | 

{{#ifeq:show |show

         | {{
 {{#invoke:Namespace detect|main}}

| type = notice | image = File:Edit-copy green.svg | imageright = | class = | style = margin-bottom:1.0em; | textstyle = | text = This is a documentation subpage for Template:Notice.
It contains usage information, categories and other content that is not part of the original {{#if: |{{{text2}}} |{{#if: |{{{text1}}} |{{#ifeq:Template |User |template template page |{{#if:Template |template page|article}}}}}}}}. | small = | smallimage = | smallimageright = | smalltext = | subst = | date = | name = }}

        }}{{#if: |
         |   {{#ifexist:Template:Notice
                  | [[Category:{{#switch:Template |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]]
                  |
                 }}
        }}
    | 
   }}

Usage

This is the {{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:

{{notice|Include text here.}}

Which renders like this:

{{

 {{#invoke:Namespace detect|main}}

| type = | image = {{#if:|[[file:{{{image}}}|40px|Notice]]}} | imageright = | class = | style = | textstyle =

| text = {{#if:|

{{{header}}}

}}Include text here.

| small = | smallimage = {{#if:|[[file:{{{image}}}|30px|Notice]]}} | smallimageright = | smalltext = | subst = {{subst:substcheck}} | date = | name = Notice }}

An optional header text can be added. Like this:

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

Which renders like this:

{{

 {{#invoke:Namespace detect|main}}

| type = | image = {{#if:|[[file:{{{image}}}|40px|Notice]]}} | imageright = | class = | style = | textstyle =

| text = {{#if:Header text|

Header text

}}Include text here.

| small = | smallimage = {{#if:|[[file:{{{image}}}|30px|Notice]]}} | smallimageright = | smalltext = | subst = {{subst:substcheck}} | date = | name = Notice }}

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:

{{notice|Include text here.}}

Which renders like this:

{{

 {{#invoke:Namespace detect|main}}

| type = | image = {{#if:|[[file:{{{image}}}|40px|Notice]]}} | imageright = | class = | style = | textstyle =

| text = {{#if:|

{{{header}}}

}}Include text here.

| small = | smallimage = {{#if:|[[file:{{{image}}}|30px|Notice]]}} | smallimageright = | smalltext = | subst = {{subst:substcheck}} | date = | name = Notice }}

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.}}

{{

 {{#invoke:Namespace detect|main}}

| type = | image = {{#if:|[[file:{{{image}}}|40px|Notice]]}} | imageright = | class = | style = | textstyle =

| text = {{#if:Header text|

Header text

}}Include text here.

| small = yes | smallimage = {{#if:|[[file:{{{image}}}|30px|Notice]]}} | smallimageright = | smalltext = | subst = {{subst:substcheck}} | date = | name = Notice }}

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.}}

{{

 {{#invoke:Namespace detect|main}}

| type = | image = {{#if:Stop hand nuvola.svg|Notice}} | imageright = | class = | style = | textstyle =

| text = {{#if:Header text|

Header text

}}Include text here.

| small = yes | smallimage = {{#if:Stop hand nuvola.svg|Notice}} | smallimageright = | smalltext = | subst = {{subst:substcheck}} | date = | name = Notice }}

Image and category pages

This is how this box looks on image pages:

{{

 {{#invoke:Namespace detect|main}}

| type = | image = {{#if:|[[file:{{{image}}}|40px|Notice]]}} | imageright = | class = | style = | textstyle =

| text = {{#if:|

{{{header}}}

}}Include text here.

| small = | smallimage = {{#if:|[[file:{{{image}}}|30px|Notice]]}} | smallimageright = | smalltext = | subst = {{subst:substcheck}} | date = | name = Notice }}

This is how this box looks on category pages:

{{

 {{#invoke:Namespace detect|main}}

| type = | image = {{#if:|[[file:{{{image}}}|40px|Notice]]}} | imageright = | class = | style = | textstyle =

| text = {{#if:|

{{{header}}}

}}Include text here.

| small = | smallimage = {{#if:|[[file:{{{image}}}|30px|Notice]]}} | smallimageright = | smalltext = | subst = {{subst:substcheck}} | date = | name = Notice }}

Other pages

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

{{notice|Include text here.}}

Which renders like this:

{{

 {{#invoke:Namespace detect|main}}

| type = | image = {{#if:|[[file:{{{image}}}|40px|Notice]]}} | imageright = | class = | style = | textstyle =

| text = {{#if:|

{{{header}}}

}}Include text here.

| small = | smallimage = {{#if:|[[file:{{{image}}}|30px|Notice]]}} | smallimageright = | smalltext = | subst = {{subst:substcheck}} | date = | name = Notice }}

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

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

Which renders like this:

{{

 {{#invoke:Namespace detect|main}}

| type = | image = {{#if:Stop hand nuvola.svg|Notice}} | imageright = | class = | style = | textstyle =

| text = {{#if:|

{{{header}}}

}}Include text here.

| small = | smallimage = {{#if:Stop hand nuvola.svg|Notice}} | smallimageright = | smalltext = | subst = {{subst:substcheck}} | date = | name = Notice }}

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:

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

See also

• {{consensus}} – for topics based around reaching consensus
• {{warning}} – for important warnings
• {{caution}} – for messages indicating serious problems
• {{ambox}} – article message boxes of any type; there is comprehensive documentation of its different options