Changes between Version 1 and Version 2 of PluginsToc

Timestamp:

02/09/10 16:14:26 (7 months ago)

Author:

traffin (IP: 212.99.15.222)

Comment:

themesandviews version 4 doc

PluginsToc

@@ -182 +182 @@
 == Themes and views ==
 
-'''Documentation is too old!!!'''
+
+=== Description ===
 
 This plugin can extend the layers selection.
@@ -195 +196 @@
  * use a button tool to show theme box in "mapToolArea"
  * use a button tool to show view box in "mapToolArea"
- * if use with "legendonly" plugin, TOC behavior become very simple (but with less functionalities !) for GIS beginner
-
-=== Activation ===
- * add the string "themesandviews" to the plugins list in the pmapper config file.
- * add parameters to your pmapper ini config file:
-  * ''tavFile'': XML file path and name describing your themes and views
-  * ''tavThemesBoxType'': how to insert themesbox
-  * ''tavThemesBoxContainer'': container for themesbox
-  * ''tavThemesKeepSelected'': when a theme is selected in the selectbox, should the box keep it selected ?
-  * ''tavViewsBoxType'': see tavThemesBoxType
-  * ''tavViewsBoxContainer'': see tavThemesBoxContainer
-  * ''tavViewsKeepSelected'': see tavThemesKeepSelected
-  * ''tavSetDefault'': indicate if a theme or a view will be automaticaly applied
-  * ''tavDefaultCodeValue'': code of the theme or view auto-loaded
- * configure your themes and views (either with [wiki:AvailablePlugins#ThemesAndViewsAdmin Themes and views Administration] plugin, either directly in a XML file)
- * if you want, you add new tools in your button bar. To do that, modify your "$buttons" variable in "php_config.php" (in your config directory) like this:
-{{{"themesbox" => array(_p("Apply theme"), "0")}}} for themes
-{{{"viewsbox" => array(_p("Apply vue"), "0")}}} for views
-
-=== Config.ini example ===
-{{{
-;==============================================================
-; Plugin ThemesAndViews options :
-;--------------------------------------------------------------
-; tavThemesType and tavViewsType :
-; - 0 = disabled (default value), but can be use with buttons tools
-; - 1 = div fixed in the window with manual insert of the div
-; - 2 = div fixed in the window but automaticaly inserted in the div 
-; as first element specified by tavThemesBoxContainer and tavViewsBoxContainer 
-; - 3 = div fixed in the window but automaticaly inserted in the div 
-; as last element specified by tavThemesBoxContainer and tavViewsBoxContainer 
-;--------------------------------------------------------------
-; tavThemesBoxContainer and tavViewsBoxContainer :
-; id of the div containing the boxes
-; (default is "mapNorth")
-;--------------------------------------------------------------
-; tavThemesKeepSelected and tavViewsKeepSelected:
-; indicate if the selected element keep selected, or if the box is re-initialized
-; (default value is false)
-; Indeed, this parameters is only interesting with the "legendonly" plugin.
-;--------------------------------------------------------------
-; tavSetDefault :
-; if specified, then just after loading, the chosen theme or view (specified 
-; by "tavDefaultCodeValue" parameter) is applied.
-; Possible values : "theme", "view", "none"
-; (default value is "none")
-;--------------------------------------------------------------
-; tavDefaultCodeValue
-; Name of the theme or vue to use by default.
-; If not specified, then the first one in the TAV file will be use.
-;--------------------------------------------------------------
-; tavFile :
-; path to the file (default is "themesandviews.xml" in the config directiry)
-;--------------------------------------------------------------
-tavThemesBoxType = 2
-tavThemesBoxContainer = toc
-;tavThemesKeepSelected = false
-;tavViewsBoxType = 2
-;tavViewsBoxContainer = mapSouth
-;tavViewsKeepSelected = false
-;tavSetDefault = view
-;tavDefaultCodeValue = France
-;tavFile = xxxx/themesandviews.xml
-}}}
+ * if you don't show TOC but only legend, the layer management behavior become very simple (but with less functionalities !) for GIS beginner
+
+Complementary plugin : ThemesAndViewsAdmin plugin (maybe soon available...)
+
+=== How to use ===
+
+==== Configuration ====
+
+Enable the plugin by adding a line in config_XXXXX.xml file:
+{{{
+<pmapper>
+    <ini>
+        <pmapper>
+....
+            <plugins>themesandviews</plugins>
+....
+        </pmapper>
+        </ini>
+</pmapper>
+}}}
+
+Set plugin configuration by adding a line in config_XXXXX.xml file:
+{{{
+<pmapper>
+    <ini>
+....
+        <pluginsConfig>
+....
+            <themesandviews>
+                <file>common/themesAndViews.xml</file>
+                <defaultType>none</defaultType>
+                <defaultCodeValue></defaultCodeValue>
+                <themes>
+                    <insertBoxType>first</insertBoxType> 
+                    <boxContainer>.pm-header</boxContainer> 
+                    <initAfterTOC>0</initAfterTOC> 
+                    <selBoxStr>&lt;div id='selThemeBox' class='tavSelectBox' /&gt;</selBoxStr>
+                    <keepSelected>0</keepSelected>
+                </themes>
+                <views>
+                    <insertBoxType>last</insertBoxType> 
+                    <boxContainer>.pm-header</boxContainer> 
+                    <initAfterTOC>0</initAfterTOC> 
+                    <selBoxStr>&lt;div id='selViewBox' class='tavSelectBox' /&gt;</selBoxStr>
+                    <keepSelected>0</keepSelected>
+                </views>
+            </themesandviews>   
+....
+        </pluginsConfig>
+    </ini>
+</pmapper>
+}}}
+
+Common parameters for themes and views:
+        - file: file that will define the themes and views
+        - defaultType: what to automatically apply at startup. Possible values: none, theme, view
+        - defaultCodeValue: empty or name of a theme or view to load at startup (depends on defaultType)
+
+Parameters that can be different for themes and views:
+        - insertBoxType: user (user defined in layout), first (= at first position in the specifyed container), last (= at the end of the specified container)
+        - boxContainer: jQuery selector for box container
+        - initAfterTOC: 0=before or 1=after
+        - selBoxStr: HTML code for container
+        - keepSelected: 0 (the box will not keep selected value) or 1 (keep selected value)
+
+(optional) Add the themesandviews tool buttons to the interface in /config/XXXXX/js_config.php file:
+{{{
+PM.buttonsDefault = {
+.....
+    buttons: [
+.....
+                {tool:'themesbox',              name:'themesbox'},
+                {tool:'viewsbox',               name:'viewsbox'},
+.....
+        ]
+}
+}}}
+
+==== Integration ====
+
+Add default translation from ''plugins/themesandviews /install/language_en-part.php'' to ''incphp/locale/language_en.php''. You can add translations for other language (French is provided) by doing the same.
+
+(optional) Add the appropriate icons for the buttons in images/buttons/default (or the corresponding theme directory)
+
+
+=== Themes and views file content ===
+Example provided in ''plugins/themesandviews/install/themesAndViews.xml''
+
+{{{
+<?xml version="1.0" standalone="yes"?>
+<themesorviews>
+        <themeorview>
+                <type>Theme</type>
+                <name>theme1</name>
+                <description>Vector data</description>
+                <layers>
+                        <layer>
+                                <name>countries</name>
+                                <opacity>95</opacity>
+                        </layer>
+                        <layer>
+                                <name>cities10000eu</name>
+                                <opacity>map</opacity>
+                        </layer>
+                        <layer>
+                                <name>rivers</name>
+                                <opacity>map</opacity>
+                        </layer>
+                </layers>
+                <extent/>
+        </themeorview>
+        <themeorview>
+                <type>Theme</type>
+                <name>theme2</name>
+                <description>All</description>
+                <layers>
+                        <layer>
+                                <name>dem</name>
+                                <opacity>map</opacity>
+                        </layer>
+                        <layer>
+                                <name>jpl_wms_global_mosaic</name>
+                                <opacity>map</opacity>
+                        </layer>
+                        <layer>
+                                <name>countries</name>
+                                <opacity>75</opacity>
+                        </layer>
+                        <layer>
+                                <name>cities10000eu</name>
+                                <opacity>map</opacity>
+                        </layer>
+                        <layer>
+                                <name>rivers</name>
+                                <opacity>map</opacity>
+                        </layer>
+                </layers>
+                <extent/>
+        </themeorview>
+</themesorviews>
+}}}
+
 
 ----