Difference between revisions of "Template:Notice/doc"

Revision as of 10:49, 24 April 2016

This template was copied from Template:Notice on Wikia Templates. That wiki should periodically be checked for a new version of this template.

Description:

A simple notice box.

Dependencies:

• Uses File:Gtk-ok.png as default image.
• Uses for this documentation:
  • {{SPW}} = Wikia specific to link back to original.
  • {{t}} = To show clickable template mentions.
  • {{para}} = To show parameter usage.

Syntax:

Type {{Notice|parameters}} somewhere.

Parameters:

• Recommended: |type=

  Notice box header text.

  Default: |type=Header text

• Recommended: |info=

  Notice box additional info.

  Default: |type=Explanation

• Optional: |image=

  Notice box symbol image.

  Provide the image-filename with extension, or use |image=no to completely remove/inhibit the image part.

  Default: |image=Gtk-ok.png

• Optional: |imageSize=

  Notice box symbol image-size.

  Provide the image-size including the unit, eg: px, part.

  Default: |imageSize=50px

• Optional: |border=

  Notice box left-border-bar definition.

  Use |border=definition, where definition is a valid custom definition for the CSS property border-left.

  Or use |border=preset, where preset is one of the predefined names below:

  •     red ⇒ 10px solid #b22222
  •     orange ⇒ 10px solid #f28500
  •     yellow ⇒ 10px solid #f4c430
  •     purple ⇒ 10px solid #9932cc
  •     blue ⇒ 10px solid #1e90ff
  •     green ⇒ 10px solid #228b22
  •     gray ⇒ 10px solid #bba

  Default: |border=blue

  You don't need to provide the ; at the end to properly terminate the definition(s) because it will be appended automatically for proper functionality.

• Optional: |style=inline-CSS;

  Completely override the inline-CSS used in the style-attribute of the table that generates the Notice box.

  Where inline-CSS; defaults to:

  font-size:{{{styleFontSize}}}; width:{{{styleWidth}}}; margin:{{{styleMargin}}}; border:{{{styleBorder}}}; border-collapse:{{{styleBorderCollapse}}}; background-color:{{{styleBackgroundColor}}}; border-left:{{{border}}}

  To override parts of the default shown above you can use: (defaults shown as value)

  • |styleFontSize=95%
  • |styleWidth=80%
  • |styleMargin=0 auto
  • |styleBorder=1px #aaa solid
  • |styleBorderCollapse=collapse
  • |styleBackgroundColor=#eee

Sample output:

{{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.}}

gives...

Notice box Does not use the {{Ambox}} template and could be considered a simpler alternative, since it doesn't have a CSS dependency.

---

{{Notice|styleWidth=50%|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.}}

gives...

Notice box Does not use the {{Ambox}} template and could be considered a simpler alternative, since it doesn't have a CSS dependency.

See also:

• {{Ambox}}