Page protected

User:ClueBot III

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search



ClueBot III
This user is a bot
(talk · contribs)
B-2 Spirit bombing, 1994.jpg
ClueBot III aids in Operation Enduring Encyclopedia.
Operator Cobi (t)
Approved? Yes, BRFA.
Flagged? Yes.
Task(s) Talk page archival, including link fixing to archived sections.[1]
Edit rate maxlag = 2
Edit period(s) Continually
Automatic or manual? Automatic
Programming language(s) PHP, my own code utilizing api.php, query.php, and index.php.
Exclusion compliant? Yes
Emergency shutoff-compliant? Yes
Other information ClueBot III is run from the ClueNet servers and Wikimedia Labs infrastructure.
ClueBots
ClueBot NG/Anti-vandalism · ClueBot/Anti-vandalism · ClueBot II/ClueBot Script
Crystal Clear action run.png
ClueBot III/Archive · ClueBot VI/WP:CHUU Clerk  · Talk

Cobi/Owner // Talk

Documentation

Administrator emergency shutoff

Administrators may turn the bot off by changing this page to 'False'.

Exclusion compliant

This bot is an exclusion compliant bot.

How your page is archived

ClueBot III can be used to automatically archive sections/threads from a given page. Usually the page you are archiving from will be a talk page. Your archive pages can be organized by date, or numbered. Combinations of dates and numbering are also possible. This is configured by the arguments used for the format and archiveprefix parameters. Please see the parameter descriptions and examples for a few of the many ways to do this.

How does ClueBot III know when to archive my page?

ClueBot III works based on the revision history of the page in question, and not on the timestamps associated with signatures. This means that the practice of manually adding a timestamp way in the future will not work to prevent ClueBot III from archiving a thread. Furthermore, on one archival sweep, ClueBot III will select an archive target and will archive all eligible threads to that archive. This means that when you initially set up ClueBot III, if you have untidy archives then, it will sweep all of the old conversations into whatever archive it deems to be the current one. It also means that pages with massively long discussion threads will have the entire thread archived into the current archive, which can cause slight overstuffing of size-based archives.

Keeping linked

Once a series of threads is archived, ClueBot III looks for all pages that could have been linked to the moved parts, and updates the links that need to be fixed. When a page is linked to a huge number of others pages, the process takes a lot of time. In any case, this is the reason of collapse described at User talk:Jimbo Wales/Archive_202#Conspiracy Unveiled. Said more clearly: don't use ClueBot III on a page where the what links here are large.

Index generation

In addition to archiving your page, ClueBot III can also generate an index of all your archive pages. Assuming that you are archiving the page Talk:YourPage, the archive index generated by ClueBot III is located at:
User:ClueBot III/Master Detailed Indices/Talk:YourPage
You can make use of this either directly or by transcluding it onto your Talk:YourPage/Archive index page. One way to use this directly would be to include it as the archive index page in your archive box. For example:
{{Archives |auto= short |index= User:ClueBot III/Master Detailed Indices/{{FULLPAGENAME}} |search= yes |bot= ClueBot III |age= 90}}
will produce an archive box with an appropriate link to your index.

If you want to use this index with the {{talk header}} template you will need to transclude it onto your Talk:YourPage/Archive index page. To do so you would put the text:
{{User:ClueBot III/Master Detailed Indices/{{NAMESPACE}}:{{BASEPAGENAME}}}}
on your Talk:YourPage/Archive index page.

General template format

The general format for the archive template:

{{User:ClueBot III/ArchiveThis
|archiveprefix=
|format=
|age=
}}


Required parameters

age
Type: unsigned integer
Default: 0
Description: This parameter must be set to the number of hours a thread can go without a reply before it should be archived. If you do not set it all threads will qualify to be archived.


archiveprefix
Type: string
Description: This parameter must be set to a fully qualified page name under the page you wish to archive. For example, if User talk:Cobi was being archived using dated archives, then archiveprefix=User talk:Cobi/Archives/ would be appropriate. For the same page being archived with numbered archives, archiveprefix=User talk:Cobi/Archive would be appropriate. Not setting this parameter correctly can have some strange results. The {{FULLPAGENAME}} variable can not actually be passed to ClueBot III. The fully qualified page name must be hard coded. The easiest way to do this is to use immediate substitution such as:
For archives organized by date enter:
|archiveprefix={{subst:FULLPAGENAME}}/Archives/
For numbered archives enter (note /Archive instead of /Archives/):
|archiveprefix={{subst:FULLPAGENAME}}/Archives


