Extension:Semantic Result Formats
From MediaWiki.org
 Release status: beta |
|||
|---|---|---|---|
 |
|||
| Description | Adds further formats to render inline query results. | ||
| Author(s) | Frank Dengler, Steren Giannini, Fabian Howahl, Yaron Koren, Markus Krötzsch, David Loomer, Joel Natividad, Denny Vrandecic, Nathan Yergler | ||
| Last Version | 1.4.5 (2009-06-03) | ||
| MediaWiki | 1.11.0 or greater (tested up to 1.14alpha) | ||
| License | GPLv2 | ||
| Download | Download snapshot |
||
| Example | North America page on semanticweb.org | ||
|
|||
|
check usage (experimental) |
|||
Semantic Result Formats is a MediaWiki extension, used in conjunction with the Semantic MediaWiki extension, that bundles a number of further result formats for SMW's inline queries. The individual formats can be added to the installation independently.
Contents |
[edit] Formats
Semantic Result Formats defines the following formats, listed here by type:
[edit] Graphing
- graph - uses the GraphViz extension to graph connections between pages
- googlebar - displays a bar chart of number values, using the Google Charts API
- googlepie - displays a pie chart of number values, using the Google Charts API
- ploticus - uses the open-source ploticus graphing library (currently disabled due to a security leak)
- process - uses the GraphViz extension to display process graphs
[edit] Time-based
- timeline - displays pages in a scrollable timeline, using the SIMILE Timeline Javascript library
- eventline - similar to 'timeline', but shows each page as an individual point, instead of sometimes showing date ranges as 'timeline' does
- calendar - displays pages in a monthly calendar
[edit] Math
Each of the mathematical formats simply display a number, and take no additional parameters. It is important to ensure that the number of pages queried is not less than the complete set, for accurate results; you can set the "limit=" parameter to a high number to try to guarantee this.
- average - displays the average of a queried set of numbers
- sum - displays the sum of a queried set of numbers
- min - displays the lowest of a queried set of numbers
- max - displays the highest of a queried set of numbers
[edit] Export
- bibtex - exports bibliographic data in the BibTeX format
- icalendar - exports calendar data in the iCalendar format
- vcard - exports business-card data in the vCard format
[edit] Other
- exhibit - displays a dynamic browsing interface for queried pages using the SIMILE Exhibit application
- outline - lists pages in a hierarchical outline, based on property values
[edit] Version
Semantic Result Formats is at version 1.4.5, released on June 3, 2009. You can see the version history here.
[edit] Download
Semantic Result Formats can be obtained in four ways:
- download via the MediaWiki Extensions downloader: choose SemanticResultFormats
- download from SourceForge
- download as part of the Semantic Bundle extension set
- directly from SVN using the following command inside your extensions folder:
svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/SemanticResultFormats/
[edit] Installation
In order to include the default available result formats, simply add the following line to your LocalSettings.php:
require_once("$IP/extensions/SemanticResultFormats/SRF_Settings.php");
If nothing else is added, the following formats will be enabled: 'timeline', 'eventline', 'calendar', 'average', 'sum', 'min' 'max', 'bibtex', 'icalendar', 'vcard' and 'outline'. To add more formats to this list, you can add lines like:
$srfgFormats[] = 'googlebar';
...or you can override the set of formats entirely, with a call like:
$srfgFormats = array('calendar', 'timeline', 'exhibit');
... using one or more of the following values: average, bibtex, calendar, eventline, exhibit, googlebar, googlepie, graph, icalendar, max, min, outline, sum, timeline, vcard.
There are some formats that you may not want to include because they may not follow certain policies within your wiki; the formats 'googlebar' and 'googlepie', for instance, send data to external web services for rendering, which may be considered a data leak.
In the event you want to use features that are taking advantage of Google Maps (such as the map view created by the Exhibit result printer), please assign a valid Google Maps key to the $wgGoogleMapsKey variable in LocalSettings.php. Otherwise, these features will not be available.
$wgGoogleMapsKey='Please obtain a Google Maps key for your website at http://code.google.com/intl/en-en/apis/maps/signup.html '
[edit] Mailing list
You should use the Semantic MediaWiki mailing list, semediawiki-user, for any questions, suggestions or bug reports about Semantic Result Formats. If possible, please add "[SRF]" at the beginning of the subject line, to clarify the subject matter.
