User:ArchiveBot - Revision history

Shane: /* Parameters explained */

2008-01-15T18:18:59Z

Parameters explained

← Older revision		Revision as of 18:18, 15 January 2008
Line 64:		Line 64:
	\| <tt>minthreadsleft</tt> \|\| The minimum number of threads that should be left on a page (to prevent pages from getting completely harvested). Default value: 1		\| <tt>minthreadsleft</tt> \|\| The minimum number of threads that should be left on a page (to prevent pages from getting completely harvested). Default value: 1
	\|-		\|-
	\| <tt>minthreadstoarchive</tt> \|\| The minimum number of threads to archive at one time (lowers edit frequency by refusing to act when only few threads would be archived). Default value: 2		\| <tt>minthreadstoarchive</tt> \|\| The minimum number of threads to archive at one time (lowers edit frequency by refusing to act when only few threads would be archived). Default value: 1
	\|-		\|-
	\| <tt>maxarchivesize</tt> \|\| Specifies the maximum archive size before incrementing the counter. Ignored if counter is not used.		\| <tt>maxarchivesize</tt> \|\| Specifies the maximum archive size before incrementing the counter. Ignored if counter is not used.

Shane: /* When a new archive is created */

2007-12-20T02:25:16Z

When a new archive is created

← Older revision		Revision as of 02:25, 20 December 2007
Line 89:		Line 89:
	\|}		\|}
	= When a new archive is created =		= When a new archive is created =
	When a new archive is created, the bot will automaticly add {{tl\|archive-message}} to the top. Depending on the type of archive it is creating, the fields will be filled out. As of ~~June 14~~, 2007, it will only fill out the next archive number.		When a new archive is created, the bot will automaticly add {{tl\|archive-message}} to the top. Depending on the type of archive it is creating, the fields will be filled out. As of December 19, 2007, it will only fill out the next archive number.

	= See Also =		= See Also =
	* [[:Category:Automatically archived pages]]		* [[:Category:Automatically archived pages]]

Shane at 20:51, 19 December 2007

2007-12-19T20:51:24Z

