Template:Used in system/doc

From XMS Wiki
< Template:Used in systemThis is the approved revision of this page, as well as being the most recent.
Jump to navigationJump to search
This is a documentation subpage for Template:Used in system (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

This is the {{used in system}}

message box.

It is meant to be put at the top of the documentation for templates that are used in the Wikipedia user interface.

Note! It is normal that some of the links in the message box are red.

Usage

The template can be used as is. But it can also take some parameters:

  • First parameter allows you to change the second half of the heading text. See examples below.
  • Second parameter is the name of some other talk page if you want discussion to be made there instead. But a better option might be to redirect the talkpage of your template to that other talkpage.

Here are some examples:

{{used in system| in many system messages | Wikipedia talk:High-risk templates }}

{{ombox | type = content | text = This template is used in many system messages.
Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this template's [[Template:Used in system/sandbox|/sandbox or [[Template:Used in system/testcases|/testcases subpage, or in your own Wikipedia:Subpages#How to create user subpages|user space. The tested changes can then be added in one single edit to this template. Please discuss any changes at {{#if: Wikipedia talk:High-risk templates |Wikipedia talk:High-risk templates |the [[Template talk:Used in system|talk page}} before implementing them. }}

{{used in system| in many system messages }}

{{ombox | type = content | text = This template is used in many system messages.
Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this template's [[Template:Used in system/sandbox|/sandbox or [[Template:Used in system/testcases|/testcases subpage, or in your own Wikipedia:Subpages#How to create user subpages|user space. The tested changes can then be added in one single edit to this template. Please discuss any changes at {{#if:|[[{{{2}}}]]|the [[Template talk:Used in system|talk page}} before implementing them. }}

{{used in system| | Wikipedia talk:High-risk templates }}

{{ombox | type = content | text = This template is used in system messages.
Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this template's [[Template:Used in system/sandbox|/sandbox or [[Template:Used in system/testcases|/testcases subpage, or in your own Wikipedia:Subpages#How to create user subpages|user space. The tested changes can then be added in one single edit to this template. Please discuss any changes at {{#if: Wikipedia talk:High-risk templates |Wikipedia talk:High-risk templates |the [[Template talk:Used in system|talk page}} before implementing them. }}

The full code for a /doc page top can look like this:

{{documentation subpage}}
{{used in system| in many system messages }}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

Technical details

The /sandbox and /testcases links are the standard names for such subpages. If those pages are created then the green /doc box for the template will detect them and link to them in its heading. For instance see the top of this documentation.

See also

– For templates used in the Wikipedia user interface.
– For the most high-use (high-risk) templates.
– For the slightly less high-risk templates.


– The protection template that usually is put on high-risk templates.