mediawiki/semantic-external-query-lookup

A Semantic Mediawiki extension to seamlessly integrate query results from an external query source.

dev-master / 1.x-dev 2017-08-17 13:43 UTC

README

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

Semantic External Query Lookup (a.k.a. SEQL) is a Semantic Mediawiki extension to seamlessly integrate query results from an external query source to a local repository or wiki.

The following video demonstrates the features of this extension.

Requirements

Installation

The recommended way to install Semantic External Query Lookup is by using Composer with:

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

Usage

image

{{#ask:[[Modification date::+]][[~CR*]]
 |?#-
 |?Modification date
 |format=broadtable
 |source=mw-core
 |link=all
 |headers=show
}}

The #ask/#show query only requires to add a source parameter (assuming that a query source has been registered and enabled) to retrieve query results from a selected external endpoint. Special:Ask will provide a selection box to list enabled query sources.

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

License

GNU General Public License, version 2 or later.