Template:Sporadic archiving notice/doc

From MidsouthMakers - Memphis Area Hackerpace
Jump to navigation Jump to search


This is the {{sporadic archiving notice}} message box. It should be used on pages that are automatically archived, that primary relies on the amount of sections and secondary on the elapsed time.

Usage

Style

This box automatically adapts its styles depending on what kind of page it is placed on. When this box is placed on a subject page (not a talk page), it gets the light-grey "other pages" style:

{{sporadic archiving notice|archive=3|max=7}}


Thus when it for instance is placed on a talk page it gets the brown talk page style. See next example.

The small=yes parameter works on talk pages and "other" pages. That is, it doesn't work on articles, file and category pages. But the parameter does no harm if used on such pages. So you can make the box small and right floating if you like:

{{sporadic archiving notice|archive=3|max=7|small=yes}}


Parameters

Here are the parameter:

  • archive=number (required, default: archive=3) - how many sections is set to be archived at once
  • max=number (required, default: max=7) - what is set as the maximum threshold amount of sections before archiving is started
  • age=days (recommended, example: age=180) - what is set as the elapsed time from last reply before archiving
  • units=word (optional, default: units=days) - what is the suffix of the age set, for example "months", "year" or "years" can be used.
  • bot=bot name (optional, example: bot=MiszaBot) - what is the name of the bot that takes care of archiving
  • small=yes/no (optional, default: small=no) - set the layout to be small left aligned (see examples above)
  • page=page type (optional, default: page=This talk page) - Use if you don't want to see "talk page" or "page". The word "this" or "the" must be included.

Examples

Basic example

A basic example with only required paramters:

{{sporadic archiving notice|archive=3|max=7}}


Recommended example

A example with recommended paramters:

{{sporadic archiving notice|archive=4|max=10|age=180}}


Advanced example

An more advanced example with all parameters used:

{{sporadic archiving notice|archive=5|max=12|age=6|units=months|bot=MiszaBot|page=This noticeboard}}


See also