Map API - Revision history

Sarjona: This page will not be migrated to new devdocs

2025-02-07T15:01:25Z

This page will not be migrated to new devdocs

← Older revision		Revision as of 15:01, 7 February 2025
Line 1:		Line 1:
			{{Template:WillNotMigrate}}

	{{Infobox Project		{{Infobox Project
	\|name = New Map API		\|name = New Map API

Davidbalch: /* Plugins */ Link to approved plugins.

2014-06-27T08:52:40Z

Plugins: Link to approved plugins.

← Older revision		Revision as of 08:52, 27 June 2014
Line 50:		Line 50:
	=== Plugins ===		=== Plugins ===

	The local and database modules have been formatted into three modules~~, awaiting approval~~:		The local and database modules have been formatted into three modules:
	* local_map - the API.		* https://moodle.org/plugins/view.php?plugin=local_map - the API.
	* datafield_latlongmap - a modified latlong field.		* https://moodle.org/plugins/view.php?plugin=datafield_latlongmap - a modified latlong field.
	* datapreset_infomap_latlongmap - a preset using datafield_latlongmap.		* https://moodle.org/plugins/view.php?plugin=datapreset_infomap_latlongmap - a preset using datafield_latlongmap.

			Feedback on the plugins (or the Git branch linked in MDL-42522) would be appreciated.

	== Detailed propsal ==		== Detailed propsal ==
	TBC		TBC

Davidbalch at 16:13, 16 December 2013

2013-12-16T16:13:53Z

← Older revision		Revision as of 16:13, 16 December 2013
Line 3:		Line 3:
	\|state = Proposal/Development in progress		\|state = Proposal/Development in progress
	\|tracker = MDL-42522		\|tracker = MDL-42522
			\|discussion = https://moodle.org/mod/forum/discuss.php?d=245569
	}}		}}
	{{Moodle 2.7}}This page is for collecting feature requests for a possible new API to enable easy use of geographical maps.		{{Moodle 2.7}}This page is for collecting feature requests for a possible new API to enable easy use of geographical maps.

Davidbalch: First draft

2013-12-10T16:16:27Z

First draft

New page

{{Infobox Project
|name = New Map API
|state = Proposal/Development in progress
|tracker = MDL-42522
}}
{{Moodle 2.7}}This page is for collecting feature requests for a possible new API to enable easy use of geographical maps.

== Current status ==
Moodle + contrib has three separate map implementations:
# The built-in map in the IP address lookup (under /iplookup)
# [https://moodle.org/plugins/view.php?plugin=block_online_users_map block_online_users_map] is a contrib module that shows recent users plotted on a world map.
# [https://moodle.org/plugins/view.php?plugin=block_simple_map block_simple_map] is a contrib module that allows users to search for places specified by a CSV upload

* Additionally, the Database activity has a latlong field, which outputs as links to external mapping services.

== High-level proposal ==

A core module to provide an easy way to add maps and mapping features:
# Display a map with specified size, location, zoom, and tileset.
# Display one or more markers on the map.
# Display popups (or other display methods) with additional information when a user clicks on markers.
# Geocoding (i.e. find lat/long from location name - should adopt existing iplookup solution).
# Input of locations by clicking on the map.
# Reverse geocoding (i.e. find location name from lat/long).

== Existing work (2013-12-10) ==

An alpha level implementation is done, including all proposed features except integration of the existing geocoding system.

=== Map API (local module) ===
* The [http://leafletjs.com/ Leaflet] javascript map library as a YUI module.†
* A PHP class to easily: Add maps, display markers and popups, input locations, perform reverse geocoding.

Demonstration at: http://dbtest.conted.ox.ac.uk/moodlemaps/local/map

† There are other map libs, e.g.:
* OpenLayers - older, larger, with more features than I think we need here.
* Modest Maps - fairly minimal, with fewer
* Polymap - looks interesting for data mapping, but not sure how useful that would be in Moodle.

...however, I'm most familiar with Leaflet and feel it hits the right features/weight balance (e.g. includes geoJSON, but avoids complications with projections), so think it's the right place to start.

=== Database activity submodules ===
# A modification/fork of the latlong field to enable maps for display and input
# A new preset (named "Infomap") to utilise the modified latlong field.

Demonstration at: http://dbtest.conted.ox.ac.uk/moodlemaps/course/view.php?id=2

=== Plugins ===

The local and database modules have been formatted into three modules, awaiting approval:
* local_map - the API.
* datafield_latlongmap - a modified latlong field.
* datapreset_infomap_latlongmap - a preset using datafield_latlongmap.

== Detailed propsal ==
TBC