[mapguide-commits] r5820 - in trunk/Tools/Maestro/UserDoc/source: . images

[svn_mapguide at osgeo.org]

Author: jng
Date: 2011-05-18 10:02:18 -0700 (Wed, 18 May 2011)
New Revision: 5820

Added:
   trunk/Tools/Maestro/UserDoc/source/images/ds_editor.PNG
   trunk/Tools/Maestro/UserDoc/source/images/ldf_drawing_settings.PNG
   trunk/Tools/Maestro/UserDoc/source/images/ldf_raster_advanced.PNG
   trunk/Tools/Maestro/UserDoc/source/images/ldf_raster_settings.PNG
   trunk/Tools/Maestro/UserDoc/source/images/ldf_raster_visibility.PNG
   trunk/Tools/Maestro/UserDoc/source/images/ldf_vector_label.PNG
   trunk/Tools/Maestro/UserDoc/source/images/ldf_vector_rule_control.PNG
   trunk/Tools/Maestro/UserDoc/source/images/lp_load_settings.PNG
   trunk/Tools/Maestro/UserDoc/source/images/lp_source_files.png
   trunk/Tools/Maestro/UserDoc/source/images/lp_trans_settings.png
Modified:
   trunk/Tools/Maestro/UserDoc/source/differences.rst
   trunk/Tools/Maestro/UserDoc/source/understanding_drawing_sources.rst
   trunk/Tools/Maestro/UserDoc/source/understanding_feature_sources.rst
   trunk/Tools/Maestro/UserDoc/source/understanding_layers.rst
   trunk/Tools/Maestro/UserDoc/source/understanding_load_procedures.rst
Log:
#1677: More content and screenshots for the user guide.

Modified: trunk/Tools/Maestro/UserDoc/source/differences.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/differences.rst	2011-05-18 16:54:07 UTC (rev 5819)
+++ trunk/Tools/Maestro/UserDoc/source/differences.rst	2011-05-18 17:02:18 UTC (rev 5820)
@@ -1,8 +1,12 @@
+.. _maestro-differences:
+
 Differences between Maestro and MapGuide Studio
 ===============================================
 
-Note: As of the 2012 release, MapGuide Enterprise is now known as Autodesk Infrastructure Map Server and the MapGuide Studio product is now called Autodesk Infrastructure Studio. This section will refer to these products by their old names.
+.. note::
 
+ As of the 2012 release, MapGuide Enterprise is now known as Autodesk Infrastructure Map Server and the MapGuide Studio product is now called Autodesk Infrastructure Studio. This section will refer to these products by their old names.
+
 Both Maestro and MapGuide Studio fulfill the same purpose: To create, author and publish spatial data on a MapGuide Server. However there are some main differences:
 
  * MapGuide Studio is a commerical product that comes with a MapGuide Enterprise licence only. It cannot be purchased separately.

Added: trunk/Tools/Maestro/UserDoc/source/images/ds_editor.PNG
===================================================================
(Binary files differ)


Property changes on: trunk/Tools/Maestro/UserDoc/source/images/ds_editor.PNG
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/Tools/Maestro/UserDoc/source/images/ldf_drawing_settings.PNG
===================================================================
(Binary files differ)


Property changes on: trunk/Tools/Maestro/UserDoc/source/images/ldf_drawing_settings.PNG
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/Tools/Maestro/UserDoc/source/images/ldf_raster_advanced.PNG
===================================================================
(Binary files differ)


Property changes on: trunk/Tools/Maestro/UserDoc/source/images/ldf_raster_advanced.PNG
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/Tools/Maestro/UserDoc/source/images/ldf_raster_settings.PNG
===================================================================
(Binary files differ)


Property changes on: trunk/Tools/Maestro/UserDoc/source/images/ldf_raster_settings.PNG
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/Tools/Maestro/UserDoc/source/images/ldf_raster_visibility.PNG
===================================================================
(Binary files differ)


Property changes on: trunk/Tools/Maestro/UserDoc/source/images/ldf_raster_visibility.PNG
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/Tools/Maestro/UserDoc/source/images/ldf_vector_label.PNG
===================================================================
(Binary files differ)


Property changes on: trunk/Tools/Maestro/UserDoc/source/images/ldf_vector_label.PNG
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/Tools/Maestro/UserDoc/source/images/ldf_vector_rule_control.PNG
===================================================================
(Binary files differ)


