wiki:DocManualFive

TOC?

>> GUI layout configuration

p.mapper User Manual v. 5.x

Installation

  1. see Quick install instructions for the main set up instructions.
  1. some info about MapServer installation

Additional PHP settings

PHP.INI

  • Optional: If you want to make use of the functionality to join database tables to layers (for details see below) you have to install the PEAR DB or the MDB2 library (you need to define the library in the INI file). Typically you will define the path to the installation directory of PEAR in the key include_path (under [PHP] - Paths and Directories)

Directory and File Structure

config

The directory for the configuration files. Contains config_default.xml and subdirectory default, which is the default location for custom.js, js_config.php and the mapfile. In the future XML files for detailed configuration could be added.

img

Contains all images used in the user interface. Subdirectory legend contains the legend icons and which are automatically created and updated. Additionally, a createimg.log file is created.

lib

This directory contains the PHP files with the overall functions.

lib/
├── common.php                    # Common functions and variables used in several php files
├── extlib
├── globals.php
├── group.php                     # Class functions for GROUP and GLAYER objects 
├── init
│   ├── initmap.php               # Initialization of the application
│   ├── init.php                  # Initialization of the application
│   └── startup.php 
├── initgroups.php                # Initialization of GROUP and GLAYER objects
├── js
│   ├── js_init.php               # Initialize various JS variables from PHP
│   ├── js_preloadimages.php
│   └── js_session.php
├── layerview.php
├── legend.php                    # Functions for creating legend
├── locale
│   ├── acknowledgements.txt│   
│   ├── language_*.php            # localization files for multilingual GUI
│   └── localedb.db
├── map                           # Functions for rendering map
│   ├── dynlayer_json.php
│   ├── dynlayer.php
│   ├── pmap
│   ├── pmapgroup.php
│   ├── pmaplayer.php
│   ├── pmap.php         
│   ├── pmhighlight
│   ├── pmtile
│   └── urllayer.php
├── pmsession.php
├── print                         # General print functions
│   ├── cache
│   ├── config
│   ├── fonts
│   ├── htmlcolors.php
│   ├── pdfprint.php              # Special print functions for PDF creation
│   ├── printmap.php
│   ├── printxml.php
│   ├── tcpdf.php                 # PDF creation functions (Author: Nicola Asuni)
│   └── unicode_data.php
├── query                         # Functions for queries (identify, select, search)
│   ├── index.php
│   ├── json_query_doc.txt
│   ├── query.php
│   ├── query.point.php
│   ├── queryresult.default.php
│   ├── queryresult.php
│   ├── queryresult.raw.php
│   ├── search
│   ├── suggest
│   ├── test
│   └── testresult.txt
├── toc.php
├── uielement.php
└── xajax                         # PHP parts for XMLHttp/AJAX calls
    ├── x_getsessionvar.php
    ├── x_layerview.php
    ├── x_legend.php
    ├── x_poi.php
    ├── x_proxyiframe.php
    ├── x_setsessionvar.php
    └── x_toc_update.php

js

The releases contain the JavaScript files compressed to a single file: 1 for standard p.mapper files pm_cjs.js and 1 for all jQuery files jquery_merged.js. All uncompressed source files are under the subdirectory /src/. If you want to make modifications to an existing JS file it is recommended to do this in a separate JS file (like custom.js) under the /config/.../ directory adding the modified function to this file.

All JavaScript files:

