imported>Trimoon: Switching to sections to aid modifications, and fixing a small bug

2016-04-29T12:11:55Z

Switching to sections to aid modifications, and fixing a small bug

New page

{{SPW|is not on|name=Notice}}
<includeonly>
[[Category:Wikia Help templates]]
</includeonly><noinclude>
[[Category:Template documentation]]
</noinclude>
<dl>
==<dt>Description</dt>==
<dd>A simple notice box.</dd>

==<dt>Dependencies</dt>==
<dd>
*Uses [[:File:Gtk-ok.png]] as default image.
*Uses for this documentation:
**{{t|SPW}} = Wikia specific to link back to original.
**{{t|t}} = To show clickable template mentions.
**{{t|para}} = To show parameter usage.
**{{t|-}} and {{t|Lorem ipsum}} = To format the output of the samples.
</dd>

==<dt>Syntax</dt>==
<dd>Type <code>{{t|Notice|parameters}}</code> somewhere.</dd>
===<dt>Parameters</dt>===
<dd>
*Recommended: {{para|type}}
*:Notice box header text.
*:Default: {{para|type|<var>Header text</var>}}
*Recommended: {{para|info}}
*:Notice box additional info.
*:Default: {{para|type|<var>Explanation</var>}}
*Optional: {{para|image}}
*:Notice box symbol image.
*:Provide the image-filename with extension, or use {{para|image|no}} to completely remove/inhibit the image part.
*:Default: {{para|image|<var>Gtk-ok.png</var>}}
*Optional: {{para|imageSize}}
*:Notice box symbol image-size.
*:Provide the image-size including the unit, eg: <code>px</code>, part.
*:Default: {{para|imageSize|<var>50px</var>}}
*Optional: {{para|border}}
*:Notice box left-border-bar definition.
*:Use {{para|border|<var>definition</var>}}, where <code><var>definition</var></code> is a valid custom definition for the [http://www.w3schools.com/cssref/pr_border-left.asp CSS property <code>border-left</code>].
*:Or use {{para|border|preset}}, where <code>preset</code> is one of the predefined names below<nowiki>:</nowiki>
*:*    red ⇒ <code>10px solid #b22222</code>
*:*    orange ⇒ <code>10px solid #f28500</code>
*:*    yellow ⇒ <code>10px solid #f4c430</code>
*:*    purple ⇒ <code>10px solid #9932cc</code>
*:*    blue ⇒ <code>10px solid #1e90ff</code>
*:*    green ⇒ <code>10px solid #228b22</code>
*:*    gray ⇒ <code>10px solid #bba</code>
*:Default: {{para|border|blue}}
*:You don't need to provide the <code>;</code> at the end to properly terminate the definition(s) because it will be appended automatically for proper functionality.
*Optional: {{para|float|side}}
*:Float the Notice box.
*:Where <code>side</code> can be one of: (Case insensitive)
*:*<code>l</code> or <code>left</code>
*:*<code>r</code> or <code>right</code>
*:*<code>n</code> or <code>none</code>
*:When anything else is provided it will be treated as <code>none</code>.
*:When used it alters the default value for <code>styleWidth</code> of {{para|style}}(see below) as following when the effective floating is:
*:*left ⇒ <code>25%</code>
*:*right ⇒ <code>25%</code>
*:*none ⇒ <code>50%</code>
*Optional: {{para|style|<var>inline-CSS;</var>}}
*:Completely override the inline-CSS used in the [http://www.w3schools.com/tags/att_global_style.asp style-attribute] of the table that generates the Notice box.
*:Where <code><var>inline-CSS;</var></code> defaults to:
*:<code>font-size:{{{styleFontSize}}}; width:{{{styleWidth}}}; margin:{{{styleMargin}}}; border:{{{styleBorder}}}; border-collapse:{{{styleBorderCollapse}}}; background-color:{{{styleBackgroundColor}}}; border-left:{{{border}}}</code>
*:To override parts of the default shown above you can use: (defaults shown as value)
*:*{{para|styleFontSize|95%}}
*:*{{para|styleWidth|80%}} (Default value is altered when {{para|float}}(see above) is used.)
*:*{{para|styleMargin|0 auto}}
*:*{{para|styleBorder|1px #aaa solid}}
*:*{{para|styleBorderCollapse|collapse}}
*:*{{para|styleBackgroundColor|#eee}}
</dd>

==<dt>Sample output</dt>==
<dd><dl>
===Sample:1===
<dt style="font-family:monospace,Courier; font-weight:normal; border:2px solid teal; border-radius:1em;">
<nowiki>{{Notice|type=Notice box|info=Does not use the {{t|Ambox}} template and could be considered a simpler alternative, since it doesn't have a CSS dependency.}}</nowiki>
</dt>
<dd>gives...</dd>
<dd style="border:2px solid teal; border-radius:1em;">{{Notice|type=Notice box|info=Does not use the {{t|Ambox}} template and could be considered a simpler alternative, since it doesn't have a CSS dependency.}}</dd>
===Sample:2===
<dt style="font-family:monospace,Courier; font-weight:normal; border:2px solid teal; border-radius:1em;">
<nowiki>{{Notice|styleWidth=50%|type=Notice box|info={{Lorem ipsum|1|&ldquo;|&rdquo;}} }}</nowiki>
</dt>
<dd>gives...</dd>
<dd style="border:2px solid teal; border-radius:1em;">{{Notice|styleWidth=50%|type=Notice box|info={{Lorem ipsum|1|“|”}} }}</dd>
===Sample:3===
<dt style="font-family:monospace,Courier; font-weight:normal; border:2px solid teal; border-radius:1em;">
<nowiki>{{Lorem ipsum|1|&ldquo;|&rdquo;}}</nowiki> 
<nowiki>{{Notice|float=N|type=Notice box|info={{Lorem ipsum|1|&ldquo;|&rdquo;}} }}</nowiki> 
<nowiki>{{Lorem ipsum|2|&ldquo;|&rdquo;}}{{-}}</nowiki>
</dt>
<dd>gives...</dd>
<dd style="border:2px solid teal; border-radius:1em;">{{Lorem ipsum|1|“|”}}
{{Notice|float=N|type=Notice box|info={{Lorem ipsum|1|“|”}} }}
{{Lorem ipsum|2|“|”}}{{-}}</dd>
===Sample:4===
<dt style="font-family:monospace,Courier; font-weight:normal; border:2px solid teal; border-radius:1em;">
<nowiki>{{Lorem ipsum|1|&ldquo;|&rdquo;}}</nowiki> 
<nowiki>{{Notice|float=Left|type=Notice box|info={{Lorem ipsum|1|&ldquo;|&rdquo;}} }}</nowiki> 
<nowiki>{{Lorem ipsum|2|&ldquo;|&rdquo;}}{{-}}</nowiki>
</dt>
<dd>gives...</dd>
<dd style="border:2px solid teal; border-radius:1em;">{{Lorem ipsum|1|“|”}}
{{Notice|float=Left|type=Notice box|info={{Lorem ipsum|1|“|”}} }}
{{Lorem ipsum|2|“|”}}{{-}}</dd>
===Sample:5===
<dt style="font-family:monospace,Courier; font-weight:normal; border:2px solid teal; border-radius:1em;">
<nowiki>{{Lorem ipsum|1|&ldquo;|&rdquo;}}</nowiki> 
<nowiki>{{Notice|float=Right|type=Notice box|info={{Lorem ipsum|1|&ldquo;|&rdquo;}} }}</nowiki> 
<nowiki>{{Lorem ipsum|2|&ldquo;|&rdquo;}}{{-}}</nowiki>
</dt>
<dd>gives...</dd>
<dd style="border:2px solid teal; border-radius:1em;">{{Lorem ipsum|1|“|”}}
{{Notice|float=Right|type=Notice box|info={{Lorem ipsum|1|“|”}} }}
{{Lorem ipsum|2|“|”}}{{-}}</dd>

</dl></dd>

==<dt>See also</dt>==
<dd>
*{{t|Ambox}}
</dd>

</dl>

Template:PG/Notice/doc - Revision history

imported>Trimoon: Switching to sections to aid modifications, and fixing a small bug