Template:Editnotice/doc

This is a documentation subpage for Template:Editnotice.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used in system messages, and on approximately 18,000 pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

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 {{Editnotice userpage}} template instead.

Syntax

{{editnotice
| expiry =
| id =
| header =
| headerstyle =
| text =
| textstyle =
| image =
| imagesize =
| style =
| class = 
}}

Note: All parameters are optional, except for text.

Parameters

|expiry=expiry date
|id=optional HTML id
|header=header text
|headerstyle=CSS for header style
|text=body text
|textstyle=CSS for text style
|image=image
|imagesize=size of image, e.g., 35px
|imageright=image on righthand side
|class=CSS class name for the entire editnotice
|style=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 Category:Editnotices whose targets are redirects. To suppress categorization, set |redirect=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:

January 2012
4 April 2009
11:09 5 April 2013

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, |expiry=indefinite may be used.

TemplateData

Creates a notice that appears above the text area on edit pages

Template parameters
Parameter		Description	Type	Status
text	`text` `1`	text of the editnotice	Content	required
text style	`textstyle`	CSS for text style	Content	optional
header	`header`	header text	Content	suggested
header style	`headerstyle`	CSS for header style	Content	optional
expiry	`expiry`	date the editnotice will expire and stop displaying; accepts any date format; leave blank to not expire	Date	optional
style	`style`	CSS values for the entire editnotice	Content	suggested
class	`class`	CSS class name for the entire editnotice	Content	optional
id	`id`	optional HTML id	String	optional
image	`image`	image on the left	File	suggested
image size	`imagesize`	no description Example 35px	Unknown	suggested
right image	`imageright`	image on the right	File	optional
imagerightsize	`imagerightsize`	size of the image on the right Example 35px	Unknown	optional
type	`type`	box style type Suggested values `system` `editnotice` `warning` Default editnotice	Unknown	optional
redirect	`redirect`	suppresses categorization if intended target is a redirect	Boolean	optional

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:

Instructions

To keep this list sortable, when adding a new entry using the source editor, please use {{sortname|GIVEN NAME(S)|SURNAME}}. Thanks!

Examples

{{editnotice
| id = loremipsumedn
| header = Attention editors
| headerstyle = font-size: 150%;
| text = Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
| textstyle = font-size: 120%;
| image =
}}

Attention editors

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

{{editnotice
| id = faqedn
| header = Frequently asked questions
| headerstyle = font-size: 120%;
| text = Before editing, please consult the list of Frequently Asked Questions specific to this article. The FAQ includes questions on many issues that have been discussed.
| textstyle = background-color: #fee;
| image =
}}

Frequently asked questions

Before editing, please consult the list of Frequently Asked Questions specific to this article. The FAQ includes questions on many issues that have been discussed.

{{editnotice
| id = engvaredn
| header =
| headerstyle =
| text = This article is written in '''[[British English]]''', which differs from [[American English]] in some ways. See [[American and British English differences]]. According to the [[Wikipedia:Manual of Style#National varieties of English|relevant style guide]], this should not be changed without broad consensus.
| textstyle =
| image = Flag of the United Kingdom.svg
| imagesize = 50px
}}

This article is written in British English, which differs from American English in some ways. See American and British English differences. According to the relevant style guide, this should not be changed without broad consensus.

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

Editnotices created so far

This list is created automatically by Special:PrefixIndex and is truncated given the large number of edit notices.