Wiki:Operations Manual: Difference between revisions

From XMethod Wiki
Jump to navigation Jump to search
Added PDF download link
Auto-update: Documentation refreshed
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Notice|This manual is also available as a [https://docmoates.com/images/Operations_Manual.pdf downloadable PDF].}}
{{Notice|[https://docmoates.com/images/Operations_Manual.pdf Download PDF] {{·}} [[Wiki:Operations_Manual/Changelog|Changelog]]}}


== Overview ==
== Overview ==
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).


'''Last Updated:''' January 29, 2026
'''Documentation Version:''' 1.16.0<br>
'''Last Updated:''' 2026-02-04 18:00:10 UTC<br>
'''Total Extensions:''' 45 | '''API Modules:''' 0


== Core MediaWiki Features ==
== Core MediaWiki Features ==
Line 63: Line 65:
{| class="wikitable" style="width:100%"
{| class="wikitable" style="width:100%"
|-
|-
! Extension !! Description
! Extension !! Version !! Description
|-
| '''AbuseFilter''' || Creates automated rules to detect and prevent abusive edits, spam, and vandalism. Administrators can define custom filters with conditions and actions.
|-
| '''SpamBlacklist''' || Maintains a list of URLs that cannot be added to pages. Prevents link spam by blocking known spam domains.
|-
|-
| '''TitleBlacklist''' || Prevents creation of pages with blacklisted titles. Blocks common spam page names and inappropriate titles.
| '''Abuse Filter''' || N/A || Applies automatic heuristics to edits
|-
|-
| '''LoginNotify''' || Notifies users of login attempts from new devices or locations. Enhances account security by alerting suspicious activity.
| '''SpamBlacklist''' || N/A || Regex-based anti-spam tool allowing to block list URLs in pages and email addresses for registered users
|-
|-
| '''OATHAuth''' || Two-factor authentication using TOTP (Time-based One-Time Passwords). Compatible with Google Authenticator and similar apps.
| '''TitleBlacklist''' || 1.5.0 || Allows administrators to forbid creation of pages and user accounts according to a [[MediaWiki:Titleblacklist{{!}}list of disallowed]] and [[MediaWiki:Titlewhitelist{{!}}allowed]] titles
|-
| '''SecureLinkFixer''' || Automatically upgrades HTTP links to HTTPS when the target site supports it. Improves security of external links.
|}
|}


=== Editing & Content ===
=== Parser & Content ===


{| class="wikitable" style="width:100%"
{| class="wikitable" style="width:100%"
|-
|-
! Extension !! Description
! Extension !! Version !! Description
|-
|-
| '''VisualEditor''' || WYSIWYG editor for intuitive page editing without knowing wikitext. Includes formatting toolbar, link insertion, and media embedding.
| '''CategoryTree''' || N/A || Dynamically navigate the [[Special:CategoryTree{{!}}category structure]]
|-
|-
| '''WikiEditor''' || Enhanced wikitext editor with toolbar, search/replace, and syntax highlighting. Preferred by experienced editors.
| '''Cite''' || N/A || Adds <code>&lt;ref&gt;</code> and <code>&lt;references&gt;</code> tags for citations
|-
|-
| '''DiscussionTools''' || Modern reply and discussion interface for talk pages. Adds reply buttons, topic subscriptions, and signature insertion.
| '''InputBox''' || 0.3.0 || Allow inclusion of predefined HTML forms
|-
|-
| '''Cite''' || Citation and reference management system. Creates numbered footnotes with <nowiki><ref></nowiki> tags and generates reference lists.
| '''Math''' || N/A || Render mathematical formulas between <code>&lt;math&gt;</code> ... <code>&lt;/math&gt;</code> tags
|-
|-
| '''CiteThisPage''' || Generates properly formatted citations for any wiki page in multiple academic styles (APA, MLA, Chicago).
| '''PDFEmbed''' || 3.0.1 || Media handler extension for PDF files.
|-
|-
| '''TemplateData''' || Defines structured data for templates, enabling VisualEditor to show user-friendly template insertion dialogs.
| '''ParserFunctions''' || 1.6.1 || Enhance parser with logical functions
|-
|-
| '''Math''' || Renders mathematical formulas using LaTeX syntax. Displays equations inline or as display blocks.
| '''Poem''' || N/A || Adds <code>&lt;poem&gt;</code> tag for poem formatting
|-
|-
| '''Poem''' || Preserves line breaks and formatting for poetry. Wraps content in <nowiki><poem></nowiki> tags.
| '''Scribunto''' || N/A || Framework for embedding scripting languages into MediaWiki pages
|-
|-
| '''Scribunto''' || Enables Lua scripting for advanced templates. Powers complex template logic and data manipulation.
| '''TemplateData''' || 0.1.2 || Implements data storage for template parameters (using JSON)
|-
|-
| '''InputBox''' || Creates input forms for page creation, search, and other actions. Used for user-friendly page creation workflows.
| '''TemplateStyles''' || 1.0 || Implement per-template style sheets
|-
|-
| '''WikiBoxes''' || Easy creation of navboxes and infoboxes without complex template syntax. Simplifies structured content boxes. ''(Custom)''
| '''Widgets''' || 1.7.0 || Allows wiki administrators to add free-form widgets to the wiki by editing pages within the {{ns:widget}} namespace.
Community-contributed widgets can be found on [http://www.mediawikiwidgets.org/Main_Page MediaWikiWidgets.org]
|-
| '''WikiBoxes''' || 1.0.0 || Easy creation of navboxes and infoboxes
|-
| '''WikiSignup''' || 1.0.0 || Adds a signup form shortcode that can be embedded in wiki articles
|}
|}


=== Media & Display ===
=== Editors ===


{| class="wikitable" style="width:100%"
{| class="wikitable" style="width:100%"
|-
|-
! Extension !! Description
! Extension !! Version !! Description
|-
| '''MultimediaViewer''' || Lightbox-style image viewer with zoom, pan, and slideshow. Click any image to view in expanded overlay.
|-
| '''PageImages''' || Automatically selects representative images for pages. Used by search results and page previews.
|-
|-
| '''PDF Handler''' || Enables viewing and thumbnailing of PDF files. Generates preview images for uploaded PDFs.
| '''VisualEditor''' || N/A || Visual editor for MediaWiki
|-
|-
| '''CategoryTree''' || Dynamic, expandable category browser. Navigate category hierarchies without loading new pages.
| '''WikiEditor''' || 0.5.4 || Provides an advanced, extensible wikitext editing interface
|}
|}


=== Navigation & Organization ===
=== Special Pages & Administration ===


{| class="wikitable" style="width:100%"
{| class="wikitable" style="width:100%"
|-
|-
! Extension !! Description
! Extension !! Version !! Description
|-
| '''AIChat''' || 2.4.2 || AI-powered chat assistant for the wiki
|-
| '''CiteThisPage''' || N/A || Adds a [[Special:CiteThisPage{{!}}citation]] special page and toolbox link
|-
| '''Echo''' || N/A || System for notifying users about events and messages
|-
|-
| '''Gadgets''' || Allows creation of user-selectable JavaScript/CSS gadgets. Enables optional features users can enable in preferences.
| '''GroupMe''' || 1.0.0 || GroupMe messaging integration with scheduled messages and modern features
|-
|-
| '''Linter''' || Identifies wikitext syntax errors and deprecated markup. Helps maintain clean, standards-compliant content.
| '''Linter''' || N/A || Track lint errors from an external service and show them to users
|}
 
=== Notifications & Social ===
 
{| class="wikitable" style="width:100%"
|-
|-
! Extension !! Description
| '''NewsletterManager''' || 1.0.0 || Substack-like newsletter system for MediaWiki
|-
|-
| '''Echo''' || Notification system for mentions, talk page messages, and other events. Displays alerts in header and via email.
| '''Nuke''' || N/A || Gives administrators the ability to [[Special:Nuke{{!}}mass delete]] pages
|-
|-
| '''Thanks''' || Send thank-you notifications to other users for their contributions. Encourages positive community interaction.
| '''UserImpersonate''' || 1.0.0 || Allows administrators to impersonate other users for troubleshooting
|}
|}


=== Administration ===
=== Media ===


{| class="wikitable" style="width:100%"
{| class="wikitable" style="width:100%"
|-
|-
! Extension !! Description
! Extension !! Version !! Description
|-
|-
| '''Admin Links''' || Centralized page listing all administrative special pages. Quick access to user management, logs, and settings.
| '''PDF Handler''' || N/A || Handler for viewing PDF files in image mode
|-
| '''Nuke''' || Mass deletion tool for administrators. Delete multiple pages by a specific user or matching patterns.
|}
|}


=== Custom Extensions ===
=== API Extensions ===


{| class="wikitable" style="width:100%"
{| class="wikitable" style="width:100%"
Line 161: Line 157:
! Extension !! Version !! Description
! Extension !! Version !! Description
|-
|-
| '''AIChat''' || 2.3.0 || AI-powered chat assistant integrated into the wiki. Access via Special:AIChat for conversational help with wiki content.
| '''PageImages''' || N/A || Collects information about images used on page
|-
| '''GroupMe''' || 1.0.0 || Social group management and communication features. Create and manage user groups with shared spaces.
|-
| '''CustomRegistration''' || 1.0.0 || Extended registration fields including first name, last name, email, and phone. Enhanced user onboarding.
|-
| '''PageAnalytics''' || 1.0.0 || Track page views with user and IP logging. View statistics for content performance analysis.
|-
| '''UserVerification''' || 1.0.0 || User verification badge system displayed site-wide. Distinguishes verified accounts from standard users.
|-
| '''UserBlog''' || 1.0.0 || Personal blogging system in the Blog namespace. Users can publish articles with author profiles.
|-
| '''UserImpersonate''' || 1.0.0 || Allows administrators to impersonate other users for troubleshooting. Debug permission and display issues.
|-
| '''SocialCard''' || 1.0.0 || Generates social media preview cards for wiki pages. Improves link sharing on Twitter, Facebook, etc.
|-
| '''SocialPageBuilder''' || 1.0.0 || Tools for building social profile pages with structured layouts. Creates consistent user profile presentations.
|}
|}


== Installed Skins ==
=== Skins ===


{| class="wikitable" style="width:100%"
{| class="wikitable" style="width:100%"
|-
|-
! Skin !! Description
! Extension !! Version !! Description
|-
|-
| '''Vector''' (Default) || The modern MediaWiki skin with clean typography, collapsible sidebar, and responsive design. Used by Wikipedia.
| '''MinervaNeue''' || N/A || A responsive mobile first skin
|-
|-
| '''MinervaNeue''' || Mobile-optimized skin for smartphone and tablet browsing. Simplified navigation and touch-friendly interface.
| '''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 [[mw:Desktop Improvements{{!}}Desktop Improvements]] project.
|}
|}


== MediaWiki API Reference ==
=== Other ===
 
The wiki provides a comprehensive REST-like API at <code>https://docmoates.com/api.php</code>.
 
=== Query APIs ===


{| class="wikitable" style="width:100%"
{| class="wikitable" style="width:100%"
|-
|-
! Module !! Endpoint !! Description
! Extension !! Version !! Description
|-
| '''ArticleDownloader''' || 1.0.0 || Allows users to download article content as HTML or PDF
|-
| '''CustomRegistration''' || 1.0.0 || Custom registration fields: first name, last name, email, phone
|-
|-
| '''Page Content''' || <code>action=query&titles=PageName&prop=revisions&rvprop=content</code> || Retrieve the wikitext content of any page. Supports multiple pages and revision history.
| '''DiscussionTools''' || 0.0.0 || Tools to enhance discussion pages.
|-
|-
| '''Page Info''' || <code>action=query&titles=PageName&prop=info</code> || Get metadata including page ID, namespace, protection status, and last edit timestamp.
| '''Gadgets''' || N/A || Lets users select custom [[Special:Gadgets{{!}}CSS and JavaScript gadgets]] in their [[Special:Preferences#mw-prefsection-gadgets{{!}}preferences]]
|-
|-
| '''Categories''' || <code>action=query&titles=PageName&prop=categories</code> || List all categories a page belongs to. Supports category tree traversal.
| '''GoogleWorkspace''' || 1.0.0 || Integrates Google Workspace (Drive, Docs, Sheets, Slides, Forms, Calendar, Gmail, Photos, Keep, Tasks, Meet, Vids, Gemini, NotebookLM) with MediaWiki
|-
|-
| '''Search''' || <code>action=query&list=search&srsearch=term</code> || Full-text search across wiki content. Returns titles, snippets, and match counts.
| '''LoginNotify''' || 0.1 || Notify users about suspicious logins from unfamiliar devices and/or IP addresses
|-
|-
| '''Recent Changes''' || <code>action=query&list=recentchanges</code> || Stream of recent edits with user, timestamp, and change details.
| '''MultimediaViewer''' || N/A || Expand thumbnails in a larger size in a fullscreen interface
|-
|-
| '''User Info''' || <code>action=query&list=users&ususers=Username&usprop=groups|editcount</code> || Get user details including groups, edit count, and registration date.
| '''OATHAuth''' || 0.5.0 || Provides authentication support using HMAC based one-time passwords
|-
|-
| '''Site Info''' || <code>action=query&meta=siteinfo</code> || Wiki configuration including namespaces, extensions, and statistics.
| '''PageAnalytics''' || 1.0.0 || Track page views with user/IP logging
|}
 
=== Action APIs ===
 
{| class="wikitable" style="width:100%"
|-
|-
! Module !! Endpoint !! Description
| '''SecureLinkFixer''' || N/A || Rewrites URLs to HTTPS if domain always requires HTTPS
|-
|-
| '''Edit Page''' || <code>action=edit&title=PageName&text=content&token=TOKEN</code> || Create or modify page content. Requires authentication and edit token.
| '''SocialFeed''' || 1.0.0 || Social feed functionality for wiki
|-
|-
| '''Upload File''' || <code>action=upload&filename=Name&file=DATA&token=TOKEN</code> || Upload media files to the wiki. Supports chunked uploads for large files.
| '''Thanks''' || 1.2.0 || Adds links for thanking users for edits, comments, etc.
|-
|-
| '''Login''' || <code>action=login&lgname=User&lgpassword=Pass&lgtoken=TOKEN</code> || Authenticate to obtain edit permissions. Returns session credentials.
| '''UserBlog''' || 1.0.0 || Allows users to create and manage personal blog posts in their user space
|-
|-
| '''Parse''' || <code>action=parse&text=wikitext</code> || Convert wikitext to HTML. Useful for preview and content transformation.
| '''UserVerification''' || 1.0.0 || User verification badges displayed site-wide
|-
|-
| '''Watch''' || <code>action=watch&titles=PageName&token=TOKEN</code> || Add pages to user watchlist. Supports bulk operations.
| '''WikiMail''' || 1.0.0 || Full-featured email client extension with Gmail, Outlook, and IMAP support
|}
|}


=== Extension APIs ===
== MediaWiki API Reference ==
 
The wiki provides a comprehensive REST-like API at <code>https://docmoates.com/api.php</code>.
 
=== Available API Modules (0 total) ===


{| class="wikitable" style="width:100%"
{| class="wikitable" style="width:100%"
|-
|-
! Extension !! API Module !! Description
! Module !! Description
|-
| '''Echo''' || <code>action=query&meta=notifications</code> || Retrieve user notifications. Filter by type, read status, and date range.
|-
| '''Thanks''' || <code>action=thank&rev=RevisionID</code> || Send thanks notification for a specific revision or log entry.
|-
| '''AbuseFilter''' || <code>action=abusefiltercheckmatch</code> || Test content against abuse filter rules. Useful for debugging filters.
|-
| '''VisualEditor''' || <code>action=visualeditor</code> || Get page content in Parsoid HTML format for VisualEditor editing.
|-
| '''PageImages''' || <code>action=query&prop=pageimages</code> || Get representative thumbnail images for pages.
|}
|}


Line 255: Line 226:


# Obtain login token: <code>action=query&meta=tokens&type=login</code>
# Obtain login token: <code>action=query&meta=tokens&type=login</code>
# Login with credentials: <code>action=login</code> with token
# Login with credentials: <code>action=clientlogin</code> with token
# Get CSRF token: <code>action=query&meta=tokens&type=csrf</code>
# Get CSRF token: <code>action=query&meta=tokens&type=csrf</code>
# Include token in edit/upload requests
# Include token in edit/upload requests
Line 280: Line 251:
|}
|}


== Social Features ==
== Version History ==
 
The wiki includes comprehensive social profile features:
 
=== Author Information ===
* First name, last name, display name
* Author title (e.g., "Executive Director")
* Bio/description
* Avatar image


=== Social Media Links ===
This documentation is automatically updated every 15 minutes when extensions are added, removed, or updated.
Supported platforms:
* X (Twitter)
* Facebook
* Instagram
* LinkedIn
* YouTube
* TikTok
* Reddit
* Threads
* Personal website


=== Social Tab ===
* '''Current Version:''' 1.16.0
User pages include a "Social" tab linking to the user's social profile page.
* '''Last Updated:''' 2026-02-04 18:00:10 UTC
* [[Wiki:Operations_Manual/Changelog|View Full Changelog]]


== See Also ==
== See Also ==
Line 310: Line 264:
* [[Special:AIChat]] - AI Chat assistant
* [[Special:AIChat]] - AI Chat assistant
* [[Special:SpecialPages]] - All special pages
* [[Special:SpecialPages]] - All special pages
* [https://docmoates.com/api.php API Sandbox] - Interactive API testing


[[Category:Wiki Operations]]
[[Category:Wiki Operations]]
[[Category:Documentation]]
[[Category:Documentation]]

Latest revision as of 18:00, 4 February 2026

Overview

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

Documentation Version: 1.16.0
Last Updated: 2026-02-04 18:00:10 UTC
Total Extensions: 45 | API Modules: 0

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
PDFEmbed 3.0.1 Media handler extension for PDF files.
ParserFunctions 1.6.1 Enhance parser with logical functions
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)
TemplateStyles 1.0 Implement per-template style sheets
Widgets 1.7.0 Allows wiki administrators to add free-form widgets to the wiki by editing pages within the Widget namespace.

Community-contributed widgets can be found on MediaWikiWidgets.org

WikiBoxes 1.0.0 Easy creation of navboxes and infoboxes
WikiSignup 1.0.0 Adds a signup form shortcode that can be embedded in wiki articles

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.4.2 AI-powered chat assistant for the wiki
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
NewsletterManager 1.0.0 Substack-like newsletter system for MediaWiki
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
ArticleDownloader 1.0.0 Allows users to download article content as HTML or PDF
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
GoogleWorkspace 1.0.0 Integrates Google Workspace (Drive, Docs, Sheets, Slides, Forms, Calendar, Gmail, Photos, Keep, Tasks, Meet, Vids, Gemini, NotebookLM) with MediaWiki
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
SocialFeed 1.0.0 Social feed functionality for wiki
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
WikiMail 1.0.0 Full-featured email client extension with Gmail, Outlook, and IMAP support

MediaWiki API Reference

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

Available API Modules (0 total)

Module Description

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