Extension:UseResource

From mediawiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
UseResource
Release status: stable
Implementation Tag
Description Load JS and CSS in the MediaWiki namespace on a per-page basis.
Author(s) Brandon Fowler (BrandonXLFtalk)
Latest version 1.0.0
Compatibility policy Snapshots releases along with MediaWiki. Master is not backwards compatible.
MediaWiki 1.35+
PHP 7+
License GNU General Public License 2.0 or later
Download
<usescript src=...>...</usescript>
<usestyle src=...>...</usestyle>
Translate the UseResource extension if it is available at translatewiki.net

Check usage and version matrix.

Issues Open tasks · Report a bug

The UseResource extension adds the <usescript> and <usestyle> tags that allow JavaScript and CSS to be loaded from the MediaWiki namespace on a per-page baisis.

When used in a template, pages that use the template will load the JS/CSS, this allows for the loading of scripts and stylesheets only used on some pages to be only loaded on the pages they are used on rather than being loaded on all pages using MediaWiki:Common.js and MediaWiki:Common.css or Extension:Gadgets.

Scripts can only be loaded from the MediaWiki namespace to prevent malicious code from being run, if you desire a way for user to edit stylesheets that only affect the content area, see Extension:TemplateStyles.

Installation[edit]

  • Download and place the file(s) in a directory called UseResource in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'UseResource' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage[edit]

The extension is used by including <usescript src="..." /> or <usestyle src="..." /> tags on wiki pages to load the resource (script or stylesheet), replacing ... with the name of the resource.

Resources must be located in the MediaWiki namespace and can only be edited by uses with the editinterface userright as they are the only users allowed to edit pages in the MediaWiki namespace.

The value of the src attribute is the name of the resource to load. If not namespace is included, the MediaWiki namespace is assumed. For example, if you had a script located at MediaWiki:Test.js, you could load it using <usescript src="test.js" />. This will fail if the requested script does not exist, is not located in the MediaWiki namespace, or if it does not have the correct content model, JavaScript for scripts and CSS for stylesheets.

If the same resource is included on a single page multiple times, it is only run once.