Editing Template:Pp-meta/doc

{{Documentation subpage}}
<includeonly>{{intricate template}}</includeonly>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
This is {{tl|pp-meta}}, a meta-template used to create [[MiddleWiki:Template messages/Maintenance#Protected articles, pages and images|protection message boxes]]. 

# If on an article (main space) it generates a message box in the standardised [[MiddleWiki:Article message boxes|article message box]] style. 
# If on any kind of talk page it generates a message box in the standardised [[MiddleWiki:Talk page templates|talk page "coffee roll"]] style.
# If on any other page it generates a message box in the old protection template style.

This meta-template also takes care of the code for the "small" case with just an icon at the top right corner of the page.

=== Examples ===

Note that the small padlock in the top right corner of <includeonly>this page</includeonly><noinclude>the main template page</noinclude> 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 "[[MW:SPOKEN|Spoken MiddleWiki]]" icon, or other top-right-hand-corner icons.

<!-- Example showing the small padlock in the top right corner. -->
{{pp-template|small=yes}}

==== Main space ====
{{pp-protected|demospace=main|categories=no}}

==== Any talk space ====
{{pp-template|demospace=talk|categories=no}}

==== Other spaces ====
{{pp-move|demospace=other|categories=no}}

=== Usage ===

<pre><nowiki>
{{pp-meta
 |type= <any of "full", "semi", "indef", "move", "create", or "office" depending on protection type>
 |small={{{small|}}} <unless template should always be small, then "yes", or if never small, "no" or omit>
 |expiry={{{expiry|}}} <omit for indef templates>
 |reason=&#32;<your reason here>
 |xfd=<if type is "create", then "{{{xfd|}}}", else omit>
 |demospace={{{demospace|}}} <unless template should only be used in one mainspace, when it is then
   appropriate to set this to "main", "talk", or "other" where talk includes all odd-numbered namespaces>
 |image=<your image here without Image: prefix, omit unless nonstandard>
 |icon-link=<your link without any [[]] but perhaps with a #section here, applies to icon version>
 |icon-text=<your *complete* alternate icon text including full stop if applicable.
   Use only plaintext. Omit unless nonstandard.>
 |icon-reason=<your specific reason here without full stop, use only plaintext>
 |reason-text=<your complete top line without formatting but including full stop and allowing wikilinks.>
 |explanation-text=<Your full explanation here>
 |categories={{{categories|<your categories here, else replace all with "no">}}}}}
</nowiki></pre>

=== Parameters ===
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 [[fault-tolerant system|graceful failure]], but some should almost always be applied.

===="Usually" required parameters====
;<code>type</code>:The '''type''' parameter applies most default settings for the broad classes of protection templates. It can have values equal to any of the following: <code>full</code>, <code>semi</code>, <code>indef</code>, <code>move</code>, <code>create</code>, and <code>office</code> (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 <span style="font-family:monospace;"><nowiki>{{</nowiki>[[Template:Pp-semi-protected|pp-semi-protected]]<nowiki>}}</nowiki></span> very clean. Note that not supplying this parameter causes the image to default to [[:Image:Transparent.gif]].
;<code>small</code>: The '''small''' parameter lets the template decide whether to display a small icon version or a large boilerplate version. It can take any value, but the only one which will be acted on is "<code>yes</code>" (case-insensitive). As instance templates should be able to decide, using their input, whether or not to apply <code>small</code>, this should usually be set to <code><nowiki>{{{small|}}}</nowiki></code>, which defaults to non-small but allows small to be specified. Not supplying this parameter will cause the template to always be expanded big.
;<code>expiry</code>: This '''expiry''' parameter allows, when <code>type</code> 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 <code><nowiki>{{{expiry|}}}</nowiki></code>, which allows instances using this template to be provided input specifying the expiry date. It should be left blank for templates where <code>type</code> is set to <code>indef</code>, as it has no effect because indefinite protection templates clearly do not need expiry dates to be specified.
;<code>dispute</code>:The '''dispute''' parameter adds some boilerplate text disclaiming against endorsement of the protected version or title. It is not dependent on the <code>type</code> parameter, but the <code>explanation-text</code> parameter described below overrides it when applicable.
;<code>reason</code>:The '''reason''' parameter allows a particular reason to be applied to the template to explain why the page is protected. The code used in this parameter should be prefixed with <code>&amp;#32;</code> so that there are proper spaces between words as <code><nowiki>{{{reason|}}}</nowiki></code> in the code is not prefixed with a space, such that the requisite full stop is not prefixed by a space when <code>reason</code> is null. Instances which want to pass through the reason should use code along the general lines of <code><nowiki>{{{reason|a default reason}}}</nowiki></code>.
;<code>categories</code>: The '''categories''' parameter is relatively strict in the input form instances of this template should use: if the template has categories that it should apply to pages upon which it is placed, they should be implemented within the container of <code><nowiki>{{{categories|</nowiki></code> and <code><nowiki>}}}</nowiki></code>, which will cause categories to be disabled in the instances if they are given <code>|categories=no</code> as an argument. If the template applies no categories, there is no use for this parameter.
;<code>demospace</code>: Although the '''demospace''' parameter is primarily useful for testing purposes, its name betrays its purpose: demonstration. Instances should generally use the code <code>demospace=<nowiki>{{{demospace|}}}</nowiki></code> 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 <code>demospace</code> to any of <code>main</code>, <code>talk</code>, or <code>other</code> (all case-insensitive) to specify the messagebox type typical for that namespace or namespace family such that it will never change from that type.

====Type-dependent parameters====
;<code>xfd</code>: If the <code>type</code> applied is <code>create</code>, and <code>explanation-text</code> as below does not over-ride it, then the parameter '''xfd''' should be applied as equal to <code><nowiki>{{{xfd|}}}</nowiki></code> so that this input is passed through and the explanation can be more descriptive.

====Optional parameters====
;<code>image</code>:The '''image''' parameter allows an alternate icon to be chosen if so desired. This image should typically be chosen from [[Commons:Padlock icons]], though any image can be chosen. Only the name of the alternate image should be applied; ''do not'' supply the "Image:" prefix.
;<code>icon-link</code>:The '''icon-link''' parameter allows one to change the page to which the small version's icon links. This probably shouldn't generally be used if <code>type</code> is in use as <code>type</code> applies proper links to [[MiddleWiki: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 <nowiki>[[double brackets]]</nowiki>.
;<code>icon-text</code>: The '''icon-text''' parameter, like the <code>icon-link</code> 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 <code>type</code>, ''including'' the final full stop.
;<code>icon-reason</code>: The '''icon-reason''' parameter allows text to be added to the default text of the small version's tooltip as supplied by <code>type</code>. It is over-written by <code>icon-text</code> if that parameter is used.
;<code>reason-text</code>: This parameter, '''reason-text''', allows one to over-ride the first, bolded line of the text of the expanded version of any instance. It, when used, over-rides input as initially defined by <code>type</code>, <code>expiry</code>, and <code>reason</code>, ''including'' the final full stop.
;<code>explanation-text</code>:This code over-rides the explanation text following the bolded reason line; it over-rides text initially provided by the template itself, <code>type</code>, <code>dispute</code>, and, if applicable, <code>xfd</code>.

====Full list of parameters in vertical form====

<pre><nowiki>
{{pp-meta
 |type=
 |small=
 |expiry=
 |reason=
 |xfd=
 |demospace=
 |image=
 |icon-link=
 |icon-text=
 |icon-reason=
 |reason-text=
 |explanation-text=
 |categories=}}
</nowiki></pre>

=== See also ===

* [[MiddleWiki:Template messages/Maintenance#Protected articles, pages and images]] â€“ Examples of all the current protection templates.
* [[MiddleWiki:Article message boxes]] â€“ The style guideline for creating article message boxes.
** [[MiddleWiki talk:Article message boxes]] â€“ For discussion about these matters.
* [[MiddleWiki:Talk page templates]] â€“ For the "coffee roll" standard used in talk page templates.


<includeonly>
<!-- ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE -->
[[Category:Category suppression-supporting templates|Pp-meta]]
[[Category:Protection templates|*]]
[[Category:Title templates|Pp-meta]]
[[Category:MiddleWiki metatemplates|Pp-meta]]
</includeonly>