Help:Configuration 0.6

From Mapping on MediaWiki
Jump to: navigation, search

Admin manual

Download

Installation

Configuration

Troubleshooting

User manual

This page explains how you can use various settings to tweak the display and behaviour or your maps and related features. The settings are grouped by extension. You can modify a setting by copying its code from its extension settings file and placing it with the adapted value in LocalSettings.php, after the inclusion of the extension. The settings file of each extension should contain a rough copy of the documentation found here. This list contains the common settings (the ones that affect all mapping services). For the service specific settings, see the relevant mapping service.

Maps

All settings are located in Maps_Settings.php, in the root of the extension.

Features configuration

Commenting out the inclusion of any feature will make Maps completely ignore it, and so improve performance.

Mapping features

Functionality in the features directory uses the Maps framework to support multiple mapping services.

Default:

# General function support, required for #display_map and #display_point(s).
include_once $egMapsDir . 'Features/Maps_ParserFunctions.php'; 		
# Required for #display_map.
include_once $egMapsDir . 'Features/DisplayMap/Maps_DisplayMap.php';
# Required for #display_point and #display_points.
include_once $egMapsDir . 'Features/DisplayPoint/Maps_DisplayPoint.php';

Other features

Include the additional features such geocoding and stand alone parser functions that should be loaded into Maps.

Default:

# Geocoding support, required for the geocoding parser functions and smart geocoding support in all other parser functions.
include_once $egMapsDir . 'Geocoders/Maps_Geocoders.php';
# Geocoding parser functions: #geocode, #geocodelat, #geocodelon.
include_once $egMapsDir . 'ParserFunctions/Geocode/Maps_GeocodeFunctions.php';
# Required for #coordinates.
include_once $egMapsDir . 'ParserFunctions/Coordinates/Maps_Coordinates.php';
# Geographic parser functions: #geodistance, #finddestination
include_once $egMapsDir . 'ParserFunctions/GeoFunctions/Maps_GeoFunctions.php';

Mapping services configuration

Available mapping services

Include the mapping services that should be loaded into Maps. Commenting or removing a mapping service will make Maps completely ignore it, and so improve performance.

Default:

# Google Maps API v2
include_once $egMapsDir . 'Services/GoogleMaps/Maps_GoogleMaps.php';
# Google Maps API v3
include_once $egMapsDir . 'Services/GoogleMaps3/Maps_GoogleMaps3.php';
# OpenLayers API
include_once $egMapsDir . 'Services/OpenLayers/Maps_OpenLayers.php';
# Yahoo! Maps API
include_once $egMapsDir . 'Services/YahooMaps/Maps_YahooMaps.php';


You can further restrict availability of services with this setting:

Array containing all the mapping services that will be made available to the user. Currently Maps provides the following services: googlemaps, yahoomaps, openlayers.

Default:

$egMapsAvailableServices = array( 'googlemaps2', 'googlemaps3', 'yahoomaps', 'openlayers' );

Default mapping service

The default mapping service for each feature, which will be used when no valid service is provided by the user. This service needs to be enabled, if not, the first one from the available services will be taken. Note: The default service needs to be available for the feature you set it for, since it's used as a fall-back mechanism.

Default:

$egMapsDefaultServices = array( 'display_point' => 'googlemaps2', 'display_map' => 'googlemaps2' );

An additional fall-back value is present, that will be used in case no default is specified for a certain feature. This service needs to be enabled, if not, the first one from the available services will be taken.

Default: $egMapsDefaultService = 'googlemaps';

General configuration

JS minification

Indicates if minified js files should be used where available. Do not change this value unless you know what you are doing!

Default: $egMapsUseMinJs = false;

Geocoding services configuration

Available geocoding services

Array containing all the geocoding services that will be made available to the user. The allowed values are 'yahoo', 'google' and 'geonames'.

Default geocoding service

The default geocoding service, which will be used when no service is provided by the user. This service needs to be enabled, if not, the first one from the available geocoding services will be taken.

Default: $egMapsDefaultGeoService = 'geonames';

Coordinate configuration

Available coordinate notations

The coordinate notations that should be available.

Default:

$egMapsAvailableCoordNotations = array( Maps_COORDS_FLOAT, Maps_COORDS_DMS, Maps_COORDS_DM, Maps_COORDS_DD );

Default coordinate notation

The default output format of coordinates. Possible values: Maps_COORDS_FLOAT, Maps_COORDS_DMS, Maps_COORDS_DM, Maps_COORDS_DD

