Wiki:Operations Manual: Difference between revisions

From XMethod Wiki
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
Auto-update: Documentation refreshed
Auto-update: Documentation refreshed
Line 4: Line 4:
This Operations Manual documents all features, extensions, and APIs available on the Doc Moates Wiki (MediaWiki 1.42.4).
This Operations Manual documents all features, extensions, and APIs available on the Doc Moates Wiki (MediaWiki 1.42.4).


'''Documentation Version:''' 1.2.0<br>
'''Documentation Version:''' 1.3.0<br>
'''Last Updated:''' 2026-01-29 17:01:10 UTC<br>
'''Last Updated:''' 2026-01-29 17:02:01 UTC<br>
'''Total Extensions:''' 36 | '''API Modules:''' 86
'''Total Extensions:''' 36 | '''API Modules:''' 86


Line 201: Line 201:
! Module !! Description
! Module !! Description
|-
|-
| <code>abusefiltercheckmatch</code> || MediaWiki API module.
| <code>abusefiltercheckmatch</code> || <p>Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.
</p>
<p>vars, rcid or logid is required however only one may be used.
</p>.
|-
|-
| <code>abusefilterchecksyntax</code> || MediaWiki API module.
| <code>abusefilterchecksyntax</code> || Check syntax of an AbuseFilter filter.
|-
|-
| <code>abusefilterevalexpression</code> || MediaWiki API module.
| <code>abusefilterevalexpression</code> || Evaluates an AbuseFilter expression.
|-
|-
| <code>abusefilterunblockautopromote</code> || MediaWiki API module.
| <code>abusefilterunblockautopromote</code> || Unblocks a user from receiving autopromotions due to an abusefilter consequence.
|-
|-
| <code>abuselogprivatedetails</code> || MediaWiki API module.
| <code>abuselogprivatedetails</code> || View private details of an AbuseLog entry.
|-
|-
| <code>acquiretempusername</code> || MediaWiki API module.
| <code>acquiretempusername</code> || <p>Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the sam...
|-
|-
| <code>aichat</code> || MediaWiki API module.
| <code>aichat</code> || ⧼apihelp-aichat-summary⧽
.
|-
|-
| <code>block</code> || MediaWiki API module.
| <code>block</code> || Block a user.
|-
|-
| <code>categorytree</code> || MediaWiki API module.
| <code>categorytree</code> || Internal module for the CategoryTree extension.
|-
|-
| <code>changeauthenticationdata</code> || MediaWiki API module.
| <code>changeauthenticationdata</code> || Change authentication data for the current user.
|-
|-
| <code>changecontentmodel</code> || MediaWiki API module.
| <code>changecontentmodel</code> || Change the content model of a page.
|-
|-
| <code>checktoken</code> || MediaWiki API module.
| <code>checktoken</code> || Check the validity of a token from <kbd><a href="/Special:ApiHelp/query%2Btokens" title="Special:ApiHelp/query+tokens">action=query&amp;meta=tokens</a></kbd>.
|-
|-
| <code>clearhasmsg</code> || MediaWiki API module.
| <code>clearhasmsg</code> || Clears the <code>hasmsg</code> flag for the current user.
|-
|-
| <code>clientlogin</code> || MediaWiki API module.
| <code>clientlogin</code> || <p>Log in to the wiki using the interactive flow.
</p>
 
<p>The general procedure to use this module is:
</p>
<ol><li>Fetch the fields available from <kbd><a href="/Special:ApiHelp/query%2Bauthmanag...
|-
|-
| <code>compare</code> || MediaWiki API module.
| <code>compare</code> || <p>Get the difference between two pages.
</p>
<p>A revision number, a page title, a page ID, text, or a relative reference for both "from" and "to" must be passed.
</p>.
|-
|-
| <code>createaccount</code> || MediaWiki API module.
| <code>createaccount</code> || <p>Create a new user account.
</p>
 
