View source for Template:Editnotice/doc

{{Documentation subpage}}
{{Used in system}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[</nowiki>[[Wikipedia:Wikidata]]<nowiki>]]) -->
__TOC__

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

===Syntax===
<pre style="overflow: auto">
{{editnotice
| expiry =
| id =
| header =
| headerstyle =
| text =
| textstyle =
| image =
| imagesize =
| style =
| class = 
}}
</pre>

'''''Note''': All parameters are optional, except for <code>text</code>.''

== Parameters ==
* {{para|expiry|expiry date}}
* {{para|id|optional HTML id}}
* {{para|header|header text}}
* {{para|headerstyle|CSS for header style}}
* {{para|text|body text}}
* {{para|textstyle|CSS for text style}}
* {{para|image|image}}
* {{para|imagesize|size of image, e.g., 35px}}
* {{para|imageright|image on righthand side}}
* {{para|class|CSS class name for the entire editnotice}}
* {{para|style|CSS values for the entire editnotice}}

::<small>''Use only the name of the image file, so instead of "<nowiki>[[File:Wikipedia-logo-v2.svg]]</nowiki>", use "'''Wikipedia-logo-v2.svg'''" following "image =".''</small>

If an editnotice targets a page that happens to be a redirect, the editnotice is categorized into the maintenance category {{cl|Editnotices whose targets are redirects}}. To suppress categorization, set {{para|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 {{tl|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, {{para|expiry|indefinite}} may be used.

===TemplateData===
<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"
	]
}
</templatedata>

== Instruction editnotices ==
For editnotices that provide instruction on how to edit a page, the {{tl|Instruction editnotice}} [[WP:Wrapper templates|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:

{{Instruction editnotice
| text = To keep this list sortable, when adding a new entry using the [[WP:Source editor|source editor]], please use {{tlx|sortname|GIVEN NAME(S)|SURNAME}}. Thanks!
}}

== Examples ==
<syntaxhighlight lang="wikitext" style="overflow: auto">
{{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 =
}}
</syntaxhighlight>
{{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 =
}}

<syntaxhighlight lang="wikitext" style="overflow: auto">
{{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 =
}}
</syntaxhighlight>
{{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 =
}}

<syntaxhighlight lang="wikitext" style="overflow: auto">
{{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
}}
</syntaxhighlight>
{{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
}}
{{Hatnote|{{note2|Note:}} For the modern version of the above template, see {{Tlb|British English}}.}}
=== 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 {{t|Editnotice_load/content}}.

== Editnotices created so far ==
{{Hst|reason=This list is created automatically by [[Special:PrefixIndex]] and is truncated given the large number of edit notices.}}
{{Special:PrefixIndex/MediaWiki:Editnotice}}
{{Special:PrefixIndex/Template:Editnotices/}}
{{Hsb}}

== See also ==
* [[Wikipedia:Editnotice]] – More about editnotices
* {{tl|editnotice pagename}} – Returns the pagename for the editnotice for the current page
* {{tl|editnotice talkpagename}} – Returns the talkpage name for the editnotice for the current page

{{Editnotice templates|state=expanded}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia editnotices| ]]
[[Category:Editnotice templates| ]]
}}</includeonly>