js
├── jquery
├── jquery_merged.js
├── ol
│   ├── img
│   ├── img0
│   ├── img-g
│   ├── OpenLayers.js
│   ├── src
│   └── theme
├── pm_cjs.js
└── src
    ├── jquery                          # jQuery libraries
    ├── pm.acommon.js                   # commonly used functions, initialization of objects
    ├── PM.Control.LoadingPanel.js
    ├── PM.Control.PMClearMap.js
    ├── PM.Control.PMPanel.js
    ├── PM.Control.PMToc.js             # TOC/legend definition
    ├── PM.Control.PMToolBox.js
    ├── PM.Control.PMToolBox_PMSelect.js
    ├── PM.Control.PMToolClick.js
    ├── PM.Control.PMToolClick_PMIdentify.js
    ├── PM.Control.PMToolIQuery.js
    ├── PM.Control.PMToolMeasure.js     # library for measurements/digitizing
    ├── PM.Control.PMTool_PMSelectByShape.js
    ├── PM.Control.PMToolSeparator.js
    ├── PM.Control.PMZoomBar.js
    ├── PM.Control.PMZoomToSelected.js
    ├── PM.Control.ScaleLineMetric.js
    ├── pm.form.js                      # Functions for forms and scale selection list
    ├── pm.init.js                      # init functions
    ├── PM.Layer.PMap.js
    ├── PM.Layer.PMTile.js
    ├── pm.map.js                       # Main functions used for map creation, query, etc.
    ├── pm.ol.control.js
    ├── pm.ol.customized.js
    ├── pm.ol.googlev37fix.js
    ├── pm.ol.theme.js
    ├── pm.pmapper.js                   # main p.mapper related functions, resize, GUI, dialogs, etc.
    ├── pm.queryconfig.js
    ├── pm.query.js                     # generic functions for queries
    ├── pm.search.js                    # functions for attribute search
    ├── pm.uielement.js
    ├── pm.util.js
    └── xt.sorttable.js                 # Sort result table functions (Author: Stuart Langridge)

plugins

Plugins for p.mapper are adding additional functionality and allow a more modulat design of the application. A list of available plugings with some description is available >> here. In addition, there's a short description how to write your own plugin.

templates

Cascading Style sheets. Most formatting options in p.mapper are done via CSS.


Basic Design

Application Structure

The application is set up as a single PHP page (by default named 'index.phtml') with elements set in DIV's.

PHP and Javascript

The application uses a DHTML zoom/pan interface for its navigation. The functions of the pm.zoombox.js file call as central counterpart the zoombox_apply() function in pm.map.js. This function spreads the calls to different JavaScript functions that then pass the necessary variables to the PHP files. Most calls to PHP files from JavaScript are performed via XMLHttp (AJAX) requests and call PHP scripts named x_abcdef.php.

Start

The application can be started via a JavaScript 'window.open' command, but it is recommended to just launch it in a standard browser window to avoid pop-up warnings of the browsers' pop-up blockers. Additional URL parameters that can be added to the file index.phtml are the language or the configuration, like

http://server/pmapper-site/?language=it&config=yourconfiglocation

If index.phtml is not included in the DirectoryIndex directive of the Apache configuration (or equivalent definitions for other web servers) you need to launch it as

http://server/pmapper-site/index.phtml
or
http://server/pmapper-site/map.phtml?config=test

Otherwise, if you run your own web server you should add index.phtml to your /etc/apache2/mods-enabled/dir.conf (assuming Debian here).

Multilingual User Interface

The application is designed with a multilingual approach. Nearly all text annotation in the user interface is written dynamically with PHP. The definition of the annotation strings is made in the files below /incphp/locale/language_xx.php where xx is the country id of the language. It uses a function emulating the GNU Gettext and could be substituted with the latter.

The currently predefined languages

  • English
  • German
  • Italian (with corrections by Luca Marletta)
  • French (provided by Paul Hasenohr, Thomas Raffin)
  • Dutch (provided by Wim Devos, Andre van Atten)
  • Czech (provided by Jachym Cepicky, Petr DOBEŠ)
  • Brazilian Portuguese (provided by Rodrigo Gaete)
  • Slovak (provided by Ivan Mincik)
  • Spanish (provided by Nuria González)
  • Croatian (provided by Dejan Gambin)
  • Russian (provided by Anna Kostikova )
  • Hungarian (provided by Zoltan Siki)
  • Chinese (simplified) (provided by Xiaobao Zang)
  • Japanese (provided by Takashi Ota)
  • Bulgarian (provided by Zlatomir Dimitrov)
  • Greek (provided by Andreas P)
  • Hebrew (provided by Micha Silver)
  • Latvian: Aigars Varpins
  • Indonesian: Tri Agus Prayitno
  • Catalan: Rosa Olivella González
  • Chinese (traditional): Jun Yuan Lin

Adapt the locale files or add new ones for additional languages.

p.mapper also contains an alternative function "__p()" in common.php that uses a SQLite 3 database ('localedb.db') with UTF-8 encoding. The database can be edited with a CLI or more comfortable with a SQLite GUI. Substitute the file-based function "_p()" with this one if you want to use a DB driven solution. You can also maintain all language settings in the SQLite file 'localedb.db' and write out the 'language_xx.php' files with the PHP script 'extract_locales.php'.

