Extension:HeadScripts

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
HeadScripts

Release status: beta

Implementation Parser extension
Author(s) Jean-Lou Dupont
Latest version 1.0.0
MediaWiki 1.11
License No license specified
Download SVN
See SVN ($Id: HeadScripts.doc.wikitext 658 2007-10-29 16:10:50Z jeanlou.dupont $)
Hooks used
SpecialVersionExtensionTypes

BeforePageDisplay

Translate the HeadScripts extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

Purpose[edit | edit source]

Provides adding scripts to the site's HEAD.

Features[edit | edit source]

  • Secure: only users allowed to access the namespace MediaWiki
  • Accessible through a wiki page in the MediaWiki namespace under the 'Registry' sub-namespace
    • MediaWiki:Registry/HeadScripts

Example[edit | edit source]

Here is an example of 'MediaWiki:Registry/HeadScripts' page:

        {| border=1
        {{#headscript:http://code.jquery.com/jquery-latest.min.js|jQuery}}
        |}

Dependancies[edit | edit source]



Installation[edit | edit source]

See the Mediawiki Extension table entry "download" above.[1]

LocalSettings.php[edit | edit source]

Extension:ExtensionManager: See footnote[2]

require_once "$IP/extensions/HeadScripts/HeadScripts.php";
  • Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.

PEAR[edit | edit source]

PEAR is a repository of PHP software code.

pear channel-discover mediawiki.googlecode.com/svn
  • Install extension through PEAR:
pear install mediawiki/HeadScripts
  • Add the following to LocalSettings.php[2][3]:
require 'MediaWiki/HeadScripts/HeadScripts.php';
  • Note that the required version of PEAR must be respected. Currently, the minimum version of PEAR usable with this channel is v1.6.2. Perform the following command to upgrade to the latest version of PEAR:
pear upgrade pear

Upgrades through PEAR[edit | edit source]

Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.

pear clear-cache

or use the force method:

pear upgrade --force mediawiki/HeadScripts

PEAR Web Frontend[edit | edit source]

For easier remote package management, PEAR Frontend WEB can be installed. Installation notes can be found here. An example of the WEB frontend is available here.

RSS feed[edit | edit source]

To keep up-to-date with this channel, use the following RSS feed__Rss2.jpg.

Notes[edit | edit source]

Other Extensions From the same author[edit | edit source]

Consult User Jldupont's page.


  1. The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
  2. 2.0 2.1 2.2 Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
    Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.
  3. Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

History[edit | edit source]

TODO[edit | edit source]