Property changes on: trunk/Tools/Maestro/UserDoc/source/images/ldf_vector_rule_control.PNG
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/Tools/Maestro/UserDoc/source/images/lp_load_settings.PNG
===================================================================
(Binary files differ)


Property changes on: trunk/Tools/Maestro/UserDoc/source/images/lp_load_settings.PNG
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/Tools/Maestro/UserDoc/source/images/lp_source_files.png
===================================================================
(Binary files differ)


Property changes on: trunk/Tools/Maestro/UserDoc/source/images/lp_source_files.png
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/Tools/Maestro/UserDoc/source/images/lp_trans_settings.png
===================================================================
(Binary files differ)


Property changes on: trunk/Tools/Maestro/UserDoc/source/images/lp_trans_settings.png
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Modified: trunk/Tools/Maestro/UserDoc/source/understanding_drawing_sources.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/understanding_drawing_sources.rst	2011-05-18 16:54:07 UTC (rev 5819)
+++ trunk/Tools/Maestro/UserDoc/source/understanding_drawing_sources.rst	2011-05-18 17:02:18 UTC (rev 5820)
@@ -1,2 +1,17 @@
 Understanding Drawing Sources
-=============================
\ No newline at end of file
+=============================
+
+Drawing Sources represent DWF-based drawing data. Drawing Sources provide full visual styling of the original DWF, but the associated data
+lacks any intelligence or viewer interaction elements. As such, the primary purpose of Drawing Sources is to provide a CAD-based contextual
+backdrop for your maps.
+
+This section covers the Drawing Source editor.
+
+.. figure:: images/ds_editor.png
+
+ *The Drawing Source Editor interface*
+ 
+The Drawing Source editor is very simple, only requiring 2 fields of input.
+
+ * The source DWF file embedded as a resource data file. The marked one is designated for this Drawing Source.
+ * The coordinate system of this drawing source.
\ No newline at end of file

Modified: trunk/Tools/Maestro/UserDoc/source/understanding_feature_sources.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/understanding_feature_sources.rst	2011-05-18 16:54:07 UTC (rev 5819)
+++ trunk/Tools/Maestro/UserDoc/source/understanding_feature_sources.rst	2011-05-18 17:02:18 UTC (rev 5820)
@@ -42,22 +42,53 @@
 Maestro provides a specialized feature source editor for the most frequently used FDO providers. For third party or other unrecognised FDO providers, a generic editor is
 available to configure the connection parameters to your particular data store.
 
-.. image:: images/fs_generic.png
+.. figure:: images/fs_generic.png
+   
+   *The Generic Feature Source Editor*
 
+If a connection property involves an embedded data file, upload the file first as a **Resource Data File** and you can reference it 
+by prefixing `%MG_DATA_FILE_PATH%` in front of the resource data file name.
+
 Coordinate System Overrides
 ---------------------------
 
-TODO
+The Coordinate System Overrides section of the editor allows you to override the coordinate systems of this Feature Source. 
 
-.. image:: images/fs_cs_overrides.png
+.. figure:: images/fs_cs_overrides.png
+   
+   *The Coordinate System Overrides Editor*
 
+For example, a Feature Source may report an Arbitrary or incorrectly specified coordinate system, but the actual geometries themselves 
+have real world geographical relevance. You can use this editor to replace this Arbitrary coordinate system with a different coordinate 
+system. 
+
+This is  important if you require MapGuide to transform data. The source and target coordinate systems need to be correct. This override 
+mechanism allows you to fix the source side of the transformation.
+
 Joins and Extensions
 --------------------
 
-TODO
+The Joins and Extensions section of the editor allows you to define **Extended Feature Classes**.
 
-.. image:: images/fs_extensions.png
+.. figure:: images/fs_extensions.png
 
+   *The Joins and Extensions Editor*
+
+Extended Feature Classes extend a given feature class in the edited feature source with:
+
+ * Extra calculated properties derived from FDO expressions
+ * Extra properties from another Feature Class in another Feature Source by performing a **Feature Join**
+ 
+If extending a Feature Class via a **Feature Join** you may choose the type of join to perform:
+
+ * Left Outer
+ * Right Outer
+ * Inner 
+ 
+Also you have to specify at least one property from both participating Feature Classes that will be joined on.
+
+Finally you can force a 1-to-1 cardinality to avoid redundant secondary Feature Class attributes for each primary feature or vice versa.
+
 .. note::
 
     Feature Join performance is generally bad, especially when the join is performed across Feature Classes from different Feature Sources for different FDO providers. Consider doing joins at the database level, outside of MapGuide
