Added formal definition of the <wrmap> format.

git-svn-id: http://www.winterrodeln.org/svn/servermediawiki/mediawiki_extensions/wrmap/trunk@1525 7aebc617-e5e2-0310-91dc-80fb5f6d2477

diff --git a/wrmap.php b/wrmap.php
index c7884e72112b37e610f042203a034fa57779a965..b9da674caae8b739b6864d9c67d9a3b67144595e 100644 (file)
--- a/wrmap.php
+++ b/wrmap.php
@@ -100,7 +100,61 @@ Example 2
 
 </wrmap>
 
-lat, lon and zoom are optional.
+
+
+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>
+               * <punkt>
+               * <rodelbahn>
+               * <alternative>
+               * <gehweg>
+               * <lift>
+               * <linie>
+       * The order may be used by the renderer to determine in which order the 
+         elements should be drawn.
+* <gasthaus>, <haltestelle>, <parkplatz>, <achtung> 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> 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 a <script> block. 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(