.. _mapml: MapML ========= Map Markup Language (MapML) is a text-based format which allows map authors to encode map information as hypertext documents exchanged over the Uniform Interface of the Web. The format definition is still a work-in-progress by the Maps for HTML W3C Community Group, but various tools to work with the format already exist, including a Leaflet-based map viewer. For more information on MapML refer to the `Maps for HTML Community Group `_. The MapML module for GeoServer adds new MapML resources to access WMS and WFS services configured in Geoserver. The MapML modules includes support for styles, tiling, querying, sharding, and dimensions options for WMS layers, and also provides a MapML outputFormat for WMS GetFeatureInfo and WFS GetFeatures requests. See below for information on installing and configuring the MapML module. Installation -------------------- #. Download the MapML extension from the `nightly GeoServer community module builds `_. .. warning:: Make sure to match the version of the extension to the version of the GeoServer instance. #. Extract the contents of the archive into the ``WEB-INF/lib`` directory of the GeoServer installation. Configuration ------------- Configuration can be done using the Geoserver administrator GUI. The MapML configuration is accessible in the *MapML Settings* section under the *Publishing* tab of the Layer Configuration page for the layer being configured. Here is the MapML Settings section, with some example values filled in: .. figure:: images/mapml_config_ui.png License Info ^^^^^^^^^^^^ Together these two attributes all the administrator to define the contents of the ```` element in the MapML header. Here is an example of the resulting XML: **License Title** The License Title will be included as the value of ``title`` attribute of the ```` element in the MapML header. **License Link** The License Link will be included as the value of ``href`` attribute of the ```` element in the MapML header, and should be a valid URL referencing the license document. Tile Settings ^^^^^^^^^^^^^ Using tiles to access the WMS layer can increase the perceived performance of the web map. This is especially true if there is some kind of tile cache mechanism in use, either at the Geoserver datastore level, or at the web server level. **Use Tiles** If the Use Tiles checkbox is checked, the output MapML will define a tile-based reference to the WMS server. Otherwise, an image-based reference will be used. Sharding Config ^^^^^^^^^^^^^^^^ The Sharding Config options are intended to allow for parallel access to tiles via different server names. The actual server names must be configured in the DNS to refer to either the same server or different servers with the same GeSserver layer configuration. In the example above, the mapML client would alternate between the servers a.geoserver.org, b.geoserver.org, and c.geoserver.org to access the the map images. The values in the example above would result in the following MapML: .. code-block:: html **Enable Sharding** If Enable Sharding is checked, and values are provided for the Shard List and Shard Server Pattern fields, then a hidden shard list input will be included in the MapML. **Shard List** If Enable Sharding is checked, the Shard List should be populated with a comma-separated list of shard names which will be used to populate the shard data list element. **Shard Server Pattern** The Shard Server Pattern should be a valid DNS name including the special placeholder string {s} which will be replace with the Shard Names from the Shard List in requests to the server. This pattern should not include any slashes, the protocol string (http://) or the port number (:80), as these are all determined automatically from the URL used to access the MapML resource. Dimension Config ^^^^^^^^^^^^^^^^ **Dimension** The selected dimension (if any) is advertised in the mapml as an input with the appropriate value options or ranges, as configured in the *Dimension* tab of the Layer Configuration page. Only dimensions enabled in the *Dimension* tab are available as options. MapML Resources --------------- MapML resources will be published for any published WMS layers. The MapML resources will be available at:: http://{serverName}/geoserver/mapml/{layerName}/{projectionName}?style={styleName}&transparent={true|false}&format={wmsFormat} The ``{layerName}`` is the WMS layer name, and the ``{serverName}`` is the name or IP address of the server on which Geoserver is running. The ``{projectionName}`` must be one of the projections supported by MapML: - OSMTILE - CBMTILE - APSTILE - WGS84 Each of the URL query string parameters are optional, but if provided they are effectively passed-through to the underlying WMS service call. Here are some details on the parameters: **style** If provided, the specified ``{styleName}`` must correspond to an available WMS style to use for the layer. **transparent** If provided, must be either ``true`` or ``false``. The same value is passed through to the underlying WMS service. If not provided, it defaults to the inverse of the "opaque" WMS publishing layer setting. **format** If provided, must be a valid WMS format specifier. If not provided, it defaults to ``image/png``. MapML Visualization ------------------- The only tool which is presently able to display MapML is a Leaflet-based MapML client. This client can be imported into an HTML page with the appropriate ```` and ```` elements to reference the MapML resources defined above. Here is a simple, self-contained example of such an HTML page: .. code-block:: html MapML Test Map In the above example, the place-holders ``{layerName}``, ``{serverName}``, ``{projectionName}``, and ``{styleName}`` would need to be replaced with the appropriate values, and/or the ``style`` parameter could be removed entirely from the URL if not needed.