This documentation page is under construction.
Should you want to be notified once it's published, let us know.
About
DOCUMENTATION STAGE: WIP - This documentation page is still a work in progress.
For API Endpoints documentation, please refer to this Stoplight page: APIβ
For UXUI technical information as well as other diagrams, please refer to this Figma board: MAPβ
Project Lockdown: Mapping Platform module
Table of Contents
1.
About this module
2.
The module in Project Lockdown
3.
General overview of the module
4.
Accessing the module
5.
Contributing
6.
Abstract
7.
Features
3.1 Localization
8.
Geography
3.1 Territories
3.2 Regions
9.
Embedding
β
About this module
The Mapping Platform (MAP) module offers an accessible representation of the data in Project Lockdown. It provides:
An interactive map where DataSet Layers (DSL) are presented
A StatsBox (SB) with contextual information valuable to the DSL
A Time Slider (TS) to navigate through the DSL across time
A Territory Detail Overlay (TDO) that showcases all the DSL data points organized by categories + a report view of them
A Search box (S) to locate specific territories
A Tab Menu (TB) that contains all the specific information of the DSL, from methodology to information on each data point
A simple QueryString controlled interface that allows to customize the final user experience and embed the MAP in any other website
Back to top
The module in Project Lockdown
The following diagram showcases how this Module integrates in the project:
β
β
Back to top
General overview of the module
The following diagram showcases the general design of the MAP module:
[WIP]
Back to top
Accessing the module
To access the MAP, please visit https://ProjectLockdown.earth (Status: DEPLOYED - To be converted into https://map.ProjectLockdown.world)
The MAP offers the possibility of using regional TLDs in order to customize the landing area in an easy, intuitive manner according to Project Lockdown's regions.
Pacific (Note: currently no TLD has been identified. Should you have a suggestion, please let us know https://github.com/TheIOFoundation/ProjectLockdown/issues/57)
Tasks in progress (Labels: Module: MAP + Stage: In Progress) https://github.com/TheIOFoundation/ProjectLockdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22Module%3A+MAP%22+label%3A%22Stage%3A+In+Progress%22
Upcoming tasks that are being prepared (Labels: Module: MAP + Stage: Not Ready) https://github.com/TheIOFoundation/ProjectLockdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22Module%3A+MAP%22+label%3A%22Stage%3A+Not+Ready%22
Back to top
Geography
Territories
See Territories policy
Regions
Project Lockdown aims to empower local communities and has designed the whole platform with localization as a core objective and it does so by providing access to the mapping platform through different regional TLDs and a range of languages to experience the interface.
The mapping interface has also been designed so that it can be embedded in other websites and allowing a full customization of the user interface to integrate seamlessly with its host environment. Examples can be seen in our sample page of TLDs and embedding options.
Note: The full list and description of parameters will be published soon.