[mapguide-commits] r5844 - in trunk/Tools/Maestro/UserDoc/source: .
images
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Tue May 24 10:41:27 EDT 2011
Author: jng
Date: 2011-05-24 07:41:27 -0700 (Tue, 24 May 2011)
New Revision: 5844
Added:
trunk/Tools/Maestro/UserDoc/source/expr_editor.rst
trunk/Tools/Maestro/UserDoc/source/images/expr_autocomplete.png
trunk/Tools/Maestro/UserDoc/source/images/expr_editor.PNG
trunk/Tools/Maestro/UserDoc/source/images/fl_maps.PNG
trunk/Tools/Maestro/UserDoc/source/images/fl_settings.PNG
trunk/Tools/Maestro/UserDoc/source/images/fl_widget_config.PNG
trunk/Tools/Maestro/UserDoc/source/images/fl_widgets.PNG
trunk/Tools/Maestro/UserDoc/source/images/fscacheview.PNG
trunk/Tools/Maestro/UserDoc/source/images/fspreview.PNG
trunk/Tools/Maestro/UserDoc/source/images/fspreview_query.PNG
trunk/Tools/Maestro/UserDoc/source/images/fspreview_query_results.PNG
trunk/Tools/Maestro/UserDoc/source/images/mgcooker_main.PNG
trunk/Tools/Maestro/UserDoc/source/images/pl_logos.PNG
trunk/Tools/Maestro/UserDoc/source/images/pl_properties.PNG
trunk/Tools/Maestro/UserDoc/source/images/pl_text.PNG
trunk/Tools/Maestro/UserDoc/source/images/servermon.PNG
trunk/Tools/Maestro/UserDoc/source/images/validation_results.PNG
trunk/Tools/Maestro/UserDoc/source/images/wl_commandset.PNG
trunk/Tools/Maestro/UserDoc/source/images/wl_menus_toolbars.PNG
trunk/Tools/Maestro/UserDoc/source/images/wl_settings.PNG
trunk/Tools/Maestro/UserDoc/source/other_resources.rst
Modified:
trunk/Tools/Maestro/UserDoc/source/edit_xml.rst
trunk/Tools/Maestro/UserDoc/source/index.rst
trunk/Tools/Maestro/UserDoc/source/localpreview.rst
trunk/Tools/Maestro/UserDoc/source/mgcooker.rst
trunk/Tools/Maestro/UserDoc/source/other_tools.rst
trunk/Tools/Maestro/UserDoc/source/packaging.rst
trunk/Tools/Maestro/UserDoc/source/resource_validation.rst
trunk/Tools/Maestro/UserDoc/source/understanding_applications.rst
trunk/Tools/Maestro/UserDoc/source/understanding_maps.rst
trunk/Tools/Maestro/UserDoc/source/understanding_print_layouts.rst
Log:
#1677: This submission completes the final set of content for the Maestro user guide (for now).
Modified: trunk/Tools/Maestro/UserDoc/source/edit_xml.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/edit_xml.rst 2011-05-24 13:23:57 UTC (rev 5843)
+++ trunk/Tools/Maestro/UserDoc/source/edit_xml.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -1,2 +1,15 @@
Editing via the XML editor
-==========================
\ No newline at end of file
+==========================
+
+The XML Editor is the generic editor that can be used to edit the XML form of any resource in the MapGuide Server. If you are intimately familiar with the XML schema
+of the resource in question, editing via the XML editor can often be much faster in terms of productivity than having to go through the specialized editor.
+
+For resources that are not recognised by the current release of Maestro or a specialized editor does not exist, this editor will be used as a fallback. Otherwise, you can
+choose to open any resource in the XML editor by right clicking the resource in the **Site Explorer** and choosing the **Open Resource with XML Editor** context menu item.
+
+.. note::
+
+ You cannot have an XML editor or specialized editor editing the same resource. Maestro will not let it happen.
+
+If you are editing a resource via a specialized editor, you can instantly go to and edit the resource in its XML form via the XML editor with the **Edit as XML** toolbar
+command. Upon saving the XML content in this mode, the original specialized editor will be immediately refreshed with the latest resource settings.
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/expr_editor.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/expr_editor.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/expr_editor.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -0,0 +1,31 @@
+The Expression Editor
+=====================
+
+MapGuide has a built-in expression language, which allows for flexible computations based off of existing feature class property values to be used for various Layer stylization purposes.
+
+Some uses of expressions include:
+
+ * The **Hyperlink** property of a Layer Definition being the concatenated expression of several string properties.
+ * The **Tooltip** property of a Layer Definition being the concatenated expression of several string properties and fragments of html content.
+
+Maestro provides an Expression Editor that can assist in writing these FDO expressions. Any resource editor field that can accept an FDO expression will give you the option of using this editor.
+
+.. figure:: images/expr_editor.png
+
+The **Properties** toolbar button lists all the available feature class properties.
+
+The **Functions** toolbar button lists all the available expression functions.
+
+The **Filter** toolbar button lists all the available conditional and filtering expressions.
+
+Also on the toolbar is the ability to fetch all distinct values for a given property. To do this, select the desired property in the first dropdown, then click the arrow on the right to load
+all the distinct values into the second dropdown.
+
+.. note::
+
+ The types of functions and expressions available depend on the underlying FDO provider's capabilities. For example, editing a Tooltip expression on a Layer Definition will only use functions
+ and expressions supported by the Feature Source the Layer Definition is referencing.
+
+The Expression Editor also has built-in auto-complete that brings up possible property/function suggestions as you type. You can invoke auto-complete at any time by pressing `Alt` + `Right key`
+
+.. figure:: images/expr_autocomplete.png
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/images/expr_autocomplete.png
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/expr_autocomplete.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/expr_editor.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/expr_editor.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/fl_maps.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/fl_maps.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/fl_settings.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/fl_settings.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/fl_widget_config.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/fl_widget_config.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/fl_widgets.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/fl_widgets.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/fscacheview.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/fscacheview.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/fspreview.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/fspreview.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/fspreview_query.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/fspreview_query.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/fspreview_query_results.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/fspreview_query_results.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/mgcooker_main.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/mgcooker_main.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/pl_logos.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/pl_logos.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/pl_properties.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/pl_properties.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/pl_text.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/pl_text.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/servermon.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/servermon.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/validation_results.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/validation_results.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/wl_commandset.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/wl_commandset.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/wl_menus_toolbars.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/wl_menus_toolbars.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/wl_settings.PNG
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/wl_settings.PNG
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Modified: trunk/Tools/Maestro/UserDoc/source/index.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/index.rst 2011-05-24 13:23:57 UTC (rev 5843)
+++ trunk/Tools/Maestro/UserDoc/source/index.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -28,11 +28,13 @@
understanding_print_layouts
edit_xml
+ expr_editor
resource_validation
packaging
mgcooker
localpreview
other_tools
+ other_resources
Indices and tables
==================
Modified: trunk/Tools/Maestro/UserDoc/source/localpreview.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/localpreview.rst 2011-05-24 13:23:57 UTC (rev 5843)
+++ trunk/Tools/Maestro/UserDoc/source/localpreview.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -1,2 +1,58 @@
Using Local Feature Source Preview
-==================================
\ No newline at end of file
+==================================
+
+.. note::
+
+ Server support for the operations used by this tool have questionable reliability for MapGuide Open Source 2.1 and older releases
+ (and corresponding MapGuide Enterprise versions). As such, this tool is only recommended for use in MapGuide Open Source 2.2 (MapGuide Enterprise 2011)
+ and newer releases.
+
+The **Preview** toolbar command when used on a Feature Source editor will bring up a web-based schema inspector on that Feature Source.
+
+This schema inspector allows you to view the Feature Classes in the Feature Source with the ability to either view the data attributes or
+preview the data as rendered on a map with basic styles applied.
+
+However this schema inspector is very basic in its functionality. You cannot for instance, do any of the follwing:
+
+ * Run or test certain feature queries on a Feature Source to see what kind of result we get back.
+ * Similarly, run or test certain SQL queries on a Feature Source for FDO providers that support such capability.
+
+Maestro includes a **Local Feature Source Preview** tool that is designed to overcome such limitations of the web-based
+schema inspector.
+
+This tool is available:
+
+ * From the *Tools* menu
+ * On the Maestro Start Menu folder if you installed Maestro via the windows installer.
+ * In the Feature Source editor under the **Other Options** panel.
+
+Once again like **MgCooker**, this tool requires you to login on startup. Once logged in select the feature source
+to be previewed. Once the feature source is selected, the left pane will be populated with all feature schemas found
+and their Feature Classes (and their properties)
+
+.. figure:: images/fspreview.png
+
+To open a specific feature class for running queries, select the desired Feature Class node (represented by a table/spreadsheet).
+
+Two buttons on the toolbar will be activated when you do this:
+
+ * The SQL query command (indicated by the SQL icon)
+ * The feature query command (indicated by the magnifying icon)
+
+Click either one to open the query interface.
+
+.. figure:: images/fspreview_query.png
+
+From here specify an optional filter (which is a FDO filter expression), and optionally check/uncheck the properties
+you want to show as part of the query result, and any computed properties. Computed properties are FDO expressions.
+
+Once you have specified your query parameters, click **Run Query** to execute the query.
+
+.. figure:: images/fspreview_query_result.png
+
+.. note::
+
+ Avoid issuing feature queries without a filter, large result sets being transferred over http can bring heavy
+ load to a MapGuide Server and the Web Tier.
+
+To close any query interface, click the close button on the left pane toolbar (indicated by a cross).
\ No newline at end of file
Modified: trunk/Tools/Maestro/UserDoc/source/mgcooker.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/mgcooker.rst 2011-05-24 13:23:57 UTC (rev 5843)
+++ trunk/Tools/Maestro/UserDoc/source/mgcooker.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -1,2 +1,31 @@
Using MgCooker
-==============
\ No newline at end of file
+==============
+
+Tiled Maps improve display performance by rendering the maps in tiles and keeping them stored in a special directory
+known as the **Tile Cache**. Subsequent views of the same map area will skip the rendering process and serve the already
+rendered tiles from the **Tile Cache** which is much faster. Having these tiles pre-generated up front allows you to
+get a view of the map in a near instant, because the potentially costly rendering operations are avoided.
+
+**MgCooker** is such a tool to allow you to pre-generate these tiles. **MgCooker** is available from the **Tools** menu in Maestro
+
+.. note::
+
+ If you installed Maestro via the installer, **MgCooker** is also available on the Maestro Start Menu folder.
+
+**MgCooker** requires you to login on startup. Once logged in, it will show the list of Map Definitions with
+tiled layers.
+
+.. figure:: images/mgcooker_main.png
+
+From here, tick the Map Definitions and the Base Layer Groups that you want to pre-generate tiles for.
+
+In addition other settings are available for you:
+
+ * You can set the upper limit of the number of tiles to generate
+ * You can customize the tile generation method.
+ * You can configure how many threads to generate tiles. Each thread effectively simulates an end-user looking at your specified tiled maps. Based on the method chosen, the way the simulated user navigates could be systematic or completely random.
+
+Once you have specified you settings you have the following options:
+
+ * Start the tile generation process by clicking **Build tiles now**. This process can take several hours to several days depending on the size of the maps being pre-generated.
+ * Save this out to a windows batch file, which will execute MgCooker from the command-line with your specified settings. This is useful for automation via the **Windows Task Scheduler**
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/other_resources.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/other_resources.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/other_resources.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -0,0 +1,12 @@
+Other Resources
+===============
+
+It is hoped that this user guide has given you enough information to get comfortable in authoring data in Maestro.
+
+However, should you have any questions or require more information, there are many online resources to help.
+
+ * The Maestro wiki: `http://trac.osgeo.org/mapguide/wiki/maestro <http://trac.osgeo.org/mapguide/wiki/maestro>`_
+ * The mapguide-users mailing list: `http://lists.osgeo.org/mailman/listinfo/mapguide-users <http://lists.osgeo.org/mailman/listinfo/mapguide-users>`_. User discussion of all things mapguide related. A `Nabble <http://www.nabble.com>`_ front-end exists too, but you must be registered on the mailing lists for your Nabble posts to properly make it back to the mailing lists
+ * The author's blog: `http://themapguyde.blogspot.com <http://themapguyde.blogspot.com>`_. Contains lots of Maestro, MapGuide and FDO tips and tricks.
+
+If you do find bugs or have an idea for a product enhancement, please do not hesistate to register on `Trac <http://trac.osgeo.org/mapguide/wiki>`_ and file a ticket.
\ No newline at end of file
Modified: trunk/Tools/Maestro/UserDoc/source/other_tools.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/other_tools.rst 2011-05-24 13:23:57 UTC (rev 5843)
+++ trunk/Tools/Maestro/UserDoc/source/other_tools.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -1,2 +1,26 @@
Other Tools
-===========
\ No newline at end of file
+===========
+
+Besides **MgCooker** and the **Local Feature Source Preview** tool, there are other minor tools available
+in Maestro which provide valuable functionality. These are described below and are all accessible from the
+**Tools** application menu in Maestro.
+
+Server Status Monitor
+---------------------
+
+The **Server Status Monitor** tool provides current server uptime, memory and operation statistics. The information
+is refreshed every 5 seconds.
+
+.. figure:: images/servermon.png
+
+ *Server Status Monitor*
+
+Feature Source Cache Viewer
+---------------------------
+
+The **Feature Source Cache Viewer** allows you to see what FDO providers are currently have cached connections and lists
+what Feature Sources currently have cached connections.
+
+.. figure:: images/fscacheview.png
+
+ *Feature Source Cache Viewer*
\ No newline at end of file
Modified: trunk/Tools/Maestro/UserDoc/source/packaging.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/packaging.rst 2011-05-24 13:23:57 UTC (rev 5843)
+++ trunk/Tools/Maestro/UserDoc/source/packaging.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -4,8 +4,40 @@
.. index::
single: Resources; Packaging and Loading
+**MapGuide Packages** allow you to import and export portions of the MapGuide Server repository to another MapGuide Server repostiory.
+
+It is a very useful way to backup, migrate and deploy data from one MapGuide Server to another.
+
+The MapGuide Server Site Administrator web application allows you to load and create these packages. But has some
+downsides:
+
+ * It is a server-side web application. Loading and retrieving packages requires the package be stored physically on the server's package directory
+ * Ability to automate such a process is limited.
+
+MapGuide Maestro however, allows you to load and create such packages **completely on the client-side**.
+
Creating Packages
-----------------
+There are 2 ways to load a package:
+
+ 1. The **Package - Package Folder** menu option.
+ 2. Right clicking the desired folder in the **Site Explorer** and choosing the **Package Folder** option.
+
+The time it takes to create a package is a function of how many resources in total are in the folder to be packaged up.
+
Loading Packages
-----------------
\ No newline at end of file
+----------------
+
+There are 2 ways to load a package:
+
+ 1. The **Package - Load Package** menu option
+ 2. Dragging and dropping the package file into the **Site Explorer**
+
+The time it takes to load a package is a function of how large the package is. Once loaded, the **Site Explorer**
+will refresh itself.
+
+.. note::
+
+ Because Maestro communicates to the MapGuide Server over http, loading large packages (over several hundred MBs) can be problematic. As such
+ using the Site Administrator is recommended. Otherwise, an data moving strategy is required (eg. Repository backup/restore or use of aliases instead of embedded data files)
\ No newline at end of file
Modified: trunk/Tools/Maestro/UserDoc/source/resource_validation.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/resource_validation.rst 2011-05-24 13:23:57 UTC (rev 5843)
+++ trunk/Tools/Maestro/UserDoc/source/resource_validation.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -3,3 +3,33 @@
.. index::
single: Resources; Validating
+
+Resource integrity is a very important issue when authoring and publishing data in MapGuide. Doing
+something as innocuous as deleting a resource may inadvertently break any number of resources that
+may be depending on it.
+
+There are other common scenarios that can cause resource breakage:
+
+ * You have edited or removed a column in a database table from a Feature Source that is referenced by one or more layers. Rendering of this layer may either break or be incorrect.
+ * You have renamed a Layer Definition that one or more Map Definitions reference.
+ * You have deleted a custom command in a Web Layout that is referenced in a toolbar or menu
+
+Most of these scenarios result in usually the same outcome: **You don't see things on the map that you would normally expect to be there.**
+
+Fortunately, MapGuide Maestro provides a powerful Resource Validation facility that you can use to validate a given
+resource against such common scenarios. To validate a resource, right click it in the **Site Explorer** and select
+the **Validate** context menu item.
+
+Upon completion of validation, any warnings or errors are displayed in a dialog for you to review
+
+.. figure:: images/validation_results.png
+
+ *Validation Results Dialog*
+
+Any information or warnings encountered during validation do not affect display of the map. These are generally about performance, source data and
+non-sensical (but not error-causing) configuration values.
+
+.. note::
+
+ Resource Validation is automatically done by resource editors before saving a resource. If you are confident
+ in your authoring capabilities, this may be unnecessary. An option is available for you to turn this off.
Modified: trunk/Tools/Maestro/UserDoc/source/understanding_applications.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/understanding_applications.rst 2011-05-24 13:23:57 UTC (rev 5843)
+++ trunk/Tools/Maestro/UserDoc/source/understanding_applications.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -4,29 +4,138 @@
Web Layouts
-----------
-Web Layout Settings
-^^^^^^^^^^^^^^^^^^^
+Web Layouts describe the user interface and functionality of the basic AJAX viewer. Through the **Invoke Script**
+and **Invoke URL** commands, custom functionality can be added to this viewer.
+The Web Layout editor is composed of 3 main sections, each described below.
+
+General Settings
+^^^^^^^^^^^^^^^^
+
+The **General Settings** section of the editor allows you to configure the primary aspects of the web layout
+
+ * The title that is shown when the basic AJAX viewer is displayed in the web browser
+ * The Map Definition that this viewer will be displaying.
+ * The custom initial starting view.
+ * Visibility of certain viewer elements
+ * The initial task pane url
+
+.. figure:: images/wl_settings.png
+
+ *The General Settings*
+
+When saved, the **AJAX Viewer URL** is used to publically access this web layout from the internet or intranet.
+
+.. note::
+ If you are making this web layout for public consumption over the internet, the host name in the **AJAX Viewer URL**
+ may need to be changed to match the publically accessible domain name. This URL is generated based on the mapagent URL
+ you used when you logged in.
+
Menu and Toolbar Command Layout
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The **Menus and Toolbars** section of the editor allows you to define the command layout of the toolbar and menus in the basic
+AJAX viewer
+
+.. figure:: images/wl_menus_toolbars.png
+
+ *Menus and Toolbars*
+
+The **Available Commands** box lists all the commands (built-in and custom) that can be added to the toolbar and menus
+
+.. note::
+
+ Flyout Menus can only go one level deep. Although the XML schema permits nested flyout menus the AJAX viewer will not respect this.
+
Command Set Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^
-Importing/Exporting Commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The **Commands** section of the editor allows you to add and configure custom commands.
+.. figure:: images/wl_commandset.png
+
+ *Command configuration*
+
+The **Custom Command Properties** box allows you to edit the specific launch parameters of a custom command. There are 3 types of custom commands:
+
+ * Invoke Script
+ * Invoke URL
+ * Search
+
+.. note::
+
+ Consult the MapGuide Developer's Guide for more information about implementing custom commands using the MapGuide API.
+
+For built-in commands. This box provides a read-only view of the command properties.
+
+If you have the same set of custom commands, having to re-add these custom commands to every web layout can be time consuming. The Web Layout editor
+provides you with the ability to export these custom commands out to an XML file. The commands in these XML files can be imported into another Web Layout.
+
+To export commands, click the **Export** toolbar button and select the XML file which you wish to save these exported commands to.
+
+To import commands, click the **Import** toolbar button and select the XML file containing your previously exported commands.
+
Application Definitions
-----------------------
+Application Definitions describe the user interface of a Fusion viewer. The Fusion viewer is more customizable than the basic AJAX viewer in terms of looks and out-of-the-box
+functionality. Looks are defined in terms of templates, functionality is defined in terms of widgets. A Fusion viewer application is a specified template, loaded up with your
+specific selection of widgets.
+
+The Application Definition editor is composed of 4 main sections. Each is described below.
+
Template Selection
^^^^^^^^^^^^^^^^^^
+The **Flexible Layout Settings** section allows you to select the template to use and the title to show when displayed in a web browser.
+
+.. figure:: images/fl_settings.png
+
+ *Template selection panel*
+
+When saved, the **Public URL** will be generated which you allows end users to access this Application Definition publically over the intranet or internet.
+
+.. note::
+ The same public URL generation rules apply to Application Definitions as it does for Web Layouts. It is generated based on the mapagent URL
+ you used when you logged in.
+
Map Configuration
^^^^^^^^^^^^^^^^^
+The **Map Configuration** section allows you to specify the Map Definition that this viewer is for.
+
+.. figure:: images/fl_maps.png
+
+ *Map Configuration*
+
+In addition there are various settings for integrating your map with commercial map layers.
+
+.. note::
+
+ If you use the commerical map layer integration, your map must be in the `WGS84.PseudoMercator` coordinate system. Otherwise your map will not line up with the commercial layers
+
+.. note::
+
+ An API key is required for consuming Yahoo or Google layers. You are bound by the terms and conditions of the respective commercial layer providers you wish to use.
+
Widget and Container Layout
^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The **Widgets** section allows you to configure the layout of toolbar and menu widgets
+
+.. figure:: images/fl_widgets.png
+
+ *Widget and Container Layout*
+
+Selecting a widget reference allows to you point to the correct widget in the widget set.
+
Widget Management
-^^^^^^^^^^^^^^^^^
\ No newline at end of file
+^^^^^^^^^^^^^^^^^
+
+The **Widget Management** dialog allows you to add and configure widgets in the widget set. Widgets in the widget set can then be referenced in the **Widgets** section of the editor.
+
+.. figure:: images/fl_widget_config.png
+
+ *Widget Management Dialog*
+
+Most widgets have a specialized editor to configure widget parameters. For those that don't a generic XML editor is available as a fallback mechanism.
\ No newline at end of file
Modified: trunk/Tools/Maestro/UserDoc/source/understanding_maps.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/understanding_maps.rst 2011-05-24 13:23:57 UTC (rev 5843)
+++ trunk/Tools/Maestro/UserDoc/source/understanding_maps.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -1,25 +1,67 @@
Understanding Map Definitions
=============================
+The Map Definition represents the collection of layers to be displayed. Layers are organised logically into
+groups and can be sorted by drawing order. Individual layer visibility and legend visibily control can be
+configured here.
+
+The Map Definition editor is composed to two sections, both are covered below.
+
Map Settings
------------
-.. image:: images/mdf_settings.png
+The **Map Settings** section of the editor allows you to define the core properties of this Map Definition
+.. figure:: images/mdf_settings.png
+
+You can specify the coordinate system, background color and the initial extents that this map encompasses. The
+coordinate system and initial extents are automatically set when the first layer is added to this map. You can
+re-calculate the extent at any time.
+
+.. note::
+ The coordinate system you specify here is determines the units and coordinates that are displayed when you
+ view this map from the AJAX or Fusion viewer. In addition, it is also used to automatically re-project
+ any layers whose coordinate systems do not match.
+
+.. note::
+ Automatic layer re-projection incurs a minor performance penalty when rendering the map. So if possible
+ ensure that all the layers are in the same coordinate system (as the one you specify here)
+
+.. note::
+ Extent calculation can take some time, especially if there are lots (hundreds) of layers in the Map Definition.
+ In such cases, it is faster to enter the numbers manually.
+
+.. note::
+ Extent calculation can even be inaccurate, especially if one or more layers references a badly set up feature
+ source (eg. A GDAL raster feature source is a common source of bad extents). Again, in such cases manual
+ entry of extents is faster and safer.
+
Layer Configuration
-------------------
+The **Layer Configuration** section allows you to organise the layers in the Map Definition by different facets.
+
+Selecting a layer or group in any of these tabs will allow you to edit the properties of that layer or group
+
Layers by Group
^^^^^^^^^^^^^^^
-.. image:: images/mdf_layers_grouping.png
+The **Layers by Group** tab allows you to organise the layers in your Map Definition logically into groups
+.. figure:: images/mdf_layers_grouping.png
+
+A Layer Group in this view may be converted to a Base Layer Group.
+
Layers by Drawing Order
^^^^^^^^^^^^^^^^^^^^^^^
-.. image:: images/mdf_layers_draworder.png
+The **Layers by Group** tab allows you to organise the layers in your Map Definition by drawing order
+.. figure:: images/mdf_layers_draworder.png
+
Base Layer Groups
^^^^^^^^^^^^^^^^^
-.. image:: images/mdf_layers_base.png
\ No newline at end of file
+The **Base Layer Groups** tab allows you to define and configure tiled layer and group settings
+
+.. figure:: images/mdf_layers_base.png
\ No newline at end of file
Modified: trunk/Tools/Maestro/UserDoc/source/understanding_print_layouts.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/understanding_print_layouts.rst 2011-05-24 13:23:57 UTC (rev 5843)
+++ trunk/Tools/Maestro/UserDoc/source/understanding_print_layouts.rst 2011-05-24 14:41:27 UTC (rev 5844)
@@ -1,2 +1,35 @@
Understanding Print Layouts
-===========================
\ No newline at end of file
+===========================
+
+Print Layouts describe the layout of a DWF plot. DWF plots are produced by the `MgMappingService` service API and the Fusion `SaveMap` widget.
+
+Page and Layout Properties
+--------------------------
+
+The **Page and Layout Properties** section of the editor allows you to configure the properties of this print layout
+
+.. figure:: images/pl_properties.png
+
+ *Page and Layout Properties*
+
+Custom Logos
+------------
+
+The **Custom Logos** section of the editor allows you to configure the logos which will be in this Print Layout.
+
+.. figure:: images/pl_logos.png
+
+ *Custom Logos*
+
+Logos are symbols from a **Symbol Library** resource. Each logo has size and positioning parameters that you can configure via this editor
+
+Custom Text
+-----------
+
+The **Custom Text** section of the editor allows you to configure the text labels which will be in this Print Layout
+
+.. figure:: images/pl_text.png
+
+ *Custom Text*
+
+Each text label has individual size and positioning parameters that you can configure via this editor
\ No newline at end of file
More information about the mapguide-commits
mailing list