Encoding for locale files

The default character encoding is set to UTF-8. Use a text editor that supports UTF-8 encoding if editing the locales files (eg. Scite).

Encoding for map file

If your map file includes non-ASCII characters (eg for layer DESCRIPTION or CLASS names), set the <map2unicode> entry in the config_xyz.xml to 1 (if the map file is in an encoding other than ISO-8859-1 add a METADATA entry like "MAPFILE_ENCODING" "ISO-8859-2" to the MAP tag).

<map2unicode>1</map2unicode>

If your map file has UTF-8 encoding set

<map2unicode>0</map2unicode>

Starting application in a certain language

To call the application in a certain language start the map.phtml file with the URL containing language=xx in the search portion of the URL, e.g.

http://server/map.phtml?language=en

where predefined settings are: en English, de German, it Italian, fr French, se Swedish, nl Dutch, cz Czech, br Brazilian, sk Slovak.

Correct display of non-ascii characters

The default character encoding of the pages is UTF-8. In order to ensure correct display of query results from shapefiles the result strings are converted to UTF-8. If the layers are in a different encoding than ISO-8859-1 or WIN1252 (CP1252) - eg. DOS (CP850), UTF-8 encoding of a PostGIS layer, or other ISO encodings - you should specify this as a layer METADATA tag "LAYER_ENCODING" like

METADATA
  ...
  "PM_LAYER_ENCODING" "UTF-8"
END

A correct functioning of this conversion requires the ICONV library available in PHP (usually included in standard builds).

Correct labeling of text on the map requires an ENCODING tag for the LABEL tag in the map file.

CLASS
  LABEL
    ..  
    ENCODING "UTF-8"
  END
END

See the MapServer documentation for details.

Miscellaneous

Legend The legend icons are created every time when there had been changes to the map file. The init.php file checks the modification date of the map file and compares it with a log file out of the last legend icon creation. If the map file is newer, then the icons will be created newly. On the one hand this keeps legend up-to-date, on the other hand it avoids new creation of the icons and transmission to the user every time he requests the legend.

Printing For the print function you can choose between HTML and PDF output. The PDF output uses the free library FPDF by Olivier PLATHEY. You can increase the map image quality for the PDF print by increasing the setting pdfres in the config XML file. Note that higher resolution increases file size of retrieved PDF files and map labels can become difficult to read.


Configuration

» GUI layout configuration

Configuration Options of the XML File

XML File /config/config_xyz.xml settings:

>> See detailed description for XML file

Selection of the XML file at start up

It is possible to select the XML file to use for the configuration via the start up URL parameter &config=.... This setting requires to have the config file named like config_name-of-your-configuration.xml. E.g. &config=test will use the file config_test.xml in the /config/ directory. This allows flexible presentations based on the same common application code. Because config files can use different map files, one can also choose a different content via the config parameter. See the file start.html for examples how to start an application with different configurations.

For how to achieve this with "cleaner" looking URL's, see here.

Common settings for various configurations

If you use different config settings as mentioned in the section above, you can define common parameters in config_common.xml and the corresponding config/common/ directory. This way in the specific config files, like config_app1.xml, config_app2.xml you only need to define the specific parameters like groups, categories, etc.

Additional JavaScript related configuration options

Some settings for various JavaScript related options can to be set in the file

/config/your-config/js_config.php

For most settings: if not set, reasonable default values are taken.

The toolbar of the application is e.g. set in this file.

See more details here

Configuration Options of the MAP File

General Settings

RESOLUTION

In order to allow correct PDF printing and to have correct scales for printing set RESOLUTION tag below MAP to 96. This is the default screen resolution Windows calculates with. With regard to a vast majority of users using Windows (and in its default configuration) this should be an appropriate setting.

Symbols

p.mapper uses a symbol called 'circle' for highlighting selected features. This symbol definition has to be present either in the map file or the symbol file referenced in the map file. The default definition of this symbol is

SYMBOL
  NAME 'circle'
  TYPE ELLIPSE
  POINTS 1 1 END
  FILLED TRUE
END

