View source for Template:Pp-meta/doc

{{template doc page}}
<includeonly>{{intricate template}}</includeonly>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<noinclude><center>'''Note: This documentation page is NOT protected, despite the golden padlock in the corner.'''</center></noinclude>
This is {{tl|pp-meta}}, a meta template used to create [[Wikipedia: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 [[Wikipedia:Article message boxes|article message box]] style. 
# If on any kind of talk page it generates a message box in the standardised [[Wikipedia: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 part of the code for the "small" case with just an icon at the top right corner of the page.

'''Note:''' 

If these two boxes don't look alike, you need to [[Wikipedia:Bypass your cache|refresh your web browser cache]]:

{{pp-meta
| demospace = Main
| image = -
| text = Box generated by {{tl|pp-meta}}.
}}
{| style="width: 80%; margin: 0 auto; border-collapse: collapse; background: #FBFBFB; border: 1px solid #aaa; border-left: 10px solid #bba;"
|- 
| style="width:52px; padding:2px 0px 2px 0.5em; text-align:center;" | -
| style="padding: 0.25em 0.5em;" | Hardcoded box.
|}

This is a temporary caching problem that should be gone in some days.

=== Examples ===

Note that the small padlock in the top right corner of this page also is an example created with this meta template.

<!-- Example showing the small padlock in the top right corner. 
The #if: statement is there to show where best to put an 
if-statement that chooses whether to use
the small padlock or the big protection box. -->
<noinclude>
{{pp-meta
| smalltext = 
  {{#if:"small==yes"|
    <imagemap>
      Image:Padlock.svg|20px
      rect 0 0 1000 1000 [[Wikipedia:Protection policy|This high-risk template has been semi-protected from editing to prevent vandalism]]
      desc none
    </imagemap>
  }}
}}
</noinclude>

==== Main space ====
{{pp-meta
| demospace = Main
| image = [[Image:Padlock.svg|40px]]
| text = 
'''This page is {{#if:{{{tprot|}}}|temporarily|currently}} [[Wikipedia:This page is protected|protected]] from editing {{#if:{{{expiry|}}}|until {{#time:[[F j]], [[Y]]|{{{expiry}}}}} <small>(UTC)</small>}} {{#if:{{{reason<includeonly>|</includeonly>}}}|because {{lcfirst:{{{reason|<noinclude>[[Lorem ipsum|Lorem ipsum dolor sit amet]]</noinclude>}}}}}}}.''' ([{{fullurl:Special:Log|type=protect&page={{FULLPAGENAMEE}}}} protection log]). {{howtoedit}}
}}

==== Any talk space ====
{{pp-meta
| demospace = Talk
| image = [[Image:Padlock-silver-medium.svg|40px]]
| text =
'''This user talk page has been {{#if:{{{expiry|}}}|temporarily}} [[Wikipedia:This page is protected|protected]] from editing by new or unregistered users {{#if:{{{expiry|}}}|until {{#time:[[F j]], [[Y]]|{{{expiry}}}}} <small>(UTC)</small>}} {{#if:{{{reason|}}}|{{{reason}}}.'''|to prevent {{vandal-m|<includeonly>{{{user|{{BASEPAGENAME}}}}}</includeonly><noinclude>Example</noinclude>}} and other new users from making disruptive edits'''.}}
}}

==== Other spaces ====
{{pp-meta
| image = [[Image:Padlock.svg|40px]]
| text = 
'''This {{#switch:{{NAMESPACE}}
  |{{ns:image}}=image, used in one or more [[Wikipedia:High-risk templates|high-risk templates]] and/or [[Special:Allmessages|system messages]],
  |#default=[[Wikipedia:High-risk templates|high-risk template]]
}} has been [[Wikipedia:This page is protected|protected]] from editing to prevent [[Wikipedia:vandalism|vandalism]].''' ([{{fullurl:Special:Log|type=protect&page={{FULLPAGENAMEE}}}} protection log]). {{howtoedit}}
{{#switch:{{NAMESPACE}}|{{ns:image}}=<small>'''Do not move this image''' to [[commons:|Wikimedia Commons]].</small>}}
}}

=== Usage ===
<pre>
{{pp-meta
| smalltext = <imagemap> </imagemap>
| image = [[Image:Padlock.svg|40px]]
| text = The message body text.
| categories = {{{categories|Any categories the child template should place on the target page, with ParserFunctions if desired.}}}
}}
</pre>

=== Parameters ===
'''smalltext'''
:Should be empty or undefined if the normal big message box is wanted. If non-empty it puts the data it gets in the upper right corner of the page. Feed the imagemap with all its content for the small padlock in the upper right corner. For instance:

<pre><nowiki>
<imagemap>
  Image:Padlock-silver-medium.svg|20px
  rect 0 0 1000 1000 [[Wikipedia:Protection policy | This high-risk 
template has been semi-protected from editing to prevent vandalism]]
  desc none
</imagemap>
</nowiki></pre>

'''image'''
:The image to use for the big message box. Usual wiki image notation and should be about 40px size. For instance:
::<code><nowiki>[[Image:Padlock.svg|40px]]</nowiki></code>

'''text'''
:The message body text.

'''demospace'''
:'''Main / Talk / Other''' = Manually set namespace. Only for testing and demonstration purposes. If empty or undefined then the namespace is detected automatically.

'''categories'''
:This parameter is designed to support [[:Category:Category suppression supporting templates|category suppression]], such that if <code>categories=no</code> is passed, the template will not return categories. It should be used to insert the categories that will be placed upon the page where the template is transcluded. For use in a child template, wrap the categories in <tt><nowiki>{{{categories|</nowiki>&nbsp;&nbsp;&nbsp;&nbsp;<nowiki>}}</nowiki></tt> to allow the input "no" to be made to the child template. This parameter should '''never''' have non-category, non-invisible content passed, as this will display under and outside the template box.

=== Technical details ===
;smalltext:
The reason the '''smalltext''' has to get the whole imagemap as parameter instead of creating it based on the '''image''' and a text parameter is that [[MediaWiki]] can not handle template variables inside an imagemap.

;categories:
This template contains the following code to support category placement: <pre><nowiki><includeonly>{{#ifeq:{{{categories|no}}}|no||{{{categories|}}}}}</includeonly></nowiki></pre>
*This code first evaluates if <code>categories</code> is equal to "<code>no</code>". If so, it cancels the display of a pp-template's article categories at each level. If not, it displays the values if and only if present.
*It is offset with includeonly tags to only be made effective at the transcluded level - that is, wherever the template is placed, so will its categories.
Any template calling pp-meta should use the following code for categories: <pre>|categories={{{categories|Foo}}</pre>
* Where <code>Foo</code> is in the example is where the categories that one wants the calling template to display should be placed. These can also use ParserFunctions to be disabled where desired (i.e. expiry-enabled categories that appear once the current article is unprotected again).
*Any template calling pp-meta should use the form <code><nowiki><includeonly>{{pp-meta}}</includeonly></nowiki></code> (where the pp-meta transclusion includes parameters), so categories placed as the calling template's default for <code>categories</code> will be transcluded only to the protected page where the calling template is transcluded, rather than to the calling template itself.

=== See also ===
* [[Wikipedia:Template messages/Maintenance#Protected articles, pages and images]] – Examples of all the current protection templates.
* [[Wikipedia:Article message boxes]] – The (proposed) style guideline for creating article message boxes.
* [[Wikipedia talk:Article message boxes]] – For discussion about these matters.
* [[Wikipedia:Talk page templates]] – For the "coffee roll" standard used in talk page templates.

{{protection templates}}

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