Template documentation[view] [edit] [history] [purge]

This template is used to provide an archive name and counter number to Technical 13's (Original by Equazcion) OneClickArchiver (Original) script, on pages where a ((User:MiszaBot/config)) 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).

Examples

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 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))

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Archive basics in articles based on its TemplateData.

TemplateData for Archive basics

No description.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
archivearchive

WikiPath to where you want the archives stored.

Stringrequired
countercounter

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.

Numberrequired
maxsizemaxsize 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.

Default
153600
Numberoptional

See also

  • v
  • t
  • e
Templates for archiving
  • Archiving (simple)
  • Archiving (technical)
Recommended
  • ((Archives)) (very configurable side box or banner for main talk page)
  • ((Automatic archive navigator)) (banner placed on archive pages with navigation)
  • ((Talk header)) (banner with talk page guidelines and archives)
  • ((Archive top)) / ((Atop)) (archives/closes discussion)
  • lowercase sigmabot III (MiszaBot) (most popular auto archiving bot)
  • Archy McArchface (archiver script)
Side box
  • ((Archives))
Headers
With
navigation
  • ((Annual archive))
  • ((Archived annually))
  • ((Automatic archive navigator)) (does not need parameter)
  • ((Archives by months))
  • ((Month-year archive nav))
  • ((Monthly archived talk))
  • ((UserTalkArchive))
  • ((Warning archive notice))
Without
navigation
  • ((Archive index))
  • ((Archiving))
With
search
  • ((Talk header)) (contains an automatically appearing archive search box and nav)
Content
formatting
  • ((Archive top)) / ((atop))
  • ((Archive top green)) / ((atopg))
  • ((Archive top red)) / ((atopr))
  • ((Archive top yellow)) / ((atopy))
  • ((Archive bottom)) / ((abot))
  • ((Closed rfc top))
  • ((Collapse))
  • ((Collapse top))
  • ((Collapse bottom))
  • ((Hidden archive top)) / ((hat))
  • ((Hidden archive bottom)) / ((hab))
  • ((Poll top))
  • ((Poll bottom))
Lists
  • ((Archive list)) (numbered archives usually the default)
  • ((Archive list alpha))
  • ((Monthly archive list))
  • ((Yearly archive list))
Discussion
  • ((Archive request))
  • ((Please archive))
  • ((uw-archive))
Automatic
archiving
systems
  • Archy McArchface (archiver script)
  • ClueBot III
    • ((User:ClueBot III/ArchiveNow))
  • HBC Archive Indexerbot (Legobot)
  • lowercase sigmabot III (MiszaBot)
  • OneClickArchiver
  • ((Archive basics))
  • ((Archive now))
  • ((subst:Bump))
  • ((subst:Do not archive until))
  • ((subst:Install one click archiver))
  • ((subst:Pin section))
  • ((subst:Setup auto archiving))
  •  Category:Archival templates
The above documentation is transcluded from Template:Archive basics/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.
Category
Category:
  • Archival templates