Thumper: Created template documentation

2016-08-12T17:49:46Z

Created template documentation

New page

This template creates a notice box.
Usually you won't want to use this template directly.
Instead, it is intended to be used by other templates to create customized notices.

For example:
* {{tlx|notice}}: General purpose notice box template
* The template documentation box is also a notice box

Notice boxes 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.

== Usage ==

<pre>{{notice box
| title = <title text>
| content = <content>
}}</pre>

<tt><title></tt> is the text that will be used for the title of the notice box.

<tt><content></tt> is what will be placed in the content area of the notice box.

By default the notice box is presented with a cyan background, and an exclamation mark icon to the left of the title.
The icon is generated via {{tlx|notice icon|❢|royalblue}}.

For example, {{tlx|notice box|title{{=}}Notice|content{{=}}This is the content.}} gives:

{{notice box|title=Notice|content=This is the content.}}

(Note that if you're doing the above, it would be simpler to just do: {{tlx|notice|This is the content.}}.)

== Optional arguments ==

=== <tt>icon</tt> ===

You can change the icon used in a notice box with the <tt>icon</tt> argument.
Anything you use will replace the default icon.

You will probably want to use {{tlx|notice icon}} to create your icon.

For example:

<pre>{{notice box
| title = Looks like rain!
| icon = {{notice icon|☔|blue}}
| content = Hope you brought your umbrella!
}}</pre>

Produces:

{{notice box
| title = Looks like rain!
| icon = {{notice icon|☔|blue}}
| content = Hope you brought your umbrella!
}}

=== <tt>background</tt> ===

By default the background of the notice box is cyan.
But you can set it to any colour with <tt>background</tt>.
Any colour format recognized by Cascading Style Sheets can be used.

For example:

<pre>{{notice box
| title = Yarrr!
| icon = {{notice icon|☠}}
| background = #ccc
| content = Well, blow me down!

There be pirates here!
}}</pre>

Produces:

{{notice box
| title = Yarrr!
| icon = {{notice icon|☠}}
| background = #ccc
| content = Well, blow me down!

There be pirates here!
}}

== Notes ==

You will almost never want to use this template directly in pages.
{{tlx|notice}} does pretty much everything you need for general notices, and is easier to use.
This template is best used to create custom notice types.

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 box
| title = Title
| content = 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 box
| title = Title
| content = 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 box
| title = Title
| content = 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 box
| title = Title
| content = 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 box/Documentation - Revision history

Thumper: Created template documentation