Extension:DataMaps

From mediawiki.org
MediaWiki extensions manual
OOjs UI icon advanced.svg
DataMaps
Release status: beta
Implementation ContentHandler , Parser function
Author(s) alex4401 (Alex44019talk)
Latest version 0.14.0
MediaWiki v0.14+: 1.39
v0.1-v0.13: 1.37
Database changes No
License GNU General Public License 2.0 or later
Download
Example ARK: Survival Evolved Wiki
Temtem Wiki

The DataMaps extension lets you display interactive maps using Leaflet without additional services.

Installation[edit]

  • Download and place the file(s) in a directory called DataMaps in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php :
    wfLoadExtension( 'DataMaps' );
    
  • Optionally, if you do not want to use the built-in namespace create one and set $wgDataMapsNamespaceId to its ID.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Wikis on wiki.gg can request this extension to be enabled via the platform's representatives.

Configuration parameters[edit]

$wgDataMapsNamespaceId
Identifier of the namespace that all maps will live in.
Default: managed (uses built-in namespace)
$wgDataMapsApiCaching
Since version 0.14.0.
Associative array of settings controlling API output caching.
type
Type of cache to use.
Default: CACHE_ANYTHING
ttl
Expiry time (in seconds) of cached API responses.
Default: 86400 (1 day)
ttlExtensionThreshold
Remaining time-to-live (in seconds) of cached API responses needed for the time to be extended.
Default: 43200 (12 hours)
ttlExtensionValue
Number of seconds to extend a soon-to-be-expired cached API response's life.
Default: 57600 (16 hours)
$wgDataMapsDefaultApiMarkerBatch
Number of markers the API will return by default in a single response.
Default: 2500
$wgDataMapsMaxApiMarkerBatch
Maximum number of markers an API client can request.
Default: 5000
$wgDataMapsMarkerParserExpansionLimit
Parser expansion limit used when parsing marker labels and descriptions.
Default: 800
$wgDataMapsUseInProcessParserCache
If set to true, API will use a least recently used cache (in memory of the process handling the request) when processing markers (when uncached).
Default: true
$wgDataMapsDefaultFeatures
Associative array which controls whether features are enabled by default on maps.
ShowCoordinates
Self-explanatory.
Default: true
RequireCustomMarkerIDs
Requires every marker to have a unique identifier specified (for permanent links or collectible identification).
Default: false
Search
Enables marker search in top-left corner of the map.
Default: false
SortChecklistsByAmount
Sorts collectible marker groups by number of markers associated.
Default: true
$wgDataMapsFullLinksUpdateBudget
Since version 0.14.0.
Controls total time (in seconds) that can be spent on parsing marker wikitext to perform complete links table updates.
Set to `0` to disable.
Default: 0.5
$wgDataMapsEnableCreateMap
Enables visual map creation dialog to streamline the process for users.
Since version 0.13.2.
Default: true
$wgDataMapsEnableVisualEditor
Enables visual map editor to streamline the process for users.
This does not use the VisualEditor extension.
Since version 0.14.0.
Default: true
$wgDataMapsReportTimingInfo
Includes timing information in API output for profiling purposes.
Default: false
$wgDataMapsAllowExperimentalFeatures
Enables any experimental features bundled in the release but disabled by default.
Default: false