<p>The general procedure to use this module is:
</p>
<ol><li>Fetch the fields available from <kbd><a href="/Special:ApiHelp/query%2Bauthmanagerinfo" title="Speci...
|-
|-
| <code>cspreport</code> || MediaWiki API module.
| <code>cspreport</code> || Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
|-
|-
| <code>delete</code> || MediaWiki API module.
| <code>delete</code> || Delete a page.
|-
|-
| <code>discussiontoolscompare</code> || MediaWiki API module.
| <code>discussiontoolscompare</code> || Get information about comment changes between two page revisions.
|-
|-
| <code>discussiontoolsedit</code> || MediaWiki API module.
| <code>discussiontoolsedit</code> || Post a message on a discussion page.
|-
|-
| <code>discussiontoolsfindcomment</code> || MediaWiki API module.
| <code>discussiontoolsfindcomment</code> || Find a comment by its ID or name.
|-
|-
| <code>discussiontoolsgetsubscriptions</code> || MediaWiki API module.
| <code>discussiontoolsgetsubscriptions</code> || Get the subscription statuses of given topics.
|-
|-
| <code>discussiontoolspageinfo</code> || MediaWiki API module.
| <code>discussiontoolspageinfo</code> || Returns metadata required to initialize the discussion tools.
|-
|-
| <code>discussiontoolspreview</code> || MediaWiki API module.
| <code>discussiontoolspreview</code> || Preview a message on a discussion page.
|-
|-
| <code>discussiontoolssubscribe</code> || MediaWiki API module.
| <code>discussiontoolssubscribe</code> || Subscribe (or unsubscribe) to receive notifications about a topic.
|-
|-
| <code>echomarkread</code> || MediaWiki API module.
| <code>echomarkread</code> || Mark notifications as read for the current user.
|-
|-
| <code>echomarkseen</code> || MediaWiki API module.
| <code>echomarkseen</code> || Mark notifications as seen for the current user.
|-
|-
| <code>echomute</code> || MediaWiki API module.
| <code>echomute</code> || Mute or unmute notifications from certain users or pages.
|-
|-
| <code>edit</code> || MediaWiki API module.
| <code>edit</code> || Create and edit pages.
|-
|-
| <code>editcheckreferenceurl</code> || MediaWiki API module.
| <code>editcheckreferenceurl</code> || Check the status of a URL for use as a reference.
|-
|-
| <code>emailuser</code> || MediaWiki API module.
| <code>emailuser</code> || Email a user.
|-
|-
| <code>expandtemplates</code> || MediaWiki API module.
| <code>expandtemplates</code> || Expands all templates within wikitext.
|-
|-
| <code>feedcontributions</code> || MediaWiki API module.
| <code>feedcontributions</code> || Returns a user's contributions feed.
|-
|-
| <code>feedrecentchanges</code> || MediaWiki API module.
| <code>feedrecentchanges</code> || Returns a recent changes feed.
|-
|-
| <code>feedwatchlist</code> || MediaWiki API module.
| <code>feedwatchlist</code> || Returns a watchlist feed.
|-
|-
| <code>filerevert</code> || MediaWiki API module.
| <code>filerevert</code> || Revert a file to an old version.
|-
|-
| <code>groupme</code> || MediaWiki API module.
| <code>groupme</code> || ⧼apihelp-groupme-summary⧽
.
|-
|-
| <code>help</code> || MediaWiki API module.
| <code>help</code> || Display help for the specified modules.
|-
|-
| <code>imagerotate</code> || MediaWiki API module.
| <code>imagerotate</code> || Rotate one or more images.
|-
|-
| <code>import</code> || MediaWiki API module.
| <code>import</code> || <p>Import a page from another wiki, or from an XML file.
</p>
<p>Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending a file for the <var>xml</var> pa...
|-
|-
| <code>json</code> || MediaWiki API module.
| <code>json</code> || Output data in JSON format.
|-
|-
| <code>jsonfm</code> || MediaWiki API module.
| <code>jsonfm</code> || Output data in JSON format (pretty-print in HTML).
|-
|-
| <code>linkaccount</code> || MediaWiki API module.
| <code>linkaccount</code> || <p>Link an account from a third-party provider to the current user.
</p>
 
