Difference between revisions of "Template:Bump/doc"
imported>CapnZapp |
imported>CapnZapp (polishing examples) |
||
| Line 4: | Line 4: | ||
This is a wrapper for the invisible template {{tl|do not archive until}} that is used to prevent [[Help:Archiving a talk page#Automated archival|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. | This is a wrapper for the invisible template {{tl|do not archive until}} that is used to prevent [[Help:Archiving a talk page#Automated archival|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. | ||
| − | == | + | == Usage == |
| − | + | {{tlsx|Bump|''number of days to prevent the thread from archiving''|''additional note''}} | |
| − | {{ | + | === Parameters === |
| + | The template takes two {{em|optional}} parameters. | ||
The first integer parameter specifies the minimum number of days before archiving. Supplying this parameter does two things: | The first integer parameter specifies the minimum number of days before archiving. Supplying this parameter does two things: | ||
| Line 15: | Line 16: | ||
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 {{para|2}} or {{para|note}}. | 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 {{para|2}} or {{para|note}}. | ||
| − | == | + | === Examples === |
| − | * {{code|<nowiki>{{subst:Bump}}</nowiki>}} → [[Image:Pictogram voting wait.svg|14px|link=|alt=]] {{small|'''Bumping thread''' | + | Basic usage: |
| − | * {{code|<nowiki>{{subst:Bump| | + | * {{code|<nowiki>{{subst:Bump}}</nowiki>}} → [[Image:Pictogram voting wait.svg|14px|link=|alt=]] {{small|'''Bumping thread'''. [[User:Example|Example]] ([[User talk:Example|talk]]) 09:45, 19 December 2012 (UTC)}} <!-- Template:Bump --><!-- [[User:DoNotArchiveUntil]] 09:45, 18 January 2013 (UTC) --> |
| − | * {{code|<nowiki>{{subst:Bump| | + | Changing number of days: |
| + | * {{code|<nowiki>{{subst:Bump|7}}</nowiki>}} → [[Image:Pictogram voting wait.svg|14px|link=|alt=]] {{small|'''Bumping thread'''{{space}}for 7 days. [[User:Example|Example]] ([[User talk:Example|talk]]) 09:45, 19 December 2012 (UTC)}} <!-- Template:Bump --><!-- [[User:DoNotArchiveUntil]] 09:45, 18 January 2013 (UTC) --> | ||
| + | Specifying default number of days to force template to spell it out: | ||
| + | * {{code|<nowiki>{{subst:Bump|30}}</nowiki>}} → [[Image:Pictogram voting wait.svg|14px|link=|alt=]] {{small|'''Bumping thread'''{{space}}for 30 days. [[User:Example|Example]] ([[User talk:Example|talk]]) 09:45, 19 December 2012 (UTC)}} <!-- Template:Bump --><!-- [[User:DoNotArchiveUntil]] 09:45, 19 December 2012 (UTC) --> | ||
| + | Supplying a second sentence: | ||
| + | * {{code|<nowiki>{{subst:Bump|2=Operator is making changes.}}</nowiki>}} → <br>[[File:Pictogram voting wait.svg|14px|link=|alt=]] {{Small|1='''Bumping thread'''. Operator is making changes. [[User:Example|Example]] ([[User talk:Example|talk]]) 09:45, 19 December 2012 (UTC)}} <!-- [[Template:Bump]] --><!-- [[User:DoNotArchiveUntil]] 04:45, 24 October 2029 (UTC) -->{{User:ClueBot III/DoNotArchiveUntil|1887511510}} | ||
| + | Using both parameters: | ||
| + | * {{code|<nowiki>{{subst:Bump|7|Operator is making changes.}}</nowiki>}} → <br>[[File:Pictogram voting wait.svg|14px|link=|alt=]] {{Small|1='''Bumping thread'''{{space}}for 7 days. Operator is making changes. [[User:Example|Example]] ([[User talk:Example|talk]]) 09:45, 19 December 2012 (UTC)}} <!-- [[Template:Bump]] --><!-- [[User:DoNotArchiveUntil]] 04:45, 24 October 2029 (UTC) -->{{User:ClueBot III/DoNotArchiveUntil|1887511510}} | ||
{{Warchivenav}} | {{Warchivenav}} | ||
Revision as of 06:34, 28 April 2020
| This is a documentation subpage for Template:Bump. It contains usage information, categories and other content that is not part of the original template page. |
| 40x40px | This template should always be substituted (i.e., use {{subst:Bump}}). Any accidental transclusions will be automatically substituted by a bot. |
Contents
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.
Usage
Parameters
The template takes two optional parameters.
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 {{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 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
Basic usage:
Changing number of days:
{{subst:Bump|7}}→
Bumping threadTemplate:Spacefor 7 days. Example (talk) 09:45, 19 December 2012 (UTC)
Specifying default number of days to force template to spell it out:
{{subst:Bump|30}}→ File:Pictogram voting wait.svg Bumping threadTemplate:Spacefor 30 days. Example (talk) 09:45, 19 December 2012 (UTC)
Supplying a second sentence:
{{subst:Bump|2=Operator is making changes.}}→
File:Pictogram voting wait.svg Bumping thread. Operator is making changes. Example (talk) 09:45, 19 December 2012 (UTC) User:ClueBot III/DoNotArchiveUntil
Using both parameters:
{{subst:Bump|7|Operator is making changes.}}→
File:Pictogram voting wait.svg Bumping threadTemplate:Spacefor 7 days. Operator is making changes. Example (talk) 09:45, 19 December 2012 (UTC) User:ClueBot III/DoNotArchiveUntil