Template:Twinkle opt-out/doc
 | This is a documentation subpage for Template:Twinkle opt-out. It may contain usage information, categories and other content that is not part of the original template page. |
 | NOTE: This functionality is not currently supported in Twinkle. This documentation will become true only once https://github.com/wikimedia-gadgets/twinkle/pull/2251 is merged and deployed. |
 | Any breaking changes to this template, including moving it or nominating it for deletion, must be communicated in advance to Twinkle's users and maintainers at Wikipedia talk:Twinkle. The standard installation of Twinkle relies on this template. |
 | This template uses Lua: |
This template can be placed on user talk pages to opt out of notifications from Twinkle.
Use this template at your own risk. Even if you find a few notices annoying, it's probably not a good idea to opt out as you may miss other notices that you care about.
Usage
[edit]In the first unnamed parameter (mandatory), specify a comma-separated list of notice types from which you wish to opt out. The following notice types are supported:
- csd
- prod
- xfd (this is a shorthand for all XFD venues)
- afd
- rfd
- cfd
- tfd
- mfd
- ffd
The types are case-insensitive. Whitespaces around commas are also fine.
Example to opt out of RFD and FFD notices:
{{Twinkle optout|rfd,ffd}}
Example to opt out of CSD and all XFD notices:
{{Twinkle optout|csd,xfd}}
Do not use this template on others' talk pages without permission. Do not embed this template within other templates such as {{retired}} or {{deceased}}. The general consensus is that by default, even retired users should be notified about what's happening to their pages. Deceased users tend to have talk page watchers who may want to see these notices.