Template:Notice/doc: Difference between revisions

Content added Content deleted

Inline

Revision as of 14:56, 8 February 2016

Template:Strong 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 centered by default. This:
{{Notice |heading=Heading |Lorem ipsum dolor sit amet...}} produces an all-left notice:

It can be hard to notice a short heading on a wide monitor when it is centered. It can be moved to the left with |left=y. This:
{{Notice |heading=Heading |left=y |Lorem ipsum dolor sit amet...}} produces an all-left notice:

The parameter |style=text-align:center; can be added to center the text below the heading (which is the left by default). This:
{{Notice |heading=Heading |style=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.

Articles

{{Notice |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}

produces:

Talk pages

On talk pages, {{Notice |Lorem ipsum dolor sit amet...}} produces:

You may also set the talkpage-only parameter |small=yes, which alters the template's appearance thus:

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

(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... Page Module:Message box/imbox.css has no content.

... and, on a Category: page, would produce: Page Module:Message box/cmbox.css has no content.

Other pages

On other pages, such as those in the User:, Wikipedia: and Help: namespaces, {{Notice |Lorem ipsum dolor sit amet...}} would produce:

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:

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=. For example, {{Notice |imageright=[[File:Wiki letter w.svg|40px]] |Lorem ipsum dolor sit amet...}} produces:

{{Notice |imageright={{Shortcuts|You|Me}} |Lorem ipsum dolor sit amet...}} includes the {{Shortcut}}s template providing links to You and Me:

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:

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:

@@ Line 8: / Line 8: @@
 This box automatically changes its style depending on what kind of page it appears; see {{tl|Mbox}} for details.
-===Articles===
+===Optional parameters ===
+The box can be titled with an optional {{para|heading}} (or {{para|header}} or {{para|title}}). This is centered by default. This:<br />
-: <code><nowiki>{{Notice |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}</nowiki></code> produces:
+{{in5}}<code><nowiki>{{Notice |heading=Heading |Lorem ipsum dolor sit amet...}}</nowiki></code>
-{{Notice|demospace=main|style=margin-bottom:2.0em; |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}
+produces an all-left notice:
+{{Notice|demospace=main |heading=Heading |style=margin-bottom:2.0em; |[[Lorem ipsum|Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.]]}}
-The box can be titled with an optional {{para|heading}} (or {{para|header}}) and {{para|style|text-align:center;}} can be added to center the text below it.
+It can be hard to notice a short heading on a wide monitor when it is centered. It can be moved to the left with {{para|left|y}}. This:<br />
-: <code><nowiki>{{Notice |heading=Heading |style=text-align:center; |[[Lorem ipsum|Lorem ipsum </nowiki>''(etc)'']]}}</code> produces:
+{{in5}}<code><nowiki>{{Notice |heading=Heading |left=y |Lorem ipsum dolor sit amet...}}</nowiki></code>
+produces an all-left notice:
+{{Notice|demospace=main |heading=Heading |style=margin-bottom:2.0em; |left=y |[[Lorem ipsum|Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.]]}}
+The parameter {{para|style|text-align:center;}} can be added to center the text below the heading (which is the left by default). This:<br />
+{{in5}}<code><nowiki>{{Notice |heading=Heading |style=text-align:center; |Lorem ipsum dolor sit amet...}}</nowiki></code>
+produces an all-centered notice:
 {{Notice|demospace=main |heading=Heading |style=text-align:center;margin-bottom:2.0em; |[[Lorem ipsum|Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.]]}}
-The message box can also take an {{para|image}} parameter, but this is discouraged in articles. For an example of its use, see below.
+The message box can also take an {{para|image}} parameter (with a value of just the bare filename of the image, without <code>File:...</code>, <code>Image:...</code>, or markup), but this is discouraged in articles. For an example of its use, see below.
+See [[#Talk pages]], below for the talkpage-only {{para|small|y}} parameter.
+===Articles===
+: <code><nowiki>{{Notice |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}</nowiki></code> produces:
+{{Notice|demospace=main|style=margin-bottom:2.0em; |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}
 ===Talk pages===
-On talk pages, <code><nowiki>{{Notice |Lorem ipsum </nowiki>''(etc)''}}</code> produces:
+On talk pages, <code><nowiki>{{Notice |Lorem ipsum dolor sit amet...}}</nowiki></code> produces:
 {{Notice|demospace=talk|style=margin-bottom:2.0em; |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}
-{{para||heading}}/{{para||header}} also works, as well as setting the talkpage-only parameter {{para|small|yes}}, which alters the template's appearance thus:
+You may also set the talkpage-only parameter {{para|small|yes}}, which alters the template's appearance thus:
 {{Notice|demospace=talk |small=yes |header=Header |style=text-align:center;<!--margin-bottom:2.0em;--> |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}
-: <code><nowiki>{{Notice |small=yes |header=Header |style=text-align:center; |Lorem ipsum </nowiki>''(etc)''}}</code>&nbsp;produces&nbsp;......
+: <code><nowiki>{{Notice |small=yes |header=Header |style=text-align:center; |Lorem ipsum dolor sit amet...}}</nowiki></code>&nbsp;produces&nbsp;......
 {{clear}}
 Setting the {{para|image}} parameter changes the image shown on the lefthand side of the template.
-: <code><nowiki>{{Notice |image=Stop hand nuvola.svg |heading=Heading |Lorem ipsum </nowiki>''(etc)''}}</code> produces:
+: <code><nowiki>{{Notice |image=Stop hand nuvola.svg |heading=Heading |Lorem ipsum dolor sit amet...}}</nowiki></code> produces:
 {{Notice|demospace=talk<!--|style=margin-bottom:2.0em;--> |image=Stop hand nuvola.svg |heading=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 {{para|style|text-align:center;}} here)
@@ Line 36: / Line 51: @@
 ===File and category pages===
-<code><nowiki>{{Notice |Lorem ipsum </nowiki>''(etc)''}}</code> on a File: page would produce... {{Notice|demospace=image<!--file?-->|style=margin-bottom:2.0em; |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: {{Notice|demospace=category|style=margin-bottom:2.0em; |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}
+<code><nowiki>{{Notice |Lorem ipsum dolor sit amet...}}</nowiki></code> on a File: page would produce... {{Notice|demospace=image<!--file?-->|style=margin-bottom:2.0em; |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: {{Notice|demospace=category|style=margin-bottom:2.0em; |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 [[Wikipedia:User pages|User:]], [[Wikipedia:Wikipedia namespace|Wikipedia:]] and [[Wikipedia:Help namespace|Help:]] [[Wikipedia:Namespaces|namespaces]], <code><nowiki>{{Notice |Lorem ipsum </nowiki>''(etc)''}}</code> would produce:
+On other pages, such as those in the [[Wikipedia:User pages|User:]], [[Wikipedia:Wikipedia namespace|Wikipedia:]] and [[Wikipedia:Help namespace|Help:]] [[Wikipedia:Namespaces|namespaces]], <code><nowiki>{{Notice |Lorem ipsum dolor sit amet...}}</nowiki></code> would produce:
 {{Notice|demospace=wikipedia|style=margin-bottom:2.0em; |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}
@@ Line 49: / Line 64: @@
 {{Notice|style=margin-bottom:2.0em; |1=Any text/links including "=" should now be interpreted correctly.}}
-===Adding an image, shortcuts, etc on the righthand side===
+===Adding an image, shortcuts, etc., on the righthand side===
-To add shortcuts, images, other templates, etc. to the righthand side of the template, use {{para|imageright}}. For example, <code><nowiki>{{Notice |imageright=[[File:Wiki letter w.svg|40px]] |Lorem ipsum </nowiki>''(etc)''<nowiki>}}</nowiki></code> produces:
+To add shortcuts, images, other templates, etc. to the righthand side of the template, use {{para|imageright}}. For example, <code><nowiki>{{Notice |imageright=[[File:Wiki letter w.svg|40px]] |Lorem ipsum dolor sit amet...}}</nowiki></code> produces:
 {{Notice|style=margin-bottom:2.0em; |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |imageright=[[File:Wiki letter w.svg|40px]]}}
-<code><nowiki>{{Notice |imageright={{Shortcuts|You|Me}} |Lorem ipsum </nowiki>''(etc)''<nowiki>}}</nowiki></code> includes the {{tl|Shortcut}}s template providing links to [[You]] and [[Me]]:
+<code><nowiki>{{Notice |imageright={{Shortcuts|You|Me}} |Lorem ipsum dolor sit amet...}}</nowiki></code> includes the {{tl|Shortcut}}s template providing links to [[You]] and [[Me]]:
 {{Notice|style=margin-bottom:2.0em; |imageright={{Shortcut|You|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 {{para|shortcut}} (or {{para|shortcut1}}) and {{para|shortcut''N''}} parameters (where {{nowrap|''N'' {{=}} 2}} to 5) may be used to display shortcuts. For instance, <code><nowiki>{{Notice |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |Lorem ipsum </nowiki>''(etc)''<nowiki>}}</nowiki></code> produces:
+As an alternative to imageright, the {{para|shortcut}} (or {{para|shortcut1}}) and {{para|shortcut''N''}} parameters (where {{nowrap|''N'' {{=}} 2}} to 5) may be used to display shortcuts. For instance, <code><nowiki>{{Notice |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |Lorem ipsum dolor sit amet...}}</nowiki></code> produces:
 {{Notice|style=margin-bottom:2.0em; |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |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, <code><nowiki>{{Notice |imageright=[[File:Wiki letter w.svg|40px]] |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |Lorem ipsum </nowiki>''(etc)''<nowiki>}}</nowiki></code> produces:
+''Note: If both imageright and any of the shorcut parameters are used, the contents of imageright will override the shortcut/s.'' For example, <code><nowiki>{{Notice |imageright=[[File:Wiki letter w.svg|40px]] |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |Lorem ipsum dolor sit amet...}}</nowiki></code> produces:
 {{Notice|style=margin-bottom:2.0em; |imageright=[[File:Wiki letter w.svg|40px]] |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}

v t e Notice and warning templates
{{Caution}} – For messages indicating e.g. that errors or misuse may have wide repercussions. {{Consensus}} – For notices relating to consensus about methods, procedures, editing, etc. {{Notice}} – For significant information. {{Warning}} – For particularly significant warnings. {{Warnsign}} – Inline version of {{Warning}}.
See also {{Ambox}}, the generic messagebox for article messages.