Module:Synchbot/doc

This module is used to format Synchbot requests. The following functions are defined.

Request

Arguments

Renders a Synchbot request log which summarises the actions performed in response to this request. The following arguments are defined:

all requests
parameter	usage
user	The name of the user whose user pages to edit. This will be used by the bot to skip wikis where the user isn't registered.
action	The action to perform on each page; one of delete, replace/prepend/append (for edit), or set (for preferences).
skip wikis	An arbitrary list of wikis to skip.
status	The status of the request; one of queued (default), done, not done, or on hold.
'edit' requests
title	The title of the page to edit on each wiki (including namespace).
text	The text to write to the page.
skip existing	Whether to skip wikis where the page already exists ('yes' or blank).
'set' preferences requests
set:*	The preferences to set as key:value pairs, like set:language = en.

Example (edit pages)

{{#invoke:synchbot|request
  |user          = Pathoschild
  |action        = replace
  |title         = User:Pathoschild/common.js
  |text          = mw.loader.load('//meta.wikimedia.org/w/index.php?title=User:Pathoschild/global.js&action=raw&ctype=text/javascript');
  |skip wikis    = 
  |skip existing = 
  |status        = done
}}

request done:

Pathoschild (global account · recent activity · user pages)

• go to User:Pathoschild/common.js on every wiki
• and replace the text with
  mw.loader.load('//meta.wikimedia.org/w/index.php?title=User:Pathoschild/global.js&action=raw&ctype=text/javascript');

request_user = u'Pathoschild',
request_titles = [u'User:Pathoschild/common.js'],
request_action = lambda bot: bot.save(u"""mw.loader.load('//meta.wikimedia.org/w/index.php?title=User:Pathoschild/global.js&action=raw&ctype=text/javascript');"""),
skip_existing = False,
skip_new = False,
skip_unregistered = True,
skip_wikis = [],
only_wikis = [],
delete_summary = None,
edit_summary = None,

Example (set preferences)

{{#invoke:synchbot|request
  |user          = Pathoschild
  |action        = set
  |set:language  = en
  |set:skin      = vector
  |skip wikis    = 
  |status        = done
}}

request done:

Pathoschild (global account · recent activity · user pages)

• go to every wiki
• and set these preferences:
  • Set language to en
  • Set skin to vector

request_user = u'Pathoschild',
request_titles = [u'None'],
request_action = lambda bot: None,
skip_existing = False,
skip_new = False,
skip_unregistered = True,
skip_wikis = [],
only_wikis = [],
delete_summary = None,
edit_summary = None,

Log

Arguments

Renders a Synchbot request log which summarises the actions performed in response to this request. The following arguments are defined:

parameter	usage
log	The logged actions to output, as a multiline sequence of comma-separated values. Each line should consist of three fields: the time (like "00:53"), page link (like "[[s:User:Pathoschild|en.wikisource.org]]"), and log message (like "created (+116)"). Each message will be formatted by matching the log message for common patterns.
indent	(optional) The number of times to indent the output, corresponding to the indentation level of a threaded wiki discussion.
counts:*	(optional) Adds to the page counts used to build the summary bar graph. This is used to show an accurate summary even though some pages aren't listed (like page-doesn't-exist entries for a deletion request). Valid count keys: created, updated, deleted, missing (for missing user), skipped.

Example (no arguments)

{{#invoke:synchbot|log|
     00:53,[[w:User:Pathoschild|en.wikipedia.org]],created (+116).
     00:53,[[s:User:Pathoschild|en.wikisource.org]],deleted.
     00:55,[[wikt:User:Pathoschild|en.wiktionary.org]],updated (+116).
}}

The following log shows what the bot did on each wiki. You can click the columns to sort the log.

summary:

time	wiki	logged action
00:53	en.wikipedia.org	created (+116).
00:53	en.wikisource.org	deleted.
00:55	en.wiktionary.org	updated (+116).

Example (with arguments)

{{#invoke:synchbot|log
  |indent = 3
  |log    = 
     00:53,[[w:User:Pathoschild|en.wikipedia.org]],created (+116).
     00:53,[[s:User:Pathoschild|en.wikisource.org]],deleted.
     00:55,[[wikt:User:Pathoschild|en.wiktionary.org]],updated (+116).
}}

The following log shows what the bot did on each wiki. You can click the columns to sort the log.

summary:

time	wiki	logged action
00:53	en.wikipedia.org	created (+116).
00:53	en.wikisource.org	deleted.
00:55	en.wiktionary.org	updated (+116).