| Index: trunk/extensions/SemanticResultFormats/INSTALL |
| — | — | @@ -2,6 +2,7 @@ |
| 3 | 3 | |
| 4 | 4 | Installation instructions are available online in a more convenient form for |
| 5 | 5 | reading at: |
| | 6 | + |
| 6 | 7 | http://semantic-mediawiki.org/wiki/Semantic_Result_Formats |
| 7 | 8 | |
| 8 | 9 | Copy all files into MediaWiki's extensions folder, either by using SVN or by |
| — | — | @@ -9,38 +10,35 @@ |
| 10 | 11 | settings (after the inclusion of Semantic MediaWiki). The first one is to |
| 11 | 12 | include the code: |
| 12 | 13 | |
| 13 | | - require_once( 'path/to/extension/SRF_Settings.php' ); |
| | 14 | + require_once("$IP/extensions/SemanticResultFormats/SRF_Settings.php"); |
| 14 | 15 | |
| 15 | | -If nothing else is added, no format will be included. In order to include a |
| 16 | | -format, add the following line to your local settings after the line above: |
| 17 | | - srfInit( array('formatname', 'formatname', ...) ); |
| | 16 | +If nothing else is added, the following formats will be enabled: 'calendar', |
| | 17 | +'timeline', 'eventline', 'sum', 'average', 'min' and 'max'. To add more |
| | 18 | +formats to this list, you can add lines like: |
| 18 | 19 | |
| 19 | | -with formatname being one of the following values (you can use as many |
| 20 | | -formatnames as you like): |
| | 20 | + $srfgFormats[] = 'googlebar'; |
| 21 | 21 | |
| 22 | | - calendar, eventline, googlebar, googlepie, graph, timeline |
| | 22 | +...or you can override the set of formats entirely, with a call like: |
| 23 | 23 | |
| 24 | | -So for example to enable graph, timeline and calendar you would write: |
| | 24 | + $srfgFormats = array('calendar', 'timeline'); |
| 25 | 25 | |
| 26 | | - srfInit( array('graph', 'timeline', 'calendar') ); |
| | 26 | +with formatname being one of the following values (you can use as many |
| | 27 | +formatnames as you like): |
| 27 | 28 | |
| 28 | | -You can also just use the following command to include all available formats: |
| | 29 | + average, calendar, eventline, googlebar, googlepie, graph, max, min, |
| | 30 | + sum, timeline |
| 29 | 31 | |
| 30 | | - srfInit('all'); |
| | 32 | +There are some formats that you may not want to include because they may |
| | 33 | +not follow certain policies within your wiki; the formats 'googlebar' and |
| | 34 | +'googlepie', for instance, send data to external web services for rendering, |
| | 35 | +which may be considered a data leak. |
| 31 | 36 | |
| 32 | | -but this is not recommended since it may expand your system with formats that |
| 33 | | -do not follow certain policies within the wiki without you making that explicit |
| 34 | | -decision (consider that result formats may send data to external web services |
| 35 | | -for rendering which may be considered a data leak. For example, googlebar and |
| 36 | | -googlepie do this). |
| 37 | | - |
| 38 | 37 | Notes on specific formats: |
| 39 | | -* Eventline: Eventline requires Javascript to render. |
| 40 | | -* Googlebar: note that Googlebar is sending data to Google for rendering. |
| | 38 | +* eventline: requires Javascript to render. |
| | 39 | +* googlebar: note that Googlebar sends data to Google for rendering. |
| 41 | 40 | Googlebar requires access to the Google servers in order to render. |
| 42 | | -* Googlepie: note that Googlepie is sending data to Google for rendering. |
| | 41 | +* googlepie: note that Googlepie is sends data to Google for rendering. |
| 43 | 42 | Googlepie requires access to the Google servers in order to render. |
| 44 | | -* Graph: in order to get the graph format to run you first have to have |
| 45 | | - the graph extension up and running. The graph format is based on the |
| 46 | | - MediaWiki Graph extension. |
| 47 | | -* Timeline: Eventline requires Javascript to render. |
| | 43 | +* graph: in order to get the graph format to run, you first must have |
| | 44 | + the MediaWiki Graph extension running. |
| | 45 | +* timeline: requires Javascript to render. |