alex4401 / mediawiki-extensions-datamaps

Interactive data maps extension without extra services needed.

DataMaps extension

This is free software licensed under the GNU General Public License. Please see http://www.gnu.org/copyleft/gpl.html for further details, including the full text and terms of the license.

Overview

An extension for displaying interactive maps in articles with no external services. All data is kept and served from the wiki and maintained by editors. Initially made as a replacement for ARK: Survival Evolved Wiki's interactive maps on DOM nodes.

Repository | Issue tracker

Installation

If your wiki is hosted on wiki.gg, simply request the extension via their representatives.

Check the MediaWiki.org page otherwise.

MediaWiki support schedule

This extension's development tracks wiki.gg's platform - currently MediaWiki 1.39. All versioned releases of DataMaps target this version.

Documentation

• Creating a map (planned)
• Data format
• JavaScript API for gadgets (planned)

Configuration

Check the MediaWiki.org page.

Gadgets

External scripts can hook into Data Maps to provide additional functionality without modifying core code.

• All Leaflet APIs are public and left exposed under the ext.datamaps.leaflet module.
• • Custom Leaflet layers are exposed under ext.datamaps.leaflet.Ark.
• • Lazy-loaded. Depend (via mw.loader.using) on ext.datamaps.leaflet.
• • DataMap objects provide waitForLeaflet( function callback, [object? context] ).
• All public APIs of this extension are exposed under window.mw.dataMaps. Check resources/core/index.js for all exposed classes.
• mw.dataMaps.registerMapAddedHandler( function callback, [object? context] ) may be used to have a function called on every map initialised on current page. The callback receives one parameter, a DataMap instance.
• • Depend (via mw.loader.using) on ext.datamaps.bootstrap to use this.
• Refer to the source code for information about the classes.

Leaflet

This repository only includes a static build of modified Leaflet. Source code including the modifications is found under this link.

Gadget implications

Certain Leaflet features may not be available when using DataMaps, check the forked repository for more details.

mediawiki-extensions-datamaps's Issues

[EPIC] Extended visual editor functionality

• Delete groups
• Delete markers
• Rename groups
• Create and delete layers
• Assign markers to layers
• ...

Backport new Visual Editor initialisation logic in the CustomEditor hook to v0.13

Write formal tests for the MapStorage class

Track maps failing validation

The title sounds stupid, but maps should be softly re-validated on extension updates, and added to a tracking category of sorts.

• Error tracking
• Deprecations tracking

Hide empty marker groups in the legend

Currently we display all groups that are delivered over the inlined JSON configuration all the time, which may include groups with no associated markers. This becomes an empty toggle with no function, but confuses the user.

Additionally, visibility conditions may change at runtime and should be also used to evaluate toggle visibility. At least internal layers (such as bg:) should be queried.

Replace "centre view" and "reset view" button icons with something more intuitive

• Reset
• Centre

Have clicking on the map bypass the scroll delay

Formalise and version schema changes using JSON Schema

Layer indicators not displayed in marker popups when coordinates are hidden

A validation error in a group/layer stops validation for the field entirely

Test map:

{
	"image": "Blank.png",
	"groups": {
		"obelisk-blu e": { "name": "Error here", "fillColor": "#00a5ff", "size": 20, "icon": "Obelisk.png" },
		"obelisk green": { "name": "Green Obelisk", "fillColor": "#14e800", "size": 20, "icon": "Obelisk.png" },
		"obelisk-re d": { "name": "Error here", "fillColor": "#f70102", "size": 20, "icon": "Obelisk.png" }
	}
}

Load status overlays should be hidden before the last data chunk is downloaded

Backend does not filter groups reported to the client, when marker filtering is enabled in the embed

Backport the edit button on map embeds from v0.14.0

As map data is not contained within articles but instead separate data pages, an edit button can be shown to logged-in users to advertise the possibility.

This has been already implemented in the v0.14.0 in-dev branch, but should be backported to v0.13.5.

Extract wikitext parsing methods to a service and support Parsoid

• Parser service created
• Parsoid implementation

Turn the legend into a floating popup on mobile-grade screens

Internally promote v0.14.0 in-dev branch to the translation portal

Popup close button behaves differently on hover than link

Remove the Ark\ part of the PHP namespace

Merge CreateMap into the visual editor

