This template employs intricate features of template syntax. You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here. |
This is {{pp-meta}}, a meta-template used to create protection message boxes.
This meta-template automatically uses the right style for each namespace. It also takes care of the code for the "small" case with just a small padlock icon at the top right corner of the page.
Note that the small padlock in the top right corner of this page also is an example created with this meta-template. This template uses a position that does not collide with icons such as the "Featured Article" star, the "Spoken Wiki pp-Meta" icon, or other top-right-hand-corner icons.
Templat:Pp-protected
Templat:Pp-protected
Templat:Pp-protected
{{pp-meta | type =| disallowlevel = | small = {{{small|}}} | expiry = {{{expiry|}}} | reason = | xfd = | demospace = {{{demospace|}}} | demolevel = {{{demolevel|undefined}}} | image = | icon-link = | icon-text = | icon-reason = | reason-text = | explanation-text = | categories = {{{categories| }}} }}
This template is designed to be both defining of the major types of protection notice, but flexible enough to allow exceptions. All parameters have some fallback to allow for graceful failure, but some should almost always be applied.
type
full
, semi
, indef
, move
, create
, and office
(all case-insensitive). These values apply default boilerplate text, images, and links. This parameter should almost always be used, as the default settings require little other input, making the code of templates such as {{pp-semi-protected}} very clean. Note that not supplying this parameter causes the image to default to Image:Transparent.gif.small
yes
" (case-insensitive). As instance templates should be able to decide, using their input, whether or not to apply small
, this should usually be set to {{{small|}}}
, which defaults to non-small but allows small to be specified. Not supplying this parameter will cause the template to always be expanded big.expiry
type
is defined normally, the expiry date to be automatically displayed properly for both the tooltip of the small version and in text for the large version. It should typically take the input {{{expiry|}}}
, which allows instances using this template to be provided input specifying the expiry date. It should be left blank for templates where type
is set to indef
, as it has no effect because indefinite protection templates clearly do not need expiry dates to be specified.dispute
type
parameter, but the explanation-text
parameter described below overrides it when applicable.reason
so that there are proper spaces between words as {{{reason|}}}
in the code is not prefixed with a space, such that the requisite full stop is not prefixed by a space when reason
is null. Instances which want to pass through the reason should use code along the general lines of {{{reason|a default reason}}}
.categories
{{{categories|
and }}}
, which will cause categories to be disabled in the instances if they are given |categories=no
as an argument. If the template applies no categories, there is no use for this parameter.demospace
demospace={{{demospace|}}}
so as to allow them to be forced to display as though they were in a particular namespace. If a template is to be always used in a particular namespace and never in another, it is also possible to set demospace
to any of main
, talk
, or other
(all case-insensitive) to specify the messagebox type typical for that namespace or namespace family such that it will never change from that type.demolevel
demospace
parameter, is useful for demonstration and testing. Instances should generally use the code demospace={{{demolevel|undefined}}}
so as to allow them to be forced to display as though they were on a page with a particular level of protection. This must have the default of "undefined" if it is used, as a null value will cause the template to fail. Failing the demolevel test causes the template to disappear and the page to be placed into Category:Wikipedia pages with incorrect protection templates.xfd
type
applied is create
, and explanation-text
as below does not over-ride it, then the parameter xfd should be applied as equal to {{{xfd|}}}
so that this input is passed through and the explanation can be more descriptive.image
icon-link
type
is in use as type
applies proper links to Wikipedia:Protection policy, but it allows for exceptions and can define the link to sections within that page. Input given to this parameter should not be supplied within [[double brackets]].icon-text
icon-link
parameter, affects only the small version. This one, however, affects the text outputted as the tooltip for the protection icon. It completely replaces, when used, the default text and any specified by type
, including the final full stop.icon-reason
type
. It is over-written by icon-text
if that parameter is used.reason-text
type
, expiry
, and reason
, including the final full stop.explanation-text
type
, dispute
, and, if applicable, xfd
.disallowlevel
move
or create
. It can be set to either autoconfirmed
or sysop
to disable the template on semi-protected or full-protected pages respectively. If the page is protected at the disallowed level and demolevel
is not set to the allowed level, the template will not appear and the page will be placed into Category:Wikipedia pages with incorrect protection templates.{{pp-meta | type = | disallowlevel = | small = | expiry = | reason = | xfd = | demospace = | demolevel = | image = | icon-link = | icon-text = | icon-reason = | reason-text = | explanation-text = | categories = }}
Templat:Protection templates
The above documentation is transcluded from Templat:Pp-meta/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template. |