format
Type: string
Default: ""
Description: This parameter must be set to a valid argument to PHP's date() function. You may also include an %%i value. %%i is for numbered archives instead of dated archives, and is replaced with the archive number. Once variable substitution has occurred it will be concatenated onto the end of the value of archiveprefix. The result of the concatenation will be the the name of the archive page(s). See examples. Most commonly, for archives organized by date use:
|format=Y/F. This gives "Archives/2016/January". In order to obtain "Archives/2016/01 (January)", use |format='Y/m (F)'.
For numbered archives use:
|format= %%i
Note for date based archives: Cluebot III stores files into a single archive page each time it runs. With date based archives, the page name is whatever archiveprefix concatenated with format is for the date that is NOW-age (where age is in hours). For example, if you are starting up YYYY/Month archiving from scratch with many old threads in the page being archived, ClueBot II will put all of the threads into a single file, not multiple files. If you want a single archiving run to be split into multiple files based on the last date in each thread you will need to use MiszaBot III (lowercase sigmabot III).

Optional parameters

These parameters are shaping the behavior of the archiver.

archivenow
Type: comma delimited array of strings
Default: ""
Description: This optional parameter should contain a comma separated list of strings for which ClueBot III will search within the threads on the page. If any of these strings are found in a thread, the bot will archive the thread immediately. The bot will also convert {{templates}} in this list to {{tl|escaped templates}} upon archival. This could be useful for pages where {{resolved}} or such is used. The {{User:ClueBot III/ArchiveNow}} blank template is available for this use. However, it has no special properties. It is only just another string that happens to be a template for which ClueBot III can be told to search. In addition to the following typical usage, an example of its use is shown below.
Typical usage: |archivenow=<nowiki>{{User:ClueBot III/ArchiveNow}}</nowiki>


header
Type: string
Default: "{{Talkarchive}}"
Description: When creating a new archive page, the bot will put this at the top of the new page.


headerlevel
Type: unsigned integer, between 1 and 7 inclusive
Default: 2
Description: This is the header level for the threads the bot will archive. Anything on the page before the first header of this level will not be archived. A level 1 header is = Header =, a default thread (level 2) header is == Header ==, and the highest level header is a level 7: ======= Header =======.


key
Type: string
Default: ""
Description: The value of this parameter must match an internally generated key in order for the archives to be stored anywhere other than as subpages of the page being archived.


maxarchsize
Type: unsigned integer, greater than 10000
Default: 0
Description: The target maximum size of the archive in bytes before %%i (see format) is incremented. If 0, this is disabled. In general, this parameter is used for numbered archives, but not for archives organized by date. This is not a hard limit. Resulting archive page sizes will almost always exceed this number, perhaps by a great amount. Each time ClueBot III runs on a page it archives all threads that are old enough to qualify for archiving into a single file. If you have maxarchsize=100000 with a current archive file size of 90k and it ends up that there are 60 threads to archive with a total size of 250k, then the current archive will be extended to 340k despite of the 100k limit.


maxkeepbytes
Type: unsigned integer
Default: 0
Description: If greater than 0, this is the maximum number of thread content bytes to keep on the talk page. Older threads are forcibly archived if there are more than this number of thread content bytes on the page. If 0, this option is disabled.


maxkeepthreads
Type: unsigned integer
Default: 0
Description: If greater than 0, this is the maximum number of threads to keep on the talk page. Older threads are forcibly archived if there are more than this number of threads on the page. If 0, this option is disabled.


minarchthreads
Type: unsigned integer
Default: 0
Description: The bot will not archive unless this many or more sections need archival.


minkeepthreads
Type: unsigned integer
Default: 0
Description: The bot will not archive if there will be this many or less sections left on the page.


nogenerateindex
Type: unsigned integer (boolean)
Default: 0
Description: If this is set to 1, the bot will not generate an index under User:ClueBot III/Indices/. There are very few times this option should be used. If this option is used, the index option will no longer work right.


numberstart
Type: unsigned integer
Default: 1
Description: Default value for %%i in format.


transformheader Warning! An invalid option here can screw up your archives!
Type: string, search===replace pairs delimited by &&&
Default: ""
Description: Convert archived thread headers. For each pair, search must be a valid regular expression and replace is a replacement string. See this for more information, search corresponds to $pattern, replace corresponds to $replacement, and the thread header corresponds to $subject. If you do not understand what this does, don't try to use it. Instead, ask for help from Cobi.


Cosmetic parameters

These parameters are shaping the archive box displayed on the page where archiving is active.

archivebox
Type: string ("yes" or "no")
Default: "no"
Description: Causes an archive box to be displayed similar to {{archive box}}
The example archive box is with non-default value of archivebox=yes.


box-width Type: string
Default: "238px"
Description: The width of the archive box. This parameter is only valid if archivebox=yes.

