User:Inferno Bot/config/doc

From RationalWiki
Jump to: navigation, search

Usage[edit]

This is the configuration template for Inferno Bot's archiving capabilities. To use it, include it on a page, and it will be picked up automatically. That said, you probably will want to configure it.

Full template[edit]

The following are all the parameters accepted by this template.

{{User:Inferno Bot/config
|archive=
|algo=
|counter=
|maxarchivesize=
|minthreadsleft=
|minthreadstoarchive=
|archiveheader=
|key=
}}

Make sure that the | are on new lines. Inferno Bot will refuse to work if you put the entire template on one line.

Of these, only archive is required.

Parameter explanation[edit]
Template parameter Description
archive name of the page to which archived threads will be put. Must be a subpage of the current page. Variables are supported. If the page name has special characters, make sure that they are left as is. Don't leave HTML encoded tags, it breaks the bot (generally if there's a % in the page name and it's not to denote a variable, you should see what the actual name is).
algo specifies the maximum age of a thread. Must be in the form old(delay) where delay specifies the age in hours or days like 24h (24 hours) or 5d (5 days). Default is old(24h).
counter The current value of a counter which could be assigned as variable. Will be actualized by bot. Initial value is 1.
maxarchivesize The maximum archive size before incrementing the counter. Value can be given with appending letter like K or M which indicates KByte or MByte. Default value is 1000M (1000 megabytes).
minthreadsleft Minimum number of threads that should be left on a page. Default value is 5.
minthreadstoarchive The minimum number of threads to archive at once. Default value is 2.
archiveheader Content that will be put on new archive pages as the header. This parameter supports the use of variables. Default value is {{talkarchive}}.</translate>
key A secret key that (if valid) allows archives to not be subpages of the page being archived.</translate>

Variables[edit]

These are used when setting up the archive parameter.

In the archive parameter in the template, following variables can be used.

Variable Expands to...
%(counter)d the current value of the counter
%(year)d year of the thread being archived
%(quarter)d quarter of the year (1-4) of the thread being archived
%(month)d numeric month (1-12) of the thread being archived
%(month)02d two-digit numeric month (01-12)
%(monthname)s English name of the month
%(monthnameshort)s first three letters of the name of month

Preventing archiving[edit]

Use Template:DNAU to add a hidden block to prevent archiving a page. More visible variations include Template:Bump which disables archiving for the next 30 days by default, but is configurable, as well as Template:Pin to disable archiving for 10 years (effectively disabling archiving for that thread).

See also[edit]

  • User:Inferno Bot - The bot's userpage has a few quickly includable templates that should help in setting the bot up quickly.
  • Template:Bump - Template substitutable to temporarily disable archiving.
  • Template:Pin - Template substitutable to permanently disable archiving.