Template:Notice/doc: Difference between revisions

From TestWiki
Content added Content deleted
VisualWikitext
(doc tweak)
m (83 revisions imported: needed for policy template)
 
(32 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<!--
********************************************************************
**** This documentation is shared between multiple templates, ****
**** using {{BASEPAGENAME}} and {{#switch:...}} to customize. ****
********************************************************************
-->
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE AND INTERWIKIS TO WIKIDATA -->
{{Used in system}}
{{High use| 41371 }}
This is the {{tl|{{BASEPAGENAME}}}} message box. It should be used '''sparingly''' and only for {{#switch:{{BASEPAGENAME}}
|Warning='''important''' warnings about an article or a user that cannot be shown using a more specific template. Please only use it when something is seriously wrong and other people might not otherwise know about it.
|<!--DEFAULT:-->'''significant''' information for which a more specific template doesn't exist.
}} Less important comments should be put as regular text on the page's talk page instead.


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


'''<code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1=Place notice text here. |heading=Optional heading above the text<nowiki>}}</nowiki></code>'''
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 box automatically changes its style depending on what kind of page it appears; see {{tl|Mbox}} for details, and view the examples below for demonstrations.
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.


=== Use in talk and userspace ===
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.


Outside "important" locations like mainspace, policy pages, and noticeboards, this message box can also be used on other pages in a more relaxed way, such as on the top of talk page alerts, wikiproject pages, userspace pages, etc. Talk and noticeboard cases should probably include your [[WP:Signature|signature]] at the end of the template's main content.
=== Articles ===


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


The box can be titled with an optional {{para|heading}} (or {{para|header}} or {{para|title}}). This is left-aligned by default. This:<br />
<pre>
{{in5}}<code><nowiki>{{</nowiki>{{BASEPAGENAME}} |heading=Heading |[[Lorem ipsum|Lorem ipsum]] dolor sit amet...<nowiki>}}</nowiki></code>
{{notice|Include text here.}}
produces an all-left notice:
</pre>
{{{{BASEPAGENAME}}|demospace=main |heading=Heading |style=margin-bottom:2.0em; |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}


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 {{para|align|center}}.<br />{{small|1=[While {{para|align|right}} is a valid value, it will only be useful when this template is ported to right-to-left language Wikipedias, and shouldn't be used on English Wikipedia or it will be difficult to read.]}}<br />
Which renders like this:
This:<br />
{{in5}}<code><nowiki>{{</nowiki>{{BASEPAGENAME}} |heading=Heading |align=center |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code>
produces:
{{{{BASEPAGENAME}}|demospace=main |heading=Heading |style=margin-bottom:2.0em; |align=center |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}


A shorthand parameter to center the heading and main text at the same time is {{para|center|y}}. This:<br />
{{Notice|demospace=main|Include text here.}}
{{in5}}<code><nowiki>{{</nowiki>{{BASEPAGENAME}} |heading=Heading |center=y |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code>
produces:
{{{{BASEPAGENAME}}|demospace=main |heading=Heading |style=margin-bottom:2.0em; |center=y |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}


The parameter {{para|textstyle}} can be used to pass arbitrary inline CSS to the main note content. For example, one could center small-caps text below a left-aligned heading; this:<br />
{{in5}}<code><nowiki>{{</nowiki>{{BASEPAGENAME}} |heading=Heading |textstyle=text-align:center; font-variant:small-caps; |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code>
produces:
{{{{BASEPAGENAME}}|demospace=main |heading=Heading |style=margin-bottom:2.0em; |textstyle=text-align:center; font-variant:small-caps;|Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}


Similarly, the parameter {{para|headstyle}} can be used to pass arbitrary inline CSS to the heading content. For example, one could center a red heading above a left-aligned message; this:<br />
The box can be titled with an optional '''header (heading)''', like this:
{{in5}}<code><nowiki>{{</nowiki>{{BASEPAGENAME}} |heading=Heading |headstyle=text-align:center; color:red; |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code>
produces:
{{{{BASEPAGENAME}}|demospace=main |heading=Heading |style=margin-bottom:2.0em; |headstyle=text-align:center; color:red;|Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}


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


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


See [[#Talk pages]], below for the talkpage-only {{para|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.
<pre>
{{notice|heading=Header text|Include text here.}}
</pre>


===Articles===
Which renders like this:


: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<nowiki>}}</nowiki></code> produces:
{{notice|demospace=main|header=Header text|Include text here.}}
{{{{BASEPAGENAME}}|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>{{</nowiki>{{BASEPAGENAME}} |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code> produces:
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.
{{{{BASEPAGENAME}}|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.}}


You may also set the talkpage-only parameter {{para|small|yes}}, which alters the template's appearance thus:
=== Talk pages ===
{{{{BASEPAGENAME}}|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>{{</nowiki>{{BASEPAGENAME}} |small=yes |header=Header |style=text-align:center; |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code>&nbsp;produces&nbsp;......
{{clear}}


Setting the {{para|image}} parameter changes the image shown on the lefthand side of the template.
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:
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |image=Stop hand nuvola.svg |heading=Heading |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code> produces:
{{{{BASEPAGENAME}}|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)


===File and category pages===
<pre>
{{notice|Include text here.}}
</pre>


<code><nowiki>{{</nowiki>{{BASEPAGENAME}} |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code> on a File: page would produce... {{{{BASEPAGENAME}}|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: {{{{BASEPAGENAME}}|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.}}
Which renders like this:


===Other pages===
{{notice|demospace=talk|Include text here.}}


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>{{</nowiki>{{BASEPAGENAME}} |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code> would produce:
The '''header''' parameter works on talk pages too. But there is one parameter that only works on talk pages, the '''small''' parameter. Like this:
{{{{BASEPAGENAME}}|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.}}


===External links and equals signs===
<pre>
{{notice|small=yes|header=Header text|Include text here.}}
</pre>


In most cases, external links can be used in the template without any complications. If a link &ndash;&nbsp;or any text&nbsp;&ndash; contains one or more equals signs (" &#61; "), 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|demospace=talk|small=yes|header=Header text|Include text here.}}
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |1=Any text/links including "=" should now be interpreted correctly.<nowiki>}}</nowiki></code> produces:
{{{{BASEPAGENAME}}|style=margin-bottom:2.0em; |1=Any text/links including "=" should now be interpreted correctly.}}


===Adding an image, shortcuts, etc., on the righthand side===
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:


To add shortcuts, images, other templates, etc. to the righthand side of the template, use {{para|imageright}}. This does not work in articles. For example,<br /><code><nowiki>{{</nowiki>{{BASEPAGENAME}} |imageright=<nowiki>[[File:Wiki letter w.svg|40px]] |Lorem ipsum dolor sit amet...}}</nowiki></code> produces:
<pre>
{{{{BASEPAGENAME}}|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]]}}
{{notice|small=yes|image=Stop hand nuvola.svg
|header=Header text|Include text here.}}
</pre>


<code><nowiki>{{</nowiki>{{BASEPAGENAME}} |imageright=<nowiki>{{Shortcuts|You|Me}} |Lorem ipsum dolor sit amet...}}</nowiki></code> includes the {{tl|Shortcut}}s template providing links to [[You]] and [[Me]]:
{{notice|demospace=talk|small=yes|image=Stop hand nuvola.svg|header=Header text|Include text here.}}
{{{{BASEPAGENAME}}|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.}}
<br clear=all>


====Alternate shortcut option====
=== Image and category pages ===
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>{{</nowiki>{{BASEPAGENAME}} |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code> produces:
{{{{BASEPAGENAME}}|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,<br /><code><nowiki>{{</nowiki>{{BASEPAGENAME}} |imageright=<nowiki>[[File:Wiki letter w.svg|40px]] |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |Lorem ipsum dolor sit amet...}}</nowiki></code> produces:
This is how this box looks on image pages:
{{{{BASEPAGENAME}}|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.}}


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


{{{{BASEPAGENAME}} and warning templates}}
This is how this box looks on category pages:


<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
{{notice|demospace=category|Include text here.}}
| <!-- CATEGORIES BELOW THIS LINE PLEASE; INTERWIKIS AT WIKIDATA -->

[[Category:Notice and warning templates]]
=== Other pages ===
[[Category:Talk header templates]]

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.svg|Include text here.}}
</pre>

Which renders like this:

{{notice|image=Stop hand nuvola.svg|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 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 = TEMPLATE OR IMAGE }}
</pre>

For example, 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}} }}

== 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 AND INTERWIKIS HERE, THANKS -->

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


<!--[[labconsole:Template:Notice]]-->
<!--[[labconsole:Template:Notice]]-->
}}</includeonly>
}}</includeonly>

<includeonly>
[[el:Πρότυπο:Σημείωση]]
[[es:Plantilla:Aviso]]
[[vi:Bản mẫu:Hộp thông báo]]
</includeonly>

Latest revision as of 10:51, 16 August 2019

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. Less important comments should be put as regular text on the page's talk page instead.

Usage[edit]

{{Notice|1=Place notice text here. |heading=Optional heading above the text}}

This box automatically changes its style depending on what kind of page it appears; see {{Mbox}} for details, and view the examples below for demonstrations.

Use in talk and userspace[edit]

Outside "important" locations like mainspace, policy pages, and noticeboards, this message box can also be used on other pages in a more relaxed way, such as on the top of talk page alerts, wikiproject pages, userspace pages, etc. Talk and noticeboard cases should probably include your signature at the end of the template's main content.

Optional parameters[edit]

The box can be titled with an optional |heading= (or |header= or |title=). This is left-aligned by default. This:
     {{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 |align=center.
[While |align=right is a valid value, it will only be useful when this template is ported to right-to-left language Wikipedias, and shouldn't be used on English Wikipedia or it will be difficult to read.]
This:
     {{Notice |heading=Heading |align=center |Lorem ipsum dolor sit amet...}} produces:

A shorthand parameter to center the heading and main text at the same time is |center=y. This:
     {{Notice |heading=Heading |center=y |Lorem ipsum dolor sit amet...}} produces:

The parameter |textstyle= can be used to pass arbitrary inline CSS to the main note content. For example, one could center small-caps text below a left-aligned heading; this:
     {{Notice |heading=Heading |textstyle=text-align:center; font-variant:small-caps; |Lorem ipsum dolor sit amet...}} produces:

Similarly, the parameter |headstyle= can be used to pass arbitrary inline CSS to the heading content. For example, one could center a red heading above a left-aligned message; this:
     {{Notice |heading=Heading |headstyle=text-align:center; color:red; |Lorem ipsum dolor sit amet...}} produces:


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[edit]

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

Talk pages[edit]

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[edit]

{{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[edit]

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[edit]

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[edit]

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:

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

Alternate shortcut option[edit]

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:



Retrieved from "https://publictestwiki.com/wiki/Template:Notice/doc?oldid=10943"