Difference between revisions of "Template:Editnotice/doc"

From blackwiki
Jump to navigation Jump to search
imported>ClareSansam
imported>Sdkb
(attempt to encourage standardizing formatting of instruction editnotices)
 
(46 intermediate revisions by 38 users not shown)
Line 1: Line 1:
Clare Sansam-McGregor
+
{{Documentation subpage}}
 +
{{High-use|11479}}
 +
{{Used in system}}
 +
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[</nowiki>[[Wikipedia:Wikidata]]<nowiki>]]) -->
 +
__TOC__
 +
{{Editnotice templates|state=expanded}}
 +
== 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.
  
Exciting urban fantasy “WE EXIST” by Clare Sansam-McGregor
+
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.
By the end not only will those who hear Jess’s story know her secret but things they simply didn’t understand before will have been explained and the greatest comfort of all will be knowing that with their every move, Jess will be there.
 
  
 +
===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>.''
  
We Exist by Clare Sansam-McGregor
+
== Parameters ==
Aug 05, 2011 - Meet Jess, she is eighteen and has been for many, many years. She has a secret you know, one that she shouldn’t tell but just has to. She has kept this a secret for a very long time and now it’s time for her to let others know of their existence, of her existence. This time there is something else out there. Something which you may already be aware of, that’s if you choose to believe. WE EXISTattempts to deal with people’s beliefs and emotions by questioning them and keeping readers involved throughout the story.
+
* {{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}}
  
About the Author:
+
::<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>
  
Clare Sansam-McGregor lives in Hull where she works as an Executive Officer. She is currently working on her next novel which will also ask readers to question their commonly-held convictions and open their mind to the prospect of there being more to the real world than we currently know and understand.
+
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.
  
Excerpt from the book:
+
=== 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, 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.
  
‘This is insane,’ I said as I looked around but there was nowhere to run, nowhere to hide. Nowhere to hide at all. I was thinking, this wasn’t possible was it? What he was saying, it can’t be true can it? I looked back again at Lucas and I tried to be calm. I really did as I said, ‘Ok so what if you’re right, what if I am an angel, how? Why did I become one? Can you at least tell me that?’
+
== 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:
  
‘Come here my child,’ Lucas said and at the same time he held out his hand to me and I walked forward. I walked right to him and held out my hand to meet his. I was so bewildered, I can’t really explain.
+
{{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!
 +
}}
  
‘Are you an angel too?’ I said.
+
== Examples ==
 +
<pre 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 =
 +
}}
 +
</pre>
 +
{{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 =
 +
}}
  
‘Jess we are all angels. Come through here and I will explain to you,’ Lucas said to me.
+
<pre 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 =
 +
}}
 +
</pre>
 +
{{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 =
 +
}}
  
A copy of this book can be ordered from Authorhouse at: http://www.authorhouse.co.uk/Bookstore/BookDetail.aspx?B …  Also available at Amazon.com and Amazon.co.uk
+
<pre 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
 +
}}
 +
</pre>
 +
{{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}}.}}
 +
=== Namespace key ===
 +
<poem>
 +
0 – (Main)
 +
1 – Talk:
 +
2 – User: <ref group="note">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]].</ref>
 +
3 – User talk: <ref group="note">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]].</ref>
 +
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:
 +
</poem>
 +
 
 +
{{reflist|group="note"}}
 +
 
 +
== 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
 +
 
 +
<includeonly>{{Sandbox other||
 +
<!-- Categories below this line, please; interwikis at Wikidata -->
 +
[[Category:Wikipedia editnotices| ]]
 +
[[Category:Editnotice templates| ]]
 +
}}</includeonly>

Latest revision as of 23:43, 2 November 2020

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

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:

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 and is truncated given the large number of edit notices.


See also