Invoke MultimediaViewer when clicking on images in popups

Currently there is no direct way of enlarging an image thumbnail in a popup. MMV integration seems like a decent way to go around this, and would not reinvent the wheel.

Investigate benefits of migrating onto Vue and Codex

OOUI is effectively deprecated by Wikimedia in favour of Vue and Codex. MW 1.39 includes first components using those two, so it's a decent target for this task.

Visual editor's on-click utility bar should stick to a single position within the map

Test MW 1.39 compatibility on v0.14.0 in-dev branch

Add PHPDoc annotations to functions, classes and variables

Register the parser function as {{Map:}} when namespace is managed by the extension

Update translations for v0.14.0 before release

• Internally promote v0.14.0 in-dev branch to the translation portal
• Notify translators
• Pull changes:
• • French
• • Spanish
• • Thai

Background dropdown does not match other controls visually

Fullscreen/overlay mode

This was requested by ARK users back around the v0.3.x days.

Refactor legend management in the frontend

• Root element created at run-time and not in the parser
• Clean up MarkerLegendPanel and MapLegend classes
• Grant them clearer names
• Move all initialisation logic from DataMap into respective classes
• Perhaps move them onto an event-based approach

Release v0.13.5 and request a deployment on wiki.gg wikis

• Complete all remaining tasks on the milestone.
• Check test pages on the sandbox wiki for breakage.
• Merge into the REL1_37 branch and tag
• Push into self-hosted repository and GitHub
• Request a deployment on wiki.gg
• Deployment done

Touch zoom still has no interaction delay implemented

Lower zoom snap for view resetting button

Reported over Discord by @coldino

Content bounds not refreshed upon layer/background visibility changes

Low priority as currently we have no maps this has impact on.

• Have background/visibility changes emit an event
• Call refreshMaxBounds whenever the event happens

Test storage migration to changes of 2022/11/15

• Entries moved to the new namespace
• Aggregator object created
• background, dismissed not lost
• Dead entries removed from local storage

Mark now irrelevant MapStorage methods as internal or eliminate if possible

Allow exclusion from cave layer filtering

Check if names of marker groups/layers contain no white-space

Spaces are disallowed by design, since each word in a marker ownership specification is expected to be an individual, separate layer. Edit validation should fail if any layer/group violates these expectations.

Cache current content bounds whenever recalculated

• Change Leaflet.LatLngBounds getCurrentContentBounds() and Leaflet.LatLngBounds getPaddedContentBounds() signatures to include a bool invalidate parameter, and respect it.
• Have any invalidation sources include this parameter.

Display parsed marker labels and descriptions in popup visualisations

[EPIC] Basic visual editor functionality

• #65

The visual editor should allow:

• Changing a group's collectability status
• Changing whether a group is shown by default
• Adding markers to the map
• Name markers, set description, image
• Edit markers
• View coordinates regardless of map and instance settings, preferably after a click on the map

Invalidate API caches whenever a mix-in is modified

Currently, mix-in edits will update the map pages, but as they're not modified themselves the API data is not forced to be regenerated.

Mix-in changes should clear cached API output for each of dependee maps' latest revisions.

Validate data using JSON Schema in PHP

Write help pages on MediaWiki.org

Set up code linting for JavaScript

This is a follow-up to the PHP linting enablement.

Search control goes above the legend toggle, rendering legend toggle invisible when opened

Ensure marker associations have no layers specified twice

Cases like oil-rock cave bg:3 cave are not valid by design - a marker reference must not appear in the same layer twice at runtime.

Write help pages on support.wiki.gg

"Reset/centre view" buttons target main background bounds (fails with tiles and overlays)

Personal user-created markers

Aiming for v0.14.0 because of its storage model changes.

[EPIC] Add an internal layer to filter markers by zoom level ranges

• Define the layer format (possibly property with single level or one range of levels, zoom:3 or zoom:3-7)
• Ensure there is no substantial performance cost (possibly index zoom requirements separately from usual layer checks)
• Write-time validation for the layer instances
• Extend the visibility manager to handle the layer
• Have the client stream zoom layers from the API as needed
• Ensure the client does not flicker (hide previous markers only after new ones are loaded and instantiated)
• Consider putting irrelevant markers into "stasis" - take them out of active registered marker list, possibly destroy the Leaflet instances entirely