Thumper: Created template documentation

2016-08-21T00:49:22Z

Created template documentation

New page

This template is for creating notices.
Notices are intended for presenting information that really stands out.
They are much more disruptive than [[Template:Section note|section note]]s, so you shouldn't use them as part of the regular text of a page.
They are more for things you ''really'' want to jump out at the reader, like warnings.

This template is for general use, and it provides several standard notice types.
While it does allow you to create custom notice types, it is not really intended for that purpose.
For creating custom notice boxes, you should make a new template based on {{tlx|notice box}}.

== Usage ==

The most basic usage is simply providing the notice box content.

<pre>{{notice
| This is the notice box content.
}}
</pre>

Produces:

{{notice
| This is the notice box content.
}}

For different types of notices, you can use the <code>type</code> argument.
For example, to create an error notice, you could do:

<pre>{{notice
| type = error
| This is the notice box content.
}}
</pre>

Which produces:

{{notice
| type = error
| This is the notice box content.
}}

The recognized types are listed below.

=== Custom titles ===

By default, the notice box's title will be the type (which defaults to <code>notice</code>).
However, it is possible to change the title of the message box with the <code>title</code> argument.

<pre>{{notice
| type = question
| title = Just what do you think you're doing?
| This is not a wise course of action.
}}
</pre>

Produces:

{{notice
| type = question
| title = Just what do you think you're doing?
| This is not a wise course of action.
}}

=== Types ===

The recognized types are:

; <code>notice</code>
: For general notices.
; <code>information</code>
: For giving additional information. (<code>info</code> is a shorthand synonym.)
; <code>question</code>
: For describing unanswered questions.
; <code>caution</code>
: For telling the reader to be careful about something.
; <code>warning</code>
: For informing the reader about a problem that isn't serious enough to change anything, but that they should be aware of.
; <code>problem</code>
: For informing the reader about a serious problem that probably has noticeable impacts.

By default, <code>type</code> is set to <code>notice</code>.
Unrecognized types also fall back to <code>notice</code>.

==== Type examples ====

; <code>notice</code>

{{notice|type=notice|Content.}}

; <code>information</code>

{{notice|type=information|Content.}}

; <code>question</code>

{{notice|type=question|Content.}}

; <code>caution</code>

{{notice|type=caution|Content.}}

; <code>warning</code>

{{notice|type=warning|Content.}}

; <code>problem</code>

{{notice|type=problem|Content.}}

=== Notice box customization ===

Most everything in a notice is customizable.

; <code>title</code>
: By default, the notice box's title is the type of notice box being used (which defaults to <code>notice</code>).
; <code>icon</code>
: Sets the icon used in the top left corner. Set it to blank to remove the icon. To make icons easily, you can use {{tlx|notice icon}}.
; <code>background</code>
: Sets the background colour of the notice box. You can use anything recognized by CSS as a colour.

For a truly customizable notice box that you will use multiple times, a better plan might be to create a new template based on {{tlx|notice box}}.

== Notes ==

Because of the nature of wiki markup, you have to be careful about how you format your content text.
Normally when you have two lines of text separated by a single newline, they get joined into a single paragraph:

<pre>This is line 1.
This is line 2.</pre>

produces:

This is line 1.
This is line 2.

That works in the content of a notice box... ''except'' for the last line:

<pre>{{notice
| This is line 1.
This is line 2.

This is line 3.
This is line 4.

This is line 5.
This is line 6.
}}</pre>

Produces:

{{notice
| This is line 1.
This is line 2.

This is line 3.
This is line 4.

This is line 5.
This is line 6.
}}

Notice that lines 5 and 6 are separated into two paragraphs.

To prevent this, you can do:

<pre>{{notice
| This is line 1.
This is line 2.

This is line 3.
This is line 4.

This is line 5.
This is line 6.

<nowiki/>}}</pre>

to get:

{{notice
| This is line 1.
This is line 2.

This is line 3.
This is line 4.

This is line 5.
This is line 6.

<nowiki/>}}

But as you can see, it creates extra space at the bottom.

The only real solution is to simply make sure the last paragraph in your notice box content is all on a single line.
It's a pain the ass, sure, but... it's all you can do.

<noinclude>
[[Category:Template documentation]]
</noinclude>

Template:Notice/Documentation - Revision history

Thumper: Created template documentation