[Commits] r1234 - apps/opengeo/geoexplorer/trunk/src/doc
commits at geoext.org
commits at geoext.org
Tue Jul 7 15:34:21 CEST 2009
Author: ahocevar
Date: 2009-07-07 15:34:20 +0200 (Tue, 07 Jul 2009)
New Revision: 1234
Added:
apps/opengeo/geoexplorer/trunk/src/doc/working-with-geoexplorer.rst
Modified:
apps/opengeo/geoexplorer/trunk/src/doc/getting-started.rst
apps/opengeo/geoexplorer/trunk/src/doc/index.rst
Log:
more documentation (see http://projects.opengeo.org/geoext/ticket/272)
Modified: apps/opengeo/geoexplorer/trunk/src/doc/getting-started.rst
===================================================================
--- apps/opengeo/geoexplorer/trunk/src/doc/getting-started.rst 2009-07-06 21:04:08 UTC (rev 1233)
+++ apps/opengeo/geoexplorer/trunk/src/doc/getting-started.rst 2009-07-07 13:34:20 UTC (rev 1234)
@@ -2,4 +2,125 @@
Getting Started
===============
-This is the getting started doc.
\ No newline at end of file
+Installing GeoExplorer on your server
+-------------------------------------
+
+The easiest way to install GeoExplorer is to use the Vulcan Installer. This
+will install GeoServer, GeoExplorer and the required proxy. Once GeoServer is
+started, GeoExplorer can be accessed at
+http://localhost:8080/geoserver/www/GeoExplorer/index.html.
+
+But GeoExplorer will run on any HTTP server, like Apache. All that needs to be
+done is unpack GeoExplorer to a web accessible path on your server. There is
+only server side requirement: an OGC service proxy. If you have Python
+installed, you can e.g. use the OpenGeo python proxy:
+http://svn.opengeo.org/util/proxy/proxy.py. Information on how to configure
+Apache to use that proxy are included in the file.
+
+Initial Configuration
+---------------------
+
+Once installed, GeoExplorer will work out of the box, configured to use
+http://demo.opengeo.org/geoserver/ows as WMS. Starting from here, layers and
+WMS servers can be added and configured as described in the :doc:`Working With
+GeoExplorer <working-with-geoexplorer>` documentation.
+
+If, however, you want to provide a customized application builder, here is how
+to configure it:
+
+The startup WMS or additional WMS servers can be configured by modifying
+GeoExplorer/index.html:
+
+.. code-block:: javascript
+
+ wms: {
+ "demo": "http://demo.opengeo.org/geoserver/ows/"
+ },
+
+"demo" is the key used to reference the WMS in the layer configuration (see
+below). More servers can be added easily, e.g. by changing the above to
+
+.. code-block:: javascript
+
+ wms: {
+ "demo": "http://demo.opengeo.org/geoserver/ows/",
+ "terraserver": "http://terraserver-usa.com/ogccapabilities.ashx"
+ },
+
+Two layers will be loaded by default:
+
+ * Global Imagery (topp:bluemarble) as base layer
+ * USA Population (topp:states) as overlay
+
+The layers to be loaded at startup can be configured in GeoExplorer/index.html:
+
+.. code-block:: javascript
+
+ map: {
+ layers: [{
+ name: "topp:bluemarble",
+ title: "Global Imagery",
+ wms: "demo",
+ group: "background"
+ }, {
+ name: "topp:states",
+ wms: "demo",
+ visibility: true
+ }],
+ center: [-96.7, 37.6],
+ zoom: 4
+ }
+
+The ``name`` property of the layers (e.g. "topp:states" in the above snippet)
+are the layer names from the Capabilities document of the
+WMS (see
+`<http://demo.opengeo.org/geoserver/ows/?SERVICE=WMS&REQUEST=GetCapabilities>`_
+for a complete example):
+
+.. code-block:: xml
+
+ <Layer queryable="1">
+ <Name>topp:states</Name>
+ <Title>USA Population</Title>
+ <Abstract>This is some census data on the states.</Abstract>
+ <KeywordList>
+ <Keyword>census</Keyword>
+ <Keyword>united</Keyword>
+ <Keyword>boundaries</Keyword>
+ <Keyword>state</Keyword>
+ <Keyword>states</Keyword>
+ </KeywordList>
+ <SRS>EPSG:4326</SRS>
+ <LatLonBoundingBox minx="-125.30903773" miny="7.705448770000002" maxx="-66.39223326999999" maxy="66.62225323"/>
+ <BoundingBox SRS="EPSG:4326" minx="-124.73142200000001" miny="24.955967" maxx="-66.969849" maxy="49.371735"/>
+ <Style>
+ <Name>population</Name>
+ <Title>Population in the United States</Title>
+ <Abstract>A sample filter that filters the United States into three
+ categories of population, drawn in different colors</Abstract>
+ <LegendURL width="20" height="20">
+ <Format>image/png</Format>
+ <OnlineResource xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://demo.opengeo.org/geoserver/wms/GetLegendGraphic?VERSION=1.0.0&FORMAT=image/png&WIDTH=20&HEIGHT=20&LAYER=topp:states"/>
+ </LegendURL>
+ </Style>
+ </Layer>
+
+The ``title`` property is optional. By default, the title from the
+Capabilities document will be used.
+
+The ``wms`` property tells the application on which server to find the layer.
+If we would like to add a layer from the "terraserver" WMS that we configured
+above, we would simply set ``wms`` to "terraserver".
+
+Layers that should not be visible when loading the application, but shown in
+the layer tree, can be configured with the ``visibility`` property set to
+false.
+
+Layers with the ``group`` property set to "background" will be base layers.
+Only one base layer can be visible at a time.
+
+The ``center`` and ``zoom`` properties are also optional. If not provided,
+the map extent will be set to the LatLonBoundingBox specified in the
+Capabilities document. For a configuration with more than one layers, the
+extent will be taken from the first layer in the "background" group, or the
+first layer if there are no layers in the "background" group.
\ No newline at end of file
Modified: apps/opengeo/geoexplorer/trunk/src/doc/index.rst
===================================================================
--- apps/opengeo/geoexplorer/trunk/src/doc/index.rst 2009-07-06 21:04:08 UTC (rev 1233)
+++ apps/opengeo/geoexplorer/trunk/src/doc/index.rst 2009-07-07 13:34:20 UTC (rev 1234)
@@ -2,7 +2,7 @@
GeoExplorer
===========
-Quickly assembly rich mapping applications from multiple :term:`OGC` Web Mapping
+Quickly assemble rich mapping applications from multiple :term:`OGC` Web Mapping
Services (:term:`WMS`) with GeoExplorer. Using the publish wizard, embed your
mapping application in any web page.
@@ -12,6 +12,7 @@
.. toctree::
getting-started
+ working-with-geoexplorer
glossary
license
@@ -24,16 +25,15 @@
on getting started with GeoExplorer, see the :doc:`introductory <getting-started>`
documentation.
-#. Open up GeoExplorer in your browser.
+#. Open up `GeoExplorer <../>`_ in your browser.
#. Use the add and remove buttons to choose which layers will be included in
your application.
-#. From the "Available Layers" dialog, add a new WMS server (e.g.
+#. From the "Available Layers" dialog, add new WMS servers (e.g.
http://terraserver-usa.com/ogccapabilities.ashx).
#. Reorder layers by dragging
them around. Only one layer at a time can be visible in the "Base Layers"
group.
#. Launch the "Publish Map" wizard to embed your application in any web page.
-
-
-
+For a more detailled description of what you can do with GeoExplorer, see the
+:doc:`Working With GeoExplorer <working-with-geoexplorer>` documentation.
\ No newline at end of file
Added: apps/opengeo/geoexplorer/trunk/src/doc/working-with-geoexplorer.rst
===================================================================
--- apps/opengeo/geoexplorer/trunk/src/doc/working-with-geoexplorer.rst (rev 0)
+++ apps/opengeo/geoexplorer/trunk/src/doc/working-with-geoexplorer.rst 2009-07-07 13:34:20 UTC (rev 1234)
@@ -0,0 +1,76 @@
+========================
+Working With GeoExplorer
+========================
+
+Overview
+--------
+
+GeoExplorer is divided into four areas:
+
+* The main area is covered by the map with the map controls for zooming and
+ panning.
+
+* The button bar on top contains the following buttons:
+
+ - GeoExplorer: click to see about information and credits.
+ - Publish map: click to open a wizard for building an embeddable map widget
+ with the layers you are currently viewing.
+ - Bookmark: click to create a permalink for a GeoExplorer configured
+ with the layers and extent you are currently looking at.
+ - Pan Map: enabled by default, for dragging the map with the mouse and
+ zooming by shift-click-dragging an extent rectangle.
+ - Get Feature Info: if active, clicking on the map will open a Feature
+ Info Popup for the clicked location and the currently visible layers.
+ if they are queryable.
+ - Measure: an expandable button for measuring distance and area when
+ active. To measure, click on the map, drawing a line for distance or a
+ polygon for area measurement. Freehand measuring can be activated by
+ pressing and holding the shift key. Double click on the map to draw the
+ last vertex of the measurement line or polygon. The distance or area will
+ be displayed in a small popup.
+ - Zoom in: click to zoom in by one zoom level.
+ - Zoom out: click to zoom out by one zoom level.
+ - Zoom to previous extent: click to zoom to the extent you were previously
+ viewing.
+ - Zoom to next extent: after using the ``Zoom to previous extent`` button,
+ click to zoom to the next extent.
+ - Zoom to visible extent: click to view the largest possible area
+
+* The Layers panel for managing layers:
+
+ - Click (+) to add layers.
+ - Click (-) to remove the currently selected layer.
+ - Drag and drop layers to change layer order.
+ - Click checkboxes or radio buttons to make layers visible/invisible.
+ - Click on the layer name to select a layer.
+ - Double click on a layer to toggle visibility.
+ - Right click on a layer to show a context menu, allowing to zoom to the
+ layer extent or to remove the layer.
+
+* The Legend panel displaying a legend for every visible layer.
+
+Adding Layers
+-------------
+
+Clicking on the (+) button in the layers panel will open the ``Available
+Layers`` dialog. The grid lists all layers available on the currently
+selected WMS server. Clicking on the [+] next to each layer, meta information
+about the layer will be displayed. Double click a layer row in the grid, or
+select layers and click ``Add Layers`` to add them to the map.
+
+To see layers from a different WMS server in the grid, select a server from
+the ``View available data from:`` combo box, or add a new WMS server by
+clicking on ``or add a new server``. A small window will pop up, where a
+WMS service URL can be entered (e.g.
+http://terraserver-usa.com/ogccapabilities.ashx).
+
+Publishing A Map Widget
+-----------------------
+
+Based on the currently configured layers and extent, an embeddable map widget
+can be created by clicking the ``Publish Map`` button on the button bar.
+
+In the first page of the wizard, select the initial visibility of the layers.
+On the second page, the map size can be specified, either by selecting a
+pre-configured size from the dropdown, or enter a width and height. When you
+are satisfied, copy the HTML and paste it in your website. That's it!
\ No newline at end of file
More information about the Commits
mailing list