Extension:RDFIO

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
RDFIO

Release status:Extension status beta

DescriptionTemplate:Extension#description Extended RDF import and export capabilities in Semantic MediaWiki, including a fully PHP-based SPARQL Endpoint
Author(s)Template:Extension#username Samuel Lampa, Ali King, Denny Vrandečić
Latest versionTemplate:Extension#version v2.1.0 (2017-05-08)
MediaWikiTemplate:Extension#mediawiki Tested with 1.26.x
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GPL
Download

Translate the RDFIO extension if it is available at translatewiki.net

Check usage and version matrix.

Update 8 May, 2017: RDFIO 2.1.0 - Updated variable names[edit]

RDFIO 2.1.0 was just released, containing many stability improvements, but also one API change: Updated config variables names, to make them shorter, to follow code recommendations:

$rdfiogPropertiesToUseAsWikiTitle --> $rogTitleProperties
$rdfiogQueryByEquivURI            --> $rogQueryByEquivURI
$rdfiogOutputEquivURIs            --> $rogOutputEquivURIs
$rdfiogAllowRemoteEdit            --> $rogAllowRemoteEdit
$rdfiogBaseURIs                   --> $rogBaseURIs

So, if you have an existing RDFIO installation and do install the 2.1.0 version, you will need to change the variable names in LocalSettings.php.

Introduction[edit]

This extension extends the RDF import and export functionality in Semantic MediaWiki by providing import of arbitrary RDF triples (not only OWL ontologies, as was the case before) and a SPARQL endpoint that allows write operations.

Technically, RDFIO implements the PHP/MySQL based triple store and accompanying SPARQL Endpoint provided by the ARC2 library.

The RDF import stores the original URI of all imported RDF entities in the Equivalent URI property, which can later be used by the SPARQL endpoint, instead of SMW's internal URIs, which thus allows to expose the imported RDF data "in its original formats", with its original URIs. This allows to use SMW as a collaborative RDF editor, in workflows together with other semantic tools, from which it is then possible to "export, collaboratively edit, and import again", to/from SMW.

This extensions was developed as part of a GSoC 2010 project, and later further extended as part of a Extension:RDFIO/Template_matching_for_RDFIO FOSS OPW 2014 project.

Installation[edit]

Dependencies[edit]

Composer[edit]

  • See this page for installation instructions.

MediaWiki[edit]

  • See this page for installation instructions.

Semantic MediaWiki[edit]

  • See this page for installation instructions.
  • To show the "Semantic factbox" on all pages, make sure to include this in your LocalSettings.php file:
$smwgShowFactbox = SMW_FACTBOX_NONEMPTY;

Installation steps[edit]

Assuming you have followed the steps above to install the dependencies for RDFIO:

  • Install RDFIO by executing the following commands in a terminal:
cd <wiki_folder>
composer require rdfio/rdfio --update-no-dev

  • Add the following option to the end of LocalSettings.php:
$smwgOWLFullExport = true;

It allows user defined properties for property articles (which is needed by the RDF import)

  • Log in to your wiki as a super user
  • Browse to http://[your-domain]/wiki/Special:RDFIOAdmin
  • Click the "Setup" button to set up ARC2 database tables.
  • If you already have semantic annotations in your wiki, you need to go to the article "Special:SMWAdmin" in your wiki, and click "Start updating data", and let it complete, in order for the data to be available in the SPARQL endpoint.

Optional but recommended steps[edit]

  • Edit the MediaWiki:Sidebar page and add the following wiki snippet, as an extra menu (I use to place it before just the "* SEARCH" line), which will give you links to the main functionality with RDFIO from the main links in the left sidebar on the wiki:
* Semantic Tools
** Special:RDFIOAdmin|RDFIO Admin
** Special:RDFImport|RDF Import
** Special:SPARQLEndpoint|SPARQL Endpoint
** Special:SPARQLImport|SPARQL Import
  • Create the article "MediaWiki:Smw_uri_blacklist" and make sure it is empty (you might need to add some nonsense content like {{{}}}).

Test that it works[edit]

  • Now, try adding some semantic data to wiki pages, and then check the database (using phpMyAdmin e.g.) to see if you get some triples in the table named arc2store_triple.
  • Access the SPARQL endpoint at http://[url-to-your-wiki]/Special:SPARQLEndpoint
  • Access the RDF Import page at http://[url-to-your-wiki]/Special:RDFImport
  • Access the SPARQL Import page at http://[url-to-your-wiki]/Special:SPARQLImport

Additional configuration[edit]

These are some configuration options that you might want to adjust to your specific use case. That goes into your LocalSettings.php file. Find below a template with the default options, which you can start from, add to your LocalSettings.php file and modify to your liking:

# ---------------------------------------------------------------
#  RDFIO Configuration
# ---------------------------------------------------------------
# An associative array with base uris as keys and corresponding 
# prefixes as the items. Example:
# array( 
#       "http://example.org/someOntology#" => "ont1",
#       "http://example.org/anotherOntology#" => "ont2"
#      );
# $rogBaseURIs = array();
# ---------------------------------------------------------------
# Query by /Output Equivalent URIs SPARQL Endpoint 
# (overrides settings in HTML Form)
# 
# $rogQueryByEquivURI = false;
# $rogOutputEquivURIs = false;
#
# $rogTitleProperties = array(
#  'http://semantic-mediawiki.org/swivt/1.0#page',
#  'http://www.w3.org/2000/01/rdf-schema#label',
#  'http://purl.org/dc/elements/1.1/title',
#  'http://www.w3.org/2004/02/skos/core#preferredLabel',
#  'http://xmlns.com/foaf/0.1/name',
#  'http://www.nmrshiftdb.org/onto#spectrumId'
# );
# ---------------------------------------------------------------
# Allow edit operations via SPARQL from remote services
#
# $rogAllowRemoteEdit = false;
# ---------------------------------------------------------------

Dependencies[edit]

Basic Usage[edit]

User manual (under development)

Bugs, new feature request and contact information[edit]

Please use the issue tracker on GitHub for all issues, suggestions or general feedback!

Alternative triple store connectors / SPARQL Endpoints[edit]

One of the features of RDFIO is to connect Semantic MediaWiki with a triple store, and to provide a SPARQL Endpoint. There are (already) a few extensions that offer this feature. See this page for an overview of triple store connector features. (The idea behind RDFIO is mainly focusing on the RDF import functionality, and merge of some or all of the extensions is being discussed).

See also[edit]