[mapguide-commits] r6224 - in trunk/Tools/Maestro/UserDoc/source: .
images
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Mon Nov 14 05:05:28 EST 2011
Author: jng
Date: 2011-11-14 02:05:28 -0800 (Mon, 14 Nov 2011)
New Revision: 6224
Added:
trunk/Tools/Maestro/UserDoc/source/images/connect_local.png
trunk/Tools/Maestro/UserDoc/source/images/local_repository.png
trunk/Tools/Maestro/UserDoc/source/images/package_add_resource.png
trunk/Tools/Maestro/UserDoc/source/images/package_editor.png
trunk/Tools/Maestro/UserDoc/source/images/package_failed_operations.png
trunk/Tools/Maestro/UserDoc/source/images/package_load_options.png
trunk/Tools/Maestro/UserDoc/source/images/package_non_trans.png
trunk/Tools/Maestro/UserDoc/source/local_connection_mode.rst
Modified:
trunk/Tools/Maestro/UserDoc/source/index.rst
trunk/Tools/Maestro/UserDoc/source/installation.rst
trunk/Tools/Maestro/UserDoc/source/packaging.rst
Log:
Update User Documentation for 4.0
Added: trunk/Tools/Maestro/UserDoc/source/images/connect_local.png
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/connect_local.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/local_repository.png
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/local_repository.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/package_add_resource.png
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/package_add_resource.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/package_editor.png
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/package_editor.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/package_failed_operations.png
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/package_failed_operations.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/package_load_options.png
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/package_load_options.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/Tools/Maestro/UserDoc/source/images/package_non_trans.png
===================================================================
(Binary files differ)
Property changes on: trunk/Tools/Maestro/UserDoc/source/images/package_non_trans.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Modified: trunk/Tools/Maestro/UserDoc/source/index.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/index.rst 2011-11-13 04:50:00 UTC (rev 6223)
+++ trunk/Tools/Maestro/UserDoc/source/index.rst 2011-11-14 10:05:28 UTC (rev 6224)
@@ -35,6 +35,7 @@
packaging
mgcooker
localpreview
+ local_connection_mode
other_tools
other_resources
Modified: trunk/Tools/Maestro/UserDoc/source/installation.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/installation.rst 2011-11-13 04:50:00 UTC (rev 6223)
+++ trunk/Tools/Maestro/UserDoc/source/installation.rst 2011-11-14 10:05:28 UTC (rev 6224)
@@ -14,7 +14,11 @@
.. note::
MapGuide Maestro requires .net Framework 2.0 or higher installed. For Windows Vista or newer versions of Windows, this is already installed.
+
+.. note::
+ As of the 4.0 release of Maestro, the zip package differs from the installer package in that the zip package does not include the :doc:`Local Connection Mode <local_connection_mode>` feature.
+
Installing on Linux/Mac OSX
---------------------------
@@ -22,7 +26,7 @@
The installation is simply unzipping the file::
- unzip "MapGuideMaestro-3.0.0-Release.zip"
+ unzip "MapGuideMaestro-4.0.0-Release.zip"
Then run the application::
@@ -41,4 +45,8 @@
**Please note that Mono support for WinForms is not 100% stable.** Even though WinForms is feature complete, some features do not work flawlessly. This means that there are occasional drawing problems. Flipping a tab page back and forth usually solves the problem. Some buttons are missing, because Mono renders them outside the visible area. There are also some issues with certain icons.
For best results, use the most current release of Mono (currently 2.10.2) where possible. The minimum usable release is Mono 2.0 (this was the release where WinForms was 100% API complete)
+
+.. note::
+ The :doc:`Local Connection Mode <local_connection_mode>` feature is only available on windows. The zip package does not include this feature.
+
Added: trunk/Tools/Maestro/UserDoc/source/local_connection_mode.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/local_connection_mode.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/local_connection_mode.rst 2011-11-14 10:05:28 UTC (rev 6224)
@@ -0,0 +1,35 @@
+.. _local-connection-mode:
+
+The Local Connection Mode
+=========================
+
+The Local Connection Mode is a new feature of Maestro 4.0 that allows you to work with a resource repository that is local on your machine.
+
+The Local Connection Mode is designed for the following user scenarios:
+
+ * Authoring resources and spatial data locally without requiring any connectivity to a MapGuide Server
+ * Authoring/editing resources for a `mg-desktop <http://mg-desktop.googlecode.com>`_ based application
+
+.. note::
+
+ The Local Connection Mode feature is only available on Windows.
+
+.. note::
+
+ The physical location of the local repository is situated in: %APPDATA%\MgLocal\Repositories
+
+To connect to your local repository, select the **Connect Locally** option.
+
+.. figure:: images/connect_local.png
+
+ * Connecting to the local repository *
+
+For the **Platform Configuration File**, select the **Platform.ini** file in the Maestro installation directory. Then click **OK** to connect to your local repository.
+
+.. figure:: images/local_repository.png
+
+At this point, your local repository functions pretty much like a MapGuide Server repository. You can load packages into this repository and you can package data from this repository.
+
+.. note::
+
+ If the **Connect Locally** option is disabled on Windows, you can enable it by running **LocalConfigure.exe** in your Maestro installation directory. This program is automatically run the first time Maestro is run (after installation)
\ No newline at end of file
Modified: trunk/Tools/Maestro/UserDoc/source/packaging.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/packaging.rst 2011-11-13 04:50:00 UTC (rev 6223)
+++ trunk/Tools/Maestro/UserDoc/source/packaging.rst 2011-11-14 10:05:28 UTC (rev 6224)
@@ -13,6 +13,7 @@
* 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.
+ * Questionable reliability with really large package files.
MapGuide Maestro however, allows you to load and create such packages **completely on the client-side**.
@@ -35,9 +36,70 @@
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.
+will refresh itself. When loading a package, you will be presented with the following options:
+.. figure:: images/package_load_options.png
+
+ *Package loading options*
+
+Each option is described below.
+
+Transactional Loading
+^^^^^^^^^^^^^^^^^^^^^
+
+Transactional loading is the default loading mechanism. There is no way to measure loading progress, but the operation itself will either wholly succeed or wholly fail (hence the transactional nature of this operation). This operation is safe to use on small to moderately sized package files, and does not affect the integrity of the repository regardless of the result.
+
+Non-Transactional Loading
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Non-transactional loading is a new loading mechanism designed to work around the limitations of the default loading mechanism:
+
+ * The inability to measure/track progress
+ * More reliability with loading large package files (several hundred MBs in size)
+
+With the non-transaction loading approach, progress can be measured:
+
+.. figure:: images/package_non_trans.png
+
+ *Non-transactional packaging progress*
+
+Should any package operations fail, they are logged and presented to the user at the end of the operation.
+
+.. figure:: images/package_failed_operations.png
+
+ *Failed Non-transactional packaging operations*
+
+At this point you can retry these failed operations, and only the failed operations will be re-executed. Otherwise you can close the dialog to complete this package loading operation.
+
.. 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
+ 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)
+
+Editing Packages
+----------------
+
+Maestro also includes a package editing tool. To edit a package, select **Package - Package Editor** from the menu. Select the package file to edit, and the Package Editor dialog will be displayed.
+
+.. figure:: images/package_editor.png
+
+ *Package Editor Dialog*
+
+The Package Editor shows the layout of the Package and the resources that would be created if this package were to be loaded.
+
+Package Editing Options
+^^^^^^^^^^^^^^^^^^^^^^^
+
+To create a new folder, select **New Folder** to create a new folder at the selected folder node. To edit the name of this folder, click the node label until an edit box appears.
+
+To create a new resource to be loaded, select **New Resource** to create a new resource entry at the selected resource node. You will get a dialog to specify the location of the resource content file
+
+.. figure:: images/package_add_resource.png
+
+ *Add Resource Dialog*
+
+To delete a folder or resource, select the node and click **Delete** to delete the selected resource or folder node.
+
+To add resource data for a resource entyr, select the resource node and use the **Data Files** user interface to add your resource data files.
+
+Once you have made your changes, click **OK** to save this to a new package. Clicking **Cancel** will discard all modifications
\ No newline at end of file
More information about the mapguide-commits
mailing list