Removed the ul element from the sledrun info box.
[philipp/winterrodeln/mediawiki_extensions/wrmap.git] / wrmap.php
index e2f637b79dc8811eba66fb66bd296cfd01f66091..07d6200969bcccbc55f6ae4f57561a2f95497e18 100644 (file)
--- a/wrmap.php
+++ b/wrmap.php
 <?php
+/* This extension creates a map using OpenLayers to show sledrun details and sledrun overviews.
+This extension depends on no other extension.
+
+
+Example 1
+---------
+
+<wrgmap lat="47.267648" lon="11.40465" zoom="10"/>
+
+(Shows icons for all sledruns. lat, lon and zoom are optional.)
+
+
+Example 2
+---------
+
+<wrmap lat="47.2417134" lon="11.21408895" zoom="14" width="700" height="400">
+
+<gasthaus name="Rosskogelhütte" wiki="Rosskogelhütte">47.240689 11.190454</gasthaus>
+<gasthaus name="Stiglreith">47.238186 11.221940</gasthaus>
+<gasthaus name="Sulzstich">47.240287 11.203006</gasthaus>
+<parkplatz>47.245789 11.238971</parkplatz>
+<parkplatz>47.237627 11.218886</parkplatz>
+<haltestelle name="Oberperfuss Rangger Köpfl Lift">47.245711 11.238283</haltestelle>
+<achtung name="Kreuzung mit Schipiste">47.2383200 11.2235592</achtung>
+
+<gehweg>
+47.238587 11.203360
+47.239743 11.203522
+47.240135 11.203247
+</gehweg>
+
+<gehweg>
+47.238442 11.203263
+47.237799 11.203511
+47.237133 11.202988
+47.238091 11.206642
+47.237273 11.211675
+47.237133 11.214466
+47.237513 11.218199
+</gehweg>
+
+<alternative>
+47.240487 11.190169
+47.238996 11.188628
+47.238987 11.188018
+47.238267 11.187075
+47.238461 11.190511
+47.239751 11.191795
+47.240037 11.192702
+47.239525 11.193535
+47.239688 11.194272
+47.239017 11.193925
+47.239536 11.195457
+47.240063 11.196230
+47.240747 11.196658
+47.239734 11.198295
+47.238857 11.198346
+47.237743 11.199778
+47.238250 11.202755
+47.238587 11.203360
+</alternative>
+
+<rodelbahn>
+47.238587 11.203360
+47.238185 11.203982
+47.238297 11.204381
+47.239417 11.204972
+47.239210 11.208772
+47.238999 11.209523
+47.239126 11.209839
+47.238933 11.210641
+47.239102 11.210739
+47.238666 11.215042
+47.238203 11.216089
+47.238183 11.218151
+47.237851 11.218599
+47.238055 11.219755
+47.237686 11.222441
+47.238000 11.223367
+47.238625 11.223687
+47.239915 11.223118
+47.240992 11.219781
+47.243412 11.214141
+47.243207 11.218331
+47.243990 11.216205
+47.243785 11.223251
+47.242845 11.228510
+47.242917 11.232501
+47.242524 11.235001
+47.244737 11.231791
+47.244951 11.230868
+47.245470 11.237853
+</rodelbahn>
+
+<lift>
+47.245656 11.237286
+47.238189 11.221344
+</lift>
+
+</wrmap>
+
+
+
+Definition
+----------
+
+* <wrmap>...</wrmap> has to be valid XML.
+* All coordinates are in WGS84 coordinate system.
+* Coordinates have the preferred format "latitude N longitude E",
+  however for parsing the N and E can be omitted.
+* <wrmap> has the following attributes:
+       * lat (float): latitude of map-center, optional.
+       * lon (float): longitude of map-center, optional.
+       * zoom (integer): zoom level of the map (google zoom levels). optional.
+       * width (integer): width of the map in pixel. optional (100% if omitted)
+       * height (integer): height of the map in pixel. optional.
+       * <wrmap> can have any number of the following sub-elements:
+               * <gasthaus>
+               * <haltestelle>
+               * <parkplatz>
+               * <achtung>
+               * <foto>
+               * <punkt>
+               * <rodelbahn>
+               * <alternative>
+               * <gehweg>
+               * <lift>
+               * <anfahrt>
+               * <linie>
+       * The order may be used by the renderer to determine in which order the 
+         elements should be drawn.
+* <gasthaus>, <haltestelle>, <parkplatz>, <achtung>, <foto> and <punkt> define points
+       * The elements may have the following attributes:
+               * name (string): defines the name (not the label) of the element
+               * wiki (string): name of a MediaWiki page the point refers to
+       * The content is exactly one coordinate pair.
+* <rodelbahn>, <alternative>, <gehweg>, <lift>, <anfahrt> and <linie>
+  define non-closed polygons.
+       * They may have the following attributes:
+               farbe (hex format, e.g. #12a50f): color of the line
+               dicke (int): width of the line in pixel
+       * The content of the elements are a whitespace separated list of 
+               coordinates.
+
+
+For transmitting the map to javascript, geojson is used in the <div> element of the map.
+This way, an extra request is avoided. The geojson format used here consists of a single
+"FeatureCollection" (representing the <wrmap>) containing the sub-elements of wrmap
+as features.
+The features have an properties key that has a hash as values with the properties of 
+the XML subelements of wrmap. Optional attributes/properties can be omitted.
+Additionally one mandatory property key is called 'type' and has the sub-element's name
+as value.
+The featurecollection itself has a properties key as well containing the attributes of
+the wrmap element.
+
+
+
+*/
+
 $wgExtensionCredits['parserhook'][] = array(
        'name' => 'Winterrodeln Map',
-       'version' => '1.2.0',
+       'version' => '3.1.0',
        'author' =>'Philipp Spitzer', 
-       'url' => 'http://www.winterrodeln.org', 
-       'description' => 'This extension creates a map from coordinates and uses the GoogleMaps extension to do so.'
+       'url' => 'http://www.winterrodeln.org/trac/wiki/WrMap', 
+       'description' => 'This extension creates a map using OpenLayers to show sledrun details and sledrun overviews.'
+);
+
+
+
+$wgResourceModules['ext.wrmap'] = array(
+       'scripts' => array('openlayers/OpenLayers.min.js', 'wrmap.js'),
+       // 'scripts' => array('openlayers/OpenLayers.js', 'wrmap.js'), // non-minimized version for debugging
+       'styles' => array('openlayers/theme/default/style.css', 'openlayers/theme/default/google.css'),
+
+       // When your module is loaded, these messages will be available through mw.msg()
+       //'messages' => array( 'myextension-hello-world', 'myextension-goodbye-world' ),
+
+       // If your scripts need code from other modules, list their identifiers as dependencies
+       // and ResourceLoader will make sure they're loaded before you.
+       // You don't need to manually list 'mediawiki' or 'jquery', which are always loaded.
+       //'dependencies' => array( 'jquery.ui.datepicker' ),
+
+       // You need to declare the base path of the file paths in 'scripts' and 'styles'
+       'localBasePath' => dirname( __FILE__ ),
+
+       // ... and the base from the browser as well. For extensions this is made easy,
+       // you can use the 'remoteExtPath' property to declare it relative to where the wiki
+       // has $wgExtensionAssetsPath configured:
+       'remoteExtPath' => 'wrmap',
+
+       'position' => 'top'
 );
 
 
+$wgAutoloadClasses['WrMap'] = dirname(__FILE__) . '/wrmap.body.php';
+$wgAutoloadClasses['WrGMap'] = $wgAutoloadClasses['WrMap'];
+
+
 $wgHooks['ParserFirstCallInit'][] = 'wrMapParserFirstCallInit';
-$wgHooks['ParserAfterTidy'][] = 'wrMapParserAfterTidy';
 
 
-require_once dirname(__FILE__) . '/wrmap.body.php';
+function wrMapParserFirstCallInit($parser) {
+       $parser->setHook('wrgmap', 'WrGMap::render');
+       $parser->setHook('wrmap', 'WrMap::render');
+       return true;
+}
+
 
 ?>