Module:Notice/doc

From Pirate Software Wiki

This is the documentation page for Module:Notice

Usage

Use this template to create other Notice Templates.

Syntax: {{notice|align=|text-align=|width=|file=|filesize=|header=|content=}}

color Named, optional The color preset for the border. Defined options are green, blue, teal, orange, yellow, red, maroon, pink, and gray. However, if a color is a known CSS color, it can be used. Defaults to green.
text-align Named, optional The text-align attribute of the header and content text, e.g. center. Defaults to left.
file Named, optional The file to show on the left-hand section as a filename. e.g. Example.jpg. Defaults to nothing shown.
filesize Named, optional The file's size on the left-hand section. e.g. 30px. Defaults to 48px if a file was specified, otherwise none.
header Named, optional The header text. e.g. Notice. Defaults to nothing shown.
content Named, optional The content text. e.g. Test message. Defaults to nothing shown.
width Named, optional The width attribute of the notice, e.g. 30%. Defaults to unwritten (inherit).

Examples

{{notice|file=Thor.png|header=Under Construction|content=This article is under construction.}}

Under Construction
This article is under construction.

{{notice|file=Thor.png|header=Notice with header text only.}}

Notice with header text only.

{{notice|file=Thor.png|content=Small notice without a header.}}

Small notice without a header.

{{notice|file=Thor.png|header=Green notice|color=green}}

Green notice

{{notice|file=Thor.png|header=Blue notice with custom width|width=30%|color=blue}}

Blue notice with custom width

{{notice|file=Thor.png|header=Teal notice|color=teal}}

Teal notice

{{notice|file=Thor.png|header=Orange notice|color=orange}}

Orange notice

{{notice|file=Thor.png|header=Yellow notice|color=yellow}}

Yellow notice

{{notice|file=Thor.png|header=Red notice|color=red}}

Red notice

{{notice|file=Thor.png|header=Maroon notice|color=maroon}}

Maroon notice

{{notice|file=Thor.png|header=Pink notice|color=pink}}

Pink notice

{{notice|file=Thor.png|header=Gray notice|color=gray}}

Gray notice

{{notice|file=Thor.png|header=Custom color notice|color=slateblue|text-align=center}}

Custom color notice