[GRASS-SVN] r57002 - grass/trunk/gui/wxpython/docs

svn_grass at osgeo.org svn_grass at osgeo.org
Wed Jul 3 08:30:10 PDT 2013 

Author: annakrat
Date: 2013-07-03 08:30:09 -0700 (Wed, 03 Jul 2013)
New Revision: 57002

Added:
   grass/trunk/gui/wxpython/docs/wxGUI.toolboxes.html
   grass/trunk/gui/wxpython/docs/wxGUI_toolboxes.jpg
Modified:
   grass/trunk/gui/wxpython/docs/wxGUI.html
Log:
wxGUI/toolboxes: add user manual

Modified: grass/trunk/gui/wxpython/docs/wxGUI.html
===================================================================
--- grass/trunk/gui/wxpython/docs/wxGUI.html	2013-07-03 15:29:37 UTC (rev 57001)
+++ grass/trunk/gui/wxpython/docs/wxGUI.html	2013-07-03 15:30:09 UTC (rev 57002)
@@ -630,7 +630,8 @@
 <h2>SEE ALSO</h2>
 
 <em>
-  <a href="wxGUI.Components.html">wxGUI components</a>
+  <a href="wxGUI.Components.html">wxGUI components</a><br/>
+  <a href="wxGUI.Toolboxes.html">wxGUI toolboxes (menu customization)</a>
 </em>
 
 <p>