\ No newline at end of file

Modified: trunk/Tools/Maestro/UserDoc/source/understanding_layers.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/understanding_layers.rst	2011-05-18 16:54:07 UTC (rev 5819)
+++ trunk/Tools/Maestro/UserDoc/source/understanding_layers.rst	2011-05-18 17:02:18 UTC (rev 5820)
@@ -7,88 +7,234 @@
  * Drawing Layer Definitions
  * Grid (Raster) Layer Definitions
  
-Vector Layer Definitions describe style and presentation settings for vector data coming from a Feature Source
+**Vector Layer Definitions** describe style and presentation settings for vector data coming from a Feature Source. Structurally, a Vector
+Layer Definition has:
 
-Drawing Layer Definitions describe presentation settings for data coming from a Drawing Source
+ * 1 or more Scale Ranges
+ * Each Scale Range can have 1 or more point/area/line rules. Creating a theme will auto-generate a certain number of point/area/line rules based on the theming criteria.
 
-Raster Layer Definitions describe style and presentation settings for raster data coming from a Feature Source
+**Drawing Layer Definitions** describe presentation settings for data coming from a Drawing Source. A Drawing Source layer simply specifies 
+the DWF layers from the Drawing Source that will be displayed for this Layer Definition
 
-Vector Layer Settings
----------------------
+**Raster Layer Definitions** describe style and presentation settings for raster data coming from a Feature Source. Structurally a Raster
+Layer Definition has a single scale range, with a specified color style and optional hillshade and elevation settings.
 
-Basic Layer Properties
-^^^^^^^^^^^^^^^^^^^^^^
+This section describes the Layer Definition editor and its various settings.
 
-TODO
+Vector Layer Editor
+-------------------
 
-.. image:: images/ldf_vector_settings.png
+Resource Settings
+^^^^^^^^^^^^^^^^^
 
-TODO
+The **Resource Settings** section of the Vector Layer editor specifies the core properties of this Vector Layer
 
-Layer Property Mappings
-^^^^^^^^^^^^^^^^^^^^^^^
+.. figure:: images/ldf_vector_settings.png
 
-TODO
+ *Resource Settings section*
 
-.. image:: images/ldf_vector_property_mappings.png
+The **Feature Source** field specifies the Feature Source this Layer Definition applies to. The **Feature Class** field and **Geometry Property**
+fields specifies the Geometry property that these style settings will be applied to.
 
-TODO
+All the fields under the **Layer Settings** group specify viewer interaction behaviors:
 
-Layer Scale Ranges
-^^^^^^^^^^^^^^^^^^
+ * **Filter** specifies an FDO attribute filter that will be applied when querying data from the Feature Source for rendering
+ * **Hyperlink** specifies an FDO expression that represents the URL that will be launched when the user CTRL+clicks on a feature in this layer
+ * **Tooltip** specifics an FDO expression that represents the HTML content that is displayed in a tooltip when the user hovers over any feature on this layer with the mouse pointer.
 
-TODO
+Layer Properties Visible in Viewer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. image:: images/ldf_vector_scale_range.png
+The **Layer Properties Visible in Viewer** section of the editor specifies what properties of this layer are visible in the **Properties Pane** of the AJAX or Fusion viewer when a feature
+from this layer is selected.
 
-TODO
+.. figure:: images/ldf_vector_property_mappings.png
 
