mediawiki/semantic-notifications

A Semantic Mediawiki extension that notifies about changes to structured data using the Echo(Notifications) extension.

dev-master / 1.x-dev 2017-07-31 14:54 UTC

README

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

Semantic Notifications (a.k.a. SNO) is a Semantic Mediawiki extension that can inform registered users about changes to their structured data with help of the Echo(Notifications) extension.

Support for notifications on:

  • Changes for selected properties and specific values
  • Changes for selected categories
  • Changes to the specification and declaration of a property, category or concept

Requirements

Installation

The recommended way to install Semantic Notifications is by using Composer with:

{
	"require": {
		"mediawiki/semantic-notifications": "~1.0"
	}
}
  1. From your MediaWiki installation directory, execute composer require mediawiki/semantic-notifications:~1.0
  2. Navigate to Special:Version on your wiki and verify that the package have been successfully installed.

Usage

image

Documentation

The workflow document contains a detailed description about the required settings and decisions a user has to make in order for him or her to receive notifications.

Additional tips and use cases can be found here while this document describes some technical details.

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 composer phpunit from the extension base directory.

License

GNU General Public License, version 2 or later.