Template:Editnotice/doc

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search

Script error: No such module "Message box". Template:Used in system

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:Tlx 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 Template:Cl. 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 Template:Tl 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

ParameterDescriptionTypeStatus
texttext 1

text of the editnotice

Contentrequired
text styletextstyle

CSS for text style

Contentoptional
headerheader

header text

Contentsuggested
header styleheaderstyle

CSS for header style

Contentoptional
expiryexpiry

date the editnotice will expire and stop displaying; accepts any date format; leave blank to not expire

Dateoptional
stylestyle

CSS values for the entire editnotice

Contentsuggested
classclass

CSS class name for the entire editnotice

Contentoptional
idid

optional HTML id

Stringoptional
imageimage

image on the left

Filesuggested
image sizeimagesize

no description

Example
35px
Unknownsuggested
right imageimageright

image on the right

Fileoptional
imagerightsizeimagerightsize

size of the image on the right

Example
35px
Unknownoptional
typetype

box style type

Suggested values
system editnotice warning
Default
editnotice
Unknownoptional
redirectredirect

suppresses categorization if intended target is a redirect

Booleanoptional

Instruction editnotices

For editnotices that provide instruction on how to edit a page, the Template:Tl 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:

Template:Instruction editnotice

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

Script error: No such module "Message box". 

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

Script error: No such module "Message box". 

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

Script error: No such module "Message box". Script error: No such module "Hatnote".

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

<templatestyles src="Template:Hidden begin/styles.css"/>

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

See also

Template:Editnotice templates


Retrieved from "http://debianws.lexgopc.com/wiki143/index.php?title=Template:Editnotice/doc&oldid=7159358"