Template:Archive basics/doc

From Orain Meta
Jump to navigation Jump to search

<templatedata> { "description": "This template is used to provide an archive name and counter number to User:Equazcion/OneClickArchiver.js, on pages where a Template:Tlu configuration doesn't exist, or does not contain a numeric counter. This template and OneClickArchiver work with archives that end with a number. It does not work with archives that do not end in a number (e.g. archives organized by year/month).", "params": { "archive": { "description": "WikiPath to where you want the archives stored", "type": "string", "required": true }, "counter": { "description": "Counter to be replaced in the archive path string", "type": "number", "required": true }, "maxsize": { "description": "Size at which a \"nag\" notice will show up on page letting users know that the size of the current archive (defined by archive and counter parameters) is above and to suggest that the archive be incremented", "type": "number", "default": "153600" } } } </templatedata>


Example 1:

{{Archive basics
|archive = User talk:Username/Archive %(counter)d
|counter = 4

Example 2 if you want to cut & paste for numbered archives:

{{Archive basics
|archive = {{SAFESUBST:FULLPAGENAME}}/Archive %(counter)d
|counter = 1

Because User:Equazcion/OneClickArchiver.js is extremely sensitive for case and spaces, There is a shortcut template to make it even easier for you to apply this. Simply change the number "1" to whatever number you want to start with for a counter number: