Template:Editnotice

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Documentationviewedithistorypurge
This documentation is transcluded from Template:Editnotice/doc.

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

To create a new editnotice, please follow the instructions at Commons:Editnotice. See also standard editnotice templates at Category:Editnotice templates or for a user page insert {{Editnotice userpage}}.

Usage

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

Template parameters

ParameterDescriptionDefaultStatus
expiryexpiry dateWhen the editnotice will cease to be visible on the affected page(s). 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 April 5 2013
To specify that an editnotice never expires, “indefinite” may be used.
indefiniteoptional
idIDHTML ID of the edit noticeemptyoptional
headerheaderHeader textemptyoptional
headerstyleheader styleCSS for the headeremptyoptional
text
1
textThe body text of the edit noticeemptyrequired
textstyletext styleCSS for the body textemptyoptional
imageimageImage name to be shown on the left of the edit notice, e.g. “Example.svg”emptyoptional
imagerightright imageImage name to be shown on the right of the edit notice, e.g. “Example.svg”emptyoptional
classbox classExtra CSS class for the whole boxemptyoptional
stylebox styleCSS style for the whole boxemptyoptional
Template data
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either useTemplateData=1 or useTemplateData=only on the /doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

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

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
box classclass

Extra CSS class for the whole box

Lineoptional
expiry dateexpiry

When the editnotice will cease to be visible on the affected page(s). 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; or 11:09 April 5 2013. To specify that an editnotice never expires, “indefinite” may be used.

Default
indefinite
Lineoptional
headerheader

Header text

Contentoptional
header styleheaderstyle

CSS for the header

Lineoptional
IDid

HTML ID of the edit notice

Lineoptional
imageimage

Image name to be shown on the left of the edit notice, e.g. “Example.svg”

Fileoptional
right imageimageright

Image name to be shown on the right of the edit notice, e.g. “Example.svg”

Fileoptional
box stylestyle

CSS style for the whole box

Lineoptional
texttext 1

The body text of the edit notice

Contentrequired
text styletextstyle

CSS for the body text

Lineoptional

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: Administrators

See also

Localization

This template is not intended to be localized.

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 =
}}
{{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 book. The FAQ includes questions on many issues that have been discussed.
| textstyle = background-color: #fee;
| image =
}}
{{editnotice
| id = engvaredn
| header =
| headerstyle =
| text = This book is written in '''British English''', which differs from American English in some ways. See [[w:American and British English differences|]]. According to the local manual of style, this should not be changed without broad consensus.
| textstyle =
| image = [[File:Flag of the United Kingdom.svg|50px|link=|alt=]]
}}

Namespace key

0 – Gallery
1 – Talk:
2 – User: [1]
3 – User talk: [2]
4 – Commons:
5 – Commons talk:
6 – File:
7 – File talk:
8 – MediaWiki:
9 – MediaWiki talk:
10 – Template:
11 – Template talk:
12 – Help:
13 – Help talk:
14 – Category:
15 – Category talk:
100 – Creator:
101 – Creator talk:
102 - TimedText:
103 - TimedText talk:
104 - Sequence:
105 - Sequence talk:
106 - Institution:
107 - Institution talk:

  1. User edit notices are now implemented by creating a subpage on the user page named "/Editnotice". This allows non-admin users to edit their own notices. Display of the user edit notice is controlled by MediaWiki:Editnotice-2.
  2. User talk edit notices are now implemented by creating a subpage on the user talk page named "/Editnotice". This allows non-admin users to edit their own notices. Display of the user talk edit notice is controlled by MediaWiki:Editnotice-3.