Difference between revisions of "Template:Bump/doc"

From blackwiki
Jump to navigation Jump to search
imported>JJMC89
(auto subst)
imported>CapnZapp
Line 5: Line 5:
  
 
== Parameters ==
 
== Parameters ==
The template takes one {{em|optional}} integer parameter to specify the number of days to prevent the thread from archiving. If the parameter is omitted, the template will set the thread to archive in '''30 days''' (not 3560 days, the default of the underlying {{tl|do not archive until}} template).
+
The template takes two {{em|optional}} parameters:
  
The template's second optional parameter specifies some text to go after the main text, perhaps an explanation for why the bump occurs. You can set it with {{para|2}} or {{para|note}}.
+
{{tlsx|Bump|''number of days to prevent the thread from archiving''|''additional note''}}
  
{{tlsx|Bump|''number of days to prevent the thread from archiving''|''additional note''}}
+
The first integer parameter specifies the minimum number of days before archiving. Supplying this parameter does two things:
 +
# it overrides the default of '''30 days''' (not 3560 days, the default of the underlying {{tl|do not archive until}} template)
 +
# it specifies the number of days in the message (if the parameter is omitted, the template will not output a number of days)
 +
 
 +
The second text parameter allows for extra text to go after the main text, perhaps an explanation for why the bump occurs. You can set it independently of the first parameter with {{para|2}} or {{para|note}}.
  
 
== Usage ==
 
== Usage ==

Revision as of 06:20, 28 April 2020

Purpose

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 bumped. It will auto-sign the notification. It changes the default number of days until auto-archival to 30.

Parameters

The template takes two optional parameters:

Template:Tlsx

The first integer parameter specifies the minimum number of days before archiving. Supplying this parameter does two things:

  1. it overrides the default of 30 days (not 3560 days, the default of the underlying {{do not archive until}} template)
  2. it specifies the number of days in the message (if the parameter is omitted, the template will not output a number of days)

The second text parameter allows for extra text to go after the main text, perhaps an explanation for why the bump occurs. You can set it independently of the first parameter with |2= or |note=.

Usage

Template:Warchivenav