Difference between revisions of "User:RoboJeb/Archive"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Created page with "<noinclude> {{doc start}} === Parameters explained === <pre> {{User:RoboJeb/Archive | archive = | algo = | counter = | maxarchivesize...")
 
Line 22: Line 22:
 
| <tt>algo</tt> || Algorithm that instructs the bot how to decide whether to archive a thread or not. Complex formulas (including regex matching) will be available in the future, but so far it '''must''' be of the form '''<tt>old(...)</tt>''' where '''...''' specifies the maximum age of a thread (in hours or days: ''24h'', ''72h'', ''5d'', ''21d'' etc.)
 
| <tt>algo</tt> || Algorithm that instructs the bot how to decide whether to archive a thread or not. Complex formulas (including regex matching) will be available in the future, but so far it '''must''' be of the form '''<tt>old(...)</tt>''' where '''...''' specifies the maximum age of a thread (in hours or days: ''24h'', ''72h'', ''5d'', ''21d'' etc.)
 
|-
 
|-
| <tt>counter</tt> || The current value of the counter. If the <tt>%(counter)d</tt> variable is not used, it is ignored. MiszaBot will update this parameter as necessary.
+
| <tt>counter</tt> || The current value of the counter. If the <tt>%(counter)d</tt> variable is not used, it is ignored. RoboJeb will update this parameter as necessary.
 
|-
 
|-
 
| <tt>maxarchivesize</tt> || The maximum archive size before incrementing the counter. Ignored if counter is not used. The values used must be in a #K format, using a capital letter "K". For example: <tt>maxarchivesize=256K</tt>
 
| <tt>maxarchivesize</tt> || The maximum archive size before incrementing the counter. Ignored if counter is not used. The values used must be in a #K format, using a capital letter "K". For example: <tt>maxarchivesize=256K</tt>
Line 28: Line 28:
 
| <tt>minthreadsleft</tt> || The minimum number of threads that should be left on a page (to prevent pages from getting completely harvested). Default value: 5
 
| <tt>minthreadsleft</tt> || The minimum number of threads that should be left on a page (to prevent pages from getting completely harvested). Default value: 5
 
|-
 
|-
| <tt>minthreadstoarchive</tt> || The minimum number of threads to archive at one time, which is used to lower edit frequency. MiszaBot will not archive threads when fewer than the value of this parameter would be archived. Default value: 2
+
| <tt>minthreadstoarchive</tt> || The minimum number of threads to archive at one time, which is used to lower edit frequency. RoboJeb will not archive threads when fewer than the value of this parameter would be archived. Default value: 2
 
|-
 
|-
| <tt>archiveheader</tt> || Content that will be put on new archive pages as the header. This parameter supports the use of [[#Variables|variables]]. The value of this parameter ''Cannot'' be multiline! Use a template such as {{tl|archive navigation}} in order to add significant content. The Default value is {{tl|talk archive}}.
+
| <tt>archiveheader</tt> || Content that will be put on new archive pages as the header. This parameter supports the use of [[#Variables|variables]]. The value of this parameter ''Cannot'' be multiline! Use a template such as {{tlx|archive navigation}} in order to add significant content. The Default value is {{tlx|talkarchive}}.
 
|-
 
|-
| <tt>key</tt> || A secret key that (if valid) allows archives to ''not'' be subpages of the page being archived. To obtain such a key, [[User talk:N3X15|ask me]] and have a good reason for that. :-)
+
| <tt>key</tt> || A secret key that (if valid) allows archives to ''not'' be subpages of the page being archived. To obtain such a key, [[User talk:N3X15|ask me]] and have a good reason for it.
 
|}
 
|}
 
</noinclude>
 
</noinclude>

Revision as of 22:55, 25 October 2012

Documentation for RoboJeb/Archive

Parameters explained

{{User:RoboJeb/Archive
| archive             = 
| algo                = 
| counter             = 
| maxarchivesize      = 
| minthreadsleft      = 
| minthreadstoarchive = 
| archiveheader       = 
| key                 = 
}}
Parameter Description
archive Name of the page to which archived threads will be put. This parameter supports the use of 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 key is supplied (see below), the target page must be a subpage of the current page.
algo Algorithm that instructs the bot how to decide whether to archive a thread or not. Complex formulas (including regex matching) will be available in the future, but so far it must be of the form old(...) where ... specifies the maximum age of a thread (in hours or days: 24h, 72h, 5d, 21d etc.)
counter The current value of the counter. If the %(counter)d variable is not used, it is ignored. RoboJeb will update this parameter as necessary.
maxarchivesize The maximum archive size before incrementing the counter. Ignored if counter is not used. The values used must be in a #K format, using a capital letter "K". For example: maxarchivesize=256K
minthreadsleft The minimum number of threads that should be left on a page (to prevent pages from getting completely harvested). Default value: 5
minthreadstoarchive The minimum number of threads to archive at one time, which is used to lower edit frequency. RoboJeb will not archive threads when fewer than the value of this parameter would be archived. Default value: 2
archiveheader Content that will be put on new archive pages as the header. This parameter supports the use of variables. The value of this parameter Cannot be multiline! Use a template such as {{archive navigation}} in order to add significant content. The Default value is {{talkarchive}}.
key A secret key that (if valid) allows archives to not be subpages of the page being archived. To obtain such a key, ask me and have a good reason for it.