mediawiki/semantic-scribunto

A Semantic Mediawiki extension to natively support the Scribunto extension

2.0.0 2018-10-05 05:57 UTC

README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Packagist download count

Semantic Scribunto (a.k.a. SSC) is a Semantic Mediawiki extension to provide native support for the Scribunto extension.

Requirements

Installation

The recommended way to install Semantic Scribunto is by using Composer.

  1. Installing the sources via composer can be done in one of two ways:
    • Either execute from your MediaWiki installation directory: composer require mediawiki/semantic-scribunto:~2.0
    • (recommended) Or add an entry to MediaWiki's "composer.json" or preferably "composer.local.json" file. Afterwards run composer update --no-dev.
{
	"require": {
		"mediawiki/semantic-scribunto": "~2.0"
	}
}
  1. Edit your LocalSettings.php and add the line
   wfLoadExtension( 'SemanticScribunto' );
  1. Navigate to Special:Version on your wiki and verify that the extension has been successfully installed.

Usage

A description of the mw.smw library functions can be found here.

Contribution and support

If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guideline.

Tests

This extension provides unit and integration tests that are run by a continues integration platform but can also be executed using the composer phpunit command from the extension base directory that will run all tests. In order to run only a specific test suit, the following commands are provided for convenience:

  • composer unit to run all unit tests
  • composer integration to run all integration tests (which requires an active MediaWiki, DB connection)

License

GNU General Public License, version 2 or later.