+ *Layer Properties Visible in Viewer*
+
+Simply tick the desired properties to make them visible. You can edit cells in the **Display Name** column to change the label for each property.
+
+Layer Styles
+^^^^^^^^^^^^
+
+The **Layer Styles** section is the meat and potatoes of this editor. 
+
+.. figure:: images/ldf_vector_scale_range.png
+
+ *Layer Styles*
+ 
+The above screenshot shows an editor for one particular scale range (0 to 10000). Clicking **Add** on the toolbar will add another control
+for a new scale range. Each scale range has:
+
+ * 0 or more point styles. Un-ticking **Display points** will detach all currently specified point styles.
+ * 0 or more line styles. Un-ticking **Display lines** will detach all currently specified line styles.
+ * 0 or more area (polygon) styles. Un-ticking **Display areas** will detach all currently specified area styles.
+
+Each point/line/area style is represented by a control like the one below
+
+.. figure:: images/ldf_vector_rule_control.png
+
+ *A style rule control*
+ 
+These controls will allow you to edit (from left to right):
+
+ * The FDO filter that a feature must satisfy for this rule to be applied (default is empty = all features). Clicking the button will launch the FDO Expression Editor.
+ * The legend label for this rule
+ * The style preview for this rule. Clicking the button will launch the respective point/line/area style editor.
+ * The feature label. Clicking the button will launch the FDO Expression Editor.
+ 
+Rules can be added by clicking the add button on the top toolbar (indicated by a green plus icon).
+
+A theme can be generated by clicking on the theme button on the top toolbar (indicated by 3 overlapping circles of different colors). See :ref:`ldf-theming-layers` for more information.
+
+Rules can be removed by clicking the remove button for the associated rule style control (indicated by a red minus icon)
+
+.. _ldf-theming-layers:
+
 Theming Layers
 ^^^^^^^^^^^^^^
 
-TODO
+Clicking the theme button will display the following dialog
 
-.. image:: images/ldf_vector_theme_generator.png
+.. figure:: images/ldf_vector_theme_generator.png
 
-TODO
+ *The theme creator dialog*
+ 
+This dialog provides all the options for generating a theme, which can be based on:
 
+ * All values of a specific property
+ * All ranges/distributions of a specific property
+
+Each generated rule wil use a color from a specified color ramp. The color ramp can be gradient-based or use
+ColorBrewer thematics.
+
+Once you have specified the theme settings and clicked **OK**, the matching rules will be generated and will replace
+or be appended to your existing set of style rules for this scale range.
+
 Point Style Rules
 ^^^^^^^^^^^^^^^^^
 
-TODO
+Clicking the **...** button beside the previewed point style on the rule editor control will display the Point Style Dialog
 
-.. image:: images/ldf_vector_point_rule.png
+.. figure:: images/ldf_vector_point_rule.png
 
-TODO
+ *The Point Style dialog*
+ 
+There are many options here, but this guide will only cover the main ones.
 
+Point features can be drawn as symbols or as text labels. The **Display Points** checkbox governs this behavior. Ticking it will
+cause these points to be drawn as symbols. Un-ticking it will cause these points to be drawn as text. The symbol size and rotation
+parameters can either be numbers or numerical FDO expressions.
+
+For point symbology, you can choose a pre-defined list of symbols under the **Symbol** dropdown. The very last option 
+in that dropdown (`Symbol`) allows you to pick a custom symbol from an existing **Symbol Library** resource.
+
+Note that the generated preview at the bottom of the dialog is not perfect and does not exactly reflect the style settings
+you have defined. Use the **Preview** command in the main toolbar to view this Layer in your system default web browser. Here
+you can better verify your point style settings are correct.
+
 Line Style Rules
 ^^^^^^^^^^^^^^^^
 
-TODO
+Clicking the **...** button beside the previewed line style on the rule editor control will display the Line Style Dialog
 
-.. image:: images/ldf_vector_line_rule.png
+.. figure:: images/ldf_vector_line_rule.png
 
-TODO
+ *The Line Style Dialog*
 
-.. image:: images/ldf_vector_line_rule_composite.png
+Just like point rules, line rules need not actually display lines. Line rules can display text. If so, the text labels will
+be rendered along the line geometry of each matching feature, but the line itself will not be rendered. The **Apply line style**
+checkbox governs whether the lines will be rendered. 
 
-TODO
+You can specify color, thickness and line pattern for the line style. Size context and units govern how the thickness
+parameter is to be interpreted when rendering.
 
+Line styles can be single or composite. The **Use composite lines** checkbox determines whether the line style will be single or composite. 
+
+.. figure:: images/ldf_vector_line_rule_composite.png
+
+ *The Line Style Dialog with composite settings enabled*
+ 
+Composite line styles consists of multiple line patterns stacked on top of each other to form a composite line style. Line 
+geometries of each matching feature will be rendered with this line style. To add or remove lines from the composite line style,
+use the **Add** and **Remove** buttons on the Composite Line toolbar.
+
 Area Style Rules
 ^^^^^^^^^^^^^^^^
 
-TODO
+Clicking the **...** button beside the previewed area style on the rule editor control will display the Area Style Dialog
 
-.. image:: images/ldf_vector_area_rule.png
+.. figure:: images/ldf_vector_area_rule.png
 
