Template:Pp-template/doc: Difference between revisions
meta>Davidgothberg Reworking this doc since {{documentation}} now auto-loads this template, and since this template is also for file pages. |
m 71 revisions imported |
||
(43 intermediate revisions by 35 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{Twinkle standard installation}} | |||
{{lua|Module:Protection banner}} | |||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | ||
Line 8: | Line 10: | ||
This template does not show on pages that are not protected, instead it reports an error. Please note that only [[Wikipedia:Administrators|administrators]] can protect pages, this template only informs about the protection status of the page. | This template does not show on pages that are not protected, instead it reports an error. Please note that only [[Wikipedia:Administrators|administrators]] can protect pages, this template only informs about the protection status of the page. | ||
This template should usually not be manually placed on template pages, since it is | This template should usually not be manually placed on template pages, since it is automatically loaded by the {{tl|Documentation}} template of protected template pages. Protected templates (both semi and full) should preferably have a documentation subpage (/doc) so that any editor can update the documentation, categories and interwiki links of the template. See [[Wikipedia:Template documentation]] for more on that. | ||
This template automatically detects the edit protection level (semi or full) of a page, and if it is on a template or file page, and modifies its appearance and how it categorizes the page. | This template automatically detects the edit protection level (semi or full) of a page, and if it is on a template or file page, and modifies its appearance and how it categorizes the page. | ||
Line 15: | Line 17: | ||
* Use {{tlc|pp-template|small=no}} for the large message box. On file pages we recommend using the large box. (It is usually a good idea to also add the {{tl|nocommons}} box on protected image pages, to remind people that protected images should not be deleted even if there is a backup copy on Commons.) | * Use {{tlc|pp-template|small=no}} for the large message box. On file pages we recommend using the large box. (It is usually a good idea to also add the {{tl|nocommons}} box on protected image pages, to remind people that protected images should not be deleted even if there is a backup copy on Commons.) | ||
When {{tl|pp-template}} is added to a protected template, it should be placed inside {{tag|noinclude}} tags (otherwise, every page which uses the template will load the protection notice, which will result in an error message). On file (image) pages the <noinclude></ | When {{tl|pp-template}} is added to a protected template, it should be placed inside {{tag|noinclude}} tags (otherwise, every page which uses the template will load the protection notice, which will result in an error message). On file (image) pages the <noinclude></noinclude> tags are not necessary. | ||
=== See also === | === See also === | ||
{{ | {{Protection templates}} | ||
<includeonly> | <includeonly>{{Sandbox other|| | ||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | <!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | ||
[[Category: | [[Category:Top icon protection templates|{{PAGENAME}}]] | ||
}}</includeonly> | |||
</includeonly> |
Latest revision as of 04:52, 3 September 2020
This is a documentation subpage for Template:Pp-template. It may contain usage information, categories and other content that is not part of the original template page. |
If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify Twinkle's users and maintainers at Wikipedia talk:Twinkle as a courtesy, as the standard installation of Twinkle adds and removes this template. Thank you! |
This template uses Lua: |
This is the {{pp-template}} protection notice.
It is used on protected templates and on protected file (image) pages.
This template does not show on pages that are not protected, instead it reports an error. Please note that only administrators can protect pages, this template only informs about the protection status of the page.
This template should usually not be manually placed on template pages, since it is automatically loaded by the {{Documentation}} template of protected template pages. Protected templates (both semi and full) should preferably have a documentation subpage (/doc) so that any editor can update the documentation, categories and interwiki links of the template. See Wikipedia:Template documentation for more on that.
This template automatically detects the edit protection level (semi or full) of a page, and if it is on a template or file page, and modifies its appearance and how it categorizes the page.
- Use
{{pp-template}}
for the normal appearance (a small icon at the top). - Use
{{pp-template|small=no}}
for the large message box. On file pages we recommend using the large box. (It is usually a good idea to also add the {{nocommons}} box on protected image pages, to remind people that protected images should not be deleted even if there is a backup copy on Commons.)
When {{pp-template}} is added to a protected template, it should be placed inside <noinclude>...</noinclude>
tags (otherwise, every page which uses the template will load the protection notice, which will result in an error message). On file (image) pages the <noinclude></noinclude> tags are not necessary.
See also