<p>The general procedure to use this module is:
</p>
<ol><li>Fetch the fields available from <kbd><a href="/Special:ApiHelp...
|-
|-
| <code>login</code> || MediaWiki API module.
| <code>login</code> || <p>Log in and get authentication cookies.
</p>
<p>This action should only be used in combination with <a href="/Special:BotPasswords" title="Special:BotPasswords">Special:BotPasswords</a>; use for ...
|-
|-
| <code>logout</code> || MediaWiki API module.
| <code>logout</code> || Log out and clear session data.
|-
|-
| <code>managetags</code> || MediaWiki API module.
| <code>managetags</code> || Perform management tasks relating to change tags.
|-
|-
| <code>mergehistory</code> || MediaWiki API module.
| <code>mergehistory</code> || Merge page histories.
|-
|-
| <code>move</code> || MediaWiki API module.
| <code>move</code> || Move a page.
|-
|-
| <code>none</code> || MediaWiki API module.
| <code>none</code> || Output nothing.
|-
|-
| <code>oathvalidate</code> || MediaWiki API module.
| <code>oathvalidate</code> || Validate a two-factor authentication (OATH) token.
|-
|-
| <code>opensearch</code> || MediaWiki API module.
| <code>opensearch</code> || Search the wiki using the OpenSearch protocol.
|-
|-
| <code>options</code> || MediaWiki API module.
| <code>options</code> || <p>Change preferences of the current user.
</p>
<p>Only options which are registered in core or in one of installed extensions, or options with keys prefixed with <code>userjs-</code> (intended to ...
|-
|-
| <code>paraminfo</code> || MediaWiki API module.
| <code>paraminfo</code> || Obtain information about API modules.
|-
|-
| <code>parse</code> || MediaWiki API module.
| <code>parse</code> || <p>Parses content and returns parser output.
</p>
<p>See the various prop-modules of <kbd><a href="/Special:ApiHelp/query" title="Special:ApiHelp/query">action=query</a></kbd> to get information fr...
|-
|-
| <code>patrol</code> || MediaWiki API module.
| <code>patrol</code> || Patrol a page or revision.
|-
|-
| <code>php</code> || MediaWiki API module.
| <code>php</code> || Output data in serialized PHP format.
|-
|-
| <code>phpfm</code> || MediaWiki API module.
| <code>phpfm</code> || Output data in serialized PHP format (pretty-print in HTML).
|-
|-
| <code>protect</code> || MediaWiki API module.
| <code>protect</code> || Change the protection level of a page.
|-
|-
| <code>purge</code> || MediaWiki API module.
| <code>purge</code> || Purge the cache for the given titles.
|-
|-
| <code>query</code> || MediaWiki API module.
| <code>query</code> || <p>Fetch data from and about MediaWiki.
</p>
<p>All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.
</p>.
|-
|-
| <code>rawfm</code> || MediaWiki API module.
| <code>rawfm</code> || Output data, including debugging elements, in JSON format (pretty-print in HTML).
|-
|-
| <code>removeauthenticationdata</code> || MediaWiki API module.
| <code>removeauthenticationdata</code> || Remove authentication data for the current user.
|-
|-
| <code>resetpassword</code> || MediaWiki API module.
| <code>resetpassword</code> || Send a password reset email to a user.
|-
|-
| <code>revisiondelete</code> || MediaWiki API module.
| <code>revisiondelete</code> || Delete and undelete revisions.
|-
|-
| <code>rollback</code> || MediaWiki API module.
| <code>rollback</code> || <p>Undo the last edit to the page.
</p>
<p>If the last user who edited the page made multiple edits in a row, they will all be rolled back.
</p>.
|-
|-
| <code>rsd</code> || MediaWiki API module.
| <code>rsd</code> || Export an RSD (Really Simple Discovery) schema.
|-
|-
| <code>scribunto-console</code> || MediaWiki API module.
| <code>scribunto-console</code> || Internal module for servicing XHR requests from the Scribunto console.
|-
|-
| <code>setnotificationtimestamp</code> || MediaWiki API module.
| <code>setnotificationtimestamp</code> || <p>Update the notification timestamp for watched pages.
</p>
<p>This affects the highlighting of changed pages in the watchlist and history, and the sending of email when the "Email me when a page ...
|-
|-
| <code>setpagelanguage</code> || MediaWiki API module.
| <code>setpagelanguage</code> || <p>Change the language of a page.
</p>
<p>Changing the language of a page is not allowed on this wiki.
</p><p>Enable <var><a href="https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:$wgPageLa...
|-
|-
| <code>spamblacklist</code> || MediaWiki API module.
| <code>spamblacklist</code> || Validate one or more URLs against the spam block list.
|-
|-
| <code>stashedit</code> || MediaWiki API module.
| <code>stashedit</code> || <p>Prepare an edit in shared cache.
</p>
<p>This is intended to be used via AJAX from the edit form to improve the performance of the page save.
</p>.
|-
|-
| <code>tag</code> || MediaWiki API module.
| <code>tag</code> || Add or remove change tags from individual revisions or log entries.
|-
|-
| <code>templatedata</code> || MediaWiki API module.
| <code>templatedata</code> || Fetch data stored by the TemplateData extension.
|-
|-
| <code>thank</code> || MediaWiki API module.
| <code>thank</code> || Send a thank-you notification to an editor.
|-
|-
| <code>titleblacklist</code> || MediaWiki API module.
| <code>titleblacklist</code> || Validate a page title, filename, or username against the TitleBlacklist.
|-
|-
| <code>unblock</code> || MediaWiki API module.
| <code>unblock</code> || Unblock a user.
|-
|-
| <code>undelete</code> || MediaWiki API module.
| <code>undelete</code> || <p>Undelete revisions of a deleted page.
</p>
<p>A list of deleted revisions (including timestamps) can be retrieved through <a href="/Special:ApiHelp/query%2Bdeletedrevisions" title="Special:ApiHe...
|-
|-
| <code>unlinkaccount</code> || MediaWiki API module.
| <code>unlinkaccount</code> || Remove a linked third-party account from the current user.
|-
|-
| <code>upload</code> || MediaWiki API module.
| <code>upload</code> || <p>Upload a file, or get the status of pending uploads.
</p>
<p>Several methods are available:
</p>
<ul><li>Upload file contents directly, using the <var>file</var> parameter.</li>
<li>Upload the f...
|-
|-
| <code>userrights</code> || MediaWiki API module.
| <code>userrights</code> || Change a user's group membership.
|-
|-
| <code>validatepassword</code> || MediaWiki API module.
| <code>validatepassword</code> || <p>Validate a password against the wiki's password policies.
</p>
<p>Validity is reported as <samp>Good</samp> if the password is acceptable, <samp>Change</samp> if the password may be used for log...
|-
|-
| <code>visualeditor</code> || MediaWiki API module.
| <code>visualeditor</code> || Returns HTML5 for a page from the Parsoid service.
|-
|-
| <code>visualeditoredit</code> || MediaWiki API module.
| <code>visualeditoredit</code> || Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
|-
|-
| <code>watch</code> || MediaWiki API module.
| <code>watch</code> || Add or remove pages from the current user's watchlist.
|-
|-
| <code>xml</code> || MediaWiki API module.
| <code>xml</code> || Output data in XML format.
|-
|-
| <code>xmlfm</code> || MediaWiki API module.
| <code>xmlfm</code> || Output data in XML format (pretty-print in HTML).
|}
|}


