Purpose

edit

"Pin" a discussion thread (a talk page section) so it does not automatically archive. Produces a box explaining to readers the thread will remain unarchived.

Effect

edit

This is a wrapper for the invisible template {{do not archive until}} that is used to prevent bots archiving a discussion thread. It produces a visible message that the thread has been pinned.

The pin message will remain in the thread for a long time. Please see the template documentation on {{DNAU}} for details.

Usage

edit

Place {{subst:Pin section}} or {{subst:pinsec}} at the top of a talk page section (on a new line after the section title). For example:

== Something ==
{{subst:Pin section}}

This template must be substituted.

Use |1= to specify a number of days to keep the section pinned for. If this parameter is used, the message box will display the end date/time. For example, to keep a message pinned for 47 days:

== Something ==
{{subst:Pin section|47}}

Use |2= to specify a time unit other than the default of days. For example, to keep a message pinned for 47 weeks:

== Something ==
{{subst:Pin section|47|weeks}}

TemplateData

edit

This template should '''ALWAYS''' be substituted! "Pin" a discussion thread (a talk page section) so it does not automatically archive. Produces a box explaining to readers the thread will remain unarchived. Expires after ten years by default.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Expires after1

Specify a number of days ('time unit') to keep the section pinned for. 'Number of days' is the time unit by default, if "Time unit" or second unnamed parameter not specified. The message box will display the end date or time. For example, setting 30 will set an expiry of 30 days.

Default
3650
Example
30
Numbersuggested
"Time unit" for expiry2

Specify the time unit in days, weeks, months, years.

Default
days
Example
weeks
Stringsuggested

See also

edit