Difference between revisions of "Template:Editnotice/doc"

From blackwiki
Jump to navigation Jump to search
imported>Ahecht
(document style and class parameters)
imported>Funandtrvl
(update code)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[</nowiki>[[Wikipedia:Wikidata]]<nowiki>]]) -->
 
+
== Usage ==
=== 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.
 
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 insert <code><nowiki>{{</nowiki>[[Template:Editnotice userpage|Editnotice userpage]]<nowiki>}}</nowiki>.</code>
+
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">
 
<pre style="overflow: auto">
 
{{editnotice
 
{{editnotice
Line 22: Line 22:
 
</pre>
 
</pre>
  
'''''Note''': All parameters are optional except <code>text</code>.''
+
'''''Note''': All parameters are optional, except for <code>text</code>.''
  
=== Parameters ===
+
== Parameters ==
 
* {{para|expiry|expiry date}}
 
* {{para|expiry|expiry date}}
 
* {{para|id|optional HTML id}}
 
* {{para|id|optional HTML id}}
Line 39: Line 39:
 
::<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>
 
::<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>
  
=== Examples ===
+
=== 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 April 5 2013
 +
To specify that an editnotice never expire, {{para|expiry|indefinite}} may be used.
  
 +
== Examples ==
 
<pre style="overflow: auto">
 
<pre style="overflow: auto">
 
{{editnotice
 
{{editnotice
Line 100: Line 106:
 
}}
 
}}
  
==== Namespace key ====
+
=== Namespace key ===
 
<poem>
 
<poem>
 
0 – (Main)
 
0 – (Main)
Line 132: Line 138:
 
{{reflist|group="note"}}
 
{{reflist|group="note"}}
  
=== Expiry date ===
+
== Editnotices created so far ==
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 April 5 2013
 
To specify that an editnotice never expire, {{para|expiry|indefinite}} may be used.
 
 
 
=== Editnotices created so far ===
 
 
{{Hst|reason=This list is created automatically by [[Special:PrefixIndex]].}}
 
{{Hst|reason=This list is created automatically by [[Special:PrefixIndex]].}}
 
{{Special:PrefixIndex/MediaWiki:Editnotice}}
 
{{Special:PrefixIndex/MediaWiki:Editnotice}}
Line 145: Line 144:
 
{{Hsb}}
 
{{Hsb}}
  
=== See also ===
+
== See also ==
 
* [[Wikipedia:Editnotice]] – More about editnotices
 
* [[Wikipedia:Editnotice]] – More about editnotices
 
* {{tl|editnotice pagename}} – Returns the pagename for the editnotice for the current page
 
* {{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
 
* {{tl|editnotice talkpagename}} – Returns the talkpage name for the editnotice for the current page
  
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 +
<!-- Categories below this line, please; interwikis at Wikidata -->
 
[[Category:Wikipedia editnotices| ]]
 
[[Category:Wikipedia editnotices| ]]
 
[[Category:Editnotice templates| ]]
 
[[Category:Editnotice templates| ]]
 
+
}}</includeonly>
</includeonly>
 

Revision as of 17:58, 17 December 2015

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 =".

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 April 5 2013

To specify that an editnotice never expire, |expiry=indefinite may be used.

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 article. The FAQ includes questions on many issues that have been discussed.
| textstyle = background-color: #fee;
| image =
}}
{{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
}}

Namespace key

0 – (Main)
1 – Talk:
2 – User: [note 1]
3 – User talk: [note 2]
4 – Wikipedia:
5 – Wikipedia 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 – Portal:
101 – Portal talk:
108 – Book:
109 – Book talk:
118 – Draft:
119 – Draft talk:
710 – TimedText:
711 – TimedText talk:
828 – Module:
829 – Module 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.

Editnotices created so far

This list is created automatically by Special:PrefixIndex.


See also