Template:Notice/doc
This is a documentation subpage for Template:Notice. It may contain usage information, categories and other content that is not part of the original template page. |
This is the {{Notice}} message box. It should be used sparingly and only for significant information for which a more specific template doesn't exist.
This box automatically changes its style depending on what kind of page it appears; see {{Mbox}} for details.
Optional parameters
The box can be titled with an optional |heading=
(or |header=
or |title=
). This is left-aligned by default. This:
Script error: No such module "in5".{{Notice |heading=Heading |Lorem ipsum dolor sit amet...}}
produces an all-left notice:
It can be hard to notice or read short heading and/or message on a wide monitor when they centered. For long content, it can be centered with |center=y
. This:
Script error: No such module "in5".{{Notice |heading=Heading |center=y |Lorem ipsum dolor sit amet...}}
produces an all-centered notice:
The parameter |textstyle=
can be used to pass arbitrary inline CSS to the main note content. For example, one could center the just the text below a left-aligned heading; this:
Script error: No such module "in5".{{Notice |heading=Heading |textstyle=text-align:center; |Lorem ipsum dolor sit amet...}}
produces an all-centered notice:
Similarly, the parameter |headstyle=
can be used to pass arbitrary inline CSS to the heading content. For example, one could center the just the heading above a left-aligned message; this:
Script error: No such module "in5".{{Notice |heading=Heading |headstyle=text-align:center; |Lorem ipsum dolor sit amet...}}
produces an all-centered notice:
The message box can also take an |image=
parameter (with a value of just the bare filename of the image, without File:...
, Image:...
, or markup), but this is discouraged in articles. For an example of its use, see below.
See #Talk pages, below for the talkpage-only |small=y
parameter. See also #Adding an image, shortcuts, etc., on the righthand side for additional parameters that work in talk and project pages but not articles.
Articles
{{Notice |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}
produces:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
Talk pages
On talk pages, {{Notice |Lorem ipsum dolor sit amet...}}
produces:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
You may also set the talkpage-only parameter |small=yes
, which alters the template's appearance thus:
Header Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
{{Notice |small=yes |header=Header |style=text-align:center; |Lorem ipsum dolor sit amet...}}
produces ......
Setting the |image=
parameter changes the image shown on the lefthand side of the template.
{{Notice |image=Stop hand nuvola.svg |heading=Heading |Lorem ipsum dolor sit amet...}}
produces:
File:Stop hand nuvola.svg | Heading Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
(Note the effect of omitting |style=text-align:center;
here)
File and category pages
{{Notice |Lorem ipsum dolor sit amet...}}
on a File: page would produce...
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
... and, on a Category: page, would produce:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
Other pages
On other pages, such as those in the User:, Wikipedia: and Help: namespaces, {{Notice |Lorem ipsum dolor sit amet...}}
would produce:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
External links and equals signs
In most cases, external links can be used in the template without any complications. If a link – or any text – contains one or more equals signs (" = "), however, everything before the first sign will be interpreted as the name of a parameter. To prevent this, name the text carrying the link as the first numbered parameter:
{{Notice |1=Any text/links including "=" should now be interpreted correctly.}}
produces:
Any text/links including "=" should now be interpreted correctly. |
Adding an image, shortcuts, etc., on the righthand side
To add shortcuts, images, other templates, etc. to the righthand side of the template, use |imageright=
. This does not work in articles. For example, {{Notice |imageright=[[File:Wiki letter w.svg|40px]] |Lorem ipsum dolor sit amet...}}
produces:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
{{Notice |imageright={{Shortcuts|You|Me}} |Lorem ipsum dolor sit amet...}}
includes the {{Shortcut}}s template providing links to You and Me:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
Alternate shortcut option
As an alternative to imageright, the |shortcut=
(or |shortcut1=
) and |shortcutN=
parameters (where N = 2 to 5) may be used to display shortcuts. For instance, {{Notice |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |Lorem ipsum dolor sit amet...}}
produces:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
Note: If both imageright and any of the shorcut parameters are used, the contents of imageright will override the shortcut/s. For example, {{Notice |imageright=[[File:Wiki letter w.svg|40px]] |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |Lorem ipsum dolor sit amet...}}
produces:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |