Help:Exhibit format

From semantic-mediawiki.org
Jump to: navigation, search


This page contains outdated information and is thus OBSOLETE!
This documentation page applies to all SMW versions from 1.4.0 to 1.7.1.
      Other languages: dezh-hans

Help:Exhibit format en 1.4.0 1.7.1


Exhibit format
Displays query results in interactive charts, tables and maps
Further Information
Provided by: Semantic Result Formats
Added: 1.4.0
Removed: 1.7.1
Requirements: none
Format name: exhibit
Enabled by default: 
Indicates whether the result format is enabled by default upon installation of the respective extension.
no
Authors: Fabian Howahl
Categories: misc
Group:
Table of Contents

↓ INFO ↓

The result format exhibit is used to display query results in interactive charts, tables and maps, which can be filtered down after page load.

NoteNote: This format was superseded by the result format filtered available starting with SMW 1.8.0. However not all views formerly supported by this format are supported by the new format.
NoteNote: This result format might not work properly with MediaWiki 1.17 and later.

Parameters

Like other result printers (e.g. Timeline), the result printer needs more information to set up a visualization. Basically, three parameters supply Exhibit with the required information:

  • 'views' - Right now, the views tiles, tabular, timeline and maps can be selected here. In case one would like to have more than one view, multiple values can be limited by a comma. After Exhibit has rendered the views, one can switch between them by using a panel.
  • 'facets' - Exhibit offers faceted browsing. Property values that occur more often can be grouped. The user is able to select the values she would like to see by checking them. Query results that do not hold the selected values will vanish then. In order to let Exhibit know which Property should be subject to a facet, the property's name has to be passed through the 'facets' parameter of the query. Multiple properties are possible as well (comma is the preferred limiter).
  • 'lens' - Exhibit enables the user to influence the appearance of the visualization to a certain extent. One can provide HTML or wikitext snippets that Exhibit uses to render a single query result. These snippets are lodged in MediaWiki's template system. The value of the 'lens' parameter refers to a template that has to be created before.
In the event you want to enable remote querying, please add the following snippet to the configuration file:
$srfgExhibitRemote=true;

Known bugs

"Item" Bug:

Please don't use the following property names when you want to use exhibit:

  • type
  • id
  • columns
  • hideTable
  • label
  • pluralLabel

Due to a bug, exhibit doesn't work with these property names.

IE 6/7 JavaScript errors

In some cases (depending on versions of SRF and the amount of javasript in the skin you use) there can be JavaScript errors in Internet Explorers 6 and 7. So test carefully if the users of your wikis work with these browsers.

You are strongly advised to upgrade to a newer version of the Internet Explorer, e.g. IE 9

Enabling

This result format is not enabled by default on a wiki. To enable it the line
$srfgFormats[] = 'exhibit';
must be added to the file LocalSettings.php below the inclusion of the Semantic Result Formats extension.