User:FlightTime/Template:Archive basics/doc
 | This is a documentation subpage for User:FlightTime/Template:Archive basics. It contains usage information, categories, and other content that is not part of the original user template page. |
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).
Basic markup
[edit]Archive basics requires User:FlightTime/OneClickArchiver or equal.
{{User:FlightTime/Template:Archive basics
|archive = /Archive %(counter)d
|counter = 1
|headerlevel = 2
|maxarchivesize = 150K
|archiveheader = {{tan}}
}}
|
Examples
[edit]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:#titleparts:{{SAFESUBST:FULLPAGENAME}}}}/Archive %(counter)d
|counter = 1
}}
|
Because en:User:Equazcion/OneClickArchiver.js is extremely sensitive for case and spaces and some people haven't yet upgraded to the version that doesn't care about case and spacing, 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:
{{SAFESUBST:Oca|1}}
|
Parameters
[edit]No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| archive | archive | WikiPath to where you want the archives stored. | String | required |
| counter | counter | This is what numbered archive the OneClickArchiver will archive to. If you are archiving at User talk:Example/Archive 1, for example, this parameter must be set at 1. Otherwise, the OneClickArchiver will archive to the wrong page. | Number | required |
| maxsize | maxsize maxarchivesize | 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.
| Number | optional |