Template:Notice/doc: Difference between revisions
m
83 revisions imported: needed for policy template
(replaced See also with template) |
Reception123 (talk | contribs) m (83 revisions imported: needed for policy template) |
||
| (21 intermediate revisions by 7 users not shown) | |||
Line 1:
<!--
********************************************************************
**** This documentation is shared between multiple templates, ****
**** using {{BASEPAGENAME}} and {{#switch:...}} to customize. ****
********************************************************************
-->
{{Documentation subpage}}
<!-- 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 ==
'''<code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1=Place notice text here. |heading=Optional heading above the text<nowiki>}}</nowiki></code>'''
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.
=== Use in talk and userspace ===
===Articles===▼
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.
: <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.}}▼
===Optional parameters ===
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.▼
: <code><nowiki>{{Notice |heading=Heading |style=text-align:center; |[[Lorem ipsum|Lorem ipsum </nowiki>''(etc)'']]}}</code> produces:▼
▲The box can be titled with an optional {{para|heading}} (or {{para|header}}
{{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.]]}}▼
{{in5}}<code><nowiki>{{</nowiki>{{BASEPAGENAME}} |heading=Heading |[[Lorem ipsum|Lorem ipsum]] dolor sit amet...<nowiki>}}</nowiki></code>
produces an all-left notice:
{{{{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 />
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 />
{{in5}}<code><nowiki>{{</nowiki>{{BASEPAGENAME}} |heading=Heading |center=y |Lorem ipsum dolor sit amet...<nowiki>}}</nowiki></code>
produces:
▲{{
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 />
▲
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.}}
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. 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===
▲: <code><nowiki>{{
▲The message box can also take an {{para|image}} parameter, but this is discouraged in articles. For an example of its use, see below.
▲{{
===Talk pages===
On talk pages, <code><nowiki>{{
{{
{{
: <code><nowiki>{{
{{clear}}
Setting the {{para|image}} parameter changes the image shown on the lefthand side of the template.
: <code><nowiki>{{
{{
(Note the effect of omitting {{para|style|text-align:center;}} here)
===File and category pages===
<code><nowiki>{{
===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>{{
{{
===External links and equals signs===
In most cases, external links can be used in the template without any complications. If a link
: <code><nowiki>{{
{{
===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}}. This does not work in articles. For example,<br /><code><nowiki>{{
{{
<code><nowiki>{{
{{
====Alternate shortcut option====
As an alternative to imageright, the {{para|shortcut}} (or {{para|shortcut1}}) and {{para|shortcut
{{
''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>{{
{{
{{
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| |||