Line 408: Line 462:
This documentation is automatically updated every 15 minutes when extensions are added, removed, or updated.
This documentation is automatically updated every 15 minutes when extensions are added, removed, or updated.


* '''Current Version:''' 1.2.0
* '''Current Version:''' 1.3.0
* '''Last Updated:''' 2026-01-29 17:01:10 UTC
* '''Last Updated:''' 2026-01-29 17:02:01 UTC
* [[Wiki:Operations_Manual/Changelog|View Full Changelog]]
* [[Wiki:Operations_Manual/Changelog|View Full Changelog]]


Revision as of 17:02, 29 January 2026

Overview

This Operations Manual documents all features, extensions, and APIs available on the Doc Moates Wiki (MediaWiki 1.42.4).

Documentation Version: 1.3.0
Last Updated: 2026-01-29 17:02:01 UTC
Total Extensions: 36 | API Modules: 86

Core MediaWiki Features

Page Management

Page Creation & Editing
Create and edit wiki pages using wikitext markup or the VisualEditor. Supports revision history, page protection, and content namespaces.
Categories
Organize pages into hierarchical categories. Pages can belong to multiple categories for flexible organization.
Namespaces
Separate content into distinct areas (Main, User, Talk, Wiki, Blog). Custom namespaces include Wiki (NS 3002) and Blog (NS 3000).
Redirects
Create automatic redirects from old page titles to new ones. Useful for maintaining link integrity after page moves.
Page Protection
Restrict editing or moving pages to specific user groups. Prevents vandalism on important pages.

