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

[svn_mapbender at osgeo.org]

Author: verenadiewald
Date: 2011-04-15 02:34:25 -0700 (Fri, 15 Apr 2011)
New Revision: 7777

Modified:
   trunk/mapbender/http/plugins/mb_resultList_transferToDigitize.js
Log:
added documentation

Modified: trunk/mapbender/http/plugins/mb_resultList_transferToDigitize.js
===================================================================
--- trunk/mapbender/http/plugins/mb_resultList_transferToDigitize.js	2011-04-15 09:34:11 UTC (rev 7776)
+++ trunk/mapbender/http/plugins/mb_resultList_transferToDigitize.js	2011-04-15 09:34:25 UTC (rev 7777)
@@ -1,27 +1,32 @@
 /**
- * Package: mb_resultList_transferToDigitize
+ * Package: resultList_transferToDigitize
  *
  * Description:
- * <A description>
+ * A button for a mapbender result list to transfer search results to digitize
  * 
  * Files:
- *  - <path and filename, like http/javascripts/mod_zoomIn1.php>
+ *  - http/plugins/mb_resultList_transferToDigitize.js
  *
  * SQL:
- * > <SQL for element> 
- * > 
- * > <SQL for element var> 
+ * > 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('<app_id>',
+ * > 'resultList_transferToDigitize',2,1,'transfer marked search results to digitize','','div','','',NULL,NULL,NULL,NULL,NULL,
+ * > '','','','../plugins/mb_resultList_transferToDigitize.js','','resultList','',
+ * > 'http://www.mapbender.org/ResultList'); 
+ * 
+ * > INSERT INTO gui_element_vars(fkey_gui_id, fkey_e_id, var_name, var_value, context, var_type) 
+ * > VALUES('<app_id>', 'resultList_transferToDigitize', 'digitizeId', 'digitize', 
+ * > 'references the ID of the digitize module' ,'var');
  *
  * Help:
- * http://www.mapbender.org/<wiki site name>
+ * http://www.mapbender.org/ResultList_transferToDigitize
  *
  * Maintainer:
- * http://www.mapbender.org/User:<user>
+ * http://www.mapbender.org/User:Verena_Diewald
  * 
  * Parameters:
- * <normal element var name>      - <type and description>
- * <optional element var name>    - *[optional]* <type and description>
- * <deprecated element var name>  - *[deprecated]* <type and description>
+ * digitizeId - references the ID of the digitize module
  *
  * License:
  * Copyright (c) 2009, Open Source Geospatial Foundation