Template:Notice/doc

From K6ka's Wiki
Jump to navigation Jump to search

Description[edit]

This template is used to create notice boxes located atop pages or sections denoting important information. It uses {{Metabox}} as a base.


Parameters[edit]

The template accepts many of the same parameters as {{Metabox}}. It sets some of its own custom parameters that override the default Metabox settings, and will be shown if the parameter is left blank. You can override this template's default values by specifying something in the parameter field.

1 - This is the main text inside of the template. It is a mandatory parameter.

text-color - This is for the color of the text inside the template. If it is left empty, the text will default to white text. You can either type in an HTML color name, or type in an HTML color code (without the #)

title - This parameter adds a line of bolded text at the top of the template.

title-color - This changes the color of the title. The parameter title must be defined for this parameter to do anything. If it is left empty, the title will default to white text. You can either type in an HTML color name, or type in an HTML color code (without the #)

bordercolor - The color of the border surrounding the template. If it is left empty, the border will default to a gray colour. You can either type in an HTML color name, or type in an HTML color code (without the #)

backgroundcolor - The color of the background of the template. If left empty, it will default to a transparent background (usually matches the wiki background color). You can either type in an HTML color name, or type in an HTML color code (without the #)

width - The width of the entire template, measured in percentage. Type in a number (without the % sign). If left blank, it will default to 65%.

size - Only one recognized argument - "small". If defined, the template will display as a smaller, left-aligned box instead of the default center-aligned position.

image - Add the image name into this parameter to display the image. For example, Example.jpg. Do not include the [[File: and ]] (the "File:" prefix and the square brackets); otherwise you will break the image. If left empty, it will display File:Information.svg.

imagewidth - Changes the width of the column where the image resides in. Leave blank for the default value. The parameter image must be defined in order for this parameter to work.

imagesize - Changes the size of the image in the template, measured in pixels. The parameter image must be defined in order for this parameter to work.

imagelink - If defined, the image will link to the name of the page you put into this parameter (e.g. adding Foo to this parameter will create a link to Foo). The parameter image must be defined in order for this parameter to work.