Extension:SharedHelpPages

MediaWiki extensions manual

SharedHelpPages Release status: stable
Description	Automatically fetches help pages from ShoutWiki Hub
Author(s)	Jack Phoenix Kunal Mehta
Latest version	0.7.1
MediaWiki	>= 1.35.0
License	The Unlicense
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review
Example	Any ShoutWiki-hosted wiki, e.g. Brickipedia
Parameters $wgSharedHelpPagesDevelopmentMode $wgSharedHelpPagesCacheExpiry $wgSharedHelpPagesAPIUrl $wgSharedHelpPagesTimeout $wgSharedHelpLanguages
Hooks used EditPage::showEditForm:initial BeforePageDisplay SkinTemplateNavigation::Universal TitleIsAlwaysKnown ArticleFromTitle LinksUpdateComplete PageSaveComplete ArticleDeleteComplete WikiPageFactory WantedPages::getQueryInfo
Quarterly downloads	2 (Ranked 138th)
Public wikis using	1,139 (Ranked 241st)
Translate the SharedHelpPages extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The SharedHelpPages extension automatically fetches help pages from ShoutWiki Hub and "pretends" that these pages exist locally on the wiki (when in reality they don't).

The extension was written for ShoutWiki by Jack Phoenix and it is based on an older version of Extension:HelpPages by Kunal Mehta.

Installation

• Download and move the extracted SharedHelpPages folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SharedHelpPages
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'SharedHelpPages' );
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters

• $wgSharedHelpPagesDevelopmentMode — boolean, defaults to false. Set to true to skip the page existence check. That check can be a bit of a problem when your local copy of the Hub DB is not 100% up to date (e.g. a page exists on Hub but not on your local copy of Hub's DB).
• $wgSharedHelpPagesCacheExpiry — cache expiration time. The default is 604800 which is a week (60 * 60 * 24 * 7).
• $wgSharedHelpPagesAPIUrl — fallback API URL for when the requested language code is non-English and it is not found in the $wgSharedHelpLanguages array, i.e. there is no shared help for that language (yet). Defaults to http://www.shoutwiki.com/w/api.php
• $wgSharedHelpPagesTimeout — timeout in seconds for the API request to fetch remote help content. Defaults to 10
• $wgSharedHelpLanguages — array of ISO 639 language codes in which the help pages are available. Defaults to [ "en", "fi", "fr", "nl" ] (English, Finnish, French, Dutch)