wikidata-query-gui

#Wikibase Query Service GUI

This repository contains the GUI for the Wikidata Query Service.

Please see more details about the service in the User Manual.

#Download & setup

Clone git repo, go into created folder and then pull all dependencies via npm package manager.

$ git clone https://gerrit.wikimedia.org/r/wikidata/query/gui
$ cd gui
$ npm install

Alternative use npm install

npm install wikidata-query-gui

#Run tests

Run JSHint, JSCS and QUnit tests.

$ grunt test

#Build Create a build with bundled and minified files.

$ grunt build

#Deploy Creates a build and pushes it to the deployment branch via git review

$ grunt deploy

Please make sure you have defined a gitreview username:

git config --global --add gitreview.username "[username]"

#Components

Editor

A CodeMirror based SPARQL editor with code completion (ctrl+space) and tooltips (hover)

var editor = new wikibase.queryService.ui.editor.Editor();
editor.fromTextArea( $( '.editor' )[0] );

See examples/editor.html

Example dialog

A dialog that allows browsing of SPARQL examples

new wikibase.queryService.ui.QueryExampleDialog(  $element, querySamplesApi, callback, previewUrl );

See examples/dialog.html

SPARQL

var api = new wikibase.queryService.api.Sparql();
api.query( query ).done( function(){
	var json = JSON.parse( api.getResultAsJson() );

} );

See examples/sparql.html JSFiddle.net

Result Views

Views that allow rendering SPARQL results see documentation.

var api = new wikibase.queryService.api.Sparql();
api.query( query ).done(function() {
	var result = new wikibase.queryService.ui.resultBrowser.CoordinateResultBrowser();
	result.setResult( api.getResultRawData() );
	result.draw( element );
} );

See examples/result.html JSFiddle.net

Release Notes and npm package

Unfortunately there are no releases and the provided code and interfaces are not considered to be stable. Also the dist/ folder contains a build that may not reflect the current code on master branch.