Template:Editnotice/doc

Usage
This template is a wrapper template for editnotices, notices that appear above the text area on edit pages. Editnotices can be per-namespace or per-article.

To create a new editnotice, please follow the instructions at WP:Editnotice. See also standard editnotice templates at Category:Editnotice templates or for a user page, use the template instead.

Syntax


Note: All parameters are optional, except for .

Parameters

 * expiry date
 * optional HTML id
 * header text
 * CSS for header style
 * body text
 * CSS for text style
 * image
 * size of image, e.g., 35px
 * image on righthand side
 * CSS class name for the entire editnotice
 * CSS values for the entire editnotice


 * Use only the name of the image file, so instead of " [[File:Wikipedia-logo-v2.svg]] ", use "Wikipedia-logo-v2.svg" following "image =".

If an editnotice targets a page that happens to be a redirect, the editnotice is categorized into the maintenance category. To suppress categorization, set yes explicitly. In almost all cases, this is not necessary.

Expiry date
The expiry parameter can be used to specify when an editnotice will cease to be visible on an article. This can be useful when an editnotice is created for reasons of a temporal nature. Any valid time format may be used, for example: To specify that an editnotice never expire, you can simply not provide an expiry parameter, though this makes the edit notice display the Editnotice/notice template in order to remind editors of any unintentional usage. To suppress this message while still setting the edit notice to never expire, indefinite may be used.
 * January 2012
 * 4 April 2009
 * 11:09 5 April 2013

TemplateData
{	"params": { "expiry": { "description": "date the editnotice will expire and stop displaying; accepts any date format; leave blank to not expire", "type": "date" },		"redirect": { "description": "suppresses categorization if intended target is a redirect", "type": "boolean" },		"type": { "description": "box style type", "suggestedvalues": [ "system", "editnotice", "warning" ],			"default": "editnotice" },		"id": { "description": "optional HTML id", "type": "string" },		"textstyle": { "label": "text style", "description": "CSS for text style", "type": "content" },		"style": { "description": "CSS values for the entire editnotice", "type": "content", "suggested": true },		"class": { "description": "CSS class name for the entire editnotice", "type": "content" },		"image": { "description": "image on the left", "type": "wiki-file-name", "suggested": true },		"imagesize": { "label": "image size", "example": "35px", "suggested": true },		"imageright": { "label": "right image", "description": "image on the right", "type": "wiki-file-name" },		"imagerightsize": { "description": "size of the image on the right", "example": "35px" },		"header": { "description": "header text", "type": "content", "suggested": true },		"headerstyle": { "label": "header style", "description": "CSS for header style", "type": "content" },		"text": { "aliases": [ "1"			],			"description": "text of the editnotice", "type": "content", "required": true }	},	"description": "Creates a notice that appears above the text area on edit pages", "paramOrder": [ "text", "textstyle", "header", "headerstyle", "expiry", "style", "class", "id", "image", "imagesize", "imageright", "imagerightsize", "type", "redirect" ] }

Instruction editnotices
For editnotices that provide instruction on how to edit a page, the Instruction editnotice wrapper template may be used. It takes the same parameters as this template, but with the header, image, style, and expiration preset by default to encourage consistent formatting. It generates editnotices such as this:

Examples






User editnotices
User and user talk editnotices are implemented by creating a subpage named "/Editnotice" of the user or user talk page respectively. This allows non-admin users to edit their own notices. Like all editnotices, these are displayed by Editnotice_load/content.