User Management

User Accounts
Registration system with email verification. Users have personal pages, preferences, and contribution tracking.
User Groups & Permissions
Role-based access control with groups like administrator, bureaucrat, and autoconfirmed users.
Watchlist
Track changes to specific pages. Users receive notifications when watched pages are modified.
User Preferences
Customize appearance, editing behavior, notifications, and social profile settings.

Content Features

File Uploads
Upload images, PDFs, and other media files. Maximum upload size: 100MB. Supports ImageMagick for thumbnails.
InstantCommons
Automatically use images from Wikimedia Commons without local upload.
Search
Full-text search across all wiki content with advanced query options.
Recent Changes
View all recent edits across the wiki with filtering by namespace, user, and time period.

Communication

Talk Pages
Discussion pages attached to every content page for collaborative editing discussions.
Email Integration
User-to-user email and notification emails for watchlist changes and account actions.

Installed Extensions

Anti-Spam & Security

Extension Version Description
Abuse Filter N/A Applies automatic heuristics to edits
SpamBlacklist N/A Regex-based anti-spam tool allowing to block list URLs in pages and email addresses for registered users
TitleBlacklist 1.5.0 Allows administrators to forbid creation of pages and user accounts according to a list of disallowed and allowed titles

Parser & Content

Extension Version Description
CategoryTree N/A Dynamically navigate the category structure
Cite N/A Adds <ref> and <references> tags for citations
InputBox 0.3.0 Allow inclusion of predefined HTML forms
Math N/A Render mathematical formulas between <math> ... </math> tags
Poem N/A Adds <poem> tag for poem formatting
Scribunto N/A Framework for embedding scripting languages into MediaWiki pages
TemplateData 0.1.2 Implements data storage for template parameters (using JSON)
WikiBoxes 1.0.0 Easy creation of navboxes and infoboxes

Editors

Extension Version Description
VisualEditor N/A Visual editor for MediaWiki
WikiEditor 0.5.4 Provides an advanced, extensible wikitext editing interface

Special Pages & Administration

Extension Version Description
AIChat 2.3.0 AI-powered chat assistant for the wiki
Admin Links 0.7.1 Adds a special page that holds helpful links for administrators
CiteThisPage N/A Adds a citation special page and toolbox link
Echo N/A System for notifying users about events and messages
GroupMe 1.0.0 GroupMe messaging integration with scheduled messages and modern features
Linter N/A Track lint errors from an external service and show them to users
Nuke N/A Gives administrators the ability to mass delete pages
UserImpersonate 1.0.0 Allows administrators to impersonate other users for troubleshooting

Media

Extension Version Description
PDF Handler N/A Handler for viewing PDF files in image mode

API Extensions

Extension Version Description
PageImages N/A Collects information about images used on page

Skins

Extension Version Description
MinervaNeue N/A A responsive mobile first skin
Vector 1.0.0 Provides 2 Vector skins:
  • 2011 - The Modern version of MonoBook with fresh look and many usability improvements.
  • 2022 - The Vector built as part of the WMF Desktop Improvements project.

