Template:Setup cluebot archiving
Jump to navigation
Jump to search
File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]
.svg){kind=link}
| File:Information icon4.svg | This template should always be substituted – use {{subst:Setup cluebot archiving}}. Any accidental transclusions will be automatically substituted by a bot. |
A template to easily set up archiving with ClueBot III.
Follow the help page on deciding which bot is best used for setting up archiving on a talk page.
For the commonly used lowercase sigmabot III, follow the simple setup instructions here: {{subst:Setup auto archiving}}.
Example wikitext after substitution
[edit source]Note: {{talk header}} or {{archives}} must also be used in order to see the archive list on the talk page.
The template fills in the USERNAME or ARTICLENAME. Feel free to adjust anything later. See User:ClueBot III for more parameters.
Wikitext on a user talk page
[edit source]{{User:ClueBot III/ArchiveThis
| age = 2160
| archiveprefix = {{subst:{{FULLPAGENAME}}/Archive
| numberstart = 1
| maxarchsize = 400000
| header = {{Archive}}
| minkeepthreads = 4
| format = %%i
}}
Wikitext on an article talk page
[edit source]{{User:ClueBot III/ArchiveThis
| age =2160
| archiveprefix ={{subst:{{FULLPAGENAME}}/Archive
| numberstart =1
| maxarchsize =400000
| header ={{Archive}}
| minkeepthreads =4
| format = %%i
}}
Usage
[edit source]Basic usage: {{subst:Setup cluebot archiving}}
Parameters are:
|age=- How many hours old a thread should be before archiving (multiply days by 24). Default: 2190
|maxarchsize=- How many bytes an archive should be before a new one is created. Default: 400000 (this is just a default, more active pages may need larger archives up to 2× this value)
|header=- Any templates that should go on top of an archive: Default:
{{Archive}} |small=: Will display{{Talk header|small=yes}}. Default: disabled|talk=- Optional value which will make it display
{{Talk header}}(with an archiving notice if notice is disabled). Default: disabled |talk_search=: See Template:Talk header. Default: yes|talk_arpol=: See Template:Talk header. Default: no|talk_wp=: See Template:Talk header. Default: no|talk_disclaimer=: See Template:Talk header. Default: no|talk_bottom=: See Template:Talk header. Default: no|shortcut1=: See Template:Talk header. Default: null|shortcut2=: See Template:Talk header. Default: null|shortcut3=: See Template:Talk header. Default: null|shortcut4=: See Template:Talk header. Default: null|shortcut5=: See Template:Talk header. Default: null|archives=- Optional value which will make it display
{{Archives}}if talk option is disabled. Default: disabled
See also
[edit source]- Help for choosing a bot to help decide which bot is best used for a particular talk page
{{subst:User:ClueBot III/JustArchiveThis}}, which uses ClueBot III's default settings- lowercase sigmabot III, a more commonly used archiving bot, see
{{subst:Setup auto archiving}}for quick setup