Added: grass/trunk/gui/wxpython/docs/wxGUI.toolboxes.html
===================================================================
--- grass/trunk/gui/wxpython/docs/wxGUI.toolboxes.html	                        (rev 0)
+++ grass/trunk/gui/wxpython/docs/wxGUI.toolboxes.html	2013-07-03 15:30:09 UTC (rev 57002)
@@ -0,0 +1,211 @@
+<!-- meta page description: wxGUI Toolboxes -->
+<!-- meta page index: wxGUI -->
+<h2>DESCRIPTION</h2>
+
+The <b>Toolboxes</b> is a way to customize items in <em><a href="wxGUI.html">wxGUI</a></em>
+menu. Toolboxes enable to:
+
+
+<ul>
+  <li> hide unused menu items in menu (e.g. Imagery, Database) or submenu (e.g. Wildfire modeling)
+  <li> change order of menu items and subitems
+  <li> add new menu items (e.g. Temporal)
+  <li> add addons modules
+  <li> add your own modules
+</ul>
+
+<p>
+Toolboxes are configured through two XML files (<tt>main_menu.xml</tt> and
+<tt>toolboxes.xml</tt>) located in your user home
+GRASS directory, subdirectory <tt>toolboxes</tt>
+ (<tt>$HOME/.grass7/toolboxes/</tt> on UNIX).
+Currently, there is no GUI front-end for toolboxes,
+however only simple editing of text files is needed.</p>
+
+
+<h3>Brief description of file <tt>main_menu.xml</tt></h3>
+
+<p>This file represents the main menu (File, Settings, Raster, ...).
+By modifying this file you show and hide menu items which are
+represented by <tt>subtoolbox</tt> tag.</p>
+
+<p>Tag <tt>user-toolboxes-list</tt> is interpreted as a menu containing a list of all user-defined toolboxes. If not needed it can be removed.</p>
+
+<p>Following lines can be copied to <tt>.grass7/toolboxes/main_menu.xml</tt>
+and by removing, adding or reordering lines users can change the main menu items. See further examples.</p>
+
+
+<div class="code"><pre>
+<?xml version="1.0" encoding="UTF-8"?>
+<toolbox name="MyMainMenu">
+  <label>Default GRASS GIS main menu bar</label>
+  <items>
+    <subtoolbox name="File"/>
+    <subtoolbox name="Settings"/>
+    <subtoolbox name="Raster"/>
+    <subtoolbox name="Vector"/>
+    <subtoolbox name="Imagery"/>
+    <subtoolbox name="Volumes"/>
+    <subtoolbox name="Database"/>
+    <user-toolboxes-list />
+    <subtoolbox name="Help"/>
+  </items>
+</toolbox>
+</pre></div>
+
+<h3>Brief description of file <tt>toolboxes.xml</tt></h3>
+
+<p>This file contains structure and description of individual toolboxes.
+Note that both <em>Raster</em> and e.g. <em>Query raster maps</em>
+are individual toolboxes although one contains the other.
+Tag <tt>toolbox</tt> contains <tt>subtoolbox</tt> tags
+which are defined later in the file. These nested toolboxes are linked
+through <tt>name</tt> attribute.</p>
+
+<p>Apart from <tt>subtoolbox</tt> tag, tag <tt>toolbox</tt> can contain individual items (modules)
+and separators (for visual separation in the menu tree).</p>
+
+<div class="code"><pre>
+<?xml version="1.0" encoding="UTF-8"?>
+<toolboxes>
+  <toolbox name="Raster">
+    <label>&amp;Raster</label>
+    <items>
+      <subtoolbox name="DevelopRasterMap"/>
+      <subtoolbox name="ManageRasterColors"/>
+      <subtoolbox name="QueryRasterMaps"/>
+      <subtoolbox name="RasterMapTypeConversions"/>
+      <separator/>
+      <module-item name="r.buffer">
+        <label>Buffer rasters</label>
+      </module-item>
+      ...
+      ...
+  <toolbox name="QueryRasterMaps">
+    <label>Query raster maps</label>
+    <items>
+      <module-item name="r.what">
+        <label>Query values by coordinates</label>
+      </module-item>
+      <module-item name="r.what.color">
+        <label>Query colors by value</label>
+      </module-item>
+    </items>
+  </toolbox>
+</pre></div>
+
+<p>To redefine a toolbox (or use it as a template),
+copy specific part of file <tt>grass7/gui/wxpython/xml/toolboxes.xml</tt>
+from GRASS installation to a new file in user home
+(<tt>.grass7/toolboxes/toolboxes.xml</tt>) and edit it.
+Rename this new toolbox.</p>
+
+<h2>EXAMPLES</h2>
+
+<h3>Hiding menu items</h3>
+<p>If we are for example working only with raster data,
+we can hide menu items <em>Vector</em> and <em>Database</em>.
+The file <tt>main_menu.xml</tt> then contains the following lines
+where we omitted the two toolboxes:</p>
+
+
+<div class="code"><pre>
+<?xml version="1.0" encoding="UTF-8"?>
+<toolbox name="CustomizedMainMenu">
+  <label>Default GRASS GIS main menu bar</label>
+  <items>
+    <subtoolbox name="File"/>
+    <subtoolbox name="Settings"/>
+    <subtoolbox name="Raster"/>
+    <subtoolbox name="Imagery"/>
+    <subtoolbox name="Volumes"/>
+    <user-toolboxes-list />
+    <subtoolbox name="Help"/>
+  </items>
+</toolbox>
+</pre></div>
+
+<h3>Creating custom toolbox</h3>
+
+<p>In this example we create a new toolbox <em>Favorites</em> containg
+existing GRASS module and toolbox, custom module
+created by the user and addon module.
+The <tt>toolboxes.xml</tt> file contains following lines:</p>
+
+<div class="code"><pre>
+<?xml version="1.0" encoding="UTF-8"?>
+<toolboxes>
+  <toolbox name="MyFavorites">
+    <label>&amp;Favorites</label>
+    <items>
+      <module-item name="g.region">
+        <label>Set region</label>
+      </module-item>
+      <module-item name="r.mask">
+        <label>Mask</label>
+      </module-item>
+      <separator/>
+      <module-item name="m.myown">
+        <label>Do my own stuff</label>
+      </module-item>
+      <module-item name="i.histo.match">
+        <label>Calculate histogram matching</label>
+      </module-item>
+      <subtoolbox name="RasterReportsAndStatistics"/>
+    </items>
+  </toolbox>
+</toolboxes>
+</pre></div>
+
+<p>Optionally, we can add this toolbox to the main menu items.
+The <tt>main_menu.xml</tt> file contains following lines:</p>
+
+<div class="code"><pre>
+<?xml version="1.0" encoding="UTF-8"?>
+<toolbox name="CustomizedMainMenu">
+  <label>Default GRASS GIS main menu bar</label>
+  <items>
+    <subtoolbox name="File"/>
+    <subtoolbox name="Settings"/>
+    <subtoolbox name="Raster"/>
+    <subtoolbox name="Vector"/>
+    <subtoolbox name="Imagery"/>
+    <subtoolbox name="Volumes"/>
+    <subtoolbox name="Database"/>
+    <user-toolboxes-list />
+    <subtoolbox name="Favorites"/>
+    <subtoolbox name="Help"/>
+  </items>
+</toolbox>
+</pre></div>
+
+<p>If we have <tt>user-toolboxes-list</tt> tag in the <tt>main_menu.xml</tt> file,
+our custom toolbox will be listed in the automatically added <em>Toolboxes</em> main menu item. The screenshot shows the resulting menu:</p>
+
+<center>
+  <br><img src="wxGUI_toolboxes.jpg" border="0" alt="Toolboxes - menu customization"><br><br>
+</center>
+
+
+<h2>NOTES</h2>
+<p>After the first start of wxGUI with custom toolboxes,
+<tt>.grass/toolboxes</tt> directory will contain file
+<tt>menudata.xml</tt> which is auto-generated and should not be edited.</p>
+
+
+<h2>SEE ALSO</h2>
+
+<em>
+  <a href="wxGUI.html">wxGUI</a><br>
+  <a href="wxGUI.Components.html">wxGUI components</a>
+</em>
+
+<h2>AUTHORS</h2>
+
+Anna Petrasova, OSGeoREL, Faculty of Civil Engineering, Czech Technical University in Prague<br/>
+Vaclav Petras, OSGeoREL, Faculty of Civil Engineering, Czech Technical University in Prague<br/>
+
+
+
+<p>
+<em>$Date$</em>


Property changes on: grass/trunk/gui/wxpython/docs/wxGUI.toolboxes.html
___________________________________________________________________
Added: svn:mime-type
   + text/html
Added: svn:keywords
   + Author Date Id
Added: svn:eol-style
   + native

Added: grass/trunk/gui/wxpython/docs/wxGUI_toolboxes.jpg
===================================================================
(Binary files differ)


Property changes on: grass/trunk/gui/wxpython/docs/wxGUI_toolboxes.jpg
___________________________________________________________________
Added: svn:mime-type
   + image/jpeg

More information about the grass-commit mailing list