box-advert
Type: string ("yes" or "no")
Default: "no"
Description: Displays the string "This page is archived by ClueBot III." at the bottom of the archive box. This parameter is only valid if archivebox=yes.
The example archive box is with non-default value of box-advert=yes. Compare this example to the example next to the archivebox parameter.

box-separator Type: string ("yes" or "no")
Default: "yes"
Description: Display separator lines in the archive box. This parameter is only valid if archivebox=yes.
The example archive box is with non-default value of box-separator=no. Compare this example to the example next to the archivebox parameter.


image
Type: string
Default: "[[File:Crystal Clear app file-manager.png]]"
Description: If set this is an alternate image file to use as the archive icon in the archive box. This parameter is only valid if archivebox=yes.
The example archive box is with non-default value of image=[[File:Exquisite-folder font.png|40px]]. Note that the image size must be specified as part of the argument to this parameter, not with the image-width parameter. Compare this example to the example next to the archivebox parameter.


image-width Type: string
Default: "40px"
Description: The width of the image in the archive box. This parameter is only valid if archivebox=yes and you are using the default image.

search Type: string ("yes" or "no")
Default: "yes"
Description: Display a search field in the archive box. This parameter is only valid if archivebox=yes.The example archive box is with non-default value of search=no. Compare this example to the example next to the archivebox parameter.


talkcolor / talkcolour Type: string
Default: ""
Description: This parameter is only valid if archivebox=yes and the page on which the archive box is displayed is in the User talk namespace. If not set, or set to anything other than yes, the color scheme of the archive box on a User talk page will not be the standard talk page color scheme. In such a case, the archive box will use the same color scheme as is used for archive boxes on non-talk pages. If this parameter is set to yes and the page on which the archive box is displayed is in the User talk namespace, the archive box will use the standard talk page color scheme.
The two parameters are equivalent, and are only provided to avoid an attrition war in the MOS-style.


index
Type: string
Default: ""
Description: All values of this parameter are equivalent except yes. This parameter should not be set to yes unless you have wrapped the ClueBot III template with an {{archive box}}. Using index=yes results in the ClueBot III automatically generated index contained on the page User:ClueBot III/Indices/Talk:YourPage being transcluded onto Talk:YourPage in place of the {{User:ClueBot III/ArchiveThis}} template on Talk:YourPage.
This parameter is only valid if archivebox=no. If archivebox=yes this parameter has no effect on the index being included in the archive box and does not cause a copy of User:ClueBot III/Indices/Talk:YourPage to be transcluded onto Talk:YourPage.

like in {{archivebox|{{User:ClueBot III/ArchiveThis}}}}


Examples

The following examples can be cut & pasted into the top portion of the page you desire to archive. {{subst:FULLPAGENAME}} will be substituted by the name of the page you are editing when you save the page.
The text explaining the following examples assumes that {{subst:FULLPAGENAME}} evaluates to Talk:YourPage. In other words, that Talk:YourPage is the page you are archiving.
The age in all of these examples is set to 2160 hours, which is 90 days. If you want a different amount of time, then change the age argument.

Example: Archives by date (without archive box)

{{User:ClueBot III/ArchiveThis
|archiveprefix={{subst:FULLPAGENAME}}/Archives/
|format=Y/F
|age=2160
}}

The archive subpages produced by this example will be in the format of:
Talk:YourPage/Archives/2013/June
Talk:YourPage/Archives/2013/July
...

Example: Archives by date (with archive box)

{{User:ClueBot III/ArchiveThis
|archiveprefix={{subst:FULLPAGENAME}}/Archives/
|format=Y/F
|age=2160
|archivebox=yes
|box-advert=yes
}}

The subpages created, as needed, for your archives by this example will be named similar to:
Talk:YourPage/Archives/2013/June
Talk:YourPage/Archives/2013/July
...

Example: Numbered archives (without archive box)

{{User:ClueBot III/ArchiveThis
|archiveprefix={{subst:FULLPAGENAME}}/Archive
|format= %%i
|age=2160
|maxarchsize=150000
|numberstart=1
}}

The subpages created, as needed, for your archives by this example will be named similar to:
Talk:YourPage/Archive 1
Talk:YourPage/Archive 2
...

Example: Numbered archives (with archive box)

{{User:ClueBot III/ArchiveThis
|archiveprefix={{subst:FULLPAGENAME}}/Archive
|format= %%i
|age=2160
|maxarchsize=150000
|numberstart=1
|archivebox=yes
|box-advert=yes
}}

The subpages created, as needed, for your archives by this example will be named similar to:
Talk:YourPage/Archive 1
Talk:YourPage/Archive 2
...

Example: By year and numbered (with archive box)