Other

Extension Version Description
CustomRegistration 1.0.0 Custom registration fields: first name, last name, email, phone
DiscussionTools 0.0.0 Tools to enhance discussion pages.
Gadgets N/A Lets users select custom CSS and JavaScript gadgets in their preferences
LoginNotify 0.1 Notify users about suspicious logins from unfamiliar devices and/or IP addresses
MultimediaViewer N/A Expand thumbnails in a larger size in a fullscreen interface
OATHAuth 0.5.0 Provides authentication support using HMAC based one-time passwords
PageAnalytics 1.0.0 Track page views with user/IP logging
SecureLinkFixer N/A Rewrites URLs to HTTPS if domain always requires HTTPS
Thanks 1.2.0 Adds links for thanking users for edits, comments, etc.
UserBlog 1.0.0 Allows users to create and manage personal blog posts in their user space
UserVerification 1.0.0 User verification badges displayed site-wide

MediaWiki API Reference

The wiki provides a comprehensive REST-like API at https://docmoates.com/api.php.

Available API Modules (86 total)

Module Description
abusefiltercheckmatch

Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.

vars, rcid or logid is required however only one may be used.

.
abusefilterchecksyntax Check syntax of an AbuseFilter filter.
abusefilterevalexpression Evaluates an AbuseFilter expression.
abusefilterunblockautopromote Unblocks a user from receiving autopromotions due to an abusefilter consequence.
abuselogprivatedetails View private details of an AbuseLog entry.
acquiretempusername

Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the sam...

aichat ⧼apihelp-aichat-summary⧽

.

block Block a user.
categorytree Internal module for the CategoryTree extension.
changeauthenticationdata Change authentication data for the current user.
changecontentmodel Change the content model of a page.
checktoken Check the validity of a token from <a href="/Special:ApiHelp/query%2Btokens" title="Special:ApiHelp/query+tokens">action=query&meta=tokens</a>.
clearhasmsg Clears the hasmsg flag for the current user.
clientlogin

Log in to the wiki using the interactive flow.

The general procedure to use this module is:

  1. Fetch the fields available from <a href="/Special:ApiHelp/query%2Bauthmanag...
compare

Get the difference between two pages.

A revision number, a page title, a page ID, text, or a relative reference for both "from" and "to" must be passed.

.
createaccount

Create a new user account.

The general procedure to use this module is:

  1. Fetch the fields available from <a href="/Special:ApiHelp/query%2Bauthmanagerinfo" title="Speci...
cspreport Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
delete Delete a page.
discussiontoolscompare Get information about comment changes between two page revisions.
discussiontoolsedit Post a message on a discussion page.
discussiontoolsfindcomment Find a comment by its ID or name.
discussiontoolsgetsubscriptions Get the subscription statuses of given topics.
discussiontoolspageinfo Returns metadata required to initialize the discussion tools.
discussiontoolspreview Preview a message on a discussion page.
discussiontoolssubscribe Subscribe (or unsubscribe) to receive notifications about a topic.
echomarkread Mark notifications as read for the current user.
echomarkseen Mark notifications as seen for the current user.
echomute Mute or unmute notifications from certain users or pages.
edit Create and edit pages.
editcheckreferenceurl Check the status of a URL for use as a reference.
emailuser Email a user.
expandtemplates Expands all templates within wikitext.
feedcontributions Returns a user's contributions feed.
feedrecentchanges Returns a recent changes feed.
feedwatchlist Returns a watchlist feed.
filerevert Revert a file to an old version.
groupme ⧼apihelp-groupme-summary⧽

.

help Display help for the specified modules.
imagerotate Rotate one or more images.
import

Import a page from another wiki, or from an XML file.

Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending a file for the xml pa...

json Output data in JSON format.
jsonfm Output data in JSON format (pretty-print in HTML).
linkaccount

Link an account from a third-party provider to the current user.

