General pages changes scripts#

archivebot script#

archivebot.py - discussion page archiving bot

usage:

python pwb.py archivebot [OPTIONS] [TEMPLATE_PAGE]

Several TEMPLATE_PAGE templates can be given at once. Default is User:MiszaBot/config. Bot examines backlinks (Special:WhatLinksHere) to all TEMPLATE_PAGE templates. Then goes through all pages (unless a specific page specified using options) and archives old discussions. This is done by breaking a page into threads, then scanning each thread for timestamps. Threads older than a specified threshold are then moved to another page (the archive), which can be named either basing on the thread’s name or then name can contain a counter which will be incremented when the archive reaches a certain size.

Transcluded template may contain the following parameters:

{{TEMPLATE_PAGE
|archive =
|algo =
|counter =
|maxarchivesize =
|minthreadsleft =
|minthreadstoarchive =
|archiveheader =
|key =
}}

Meanings of parameters are:

archive

Name of the page to which archived threads will be put. Must be a subpage of the current page. Variables are supported.

algo

Specifies the maximum age of a thread. Must be in the form old(<delay>) where <delay> specifies the age in seconds (s), hours (h), days (d), weeks (w), or years (y) like 24h or 5d. Default is old(24h).

counter

The current value of a counter which could be assigned as variable. Will be updated by bot. Initial value is 1.

maxarchivesize

The maximum archive size before incrementing the counter. Value can be given with appending letter like K or M which indicates KByte or MByte. Default value is 200K.

minthreadsleft

Minimum number of threads that should be left on a page. Default value is 5.

minthreadstoarchive

The minimum number of threads to archive at once. Default value is 2.

archiveheader

Content that will be put on new archive pages as the header. This parameter supports the use of variables. Default value is {{talkarchive}}.

key

A secret key that (if valid) allows archives not to be subpages of the page being archived.

Variables below can be used in the value for “archive” in the template above; numbers are latin digits. Alternatively you may use localized digits. This is only available for a few site languages. Refer NON_LATIN_DIGITS whether there is a localized one.

latin

localized

Description

%(counter)d

%(localcounter)s

the current value of the counter

%(year)d

%(localyear)s

year of the thread being archived

%(isoyear)d

%(localisoyear)s

ISO year of the thread being archived

%(isoweek)d

%(localisoweek)s

ISO week number of the thread being archived

%(semester)d

%(localsemester)s

semester term of the year of the thread being archived

%(quarter)d

%(localquarter)s

quarter of the year of the thread being archived

%(month)d

%(localmonth)s

month (as a number 1-12) of the thread being archived

%(monthname)s

localized name of the month above

%(monthnameshort)s

first three letters of the name above

%(week)d

%(localweek)s

week number of the thread being archived

The ISO calendar starts with the Monday of the week which has at least four days in the new Gregorian calendar. If January 1st is between Monday and Thursday (including), the first week of that year started the Monday of that week, which is in the year before if January 1st is not a Monday. If it’s between Friday or Sunday (including) the following week is then the first week of the year. So up to three days are still counted as the year before.

Options (may be omitted):

-help

show this help message and exit

-calc:PAGE

calculate key for PAGE and exit

-file:FILE

load list of pages from FILE

-force

override security options

-locale:LOCALE

switch to locale LOCALE

-namespace:NS

only archive pages from a given namespace

-page:PAGE

archive a single PAGE, default ns is a user talk page

-salt:SALT

specify salt

-keep

Preserve thread order in archive even if threads are archived later

-sort

Sort archive by timestamp; should not be used with keep

-async

Run the bot in parallel tasks.

Changed in version 7.6: Localized variables for “archive” template parameter are supported. User:MiszaBot/config is the default template. -keep option was added.

Changed in version 7.7: -sort and -async options were added.

Changed in version 8.2: KeyboardInterrupt was enabled with -async option.

movepages script#

This script can move pages

These command line parameters can be used to specify which pages to work on:

This script supports use of pagegenerators arguments.

Furthermore, the following command line parameters are supported:

-from

The page to move from.

-to

The page to move to.

-noredirect

Leave no redirect behind.

-notalkpage

Do not move this page’s talk page (if it exists)

-nosubpages

Do not move subpages

-prefix

Move pages by adding a namespace prefix to the names of the pages. (Will remove the old namespace prefix if any) Argument can also be given as -prefix:namespace:.

-always

Don’t prompt to make changes, just do them.

-skipredirects

Skip redirect pages (Warning: increases server load)

-summary

(str) Prompt for a custom summary, bypassing the predefined message texts. Argument can also be given as -summary:XYZ.

-pairsfile

Read pairs of file names from a file. The file must be in a format [[frompage]] [[topage]] [[frompage]] [[topage]] … Argument can also be given as -pairsfile:filename

pagefromfile script#

Bot to upload pages from a text file

This bot takes its input from the UTF-8 text file that contains a number of pages to be put on the wiki. The pages should all have the same beginning and ending text (which may not overlap). The beginning and ending text is not uploaded with the page content by default.

As a pagename is by default taken the first text block from the page content marked in bold (wrapped between ‘’’ and ‘’’). If you expect the page title not to be present in the text or marked by different markers, use -titlestart, -titleend, and -notitle parameters.

Specific arguments:

-file:xxx

The filename we are getting our material from, the default value is “dict.txt”

-begin:xxx

The text that marks the beginning of a page, the default value is “{{-start-}}”

-end:xxx

The text that marks the end of the page, the default value is “{{-stop-}}”

-include

Include the beginning and end markers to the page

-textonly

Text is given without markers. Only one page text is given. -begin and -end options are ignored.

-titlestart:xxx

The text used in place of ‘’’ for identifying the beginning of a page title

-titleend:xxx

The text used in place of ‘’’ for identifying the end of the page title

-notitle

Do not include the page title, including titlestart and titleend, to the page. Can be used to specify unique page title above the page content

-title:xxx

The page title is given directly. Ignores -titlestart, -titleend and -notitle options

-nocontent:xxx

If the existing page contains specified statement, the page is skipped from editing

-noredirect

Do not upload on redirect pages

-summary:xxx

The text used as an edit summary for the upload. If the page exists, standard messages for prepending, appending, or replacement are appended after it.

-autosummary

Use MediaWiki’s autosummary when creating a new page, overrides -summary-

-minor

Set the minor edit flag on page edits

-showdiff

Show difference between current page and page to upload, also forces the bot to ask for confirmation on every edit.

If the page to be uploaded already exists, it is skipped by default. But you can override this behavior if you want to:

-appendtop

Add the text to the top of the existing page

-appendbottom

Add the text to the bottom of the existing page

-force

Overwrite the existing page

It is possible to define a separator after the ‘append’ modes which is added between the existing and the new text. For example a parameter -appendtop:foo would add ‘foo’ between them. A new line can be added between them by specifying ‘n’ as a value.