View source for Template:Archive basics/doc

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

This template is used to provide an [[Help:Archiving a talk page|archive]] name and counter number to {{No ping|Technical 13}}'s (Original by {{No ping|Equazcion}}) [[User:Technical 13/Scripts/OneClickArchiver|OneClickArchiver]] ([[User:Equazcion/OneClickArchiver|Original]]) script, on pages where a {{Tlu|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:<br />
{| style="width: 50%"
|-
|<syntaxhighlight lang="wikitext">{{Archive basics
|archive = User talk:Username/Archive %(counter)d
|counter = 4
}}</syntaxhighlight>
|}

Example 2 if you want to cut & paste for numbered archives:
{| style="width: 50%"
|-
|<syntaxhighlight lang="wikitext">{{Archive basics
|archive = {{SAFESUBST:#titleparts:{{SAFESUBST:FULLPAGENAME}}}}/Archive %(counter)d
|counter = 1
}}</syntaxhighlight>
|}

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:
{| style="width: 50%"
|-
|<syntaxhighlight lang="wikitext">{{SAFESUBST:Oca|1}}</syntaxhighlight>
|}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"archive": {
			"description": "WikiPath to where you want the archives stored.",
			"type": "string",
			"required": true
		},
		"counter": {
			"description": "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.",
			"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",
			"aliases": [
				"maxarchivesize"
			]
		}
	}
}
</templatedata>

==See also==
{{templates for archiving}}

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Archival templates|Basics]]
}}</includeonly>