User:Yapperbot/Pruner/use/doc

This template is used to mark pages for pruning with Pruner. The template deliberately does not produce any output.

Usage

The full configuration is shown below:

{{User:Yapperbot/Pruner/use
|format=
|inactivity=
|expiredmsg=
|talkmsgheader=
|indeffed=
}}

Parameter	Details	Example
|format=	One of the defined user list formats: link: User:Example or Example user: Any of the {{user}} family of templates mailinglist: {{Mailing list member}} frs: The FRS style of user listing signature: Users' signatures (warning: may not always be accurate if signatures do not follow WP:CUSTOMSIG/P)	link
|inactivity=	A timeframe for no edits for users to be removed	3 years
|expiredmsg=	A template that will be substed in a new section on users' talk pages when they are removed for inactivity. The template is called with its first parameter being the username, its second being the page that the user was pruned from, and its third being the timeframe set. Defaults to User:Yapperbot/Pruner/expired, which you may wish to consider using as a template. Set to none to disable any message being sent, although this isn't recommended, as it could be confusing to users returning after a wikibreak.	User:Yapperbot/Pruner/expired
|talkmsgheader=	The header for the new section created for the talk page expiry message, when it is sent to a user. Defaults to You have been pruned from a list.	You were pruned!
|indeffed=	The period of time to wait before removing an indefinitely-blocked user from the list (to allow a grace period for them to appeal). Defaults to 2 months. Set to 0 to remove all indefinitely-blocked users immediately.	5 months

Only |format= and |inactivity= are required, but it is strongly recommended that you include the first four four parameters; otherwise, users who are pruned will receive very generic messages.