Default: $egMapsCoordinateNotation = Maps_COORDS_DMS;

Default coordinate directionality

Indicates if coordinates should be outputted in directional notation by default. Recommended to be true for Maps_COORDS_DMS and false for Maps_COORDS_FLOAT.

Default: $egMapsCoordinateDirectional = true;

Coordinate geocoding

Sets if coordinates should be allowed in geocoding calls.

Default: $egMapsAllowCoordsGeocoding = true;

Geocoding cache

Sets if geocoded addresses should be stored in a cache.

Default: $egMapsEnableGeoCache = true;

General map configuration

Default map coordinates

The default coordinates of the marker. This value will only be used when the user does not provide one.

Default: $egMapsMapLat = '1'; $egMapsMapLon = '1';

Default map width

The default width of a map. These values will only be used when the user does not provide them.

Default: $egMapsMapWidth = 600;

Default map height

The default height of a map. These values will only be used when the user does not provide them.

Default: $egMapsMapHeight = 350;

Map size restrictions

The minimum and maximum width and height for all maps. First min, then max. Min needs to be smaller then max. When the height or width exceed their limits, they will be changed to the closest allowed value.

Default:

$egMapsSizeRestrictions = array(
	'width'  => array( 50, 1020, 1, 100 ),
	'height' => array( 90, 1000, 1, 100 ),
);

Default map zoom

The default zoom of a map. This value will only be used when the user does not provide one. Each service has it's own zoom setting. Please refer to the mapping services for more info.

Default map title

The default title for all markers. If set, it will be visible as text or title in a pop-up when the user clicks a marker.

Default: $egMapsDefaultTitle = '';

Default map label

The default label for all markers. If set, it will be visible as text in a pop-up when the user clicks a marker.

Default: $egMapsDefaultLabel = '';


Semantic Maps

All settings are located in SM_Settings.php, in the root of the extension.

Features configuration

Semantic Maps adds data to this setting, but it belongs to Maps. See Maps available mapping features for more info.

Default:

# Query printers
include_once $smgDir . 'Features/QueryPrinters/SM_QueryPrinters.php';
# Form imputs
include_once $smgDir . 'Features/FormInputs/SM_FormInputs.php';

Mapping services configuration

Available mapping services

Include the mapping services that should be loaded into Semantic Maps. Commenting or removing a mapping service will cause Semantic Maps to completely ignore it, and so improve performance.

Default:

# Google Maps API v2
include_once $smgDir . 'Services/GoogleMaps/SM_GoogleMaps.php';
# OpenLayers API
include_once $smgDir . 'Services/OpenLayers/SM_OpenLayers.php';
# Yahoo! Maps API
include_once $smgDir . 'Services/YahooMaps/SM_YahooMaps.php';

Default mapping service

Semantic Maps adds data to this setting, but it belongs to Maps. See Maps default mapping service for more info.

Default:

$egMapsDefaultServices['qp'] = 'googlemaps2';
$egMapsDefaultServices['fi'] = 'googlemaps2';

This list contains all available features, and their feature identifier, which Semantic Maps should add to the $egMapsDefaultServices array.

  • qp - Query Printer - This default will be used for all semantic queries. Query printers handle semantic result formats.
  • fi - Form Input - This default will be used for all form input maps. Form inputs define Semantic Forms input types.

Queries

Force show maps

The default value for the forceshow parameter. Will force a map to be shown even when there are no query results when set to true.

Default: $smgQPForceShow = false;

Show title

The default value for the showtitle parameter. Will hide the title in the marker pop-ups when set to true.

Default: $smgQPShowTitle = true;

Default template

String or false. Allows you to define the content and it's layout of marker pop-ups via a template.

Default: $smgQPTemplate = false;

Query coordinate notation

The default output format of coordinates. Possible values: Maps_COORDS_FLOAT, Maps_COORDS_DMS, Maps_COORDS_DM, Maps_COORDS_DD

Default: $smgQPCoodFormat = $egMapsCoordinateNotation;

Query coordinate directionality

Indicates if coordinates should be outputted in directional notation by default.

Default: $smgQPCoodDirectional = $egMapsCoordinateDirectional;

Forms

Form width

The default width of maps in forms created by using Semantic Forms.

Default: $smgFIWidth = 665;

Form height

The default height of maps in forms created by using Semantic Forms.

Default: $smgFIWidth = $egMapsMapHeight;

This documentation page applies to all (Semantic) Maps versions from 0.6 to 0.6.6.
Other versions: ≥ 0.7      

Help:Configuration en 0.6 0.6.6