Template:Contentious topics/page restriction editnotice base/doc
This is a documentation subpage for Template:Contentious topics/page restriction editnotice base. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 3,500 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template should not be substituted. |
This template is used as a base for all contentious topics editnotices that have page restrictions, such as topic specific editnotices. It should not be used directly.
Usage of this template will place the editnotice in Category:Wikipedia arbitration enforcement current sanctions unless nocat is set.
Usage
[edit]
Parameter | Description | Type | Status | |
---|---|---|---|---|
The contentious topic code | topic t 1 | What contentious topic applies to this page. Specified using a shorthand code listed on this template's documentation page. | String | required |
Are only parts of this page covered | section | Whether only parts of this page are covered under the contentious topic restrictions. Set to yes to indicate that this is the case.
| String | optional |
The expiry of the restriction on this page | expiry | The expiry of the restriction that has been placed on this page.
| Date | optional |
Protection level applied, if any | protection | What kind of protection has been applied. Must be one of semi, ecp or full. Leave blank for no protection being applied.
| String | optional |
Is the 1RR restriction active | 1RR | Include any content to mark that the 1RR restriction is active. | Unknown | optional |
Is the 0RR restriction active | 0RR | Include any content to mark that the 0RR restriction is active. | Unknown | optional |
Is the consensus required restriction active | consensus-required | Include any content to mark that the "consensus required" restriction is active. | Unknown | optional |
Is the BRD restriction active | BRD | Include any content to mark that the BRD restriction is active. | Unknown | optional |
Custom restriction(s) | other | Any content here will be displayed as a restriction. Use this for custom restrictions that don't match any other restriction types accounted for in this template. | Unknown | optional |
Whether this template should add categories | nocat | Any content in this parameter prevents this template adding categories to the editnotice page. Should only be used for demonstration purposes, and uses for articles should never use this parameter. | Unknown | optional |
Content to be appended to the editnotice | appendedcontent | Content to be appended to the editnotice. Intended for use by custom topic specific editnotices. Shouldn't usually be a parameter in any template that uses this as a base. | String | optional |