The general procedure to use this module is:

  1. Fetch the fields available from <a href="/Special:ApiHelp...
login

Log in and get authentication cookies.

This action should only be used in combination with <a href="/Special:BotPasswords" title="Special:BotPasswords">Special:BotPasswords</a>; use for ...

logout Log out and clear session data.
managetags Perform management tasks relating to change tags.
mergehistory Merge page histories.
move Move a page.
none Output nothing.
oathvalidate Validate a two-factor authentication (OATH) token.
opensearch Search the wiki using the OpenSearch protocol.
options

Change preferences of the current user.

Only options which are registered in core or in one of installed extensions, or options with keys prefixed with userjs- (intended to ...

paraminfo Obtain information about API modules.
parse

Parses content and returns parser output.

See the various prop-modules of <a href="/Special:ApiHelp/query" title="Special:ApiHelp/query">action=query</a> to get information fr...

patrol Patrol a page or revision.
php Output data in serialized PHP format.
phpfm Output data in serialized PHP format (pretty-print in HTML).
protect Change the protection level of a page.
purge Purge the cache for the given titles.
query

Fetch data from and about MediaWiki.

All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.

.
rawfm Output data, including debugging elements, in JSON format (pretty-print in HTML).
removeauthenticationdata Remove authentication data for the current user.
resetpassword Send a password reset email to a user.
revisiondelete Delete and undelete revisions.
rollback

Undo the last edit to the page.

If the last user who edited the page made multiple edits in a row, they will all be rolled back.

.
rsd Export an RSD (Really Simple Discovery) schema.
scribunto-console Internal module for servicing XHR requests from the Scribunto console.
setnotificationtimestamp

Update the notification timestamp for watched pages.

This affects the highlighting of changed pages in the watchlist and history, and the sending of email when the "Email me when a page ...

setpagelanguage

Change the language of a page.

Changing the language of a page is not allowed on this wiki.

Enable <a href="https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:$wgPageLa...

spamblacklist Validate one or more URLs against the spam block list.
stashedit

Prepare an edit in shared cache.

This is intended to be used via AJAX from the edit form to improve the performance of the page save.

.
tag Add or remove change tags from individual revisions or log entries.
templatedata Fetch data stored by the TemplateData extension.
thank Send a thank-you notification to an editor.
titleblacklist Validate a page title, filename, or username against the TitleBlacklist.
unblock Unblock a user.
undelete

Undelete revisions of a deleted page.

A list of deleted revisions (including timestamps) can be retrieved through <a href="/Special:ApiHelp/query%2Bdeletedrevisions" title="Special:ApiHe...

unlinkaccount Remove a linked third-party account from the current user.
upload

Upload a file, or get the status of pending uploads.

Several methods are available:

  • Upload file contents directly, using the file parameter.
  • Upload the f...
userrights Change a user's group membership.
validatepassword

Validate a password against the wiki's password policies.

Validity is reported as Good if the password is acceptable, Change if the password may be used for log...

visualeditor Returns HTML5 for a page from the Parsoid service.
visualeditoredit Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
watch Add or remove pages from the current user's watchlist.
xml Output data in XML format.
xmlfm Output data in XML format (pretty-print in HTML).

API Authentication

All write operations require authentication:

  1. Obtain login token: action=query&meta=tokens&type=login
  2. Login with credentials: action=clientlogin with token
  3. Get CSRF token: action=query&meta=tokens&type=csrf
  4. Include token in edit/upload requests

Rate Limits

  • Anonymous: 10 requests/minute
  • Logged-in users: 60 requests/minute
  • Bots: 200 requests/minute (requires bot flag)

Custom Namespaces

ID Name Description
3000 Blog User blog posts and articles
3001 Blog_talk Discussion pages for blog posts
3002 Wiki Wiki operational documentation and guides
3003 Wiki_talk Discussion for Wiki namespace pages

Version History

This documentation is automatically updated every 15 minutes when extensions are added, removed, or updated.

See Also

Retrieved from "https://wiki.xmethod.net/index.php?title=Wiki:Operations_Manual&oldid=17"