{{User:ClueBot III/ArchiveThis
|archiveprefix={{subst:FULLPAGENAME}}/Archives/
|format=Y %%i
|age=2160
|minarchthreads=0
|minkeepthreads=0
|archivenow=<nowiki>{{User:ClueBot III/ArchiveNow}},{{resolved|,{{Resolved|,{{done}},{{Done}}</nowiki>
|header=<nowiki>{{Talkarchive}}</nowiki>
|headerlevel=2
|nogenerateindex=0
|maxkeepthreads=0
|maxkeepbytes=0
|maxarchsize=150000
|numberstart=1
|archivebox=yes
|box-advert=yes
}}

The subpages created, as needed, for your archives by this example will be named similar to:
Talk:YourPage/Archives/2012 1
Talk:YourPage/Archives/2012 2
...
Talk:YourPage/Archives/2013 1
Talk:YourPage/Archives/2013 2
...

Example: Changing from MiszaBot to ClueBot III

MiszaBot ClueBot III
{{User:MiszaBot/config 
|archive = {{subst:FULLPAGENAME}}/Archive %(counter)d
|algo = old(90d)
|archiveheader = {{aan}}
|maxarchivesize = 100K
|minthreadsleft = 2
|counter = 20
}}
{{User:ClueBot III/ArchiveThis
|archiveprefix={{subst:FULLPAGENAME}}/Archive
|age=2160
|header={{aan}}
|maxarchsize=100000
|minkeepthreads=2
|numberstart=21
|format= %%i
}}

The subpages created, as needed, for your archives by this example will be named similar to:
Talk:YourPage/Archive 21
Talk:YourPage/Archive 22
...

The numberstart is one more than the last used by MiszaBot because the first time ClueBot III is run it may be archiving a large number of sections. Increasing this by one will prevent the current archive from being appended. In the case from which this example is taken a 90k archive page was appended by an additional 100k leaving a 190k page for which the max was supposed to be 100k. This has been reported as a bug.

Age is in hours, not days. 90 days is 2,160 hours.

If you are using an {{Archives}} template, or other template that shows which archiving bot you are using, don't forget to change:
{{Archives |auto= short |index= /Archive index |search= yes |bot= MiszaBot I |age= 90}}
to:
{{Archives |auto= short |index= /Archive index |search= yes |bot= ClueBot III |age= 90}}


Awards

Show all awards
Special Barnstar Hires.png The Special Barnstar
To ClueBot NG, for making 5 million edits! Thanks for the hard work on reverting vandalism! SemiHypercube (talk) 15:38, 16 June 2018 (UTC)
Anti-Vandalism Barnstar for ClueBot NG Half Banstar for ClueBot NG A half barnstar for ClueBot III
The Multiple Barnstar
An Anti-vandalism barnstar and a half barn star for ClueBot NG, for the bot’s work on fighting vandalism and making over 5 MILLION edits (wow, that’s almost as much as the English Wikipedia’s article count!) and counting to fight lots of vandalism. ClueBot III gets the other half Barnstar for doing a lot of talk page archiving. Thank you so much for all your hard work, and here’s to another 5 million edits of reverting vandalism, and another 600,000+ of talk page archiving! Porkchop Jr. 17:43, 14 June 2018 (UTC)
Red barnstar.png A gift card from the Barnstar Shop
This is a red gift card that the bots can use at the Barnstar Shop. Feel free to buy any barnstars there, and maybe even give them to other users! (But please don’t award yourself some.) Porkchop Jr. 18:42, 14 June 2018 (UTC)
Barnstar of Reversion Hires.png The Anti-Vandalism Barnstar
If ClueBot NG weren’t here, we won’t revert vandalism as much as it does. Thank you for all the edits that you’ve made. 70.190.21.73 (talk) 23:14, 10 March 2018 (UTC)
Barnstar of Reversion Hires.png The Anti-Vandalism Barnstar
What!? This bot is faster than any other bot in Wikipedia. Excellent job at reverting vandalism, Cluebot NG. You have made almost everybody's lives easier. —Bey WHEELZ Let It RIP!📝Sign 20:33, 25 November 2017 (UTC)
Working Man's Barnstar Hires.png The Hard Worker's Barnstar
*qqqqqqqqqq HI!!* deleted by ClueBot NG in awards section. Report False Positive? It didn't really. :) SuperTurboChampionshipEdition (talk) 15:36, 17 June 2017 (UTC)



Praise

Show all praise

Contributions

My Contributions

Source

Bot source


ClueBots
ClueBot NG/Anti-vandalism · ClueBot/Anti-vandalism · ClueBot II/ClueBot Script
Crystal Clear action run.png
ClueBot III/Archive · ClueBot VI/WP:CHUU Clerk  · Talk

Cobi/Owner // Talk