Extension:Spark

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
Spark

Release status: beta

Spark-logo.png
Implementation Tag, Search, Extended syntax
Description Adds a <spark /> tag that enables embedding Spark mash-ups. The spark library was created by Denny Vrandecic and Andreas Harth.
Author(s) Jeroen De Dauw
Latest version 0.1 (2011-05-30)
MediaWiki 1.17.0 or higher
PHP 5.2 or above
License GNU GPL v3+
Download
Hooks used
ParserFirstCallInit

Translate the Spark extension if possible

Check usage and version matrix; code metrics

Spark is a JavaScript library that allows the simple integration of data from all over the Web in any HTML page, using a rich set of visualisations. This extension enabled embedding of spark mashups using <spark /> tags.

About[edit | edit source]

Spark is a JavaScript library that allows the simple integration of data from all over the Web in any HTML page, using a rich set of visualizations. This extension enabled embedding of spark mashups using <spark /> tags.

Spark as described on the Spark website:

The web is not only growing in sheer size, but it also grows in how much it is interconnected. Where once the Web was a set of more or less separated sites, today sites are more and more being connected. More and more data is being offered on the Web in a way that can be further processed, and more and more sites and applications are using external data. More and more mashups are created, where data from different sources is integrated and displayed with novel visualisations.

Spark is a library that enables HTML authors to create mashups more easily than ever before. Using standard Web technologies like SPARQL, RDF, HTML5, and JavaScript, Spark can query external knowledge sources (so called triple stores or SPARQL endpoints), and then visualise the results.

With Spark, website developers can create visually appealing mashups without having to write a single line of JavaScript, but merely using some markup elements describing the source of the data that is to be shown, a query to select the appropriate data, and selecting one from an expandable set of visualisations and their parameters.

This MediaWiki extension, unsurprisingly titled Spark, adds a <spark> tag to MediaWiki which is equivalent to <div class=”spark”> as described in the spark library documentation. All parameters (except the class=”spark” one) can just be copied over between spark divs in web pages, and the <spark> tag in MediaWiki.

Feature overview[edit | edit source]

  • Visualization of data obtained via SPARQL queries.
  • Support for all Spark visualizations.
  • Use of the native Spark syntax, which can be copied from native spark divs to the spark tag and back.

Requirements[edit | edit source]

Spark requires:

Download[edit | edit source]

You can download the extension directly from the MediaWiki source code repository (browse code). You can get:

One of the extensions tags

Not all extensions have tags. Some extensions have tags for each release, in which case those tags have the same stability as the release. To download a tag

  • Go to the tags list
  • Click the name of the tag you want to download
  • Click "snapshot"
The latest version of one of the extensions branches

Each extension has a master branch containing the latest code (might be unstable). Extensions can have further branches as well.

  • Go to the branches list
  • Click the branch name
  • Click "snapshot"
A snapshot made during the release of a MediaWiki version.

This might be unstable and is not guaranteed to work with the associated MediaWiki version.

After you've got the code, save it into the extensions/Spark directory of your wiki.

If you are familiar with git and have shell access to your server, you can obtain the extension, with all its tags and branches, as follows:

cd extensions
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/Spark.git

Installation[edit | edit source]

Once you have downloaded the code, place the Spark directory within your MediaWiki 'extensions' directory. Then add the following code to your LocalSettings.php file:

# Spark
require_once( "$IP/extensions/Spark/Spark.php" );

Configuration[edit | edit source]

Configuration of Spark is done by adding simple PHP statements to your LocalSettings.php file. These statements need to be placed AFTER the inclusion of Spark. The options are listed below and their default is set in the Spark settings file. You should NOT modify the settings file, but can have a look at it to get an idea of how to use the settings, in case the below descriptions do not suffice.

As of version 0.1, there are no settings yet.

Usage[edit | edit source]

Spark tag[edit | edit source]

Version[edit | edit source]

This is a copy of the release notes file on SVN, which might be more up to date then this page.

Version 0.2[edit | edit source]

2011-0x-xx

  • Added README, INSTALL, COPYTING and RELEASE-NOTES

Version 0.1[edit | edit source]

2011-05-30

Initial release with these features:

  • <spark> tag

Internationalization[edit | edit source]

Spark is fully internationalized. Translation of Spark messages is done through translatewiki.net. The translation for this extension can be found here. To add language values or change existing ones, you should create an account on translatewiki.net, then request permission from the administrators to translate a certain language or languages on this page (this is a very simple process). Once you have permission for a given language, you can log in and add or edit whatever messages you want to in that language.

Authors[edit | edit source]

Spark has been written by Jeroen De Dauw. It includes the Spark library created by Denny Vrandečić and Andreas Harth.

Screenshots[edit | edit source]

See also[edit | edit source]

  • Spark library - the JavaScript/jQuery library included in this extension to create mash-ups.
  • Spark on Ohloh - commit and comitter statistics
  • Semantic MediaWiki - extension that lets you store and query data within the wiki's pages and makes it available via the semantic web.