Difference between revisions of "Template:Archive basics/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Makyen
(Be more specific about the need for a {{User:MiszaBot/config}})
blackwiki>Hasteur
(Update to templatedata format)
Line 2: Line 2:
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
  
== Usage ==
+
<templatedata>
 
+
{
This template is used to provide an archive name and counter number to [[User:Equazcion/OneClickArchiver.js]], 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). It follows the format of [[User:MiszaBot/config]], but only requires two parameters:
+
"description": "This template is used to provide an archive name and counter number to [[User:Equazcion/OneClickArchiver.js]], 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).",
 
+
"params": {
*<code>|archive=</code>
+
"archive": {
*<code>|counter=</code>
+
"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>
  
 
=== Examples ===
 
=== Examples ===

Revision as of 13:09, 9 September 2014

This template is used to provide an archive name and counter number to [[User:Equazcion/OneClickArchiver.js]], 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).

Template parameters

ParameterDescriptionTypeStatus
Archivearchive

WikiPath to where you want the archives stored

Stringrequired
Countercounter

Counter to be replaced in the archive path string

Numberrequired
Maxsizemaxsize

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

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

{{SAFESUBST:Oca|1}}