Template:Sporadic archiving notice/doc
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}}
50x40px | This page is automatically archived. The 3 oldest sections will automatically be moved, when the total amount of sections has reached 7. Sections without timestamps are not archived. |
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}}
30px | This page is automatically archived. The 3 oldest sections will automatically be moved, when the total amount of sections has reached 7. |
Parameters
Here are the parameter:
archive=number
(required, default:archive=3
) - how many sections is set to be archived at oncemax=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 archivingunits=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 archivingsmall=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}}
50x40px | This page is automatically archived. The 3 oldest sections will automatically be moved, when the total amount of sections has reached 7. Sections without timestamps are not archived. |
Recommended example
A example with recommended paramters:
- {{sporadic archiving notice|archive=4|max=10|age=180}}
50x40px | This page is automatically archived. The 4 oldest sections will automatically be moved, when the total amount of sections has reached 10.The archived sections have to be at least 180 days old. Sections without timestamps are not archived. |
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}}
50x40px | This noticeboard is automatically archived by MiszaBot. The 5 oldest sections will automatically be moved, when the total amount of sections has reached 12.The archived sections have to be at least 6 months old. Sections without timestamps are not archived. |
See also
|