Template:Bump/doc
This is a documentation subpage for Template:Bump. It may contain usage information, categories and other content that is not part of the original template page. |
This template should always be substituted (i.e., use {{subst:Bump}} ). Any accidental transclusions will be automatically substituted by a bot. |
Purpose
[edit]"Bumping" a discussion thread - avoiding its automatic archival for (default) 30 days.
The main intended usage is on pages that archive relatively quickly. Very busy Wikipedia discussion pages are set to be archived every week, or perhaps even every 2 days. Bumping a discussion allows time for more readers to participate.
Most regular article talk pages are, in contrast, set up to archive only after 60 or 90 days or even longer; "bumping" a thread there does nothing.
Effect
[edit]This is a wrapper for the invisible template {{do not archive until}} that is used to prevent bots archiving a discussion thread, changing the default number of days until auto-archival to 30. It produces a visible message that the thread has been bumped. It will auto-sign the notification.
After 30 days (or however many days were specified) the thread (including the bump message) will once more be eligible for auto-archival. Whether it will actually archive at that point or not depends on the automatic archival settings specific to the page.
Usage
[edit]{{subst:Bump|number of days to prevent the thread from archiving|additional note}}
Parameters
[edit]The template takes two optional parameters.
The first integer parameter specifies the minimum number of days before archiving. Supplying this parameter does two things:
- a. it overrides the default of 30 days (not 3560 days, the default of the underlying {{do not archive until}} template)
- b. it specifies the number of days in the message (if the parameter is omitted, the template will not output a number of days)
While the underlying {{do not archive until}} template accepts different units than days (hours, weeks, etc) this template deals only in days.
The second text parameter allows for extra text to be output as a second sentence, after the main text. As an example perhaps an explanation for why the bump occurs. You can set it independently of the first parameter with |2=
or |note=
.
Examples
[edit]Basic usage:
Changing number of days:
Specifying default number of days to force template to spell it out:
Supplying a second sentence:
{{subst:Bump|note=Operator is making changes.}}
→
Bumping thread. Operator is making changes. Example (talk) 09:45, 19 December 2012 (UTC)
Using both parameters:
{{subst:Bump|7|Operator is making changes.}}
→
Bumping thread for 7 days. Operator is making changes. Example (talk) 09:45, 19 December 2012 (UTC)
TemplateData
[edit]Prevent the archival of a discussion.
Parameter | Description | Type | Status | |
---|---|---|---|---|
1 | 1 | The number of days to prevent archival by.
| Number | optional |
2 | 2 note | Adds a note on a new sentence, before the signature. | String | optional |
See also
[edit]- Template:Pin section – another wrapper for {{do not archive until}}