Groups and Layers

p.mapper supports grouping of layers just like the cgi-interface. To achieve this, a secondary group and layer definition is done via special group/layer objects that include also the support for multi-lingual applications. It is recommended to avoid spaces in group or layer names.

In the ini file you can set the default order how layers/groups are displayed in the table of contents (allGroups) and which layers are set visible at start (defGroups). If a layer belong to a group specify the group name, otherwise use the layer name.

p.mapper supports the definition of thematic categories, thus allowing to group layers in the table of contents together (see description of XML parameter useCategories). If categories are used, all layers/groups have to be referenced in the $categories array in /config/php_config.php. Categories are named in the appropriate language file in the incphp/locale folder.

Layer TOLERANCE settings for Queries

The query function of p.mapper uses the TOLERANCE settings in the map file. This means you should define tolerances in the map file for each layer you want to be queryable. Recommended are TOLERANCEUNITS pixels and settings for TOLERANCE between 2 and 5 for vector layers, and 0 for raster layers.

Layer/Group? Descriptions and Fields for Queries

The configuration in the map file for description (i.e. the name displayed in the TOC or legend) of the layers/groups is done via the METADATA tag PM_DESCRIPTION for each layer. If more than one layer belongs to a common group the name of the first layer is taken for the group name.

The fields used for displaying query results are defined in the METADATA tag PM_RESULT_FIELDS. For shapefiles these fields have to be defined completely in upper case. For PostGIS layers the field names will typically have to be defined in lower case. The field names displayed in the result table are similarly defined as PM_RESULT_HEADERS

 "PM_RESULT_FIELDS" "NAME_IT,TYPE_EN"
 "PM_RESULT_HEADERS" "Name,Street Type"

If no definitions are made for these METATAGS then the default values will be taken from the layer sources.

Notabene: All layers that shall be queryable need a TEMPLATE tag set for either the layer or the classes. Otherwise the query returns no result for this layer. This is a well known MapServer issue. So just define something like

LAYER
  ...
  TEMPLATE "void"
  ...
END   

Joining Database tables to layers

This functionality makes use of the PEAR database abstraction layer (module DB). It uses PEAR syntax for the connection string to the database. For installation and detailed information, especially the connection string syntax, see the PEAR documentation, especially the section DB. Joins for a layer are defined in the map file METADATA tag for the layer as RESULT_JOIN

Examples:

"RESULT_JOIN" followed by the database string:

PostgreSQL:

