Template:ArchiveBot: Difference between revisions

From The Audiovisual Identity Database
Jump to navigation Jump to search
imported>Hb1290
No edit summary
imported>Hb1290
(Replaced content with "{{#if:{{{key|}}}|Category:Pages archived using a key|{{#ifeq:{{#invoke:String|find|source={{{archive|}}}|target={{#titleparts:{{FULLPAGENAME}}}}/}}|1||<includeonly>C...")
Line 1: Line 1:
{{#if:{{{key|}}}|[[Category:Pages archived using a key]]|{{#ifeq:{{#invoke:String|find|source={{{archive|}}}|target={{#titleparts:{{FULLPAGENAME}}}}/}}|1||<includeonly>[[Category:Pages where archive parameter is not a subpage]]</includeonly>}}<nowiki />}}
{{#if:{{{key|}}}|[[Category:Pages archived using a key]]|{{#ifeq:{{#invoke:String|find|source={{{archive|}}}|target={{#titleparts:{{FULLPAGENAME}}}}/}}|1||<includeonly>[[Category:Pages where archive parameter is not a subpage]]</includeonly>}}<nowiki />}}
<noinclude> ''The following is transcluded from [[w:User:Lowercase_sigmabot_III|User:Lowercase_sigmabot_III]] on Wikipedia'' {{documentation subpage}}
<noinclude>''The following is transcluded from [[w:User:Lowercase_sigmabot_III/Archive_HowTo|User:Lowercase_sigmabot_III/Archive HowTo]] on Wikipedia. Not all information presented is applicable to CLG Wiki''
{{High-use|28000}}
{{w::User:Lowercase_sigmabot_III/Archive_HowTo}}  
{{Notice|All archiving tasks which used to be performed by the MiszaBots are now performed by '''[[User:lowercase sigmabot III|lowercase&nbsp;sigmabot&nbsp;III]]''' without the need to change the <nowiki>{{User:MiszaBot/config}}</nowiki> configuration. The actual MiszaBots were turned off in 2013. This instructional page is based on [[User:MiszaBot/Archive HowTo]].}}
</noinclude>
 
Since November 2013, {{User|Lowercase sigmabot III}} has taken over all tasks that used to be performed by {{u|MiszaBot}}. The configuration syntax is unchanged, which is why you will see the name "MiszaBot" included in configuration instructions below. According to the [[User:Lowercase sigmabot III/Source.py|source code]], Lowercase sigmabot III only uses {{tlu|User:MiszaBot/config}} as the config. You '''cannot''' substitute "Lowercase sigmabot III"  for "MiszaBot" in the configuration.
 
: (For similar bots, see [[:Category:Wikipedia archive bots]].)
 
{{Consensus|Before setting up automatic archiving on an article's talk page, please establish a consensus that archiving is really needed there.}}
 
If you are unsure what code to use, a suggestion: go to [[#Example 2: Incremental archives]] and have a look at its copy paste section.
 
=== Setting up archiving ===
Put the following template at the ''top'' of the page that you want automatically archived:
 
{{Warning|The '''exact''' code below '''won't work''' – please see the examples for possible options – I'm tired of fixing dozens of malformed templates.}}
 
<pre style="overflow: auto">
{{User:MiszaBot/config
| algo    = old(...)
| archive = Name of archive page(s): To generate multiple pages over time, use variables, described below.
[other parameters - ***read below***]
}}
</pre>
 
Well, maybe '''not exactly''' that (read about required options below), but that's how it's done. By the way, [[User:MiszaBot/config|the template]] has '''no content''' and is sysop-'''protected''', so don't worry about visual appearance. :)
 
The bot expects to see only one parameter per line. The closing }} must be on its own line. There must be no leading spaces before the pipes. If you drop out the newlines used in the above example, e.g. by wrapping the template invocation onto a single line, the bot may not do what you expect.
 
Also, the template must be located:
#before the first ==second level header== on the page
#on the actual page and not transcluded from a subpage, such as a page header, etc.
 
=== Quick examples ===
To get the hang of it – configuration may not be intuitive, but it's flexible and gives potentially vast possibilities.
 
:<span style="color:darkred;">'''Please change "''User talk:Example''" to the ''exact'' name of your own page!'''</span>
:<span style="color:darkgreen;">'''If it's still not working, read about the "''minthreadsleft''" and "''minthreadstoarchive''" parameters below.'''</span>
 
==== Example 1: Static archive ====
{{Warning|While the simplest, this is probably not the best option – the second example is the most common.}}
 
<pre style="overflow: auto">
{{User:MiszaBot/config
| algo    = old(7d)
| archive = User talk:Example/Archive
}}
</pre>
''(Please remember, this is an example and this exact code won't work on your page)''
 
This setup archives threads from [[User talk:Example]] to [[User talk:Example/Archive]] after they are 7 days old (counting from newest timestamp). The archive '''will freeze when it becomes 2000KB large'''. Probably not a very useful config (unless for sending threads to a periodically cleaned trash bin or to decide yourself when to go to the next archive page), but it's easiest, so I'm mentioning it first.
 
==== Example 2: Incremental archives ====
<pre style="overflow: auto">
{{User:MiszaBot/config
| algo                = old(30d)
| archive            = User talk:Example/Archive %(counter)d
| counter            = 1
| maxarchivesize      = 150K
| archiveheader      = {{Automatic archive navigator}}
| minthreadstoarchive = 1
| minthreadsleft      = 4
}}
</pre>
''(Please remember, this is an example and this exact code won't work on your page. Use the copy paste section below!)''
{{Hst|reason=copy and paste for easy use}}
<pre style="overflow: auto">
{{User:MiszaBot/config
| algo                = old(30d)
| archive            = {{SUBST:FULLPAGENAME}}/Archive %(counter)d
| counter            = 1
| maxarchivesize      = 150K
| archiveheader      = {{Automatic archive navigator}}
| minthreadstoarchive = 1
| minthreadsleft      = 4
}}
</pre>
{{Warning|The copy and paste code above uses the system variable FULLPAGENAME. This does not work when the article title contains special characters. Please see [[Help:Archiving a talk page#FULLPAGENAME]] for what to do after pasting the above into your talk page.}}
{{Hsb}}
This tells the bot to archive threads over thirty days old (leaving the four most recent) from [[User talk:Example]] to [[User talk:Example/Archive 1]] (more about variables [[#Variables|below]]) until it fills up to 150 kilobytes, whereupon the bot will move to 2 (updating the counter when saving page). Remember to '''specify the maximum size''' of an archive, or it will behave pretty much like in the first example. In addition, each archive page is given a {{Tl|Aan}} banner, which makes it easy to move between the different archive pages.
 
==== Example 3: Date-based archives ====
{{Warning|Do '''not''' substitute the "year" and "monthname" with actual values – the bot will treat them as variables accordingly.}}
 
<pre style="overflow: auto">
{{User:MiszaBot/config
| algo          = old(5d)
| archive      = User talk:Example/Archives/%(year)d/%(monthname)s
| archiveheader = {{MonthlyArchive}}
}}
</pre>
''(Please remember, this is an example and this exact code won't work on your page. Use the copy paste section below!)''
{{Hst|reason=copy and paste for easy use}}
<pre style="overflow: auto">
{{User:MiszaBot/config
| algo          = old(5d)
| archive      = {{SUBST:FULLPAGENAME}}/%(year)d/%(monthname)s
| archiveheader = {{MonthlyArchive}}
}}
</pre>
{{Warning|The copy and paste code above uses the system variable FULLPAGENAME. This does not work when the article title contains special characters. Please see [[Help:Archiving a talk page#FULLPAGENAME]] for what to do after pasting the above into your talk page.}}
{{Hsb}}
In this configuration, threads older than 5 days will land in archives depending on their date (that is newest timestamp). You can read about other variables [[#Variables|below]].
 
=== Parameters explained ===
<pre>
{{User:MiszaBot/config
| archive            =
| algo                =
| counter            =
| maxarchivesize      =
| minthreadsleft      =
| minthreadstoarchive =
| archiveheader      =
| key                =
}}
</pre>
 
{| class = "wikitable"
! Parameter || Default || Description
|-
| <kbd>archive</kbd> || N/A; required || Name of the page to which archived threads will be put. This parameter supports the use of [[#Variables|variables]], which can be used to create dynamically named archives (such as using date ranges). Note that magic words and templates do not work with this parameter, and unless a <kbd>key</kbd> is supplied (see below), the target page must be a subpage of the current page. Otherwise [[:Category:Pages where archive parameter is not a subpage]] is added.
|-
| <kbd>algo</kbd> || <kbd>old(24h)</kbd> || Minimum amount of time that must pass after the last reply before the bot can archive the thread. It must be in the form: '''''old(nT)''''' where '''''n''''' is a number and '''''T''''' specifies hours or days. You can leave out '''''T''''' to specify seconds. Examples: 600, 72h, 5d would specify either 600 seconds, 72 hours or 5 days respectively. To specify very long timespans, use days. For example; '''''algo=old(1100d)''''' for close to three years. Complex formulas (including regex matching) may be available in the future.
|-
| <kbd>counter</kbd> || <kbd>1</kbd> || The current number of the last archive. If the <kbd>%(counter)d</kbd> variable is not used, it is ignored. Lowercase sigmabot III will update this parameter as necessary.
|-
| <kbd>maxarchivesize</kbd> || <kbd>1954K</kbd> || The maximum archive size in either raw text size (eg <kbd>256M</kbd> for megabytes, <kbd>256K</kbd> for kilobytes, or <kbd>256B</kbd> for bytes) or threads (eg <kbd>10T</kbd>) before incrementing the counter. A bare integer will be interpreted as bytes. Ignored if counter is not used.
|-
| <kbd>minthreadsleft</kbd> || <kbd>5</kbd> || The minimum number of threads that should be left on a page (to prevent pages from getting completely harvested).
|-
| <kbd>minthreadstoarchive</kbd> || <kbd>2</kbd> || The minimum number of threads to archive at one time, which is used to lower edit frequency. lowercase sigmabot III will not archive threads when fewer than the value of this parameter would be archived.
|-
| <kbd>archiveheader</kbd> || <kbd>{{Tl|Talk archive}}</kbd> || Content that will be put on new archive pages as the header. This parameter supports the use of [[#Variables|variables]].
|-
| <kbd>key</kbd> || || A top-secret key that (if valid) allows archives to ''not'' be subpages of the page being archived. To obtain such a key, [[User talk:Σ|request it from&nbsp;this&nbsp;editor]], and you better have a ''very'' good justification for doing so.
|}
 
=== Variables ===
{| class = "wikitable"
! Variable parameter || Expands to...
|-
| <kbd>%(counter)d</kbd> || the current value of the <kbd>counter</kbd>
|-
| <kbd>%(year)d</kbd> || year of the thread being archived
|-
| <kbd>%(month)d</kbd> || month (as a number 1-12) of the thread being archived
|-
| <kbd>%(monthname)s</kbd> || English name of the month above
|-
| <kbd>%(monthnameshort)s</kbd> || first three letters of the name above
|}
 
Those [[python (programming language)|python]]-savvy people will immediately recognize these variables are filled at runtime with the <kbd>%</kbd> operator and should know how to adjust the format. A few points of interest to others:
*make sure you don't mess up the last letter after the brackets (it's "d" for [[integer]]s and "s" for [[string (computer science)|strings]])
*integer variables may be left-padded with zeros:
*:<kbd>%(counter)03d</kbd> evaluates to <kbd>013</kbd> if the <kbd>counter</kbd>'s value equals 13,
*:<kbd>%(month)02d</kbd> becomes <kbd>05</kbd> for May etc.
 
=== After you have set up archiving ===
The bot runs once a day at a preset hour, or twice a day for [[WP:Administrators' Noticeboard|WP:AN]] and [[Wikipedia:Administrators' noticeboard/Incidents|WP:AN/I]]. Simply wait for the next cycle and you should see the bot's entries in the history list of your article '''providing''' there was anything to archive, and the history list entry should provide a link to the archive page you specified.<br />
 
Various [[WP:TM|templates]] will produce an automatic list of archive subpages.  Typically, such a template will be added to the top-level talk page to make archives easier to find. Simply add the template name in <code><nowiki>{{curly-braces}}</nowiki></code> where you want it to appear. Popular templates used for this purpose include:
* {{Tlx|Archives}}
* {{Tlx|Monthly archive list}}.  If you use [[#Example 3 - date-based archives]], use this with <code>root = User talk:Example/Archives</code>.
* {{Tlx|Talk header}} (this template has other functions, but can include a list of archives and a search box)
 
A related but distinct function is templates that appear in the archived talk pages themselves. For instance:
* {{Tlx|Automatic archive navigator}}
 
=== Delaying or preventing archiving of particular threads ===
Archiving can be delayed for a particular thread by substituting the template {{tl|DNAU}} into the thread.  Use <code><nowiki>{{subst:DNAU}}</nowiki></code> to retain a thread indefinitely, or <code><nowiki>{{subst:DNAU|<integer>}}</nowiki></code> to retain a thread for &lt;integer&gt; days.  see the template documentation for details about its use and function.
 
=== Missing signatures ===
One potential problem is that lowercase sigmabot III does not archive sections that have no signatures. However editors sometimes forget to sign a comment so it may ignore old sections while archiving more recent ones.
 
One option is to [[Help:Archiving a talk page#Manual archiving|manually archive]] sections that are unintentionally unsigned. The other option, which allows lowercase sigmabot III to archive an unsigned section is to add a signature of the editor to the last comment in the section.
 
You can [[WP:SIGCLEAN|add missing signatures to the talk page]] by using the templates {{tls|unsigned}}, {{tls|unsigned2}}, {{tls|unsigned IP}}, or {{tls|xsign}}. Only the last comment added to a section needs to have a signature for lowercase sigmabot III to archive the section.
 
If the talk page history is large, it may prove time consuming to find when a specific comment was added. [[Wikipedia:WikiBlame|WikiBlame]] will reduce the time it takes to find who added an unsigned comment.
 
=== Template output ===
When parameter {{para|key}} is provided, the only output of the template is categorization into [[:Category:Pages archived using a key]]. Otherwise, the template outputs a single self closed tag {{tag|nowiki|s}}. This is a trick, which makes it easier to deal with potential vertical whitespace issues.
 
=== Causes of no archiving ===
Some of the possible reasons for a page not being archived:
* {{para|archive}} does not specify a subpage of the page to be archived. This can for example happen after a move where the parameter needs updating.
* Archive bot has not run. Archiving usually runs once a day. See the latest activity at [[Special:Contributions/Lowercase sigmabot III]].
* One of the sections to be archived has an external link matching [[MediaWiki:Spam-blacklist]] or [[:commons:MediaWiki:Spam-blacklist]]. Nothing will be archived. Manual archiving will also fail since blacklisted links cannot be saved. They can be deactivated with {{tag|nowiki}}.
* {{para|minthreadstoarchive}} is larger than the current number of sections ready for archiving.
* {{para|minthreadsleft}} is too large to currently allow any archiving.
* {{para|algo|old(...)}} is currently too long for any archiving.
* The archiving instructions are not placed somewhere before the first section heading.
* The parameters are not arranged with exactly one per line.
* If some sections are archived but not others then they may have no signature with a valid time stamp. Please see [[#Missing signatures]] above.
* If your article title contains certain punctuation characters (<code>"&'</code>). Please see [[Help:Archiving a talk page#FULLPAGENAME]] for an explanation and solution.
 
{{Warchivenav|state=uncollapsed}}</noinclude>

Revision as of 05:10, 1 June 2021

The following is transcluded from User:Lowercase_sigmabot_III/Archive HowTo on Wikipedia. Not all information presented is applicable to CLG Wiki Template:W::User:Lowercase sigmabot III/Archive HowTo

Retrieved from "https://avidwiki.mywikis.net/w/index.php?title=Template:ArchiveBot&oldid=98291"