Template:Notice/doc: Difference between revisions
(More or less finished the new documentation.) |
(Trying code tags instead of pre tags around the code examples.) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
| ⚫ | |||
<!-- |
|||
| ⚫ | |||
--> |
|||
This is the {{tl|notice}} message box. |
This is the {{tl|notice}} message box. |
||
| Line 16: | Line 14: | ||
This is how this box looks on article (main space) pages. Here is a code example: |
This is how this box looks on article (main space) pages. Here is a code example: |
||
| ⚫ | |||
<pre> |
|||
| ⚫ | |||
</pre> |
|||
Which renders like this: |
Which renders like this: |
||
| Line 27: | Line 23: | ||
An optional '''header''' text can be added. Like this: |
An optional '''header''' text can be added. Like this: |
||
| ⚫ | |||
<pre> |
|||
| ⚫ | |||
</pre> |
|||
Which renders like this: |
Which renders like this: |
||
| Line 42: | Line 36: | ||
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: |
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: |
||
| ⚫ | |||
<pre> |
|||
| ⚫ | |||
</pre> |
|||
Which renders like this: |
Which renders like this: |
||
| Line 52: | Line 44: | ||
The '''header''' parameter works on talk pages too. But there is one parameter that only works on talk pages, the '''small''' parameter. Like this: |
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> |
|||
| ⚫ | |||
</pre> |
|||
{{notice|demospace=talk|small=yes|header=Header text|Include text here.}} |
{{notice|demospace=talk|small=yes|header=Header text|Include text here.}} |
||
| Line 62: | Line 52: | ||
Let's try the '''image''' parameter too. Like this: |
Let's try the '''image''' parameter too. Like this: |
||
| ⚫ | |||
<pre> |
|||
| ⚫ | |||
|header=Header text|Include text here.}} |
|||
</pre> |
|||
{{notice|demospace=talk|small=yes|image=Stop hand nuvola.svg|header=Header text|Include text here.}} |
{{notice|demospace=talk|small=yes|image=Stop hand nuvola.svg|header=Header text|Include text here.}} |
||
| Line 73: | Line 60: | ||
This is how this box looks on all other pages, such as pages that start with "User:", "Image:", "Wikipedia:" and so on. |
This is how this box looks on all other pages, such as pages that start with "User:", "Image:", "Wikipedia:" and so on. |
||
| ⚫ | |||
<pre> |
|||
| ⚫ | |||
</pre> |
|||
Which renders like this: |
Which renders like this: |
||
| Line 83: | Line 68: | ||
The box can also take an '''image''' parameter. Like this: |
The box can also take an '''image''' parameter. Like this: |
||
| ⚫ | |||
<pre> |
|||
| ⚫ | |||
</pre> |
|||
{{Notice|image=Stop hand nuvola.svg|Include text here.}} |
{{Notice|image=Stop hand nuvola.svg|Include text here.}} |
||
Revision as of 02:32, 20 March 2008
 | 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.
When used in articles this message box 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 message box can also be used on other pages, such as on the top of talk pages or project pages. There it can be used in a more relaxed way.
This box automatically looks different depending on what kind of page it is shown on.
Articles
This is how this box looks on article (main space) pages. Here is a code example:
{{notice|Include text here.}}
Which renders like this:
 | Include text here. |
An optional header text can be added. Like this:
{{notice|header=Header text|Include text here.}}
Which renders like this:
| Header text Include text here. |
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.
Talk pages
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|Include text here.}}
Which renders like this:
| 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:
{{notice|small=yes|header=Header text|Include text here.}}
| 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.
Let's try the image parameter too. Like this:
{{notice|demospace=talk|small=yes|image=Stop hand nuvola.svg|header=Header text|Include text here.}}
 | Header text Include text here. |
Other pages
This is how this box looks on all other pages, such as pages that start with "User:", "Image:", "Wikipedia:" and so on.
{{notice|Include text here.}}
Which renders like this:
| Include text here. |
The box can also take an image parameter. Like this:
{{Notice|image=Stop hand nuvola.svg|Include text here.}}
| Include text here. |
The header and image parameters can of course be used at the same time.
See also
There are other message templates, which serve similar purposes:
- {{Consensus}} - For topics based around reaching consensus.
- {{Warning}} - For important warnings.
- {{Caution}} - For messages indicating serious problems.
- {{Ambox}} - Article message boxes of any type. There is comprehensive information in its documentation about the different options for article message boxes.