[Mapbender-commits] r6035 - trunk/mapbender/http/plugins

[svn_mapbender at osgeo.org]

Author: astrid_emde
Date: 2010-04-28 17:25:26 -0400 (Wed, 28 Apr 2010)
New Revision: 6035

Modified:
   trunk/mapbender/http/plugins/mb_loadkmlgeorss.js
Log:
docu for NaturalDocs added, needs review

Modified: trunk/mapbender/http/plugins/mb_loadkmlgeorss.js
===================================================================
--- trunk/mapbender/http/plugins/mb_loadkmlgeorss.js	2010-04-28 13:40:42 UTC (rev 6034)
+++ trunk/mapbender/http/plugins/mb_loadkmlgeorss.js	2010-04-28 21:25:26 UTC (rev 6035)
@@ -1,5 +1,52 @@
-
-options.buffer = options.buffer || 0.10;
+/*
+ * Package: load_georsskml
+ *
+ * Description:
+ * This element enables you to load GeoRSS or KML temporary to a Mapbender application. 
+ * The features will be displayed in the mapframe. The result will also be displayed in a result table. 
+ * The module enables you to load more than one GeoRSS/KML. Every resultset will be displayed in a result table.
+ * As long as the result table is open. The features are shown in the map.
+ * 
+ * Files:
+ *  - ../http/plugins/mb_loadkmlgeorss.js>
+ *
+ * SQL:
+ * > INSERT INTO gui_element(fkey_gui_id, e_id, e_pos, e_public, e_comment, e_title, e_element, 
+ * > e_src, e_attributes, e_left, e_top, e_width, e_height, e_z_index, e_more_styles, e_content, 
+ * > e_closetag, e_js_file, e_mb_mod, e_target, e_requires, e_url) VALUES('<application_name>',
+ * >'load_georsskml',2,1,'','Load GeoRSS or KML','img','../img/georss_logo_off.png','',750,10,
+ * > 24,24,NULL ,'','','','../plugins/mb_loadkmlgeorss.js','','','','');
+ * > 
+ * > INSERT INTO gui_element_vars(fkey_gui_id, fkey_e_id, var_name, var_value, context, var_type) 
+ * > VALUES('<application_name>', 'load_georsskml', 'buffer', '100', 
+ * > 'how much space to leave around a feature when zooming to it ' ,'var');
+ * >
+ * > INSERT INTO gui_element_vars(fkey_gui_id, fkey_e_id, var_name, var_value, context, var_type) 
+ * > VALUES('<application_name>', 'load_georsskml', 'position', '', 
+ * > 'position where the result frame is displayed, see the [http://docs.jquery.com/UI/Dialog |jquery UI documentation] for possible values' ,'var');
+ *
+ * Help:
+ * http://www.mapbender.org//Loadkmlgeorss
+ *
+ * Maintainer:
+ * http://www.mapbender.org/User:Karim_Malhas
+ * 
+ * Parameters:
+ * buffer    - *[optional]* var, how much space to leave around a feature when zooming to it
+ * position  - *[optional]* var, position where the result frame is displayed
+ * 
+ *
+ * Requires:
+ * <>
+ * <>
+ * 
+ * License:
+ * Copyright (c) 2009, Open Source Geospatial Foundation
+ * This program is dual licensed under the GNU General Public License 
+ * and Simplified BSD license.  
+ * http://svn.osgeo.org/mapbender/trunk/mapbender/license/license.txt
+ */
+options.buffer || 0.10;
 options.position = options.position || 'center';
 var originalI18nObject = {
 	"labelLoadError" : "Could not load Document"