View source for Module:Notice/doc

== Usage ==
Use this template to create other [[:Category:Notice templates|Notice Templates]].

'''Syntax''': <code><nowiki>{{notice|color=|colorBack=|text-align=|width=|file=|filesize=|header=|content=}}</nowiki></code>

{| class="wikitable sitecolor-generic"
| style="vertical-align:top" |<code>color</code>
| style="vertical-align:top" |Named, optional
| colspan="4" |The color preset for the border. Defined options are <code>green</code>, <code>blue</code>, <code>teal</code>, <code>orange</code>, <code>yellow</code>, <code>red</code>, <code>maroon</code>, <code>pink</code>, and <code>gray</code>. However, if a color is a known CSS color, it can be used. Defaults to <code>green</code>.
|-
| style="vertical-align:top" |<code>colorBack</code>
| style="vertical-align:top" |Named, optional
| colspan="4" |The color preset for the background color. Defined options are <code>green</code>, <code>blue</code>, <code>teal</code>, <code>orange</code>, <code>yellow</code>, <code>red</code>, <code>maroon</code>, <code>pink</code>, and <code>gray</code> with 0.2 for alpha channel. However, if a color is a known CSS color, it can be used. Defaults to <code>none</code>.
|-
| style="vertical-align:top" |<code>text-align</code>
| style="vertical-align:top" |Named, optional
| colspan="4" |The text-align attribute of the header and content text, e.g. <code>center</code>. Defaults to <code>left</code>.
|-
| style="vertical-align:top" |<code>file</code>
| style="vertical-align:top" |Named, optional
| colspan="4" |The file to show on the left-hand section as a filename. e.g. <code>Example.jpg</code>. Defaults to nothing shown.
|-
| style="vertical-align:top" |<code>filesize</code>
| style="vertical-align:top" |Named, optional
| colspan="4" |The file's size on the left-hand section. e.g. <code>30px</code>. Defaults to 48px if a file was specified, otherwise none.
|-
| style="vertical-align:top" |<code>header</code>
| style="vertical-align:top" |Named, optional
| colspan="4" |The header text. e.g. <code>Notice</code>. Defaults to nothing shown.
|-
| style="vertical-align:top" |<code>content</code>
| style="vertical-align:top" |Named, optional
| colspan="4" |The content text. e.g. <code>Test message</code>. Defaults to nothing shown.
|-
| style="vertical-align:top" |<code>width</code>
| style="vertical-align:top" |Named, optional
| colspan="4" |The width attribute of the notice, e.g. <code>30%</code>. Defaults to unwritten (inherit).
|}

=== Examples ===
<code><nowiki>{{notice|file=Beans.png|header=Under Construction|content=This article is under construction.}}</nowiki></code>
{{notice|file=Beans.png|header=Under Construction|content=This article is under construction.}}

<code><nowiki>{{notice|file=Beans.png|header=Notice with header text only.}}</nowiki></code>
{{notice|file=Beans.png|header=Notice with header text only.}}

<code><nowiki>{{notice|file=Beans.png|content=Small notice without a header.}}</nowiki></code>
{{notice|file=Beans.png|content=Small notice without a header.}}

<code><nowiki>{{notice|file=Beans.png|header=Green notice|color=green}}</nowiki></code>
{{notice|file=Beans.png|header=Green notice|color=green}}

<code><nowiki>{{notice|file=Beans.png|header=Green notice with green background|color=green|colorBack=green}}</nowiki></code>
{{notice|file=Beans.png|header=Green notice|color=green|colorBack=green}}

<code><nowiki>{{notice|file=Beans.png|header=Blue notice with custom width|width=30%|color=blue}}</nowiki></code>
{{notice|file=Beans.png|header=Blue notice with custom width|width=30%|color=blue}}

<code><nowiki>{{notice|file=Beans.png|header=Teal notice|color=teal}}</nowiki></code>
{{notice|file=Beans.png|header=Teal notice|color=teal}}

<code><nowiki>{{notice|file=Beans.png|header=Orange notice|color=orange}}</nowiki></code>
{{notice|file=Beans.png|header=Orange notice|color=orange}}

<code><nowiki>{{notice|file=Beans.png|header=Yellow notice|color=yellow}}</nowiki></code>
{{notice|file=Beans.png|header=Yellow notice|color=yellow}}

<code><nowiki>{{notice|file=Beans.png|header=Red notice|color=red}}</nowiki></code>
{{notice|file=Beans.png|header=Red notice|color=red}}

<code><nowiki>{{notice|file=Beans.png|header=Maroon notice|color=maroon}}</nowiki></code>
{{notice|file=Beans.png|header=Maroon notice|color=maroon}}

<code><nowiki>{{notice|file=Beans.png|header=Pink notice|color=pink}}</nowiki></code>
{{notice|file=Beans.png|header=Pink notice|color=pink}}

<code><nowiki>{{notice|file=Beans.png|header=Gray notice|color=gray}}</nowiki></code>
{{notice|file=Beans.png|header=Gray notice|color=gray}}

<code><nowiki>{{notice|file=Beans.png|header=Custom color notice|color=slateblue|text-align=center}}</nowiki></code>
{{notice|file=Beans.png|header=Custom color notice|color=slateblue|text-align=center}}

[[Category:Notice templates]]