-TODO
+ *The Area Style Dialog*
+ 
+This dialog allows you to control the two main aspects of an area style:
 
-Drawing Layer Settings
-----------------------
+ * The fill display
+ * The edge/border display
+ 
+Once again, the preview at the bottom of the dialog reflects your current style settings. 
 
-TODO
+Label Settings
+^^^^^^^^^^^^^^
 
+Clicking the **...** button beside the label preview on the rule editor control will display the Label Settings Dialog
+
+.. figure:: images/ldf_vector_label.png
+
+ *The Label Settings Dialog*
+ 
+This dialog allows you to control the labelling of line/area/point styles. Label text can be hard-coded strings or more commonly: derived
+from an FDO expression or a Feature Class Property.
+
+Drawing Layer Editor
+--------------------
+
+Just like the Drawing Source editor, the Drawing Layer editor is pretty simple and straight forward.
+
+.. figure:: images/ldf_drawing_settings.png
+
+ *The Drawing Layer Editor*
+ 
+All you need to specify are:
+
+ * The Drawing Source this layer will read from.
+ * The DWF sheet this layer will read from.
+ * The DWF layers this layer will read from.
+ * The min/max scale that this Drawing Layer will be visible at.
+
+Raster Layer Editor
+-------------------
+
 Raster Layer Settings
----------------------
+^^^^^^^^^^^^^^^^^^^^^
 
-TODO
\ No newline at end of file
+The Raster Layer editor defines style settings for raster data coming from a Feature Source.
+
+.. figure:: images/ldf_raster_settings.png
+
+ *Raster Layer Settings*
+ 
+Just like the Vector Layer editor, the Raster Layer editor requires a reference to a **Feature Source** and
+the **Geometry Property** (Raster Property) of a **Feature Class** so it knows where to source its raster 
+data from.
+ 
+Raster Layer Visibility
+^^^^^^^^^^^^^^^^^^^^^^^ 
+
+The Raster Layer Visibility settings govern what scale this Raster Layer is visible at.  
+ 
+.. figure:: images/ldf_raster_visibility.png
+
+ *Raster Layer Visibility*
+ 
+You can also define bitonal image color settings and the zoom factor which the raster is rebuilt.
+
+Advanced Raster Settings
+^^^^^^^^^^^^^^^^^^^^^^^^
+ 
+The Advanced Raster Settings allows you to enable settings for raster formats that support such settings.
+ 
+.. figure:: images/ldf_raster_advanced.png
+
+ *Advanced Raster Layer Settings*
\ No newline at end of file

Modified: trunk/Tools/Maestro/UserDoc/source/understanding_load_procedures.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/understanding_load_procedures.rst	2011-05-18 16:54:07 UTC (rev 5819)
+++ trunk/Tools/Maestro/UserDoc/source/understanding_load_procedures.rst	2011-05-18 17:02:18 UTC (rev 5820)
@@ -1,8 +1,43 @@
 Understanding Load Procedures
 =============================
 
+Load Procedures are resources which describe how to load a certain set of data files into the MapGuide Server.
+
+Load Procedures are a very quick way to load spatial data files into MapGuide or to refresh existing resources. However, unlike MapGuide Studio, Maestro only
+supports a subset of the features exposed by the Load Procedure schema. See :ref:`maestro-differences` for more information.
+
+This section will cover the Load Procedure Editor
+
 Source Files
 ------------
 
+The source file section of the editor shows all the source data files that the Load Procedure will load when executed
+
+.. image:: images/lp_source_files.png
+
+You can add or remove files from this list. 
+
+.. note::
+
+    When executing a Load Procedure, Maestro will look for the source files on the **machine running Maestro**, and not the machine that's running the MapGuide Server.
+    Keep this in mind when executing this Load Procedure from another Maestro installation.
+
 Transformation Settings
------------------------
\ No newline at end of file
+-----------------------
+
+The transformation settings section of the editor shows all the data transformation options available for the Load Procedure.
+
+.. image:: images/lp_trans_settings.png
+
+Elements that are disabled are not supported by Maestro and are ignored during execution.
+
+Transformation settings vary from different Load Procedure types.
+
+Load Settings
+-------------
+
+The load settings section of the editor allows you to specify where the generated resources will be loaded into.
+
+.. image:: images/lp_load_settings.png
+
+Clicking **Load Resources** will execute the Load Procedure with the current settings.
\ No newline at end of file