mediawiki / semantic-scribunto
A Semantic Mediawiki extension to natively support the Scribunto extension
Fund package maintenance!
Open Collective
www.semantic-mediawiki.org/wiki/Sponsorship
Installs: 56 345
Dependents: 0
Suggesters: 0
Security: 0
Stars: 25
Watchers: 15
Forks: 16
Open Issues: 1
Type:mediawiki-extension
Requires
- php: >=7.3
- composer/installers: ^2|^1.0.1
- mediawiki/semantic-media-wiki: ~4.0
Requires (Dev)
- mediawiki/semantic-media-wiki: @dev
- phpmd/phpmd: ~2.1
- squizlabs/php_codesniffer: ~3.10
This package is auto-updated.
Last update: 2024-12-19 09:14:22 UTC
README
Semantic Scribunto (a.k.a. SSC) is a Semantic Mediawiki extension to provide native support for the Scribunto extension.
Requirements
- PHP 7.3 or later
- MediaWiki 1.39 or later
- Semantic MediaWiki 4.0.2 or later
Installation
The recommended way to install Semantic Scribunto is using Composer with MediaWiki's built-in support for Composer.
Note that the required extensions Semantic MediaWiki and Scribunto must be installed first according to the installation instructions provided.
Step 1
Change to the base directory of your MediaWiki installation. If you do not have a "composer.local.json" file yet, create one and add the following content to it:
{ "require": { "mediawiki/semantic-scribunto": "~2.3" } }
If you already have a "composer.local.json" file add the following line to the end of the "require" section in your file:
"mediawiki/semantic-scribunto": "~2.3"
Remember to add a comma to the end of the preceding line in this section.
Step 2
Run the following command in your shell:
php composer.phar update --no-dev
Note if you have Git installed on your system add the --prefer-source
flag to the above command.
Step 3
Add the following line to the end of your "LocalSettings.php" file:
wfLoadExtension( 'SemanticScribunto' );
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.
- File an issue
- Submit a pull request
- Ask a question on the mailing list
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 testscomposer integration
to run all integration tests (which requires an active MediaWiki, DB connection)