Changeset 1234

Show
Ignore:
Timestamp:
07/07/09 15:34:20 (4 years ago)
Author:
ahocevar
Message:

more documentation (see http://projects.opengeo.org/geoext/ticket/272)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • apps/opengeo/geoexplorer/trunk/src/doc/getting-started.rst

    r1224 r1234  
    33=============== 
    44 
    5 This is the getting started doc. 
     5Installing GeoExplorer on your server 
     6------------------------------------- 
     7 
     8The easiest way to install GeoExplorer is to use the Vulcan Installer. This 
     9will install GeoServer, GeoExplorer and the required proxy. Once GeoServer is 
     10started, GeoExplorer can be accessed at 
     11http://localhost:8080/geoserver/www/GeoExplorer/index.html. 
     12 
     13But GeoExplorer will run on any HTTP server, like Apache. All that needs to be 
     14done is unpack GeoExplorer to a web accessible path on your server. There is 
     15only server side requirement: an OGC service proxy. If you have Python 
     16installed, you can e.g. use the OpenGeo python proxy: 
     17http://svn.opengeo.org/util/proxy/proxy.py. Information on how to configure 
     18Apache to use that proxy are included in the file. 
     19 
     20Initial Configuration 
     21--------------------- 
     22 
     23Once installed, GeoExplorer will work out of the box, configured to use 
     24http://demo.opengeo.org/geoserver/ows as WMS. Starting from here, layers and 
     25WMS servers can be added and configured as described in the :doc:`Working With 
     26GeoExplorer <working-with-geoexplorer>` documentation. 
     27 
     28If, however, you want to provide a customized application builder, here is how 
     29to configure it: 
     30 
     31The startup WMS or additional WMS servers can be configured by modifying 
     32GeoExplorer/index.html: 
     33 
     34.. code-block:: javascript 
     35 
     36    wms: { 
     37        "demo": "http://demo.opengeo.org/geoserver/ows/" 
     38    }, 
     39 
     40"demo" is the key used to reference the WMS in the layer configuration (see 
     41below). More servers can be added easily, e.g. by changing the above to 
     42 
     43.. code-block:: javascript 
     44 
     45    wms: { 
     46        "demo": "http://demo.opengeo.org/geoserver/ows/", 
     47        "terraserver": "http://terraserver-usa.com/ogccapabilities.ashx" 
     48    }, 
     49 
     50Two layers will be loaded by default: 
     51 
     52 * Global Imagery (topp:bluemarble) as base layer 
     53 * USA Population (topp:states) as overlay 
     54 
     55The layers to be loaded at startup can be configured in GeoExplorer/index.html: 
     56 
     57.. code-block:: javascript 
     58 
     59    map: { 
     60        layers: [{ 
     61            name: "topp:bluemarble", 
     62            title: "Global Imagery", 
     63            wms: "demo", 
     64            group: "background" 
     65        }, { 
     66            name: "topp:states", 
     67            wms: "demo", 
     68            visibility: true 
     69        }], 
     70        center: [-96.7, 37.6], 
     71        zoom: 4 
     72    } 
     73 
     74The ``name`` property of the layers (e.g. "topp:states" in the above snippet) 
     75are the layer names from the Capabilities document of the 
     76WMS (see 
     77`<http://demo.opengeo.org/geoserver/ows/?SERVICE=WMS&REQUEST=GetCapabilities>`_ 
     78for a complete example): 
     79 
     80.. code-block:: xml 
     81 
     82      <Layer queryable="1"> 
     83        <Name>topp:states</Name> 
     84        <Title>USA Population</Title> 
     85        <Abstract>This is some census data on the states.</Abstract> 
     86        <KeywordList> 
     87          <Keyword>census</Keyword> 
     88          <Keyword>united</Keyword> 
     89          <Keyword>boundaries</Keyword> 
     90          <Keyword>state</Keyword> 
     91          <Keyword>states</Keyword> 
     92        </KeywordList> 
     93        <SRS>EPSG:4326</SRS> 
     94        <LatLonBoundingBox minx="-125.30903773" miny="7.705448770000002" maxx="-66.39223326999999" maxy="66.62225323"/> 
     95        <BoundingBox SRS="EPSG:4326" minx="-124.73142200000001" miny="24.955967" maxx="-66.969849" maxy="49.371735"/> 
     96        <Style> 
     97          <Name>population</Name> 
     98          <Title>Population in the United States</Title> 
     99          <Abstract>A sample filter that filters the United States into three 
     100        categories of population, drawn in different colors</Abstract> 
     101          <LegendURL width="20" height="20"> 
     102            <Format>image/png</Format> 
     103            <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&amp;FORMAT=image/png&amp;WIDTH=20&amp;HEIGHT=20&amp;LAYER=topp:states"/> 
     104          </LegendURL> 
     105        </Style> 
     106      </Layer> 
     107 
     108The ``title`` property is optional. By default, the title from the 
     109Capabilities document will be used. 
     110 
     111The ``wms`` property tells the application on which server to find the layer. 
     112If we would like to add a layer from the "terraserver" WMS that we configured 
     113above, we would simply set ``wms`` to "terraserver". 
     114 
     115Layers that should not be visible when loading the application, but shown in 
     116the layer tree, can be configured with the ``visibility`` property set to 
     117false. 
     118 
     119Layers with the ``group`` property set to "background" will be base layers. 
     120Only one base layer can be visible at a time. 
     121 
     122The ``center`` and ``zoom`` properties are also optional. If not provided, 
     123the map extent will be set to the LatLonBoundingBox specified in the 
     124Capabilities document. For a configuration with more than one layers, the 
     125extent will be taken from the first layer in the "background" group, or the 
     126first layer if there are no layers in the "background" group. 

  • apps/opengeo/geoexplorer/trunk/src/doc/index.rst

    r1224 r1234  
    33=========== 
    44 
    5 Quickly assembly rich mapping applications from multiple :term:`OGC` Web Mapping 
     5Quickly assemble rich mapping applications from multiple :term:`OGC` Web Mapping 
    66Services (:term:`WMS`) with GeoExplorer. Using the publish wizard, embed your 
    77mapping application in any web page. 
    …… 
    1313 
    1414    getting-started 
     15    working-with-geoexplorer 
    1516     
    1617    glossary 
    …… 
    2526documentation. 
    2627 
    27 #.  Open up GeoExplorer in your browser. 
     28#.  Open up `GeoExplorer <../>`_ in your browser. 
    2829#.  Use the add and remove buttons to choose which layers will be included in 
    2930    your application. 
    30 #.  From the "Available Layers" dialog, add a new WMS server (e.g. 
     31#.  From the "Available Layers" dialog, add new WMS servers (e.g. 
    3132    http://terraserver-usa.com/ogccapabilities.ashx). 
    3233#.  Reorder layers by dragging 
    …… 
    3536#.  Launch the "Publish Map" wizard to embed your application in any web page. 
    3637 
    37  
    38  
    39  
     38For a more detailled description of what you can do with GeoExplorer, see the 
     39:doc:`Working With GeoExplorer <working-with-geoexplorer>` documentation.