<----- PEAR Connection String ------->||<---- DB Par. (join field, field type, results ---->||<Join fld in Shape>||JoinType(0: one2one, 1: one2many)
"pgsql://postgres:passwd@host/Database||DB_table@DB_join_field@0@field1,field2,field3,field4||SHAPE_join_field||0"

The join field type is 0: numeric, 1: string.

ODBC (e.g. MS Access):

"odbc://'':''/host@odbc_connection_dsn||DB_table@DB_join_field@0@field1,field2,field3||SHAPE_join_field||1"

Please note the following limitations:

  • The joined fields from the database cannot be used in p.mapper search definitions nor for class items in the map file.
  • Because of limitations of the PEAR DB module a join of dBase tables is not working. On MS Windows systems you can use an ODBC connection instead, pointing to an MS Access file that links the dBase file (this solutions is also typically faster). On Unix systems you can only use the built-in functions of Mapserver for DBF joins or use the OGR Virtual Layer definition.
  • A join works also for RASTER layers, but not for PostGIS layers. PostGIS layers can have a join defined directly in the map file DATA tag (see PostGIS manual).

In order to make the results of queries more flexible the application offers the possibility of hyperlinks for selected fields. This works both for layer fields and fields out of a joined DB table. The hyperlinks are defined in the METADATA tag for every layer like the following example:

 "PM_RESULT_HYPERLINK" '{ "NAME": {"alias": null}, "ISO2_CODE": {"alias":"Link on Country"} }'

The definition must use valid JSON notation which requires double quotes for strings. Therefore the definition in the map file must be placed inside single quotes.

Separate the hyperlink fields with commas. If you don't want to have the field value being displayed as the hyperlink text, you can define an "alias" name with the text to be displayed, otherwise define the alias as null.

The hyperlink definition has its corresponding JavaScript function openHyperlink() (in the custom.js file) that is added to every link as the action. The function receives layer, field name, and field value. For every layer and field you can define how to process this information, e.g. include them in other JavaScript functions.

XY Layers

This layer type has been removed from p.mapper 5 since this functionality is supported by OGR layers based on OGR virtual format.


Miscellaneous Functions

Definition of Attribute Queries (Search Function)

p.mapper offers a simplified definition of attribute queries (search function). Since version 3.1 the attribute queries are defined in /config/default/search.xml. See here for more details.

The query output is no longer HTML but a JSON string (see www.json.org for details). The output is then formatted to HTML via Javascript functions parsing the JSON objects. One could also use PHP instead. This makes it much easier to customize the display of the query results in different layouts. See the file /incphp/query/json_query_doc.txt for a description of the JSON structure.

Zoom to pre-defined extent

You can start the application already zoomed to a specified extent. The default extent can be defined either directly with x/y min/max values or read from a feature of a map layer. The default extent is defined by an additional key/value pair for the starting URL. See the file 'index.html' for an example.

Manually defined extent:

Comma-separated list of coordinates: xmin, ymin, xmax, ymax; like

&me=3678982,2134585,4721175,3092410

Extent read from layer feature:

&zoomLayer=countries&zoomQuery=NAME@1@Italy@0@1

zoomQuery parameters (separated by @):

  NAME: name of the field to search (upper case for shapefiles)
  1: field type, 0 = numerical, 1 = alphanumerical
  Italy: search string (case sensitive)
  0: highlight feature, 0 = no, 1 = yes
  1: set maximum map extent to feature extent, 0 = no, 1 = yes

Note: the slash character "/", for the URI needs to be properly encoded using %2F, otherwise you will get a wrong interpretation of the URI and subsequent errors.

Defining the active layers:

Additionally, it is possible to specify the layers/groups that shall be activated (visible) on startup via the &dg= URL key, with layers comma-separated

&dg=countries,cities

Utilities

If you are using ESRI ArcView 3 you can use the extension AV.p.mapper. This extension helps you to create a map file out of a given ArcView project. It also adds the necessary information, e.g. the fields to be used in query functions.


Credits

I would like to thank all who provided contributions to the p.mapper development:

  • Federico Nieri and Alessandro Radaelli from Comune di Prato:
    • Contributions in quite a few files (Javascript and PHP) in order to make p.mapper 2 compliant with W3C XHTML standards.
    • Re-structured and enhanced measure functions, including geometry.js library.
  • Luca Marletta from beOpen.it: For regularly testing of development versions and reporting bugs.

All projects and products that p.mapper is based on or uses code snippets from or that gave ideas for the development are listed below. See here for detailed information about their licenses.

  MAPSERVER: Copyright (c) 1996-2001 Regents of the University of Minnesota
  PHP/MapScript & GMAP75: Copyright (c) 2000-2002, DM Solutions Group
  TCPDF: Copyright (c) Nicola Asuni, based on FPDF Copyright (c) Olivier Plathey
  PHP PEAR: Copyright (c) 1997-2002 The PHP Group
  ka-map: Copyright (c) 2005, DM Solutions Group Inc.
  xt.slider: Copyright (c) by Mark Wilton-Jones 12-13/10/2002
  xt.wz_jsgraphics.js: Copyright (c) 2002-2004 Walter Zorn
  xt.sorttable.js Copyright (c) 1997-date Stuart Langridge
  jQuery JavaScript framework, (c) 2009 John Resig 
  jQuery Dimensions plugin, (c) 2007  Brandon Aaron 
  jQuery plugin treeview 1.4, Copyright (c) 2007 Jörn Zaefferer, Myles Angell 
  jQuery plugin qModal, Copyright (c) 2007 Brice Burgess 
  jQuery plugin autocomplete, Copyright (c) 2008 D. Verheul, D. Switzer, A. Tuladhar, J. Zaefferer 
  jQuery plugin layout, Copyright (c) 2008 Fabrizio Balliano
  jQuery plugin contextmenu, Copyright (c) 2007 Chris Domigan
  jQuery plugin cookie, Copyright (c) 2006 Klaus Hartl
Last modified 2 years ago Last modified on Nov 21, 2014, 10:32:14 AM