GithubHelp home page GithubHelp logo

alex4401 / mediawiki-extensions-datamaps Goto Github PK

View Code? Open in Web Editor NEW
5.0 2.0 4.0 3 MB

Interactive data maps extension without extra services needed.

Home Page: https://mediawiki.org/wiki/Extension:DataMaps

License: Other

PHP 34.96% JavaScript 56.06% Less 4.10% TypeScript 2.67% Python 2.21%
leaflet maps mediawiki

mediawiki-extensions-datamaps's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.