TestWiki

Template:Notice/doc: Difference between revisions

Template Discussion

Template:Notice/doc (edit)

Revision as of 12:13, 5 December 2014

1,256 bytes added ,  9 years ago
casing, removed heading, some text compression/rephrasing, code formatting, "image"→"file", Lorem ipsum, missing demospace
VisualWikitext
(→‎See also: removed all of the rest of the wikilinks - rest actually were for Template:Ambox)
(casing, removed heading, some text compression/rephrasing, code formatting, "image"→"file", Lorem ipsum, missing demospace)
Line 1:
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE, AND INTERWIKIS TO WIKIDATA -->
 
This is the {{tl|Notice}} message box. It should be used '''sparingly''' and only for '''significant''' information for which a more specific template doesn't exist. <!--[Also used in other namespaces:] Less important comments should as usual be put as text on the article's talk page instead.
==Usage==
This is the {{tl|notice}} message box.
 
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 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.
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.
 
===Articles===
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.
 
: <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:
=== Articles ===
{{Notice|demospace=main|style=margin-bottom:1.0em; |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:
This is how this box looks on article (main space) pages. Here is a code example:
: <code><nowiki>{{Notice |heading=Heading |style=text-align:center; |[[Lorem ipsum|Lorem ipsum </nowiki>''(etc)'']]}}</code> produces:
{{Notice|demospace=main|style=margin-bottom:1.0em; |heading=Heading |style=text-align:center; |[[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.
<pre>
{{notice|Include text here.}}
</pre>
 
===Talk pages===
Which renders like this:
 
On talk pages, <code><nowiki>{{Notice |Lorem ipsum </nowiki>''(etc)''}}</code> produces:
{{Notice|demospace=main|Include text here.}}
{{Notice|demospace=talk|style=margin-bottom:1.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:
{{Notice|demospace=talk|style=margin-bottom:1.0em; |small=yes |header=Header |style=text-align:center; |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> produces&nbsp;......
{{clear}}
 
Setting the {{para|image}} parameter changes the image shown on the lefthand side of the template.
The box can be titled with an optional '''header (heading)''', like this:
: <code><nowiki>{{Notice |image=Stop hand nuvola.svg |heading=Heading |Lorem ipsum </nowiki>''(etc)''}}</code> produces:
{{Notice|demospace=talk|style=margin-bottom:1.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|header=Header text|Include text here.}}
</pre>
 
<code><nowiki>{{Notice |Lorem ipsum </nowiki>''(etc)''}}</code> on a File: page would produce... {{Notice|demospace=image<!--file?-->|style=margin-bottom:1.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:1.0em; |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}
or
 
===Other pages===
<pre>
{{notice|heading=Header text|Include text here.}}
</pre>
 
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:
Which renders like this:
{{Notice|demospace=wikipedia|style=margin-bottom:1.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===
{{notice|demospace=main|header=Header text|Include text here.}}
 
In most cases, external links can be used in the template without any complications. If a link{{aside|or any text}} contains one or more equals signs ("{{padlr|&#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:
: <code><nowiki>{{Notice |1=Any text/links including "=" should now be interpreted correctly.}}</nowiki></code> produces:
{{Notice|style=margin-bottom:1.0em; |1=Any text/links including "=" should now be interpreted correctly.}}
 
===Adding an image, shortcuts, etc on the righthand side===
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.
 
To add shortcuts, images, other templates, etc to the righthand side of the template, use {{para|imageright}}. For example, {{plaincode|<nowiki>{{Notice |imageright=[[File:Wiki letter w.svg|40px]] |Lorem ipsum </nowiki>''(etc)''<nowiki>}}</nowiki>}} produces:
=== Talk pages ===
{{Notice|style=margin-bottom:1.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]]}}
 
{{plaincode|<nowiki>{{Notice |imageright={{Shortcuts|You|Me}} |Lorem ipsum </nowiki>''(etc)''<nowiki>}}</nowiki>}} includes the {{tl|Shortcut}}s template providing links to [[You]] and [[Me]]:
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|style=margin-bottom:1.0em; |imageright={{Shortcuts|You|Me}} |Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}
 
<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.svg
|header=Header text|Include text here.}}
</pre>
 
{{notice|demospace=talk|small=yes|image=Stop hand nuvola.svg|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.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 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.svg]] picture included into it:
 
<nowiki>{{notice|Include text here.|imageright = [[File:Wiki letter w.svg|40px]] }}</nowiki>
 
Which renders like this:
 
{{notice|Include text here.|imageright = [[File:Wiki letter w.svg|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====
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, {{plaincode|<nowiki>{{Notice |shortcut1=Me |shortcut2=You |shortcut3=Them |shortcut4=Us |shortcut5=Everyone |Lorem ipsum </nowiki>''(etc)''<nowiki>}}</nowiki>}} produces:
{{Notice|style=margin-bottom:1.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.''<br/>For example, {{plaincode|<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>}} produces:
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:
{{Notice|style=margin-bottom:1.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.}}
 
<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.svg|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.svg|40px]] |shortcut = Me | shortcut2 = You | shortcut3 = Them | shortcut4 = Us | shortcut5 = Everyone}}
 
== See also ==
* {{tl|Consensus}} for notices relating to [[Wikipedia:Consensus|consensus]] about methods, procedures, editing, etc.
* {{tl|consensus}} – for topics based around reaching consensus
* {{tl|warningWarning}} – for important warnings.
** {{tl|blackboxwarningBlackboxwarning}} – for extremeextremely important situations.
* {{tl|cautionCaution}} – for messages indicating seriouse.g. that errors or misuse may have wide problemsrepercussions.
* {{tl|Ambox}}, the generic article [[Template:Mbox|messagebox]].
* {{tl|ambox}} – article message boxes of any type; there is comprehensive documentation of its different options
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- CATEGORIES HERE, AND INTERWIKIS TO WIKIDATA, THANKS -->
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
[[Category:Talk header templates|{{PAGENAME}}]]
| <!-- CATEGORIES BELOW THIS LINE PLEASE; INTERWIKIS AT WIKIDATA -->
[[Category:Notice and warning templates|{{PAGENAME}}]]
[[Category:Notice and warning templates]]
[[Category:Talk header templates]]
 
<!--[[labconsole:Template:Notice]]-->
Retrieved from "https://publictestwiki.com/wiki/Special:MobileDiff/10916"