← Older revision		Revision as of 20:51, 19 December 2007
Line 53:		Line 53:
	=== Parameters explained ===		=== Parameters explained ===

	{\| class = "~~prettytable~~"		{\| class = "messagebox"
	! ~~parameter~~ \|\| ~~meaning~~		! Parameter \|\| Meaning
	\|-		\|-
	\| <tt>archive</tt> \|\| Name of the page to which archived threads will be put. Supports [[#Variables\|variables]].		\| <tt>archive</tt> \|\| Name of the page to which archived threads will be put. Supports [[#Variables\|variables]].
	\|-		\|-
	\| <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. Bot 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. Bot will update this parameter as necessary.
	\|-		\|-
	~~\| <tt>maxarchivesize</tt> \|\| The maximum archive size before incrementing the counter. Ignored if counter is not used.~~		\| <tt>minthreadsleft</tt> \|\| The minimum number of threads that should be left on a page (to prevent pages from getting completely harvested). Default value: 1
	\|-
	\| <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 (lowers edit frequency by refusing to act when only few threads would be archived). Default value: 2		\| <tt>minthreadstoarchive</tt> \|\| The minimum number of threads to archive at one time (lowers edit frequency by refusing to act when only few threads would be archived). Default value: 2
	\|-		\|-
	\| <tt>archiveheader</tt> \|\| Content that will be put on new archive pages as the header. Supports [[#Variables\|variables]]. '''Cannot''' be multiline (use a template like {{tl\|archive-~~nav~~}})~~. Defaults to {{tl\|talkarchive}}~~.		\| <tt>maxarchivesize</tt> \|\| Specifies the maximum archive size before incrementing the counter. Ignored if counter is not used.
	\|-		\|-
	\| <tt>~~key~~</tt> \|\| ~~Secret key that (if valid) allows~~ archives to '''~~not~~''' ~~be subpages of the page being archived~~. ~~To obtain such a key, [[User talk:Misza13\|ask me]] and have a good reason for that. :-)~~		\| <tt>archiveheader</tt> \|\| Content that will be put on new archive pages as the header. Supports [[#Variables\|variables]]. '''Cannot''' be multiline (use a template like {{tl\|archive-message}}).
	\|}		\|-
			\| <tt>index</tt> \|\| Creates an index of all the archives for the current page. This must equal '''Y''' to work.
			\|}

	=== Variables ===		=== Variables ===

Shane: /* Parameters explained */

2007-12-19T20:49:30Z

Parameters explained

← Older revision		Revision as of 20:49, 19 December 2007
Line 53:		Line 53:
	=== Parameters explained ===		=== Parameters explained ===

	{\| class = "~~messagebox~~"		{\| class = "prettytable"
	! ~~Parameter~~ \|\| ~~Meaning~~		! parameter \|\| meaning
	\|-		\|-
	\| <tt>archive</tt> \|\| Name of the page to which archived threads will be put. Supports [[#Variables\|variables]].		\| <tt>archive</tt> \|\| Name of the page to which archived threads will be put. Supports [[#Variables\|variables]].
	\|-		\|-
	\| <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. Bot 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. Bot will update this parameter as necessary.
	\|-		\|-
	\| <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>maxarchivesize</tt> \|\| The maximum archive size before incrementing the counter. Ignored if counter is not used.
	\|-		\|-
	\| <tt>~~maxarchivesize~~</tt> \|\| ~~Specifies~~ the ~~maximum~~ archive ~~size before incrementing the counter~~. ~~Ignored if counter is not used~~.		\| <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>~~index~~</tt> \|\| ~~Creates an index of all the~~ archives ~~for the current page. This must equal~~ '''Y''' ~~to work~~.		\| <tt>minthreadstoarchive</tt> \|\| The minimum number of threads to archive at one time (lowers edit frequency by refusing to act when only few threads would be archived). Default value: 2
	\|}		\|-
			\| <tt>archiveheader</tt> \|\| Content that will be put on new archive pages as the header. Supports [[#Variables\|variables]]. '''Cannot''' be multiline (use a template like {{tl\|archive-nav}}). Defaults to {{tl\|talkarchive}}.
			\|-
			\| <tt>key</tt> \|\| Secret key that (if valid) allows archives to '''not''' be subpages of the page being archived. To obtain such a key, [[User talk:Misza13\|ask me]] and have a good reason for that. :-)
			\|}

	=== Variables ===		=== Variables ===

ArchiveBot: /* Other things to add */

2007-12-19T20:28:30Z

Other things to add

← Older revision		Revision as of 20:28, 19 December 2007
Line 49:		Line 49:

	==== Other things to add ====		==== Other things to add ====
	Add the {{tl\|ArchiveTOC}} template underneath this template so people can get to the archives faster. Archive Index's ~~are not created by~~ the ~~bot yet~~.		Add the {{tl\|ArchiveTOC}} template underneath this template so people can get to the archives faster. Archive Index's is something you add to the primary page.

	=== Parameters explained ===		=== Parameters explained ===

ArchiveBot: /* Example 2 - Incremental archives */

2007-12-19T20:27:10Z

Example 2 - Incremental archives

← Older revision		Revision as of 20:27, 19 December 2007
Line 36:		Line 36:
	</nowiki></pre>		</nowiki></pre>

	This tells ~~the bot~~ to archive threads from <code>User talk:Example</code> to <code>User talk:Example/Archive3</code> (more about variables [[#Variables\|below]]) until it fills up to 250 kilobytes, whereupon ~~the bot~~ will move to 4 (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.		This tells me to archive threads from <code>User talk:Example</code> to <code>User talk:Example/Archive3</code> (more about variables [[#Variables\|below]]) until it fills up to 250 kilobytes, whereupon I will move to 4 (updating the counter when saving page). Remember to '''specify the maximum size''' of an archive, or I will behave pretty much like in the first example.

	==== Example 3 - Date-based archives ====		==== Example 3 - Date-based archives ====

ArchiveBot: + updating archivebot.py url

2007-12-19T20:25:53Z

+ updating archivebot.py url

← Older revision		Revision as of 20:25, 19 December 2007
Line 1:		Line 1:
	{{Bot\|Shane\|active}}		{{Bot\|Shane\|active}}
	Hello. I am the '''ArchiveBot''' that makes archives for various talk pages and other pages. I am built using the [http://sourceforge.net/projects/pywikipediabot/ pywikipediabot] Python code. Though I have other functions, I am only going to be used for only archiving purposes. [http://~~meta~~.~~wikimedia~~.~~org~~/wiki/Archivebot.py Archivebot.py] is the primary file that I use.		Hello. I am the '''ArchiveBot''' that makes archives for various talk pages and other pages. I am built using the [http://sourceforge.net/projects/pywikipediabot/ pywikipediabot] Python code. Though I have other functions, I am only going to be used for only archiving purposes. [http://botwiki.sno.cc/wiki/Python:Archivebot.py Archivebot.py] is the primary file that I use.

	== How to set up archiving? ==		== How to set up archiving? ==

Shane: /* Parameters explained */

2007-09-04T19:29:16Z

Parameters explained

← Older revision		Revision as of 19:29, 4 September 2007
Line 61:		Line 61:
	\|-		\|-
	\| <tt>counter</tt> \|\| The current value of the counter. If the <tt>%(counter)d</tt> variable is not used, it is ignored. Bot 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. Bot will update this parameter as necessary.
			\|-
			\| <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>maxarchivesize</tt> \|\| Specifies the maximum archive size before incrementing the counter. Ignored if counter is not used.		\| <tt>maxarchivesize</tt> \|\| Specifies the maximum archive size before incrementing the counter. Ignored if counter is not used.

BklynBruzer at 03:11, 10 July 2007

2007-07-10T03:11:30Z

← Older revision		Revision as of 03:11, 10 July 2007
Line 1:		Line 1:
	{{Bot\|Shane\|active}}		{{Bot\|Shane\|active}}
	Hello. I am the '''ArchiveBot''' that makes archives for ~~varrios~~ talk pages and other pages. I am built using the [http://sourceforge.net/projects/pywikipediabot/ pywikipediabot] Python code. Though I have other functions, I am only going to be used for only archiving purposes. [http://meta.wikimedia.org/wiki/Archivebot.py Archivebot.py] is the primary file that I use.		Hello. I am the '''ArchiveBot''' that makes archives for various talk pages and other pages. I am built using the [http://sourceforge.net/projects/pywikipediabot/ pywikipediabot] Python code. Though I have other functions, I am only going to be used for only archiving purposes. [http://meta.wikimedia.org/wiki/Archivebot.py Archivebot.py] is the primary file that I use.

	== How to set up archiving? ==		== How to set up archiving? ==

Shane at 22:10, 25 June 2007

2007-06-25T22:10:54Z

← Older revision		Revision as of 22:10, 25 June 2007
Line 1:		Line 1:
	{{Bot\|Shane\|~~probationary~~}}		{{Bot\|Shane\|active}}
	Hello. I am the '''ArchiveBot''' that makes archives for varrios talk pages and other pages. I am built using the [http://sourceforge.net/projects/pywikipediabot/ pywikipediabot] Python code. Though I have other functions, I am only going to be used for only archiving purposes. [http://meta.wikimedia.org/wiki/Archivebot.py Archivebot.py] is the primary file that I use.		Hello. I am the '''ArchiveBot''' that makes archives for varrios talk pages and other pages. I am built using the [http://sourceforge.net/projects/pywikipediabot/ pywikipediabot] Python code. Though I have other functions, I am only going to be used for only archiving purposes. [http://meta.wikimedia.org/wiki/Archivebot.py Archivebot.py] is the primary file that I use.