DefaultSettings.php

<?php

// DO NOT INCLUDE THIS FILE IN LocalSettings.php! Instead include Maps_Settings.php.

// This file lists all settings you can use to configure the Maps extension and their default values.
// Do not modify this file to change settings. See https://www.semantic-mediawiki.org/wiki/Maps/Configuration

return [
	// Mapping services that will be available in the wiki.
	// These can be used in #display_map with service=leaflet or in #ask with format=leaflet
	'egMapsAvailableServices' => [
		'leaflet',
		'googlemaps3'
	],

	// The mapping service that will be used when no service is specified by the user.
	'egMapsDefaultService' => 'leaflet',

	// Allows disabling the extension even when it is installed.
	// CAUTION: this setting is intended for wiki farms. On single wiki installations,
	//          the recommended way to disable maps is to uninstall it via Composer. Disabling
	//          Maps via this setting undermines package management safety: extensions that depend
	//          on Maps will likely either break or disable themselves.
	'egMapsDisableExtension' => false,

	// Allows disabling the Semantic MediaWiki integration.
	'egMapsDisableSmwIntegration' => false,

	// Boolean. Whether Maps configuration may also be set on the MediaWiki:Maps JSON config page,
	// which is editable only by users with the editinterface and editsitejson rights. When false,
	// that page is never read and only LocalSettings.php applies. The wiki page exposes most Maps
	// settings, grouped by service and topic (see the README); its values take precedence over
	// LocalSettings.php. Secrets, script-injection primitives and setup-time switches stay PHP-only.
	'egMapsEnableInWikiConfig' => true,





	/**
	 * GENERAL MAP CONFIGURATION
	 */

	// Integer or string. The default width and height of a map. These values will
	// only be used when the user does not provide them.
	'egMapsMapWidth' => 'auto',
	'egMapsMapHeight' => 350,

	// Strings. The default content for all pop-ups. This value will only be used
	// when the user does not provide one.
	'egMapsDefaultTitle' => '',
	'egMapsDefaultLabel' => '',

	'egMapsResizableByDefault' => false,
	'egMapsRezoomForKML' => false,

	// Boolean. Whether the kml parameter may reference KML outside of this wiki. These documents are
	// fetched by the browser of everyone viewing the map, so the host they come from learns the IP
	// address and user agent of each reader, and can change what it serves after the edit was
	// reviewed. When false, kml values that are not a file on this wiki are dropped, and the
	// NetworkLink elements inside a KML document may only point at this wiki. Does not apply to
	// gkml, which Google fetches and renders on its own servers.
	'egMapsAllowExternalKml' => true,

	// Boolean. Sets if pages with maps should be put in special category
	'egMapsEnableCategory' => false,

	// Integer. Determines the TTL of cached GeoJson.
	// Default value: 0 (no caching).
	'egMapsGeoJsonCacheTtl' => 0,





	/**
	 * SEMANTIC MEDIAWIKI INTEGRATION
	 */

	// Boolean. The default value for the showtitle parameter. Will hide the title in the marker pop-ups when set to false.
	// This value will only be used when the user does not provide one.
	'smgQPShowTitle' => true,

	// Boolean. The default value for the hidenamespace parameter. Will hide the namespace in the marker pop-ups when set to true.
	// This value will only be used when the user does not provide one.
	'smgQPHideNamespace' => true,

	// String or false. Allows you to define the content and it's layout of marker pop-ups via a template.
	// This value will only be used when the user does not provide one.
	'smgQPTemplate' => false,





	/**
	 * COORDINATE CONFIGURATION
	 */

	// The coordinate notations that should be available.
	'egMapsAvailableCoordNotations' => [
		'float',
		'dms',
		'dm',
		'dd'
	],

	// The default output format of coordinates.
	// Possible values: float, dms, dm, dd
	'egMapsCoordinateNotation' => 'dms',

	// Boolean. Indicates if coordinates should be outputted in directional notation by default.
	// Recommended to be true for dms and false for float.
	'egMapsCoordinateDirectional' => true,

	// The default output format of coordinates when displayed by Semantic MediaWiki.
	// Possible values: float, dms, dm, dd
	'smgQPCoodFormat' => 'dms',

	// Boolean. Indicates if coordinates should be outputted in directional notation by default when
	// displayed by Semantic MediaWiki.
	'smgQPCoodDirectional' => true,

	// Boolean. Sets if direction labels should be translated to their equivalent in the wiki language or not.
	'egMapsInternatDirectionLabels' => true,

	// Boolean. When false, the #coordinates parser function will not be enabled.
	// This is useful for people using the GeoData extension and want to use its #coordinates function instead.
	'egMapsEnableCoordinateFunction' => true,





	/**
	 * GEOCODING CONFIGURATION
	 */

	// Sets which service should be used to turn addresses into coordinates
	// Available services: geonames, google, nominatim
	// The geonames service requires you to specify a geonames user (see below),
	// if you set this setting to geonames but do not specify the user, Maps will
	// fall back to using the google service.
	'egMapsDefaultGeoService' => 'nominatim',

	// String. GeoNames API user/application name.
	// Obtain an account here: http://www.geonames.org/login
	// Do not forget to activate your account for API usage!
	'egMapsGeoNamesUser' => '',

	// Boolean. Sets if geocoded addresses should be stored in a cache.
	'egMapsEnableGeoCache' => true,

	// Integer. If egMapsEnableGeoCache is true, determines the TTL of cached geocoded addresses.
	// Default value: 1 day.
	'egMapsGeoCacheTtl' => 24 * 3600,

	// Integer. If egMapsEnableGeoCache is true, determines the cache backend.
	// Default value: any cache available (CACHE_ANYTHING).
	// Possible values: https://www.mediawiki.org/wiki/Manual:$wgMainCacheType
	'egMapsGeoCacheType' => -1,





	/**
	 * LEAFLET CONFIGURATION
	 */

	// Integer. The default zoom of a map. This value will only be used when the
	// user does not provide one.
	'egMapsLeafletZoom' => 14,

	// String. The default layer for Leaflet. This value will only be
	// used when the user does not provide one.
	'egMapsLeafletLayer' => 'OpenStreetMap',
	'egMapsLeafletLayers' => [ 'OpenStreetMap' ],

	'egMapsLeafletOverlayLayers' => [],

	// The definitions for the layers that should be available for the user.
	'egMapsLeafletAvailableLayers' => [
		'OpenStreetMap' => true,
		'OpenStreetMap.DE' => true,
		'OpenStreetMap.HOT' => true,
		'OpenTopoMap' => true,
		'Thunderforest.OpenCycleMap' => true,
		'Thunderforest.Transport' => true,
		'Thunderforest.TransportDark' => true,
		'Thunderforest.SpinalMap' => true,
		'Thunderforest.Landscape' => true,
		'Thunderforest.Outdoors' => true,
		'Thunderforest.Pioneer' => true,
		//'MapBox' => false, // todo: implement setting api key
		'Esri.WorldStreetMap' => true,
		'Esri.WorldTopoMap' => true,
		'Esri.WorldImagery' => true,
		'Esri.WorldTerrain' => true,
		'Esri.WorldShadedRelief' => true,
		'Esri.WorldPhysical' => true,
		'Esri.OceanBasemap' => true,
		'Esri.NatGeoWorldMap' => true,
		'Esri.WorldGrayCanvas' => true,
		//'HERE' => false, // todo: implement setting api key
		'FreeMapSK' => true,
		'MtbMap' => true,
		'CartoDB.Positron' => true,
		'CartoDB.PositronNoLabels' => true,
		'CartoDB.PositronOnlyLabels' => true,
		'CartoDB.DarkMatter' => true,
		'CartoDB.DarkMatterNoLabels' => true,
		'CartoDB.DarkMatterOnlyLabels' => true,
		'BasemapAT.basemap' => true,
		'BasemapAT.grau' => true,
		'BasemapAT.overlay' => true,
		'BasemapAT.highdpi' => true,
		'BasemapAT.orthofoto' => true,
		'NASAGIBS.ModisTerraTrueColorCR' => true,
		'NASAGIBS.ModisTerraBands367CR' => true,
		'NASAGIBS.ViirsEarthAtNight2012' => true,
		'NLS' => true,
	],

	'egMapsLeafletAvailableOverlayLayers' => [
		'OpenSeaMap' => true,
		'OpenWeatherMap.Clouds' => true,
		'OpenWeatherMap.CloudsClassic' => true,
		'OpenWeatherMap.Precipitation' => true,
		'OpenWeatherMap.PrecipitationClassic' => true,
		'OpenWeatherMap.Rain' => true,
		'OpenWeatherMap.RainClassic' => true,
		'OpenWeatherMap.Pressure' => true,
		'OpenWeatherMap.PressureContour' => true,
		'OpenWeatherMap.Wind' => true,
		'OpenWeatherMap.Temperature' => true,
		'OpenWeatherMap.Snow' => true,
		'NASAGIBS.ModisTerraLSTDay' => true,
		'NASAGIBS.ModisTerraSnowCover' => true,
		'NASAGIBS.ModisTerraAOD' => true,
		'NASAGIBS.ModisTerraChlorophyll' => true
	],

	// Custom named tile layers that can be used as base layers or overlays, in addition to the
	// stock leaflet-providers layers listed above. The name of each definition becomes a valid
	// value for the layers and overlays parameters. Only the definitions actually used by a map
	// are sent to the browser. The same layers can be defined on-wiki via the MediaWiki:Maps
	// config page (see egMapsEnableInWikiConfig).
	//
	// Each definition has a required 'url' plus optional 'options' and 'wms' entries:
	//   - 'url' must be an http(s) URL. XYZ tile templates ({z}, {x}, {y}, {s}) and, for WMS, the
	//     service endpoint are supported. Definitions without a valid url are ignored.
	//   - 'wms' (boolean) renders the layer with L.tileLayer.wms instead of L.tileLayer.
	//   - 'options' is passed to Leaflet, but only a safe allowlist of keys is kept: attribution,
	//     minZoom, maxZoom, minNativeZoom, maxNativeZoom, subdomains, errorTileUrl, zoomOffset,
	//     zoomReverse, tms, detectRetina, bounds, opacity, zIndex and noWrap; plus, for WMS layers,
	//     layers, styles, format, transparent, version and uppercase. Unknown options are dropped.
	//     'errorTileUrl' must be an http(s) URL, and 'attribution' is sanitized to plain text and
	//     http(s) links.
	//
	// A definition whose name matches a stock layer (e.g. 'OpenStreetMap') overrides that stock
	// layer.
	//
	// Example:
	// 'egMapsLeafletLayerDefinitions' => [
	//     'Historic 1904' => [
	//         'url' => 'https://tiles.example.org/historic1904/{z}/{x}/{y}.png',
	//         'options' => [
	//             'attribution' => 'Historic map tiles',
	//             'minZoom' => 1,
	//             'maxZoom' => 18,
	//             'subdomains' => 'abc',
	//             'bounds' => [ [ 49.5, 5.8 ], [ 53.6, 15.2 ] ],
	//         ],
	//     ],
	//     'Weather WMS' => [
	//         'wms' => true,
	//         'url' => 'https://example.org/geoserver/wms',
	//         'options' => [
	//             'layers' => 'weather:precipitation',
	//             'format' => 'image/png',
	//             'transparent' => true,
	//             'attribution' => 'Weather service',
	//         ],
	//     ],
	// ],
	'egMapsLeafletLayerDefinitions' => [],

	'egMapsLeafletLayersApiKeys' => [
		'MapBox' => '',
		'Thunderforest' => '',
	],

	'egMapsLeafletLayerDependencies' => [],





	/**
	 * GOOGLE MAPS CONFIGURATION
	 */

	// String. Google Maps v3 API Key
	'egMapsGMaps3ApiKey' => '',

	// String. Google Maps v3 API version number
	'egMapsGMaps3ApiVersion' => '',

	// Integer. The default zoom of a map. This value will only be used when the
	// user does not provide one.
	'egMapsGMaps3Zoom' => 14,

	// Array of String. The Google Maps v3 default map types. This value will only
	// be used when the user does not provide one.
	'egMapsGMaps3Types' => [
		'roadmap',
		'satellite',
		'hybrid',
		'terrain'
	],

	// String. The default map type. This value will only be used when the user
	// does not provide one.
	'egMapsGMaps3Type' => 'roadmap',

	// Array. List of controls to display onto maps by default.
	'egMapsGMaps3Controls' => [
		'pan',
		'zoom',
		'type',
		'scale',
		'streetview',
		'rotate'
	],

	// String. The default style for the type control.
	// horizontal, vertical or default
	'egMapsGMaps3DefTypeStyle' => 'default',

	// String. The default style for the zoom control.
	// small, large or default
	'egMapsGMaps3DefZoomStyle' => 'default',

	// Boolean. Open the info windows on load by default?
	'egMapsGMaps3AutoInfoWindows' => false,

	// Array. Layers to load by default.
	// traffic, bicycling and transit
	'egMapsGMaps3Layers' => [],

	// Show points of interest or not.
	'egMapsShowPOI' => true,

	// String. Set the language when rendering Google Maps.
	'egMapsGMaps3Language' => '',





	/**
	 * DISTANCE CONFIGURATION
	 */

	// Array. A list of units (keys) and how many meters they represent (value).
	// No spaces! If the unit consists out of multiple words, just write them together.
	'egMapsDistanceUnits' => [
		'm' => 1,
		'meter' => 1,
		'meters' => 1,
		'km' => 1000,
		'kilometers' => 1000,
		'kilometres' => 1000,
		'mi' => 1609.344,
		'mile' => 1609.344,
		'miles' => 1609.344,
		'nm' => 1852,
		'nauticalmile' => 1852,
		'nauticalmiles' => 1852,
	],

	// String. The default unit for distances.
	'egMapsDistanceUnit' => 'm',

	// Integer. The default amount of fractal digits in a distance.
	'egMapsDistanceDecimals' => 2,





	/**
	 * DEBUGGING
	 */

	// When true, debugging messages will be logged using mw.log(). Do not use on production wikis.
	'egMapsDebugJS' => false,

	'egMapsGlobalJSVars' => [],
];