Open ONI Map Plugin

This provides very basic functionality to browse newspaper title locations on a map.

Compatibility

The "main" branch should not be considered stable. Unlike the core Open ONI repository, plugins don't warrant the extra overhead of having separate development branches, release branches, etc. Instead, it is best to find a tag that works and stick with that tag.

• Map v0.2.0 and prior only work with Python 2 and Django 1.11 and prior
  • Therefore these versions of the Map plugin are only compatible up to (and including) ONI v0.11
• Map releases v0.3.0 and later require Python 3 and Django 2.2, and should be used with ONI 0.12 and later

Setup

Download the repository into the Open ONI's onisite/plugins directory as map:

git clone [email protected]:open-oni/plugin_map.git map

You will need a list of latitude and longitudes for all of the cities you would like to display on the map.

Add them to static/js/cities_list.js in the following format:

var cities = [
  {
    "name": "Example City",
    "latlong": [42.10, -102.87],
    "papers": {
      "Example City Herald": "lccn431431"
    }
  },
  {
    "name": "Demoville",
    "latlong": [41.16, -95.93],
    "papers": {
      "Demoville Gazette": "lccn837131",
      "Demo Journal": "lccn121331"
    }
  }
];

If you have a GeoNames account, or you have manually put latitude and longitude into your core_places table, you can run the map_places admin command to generate valid JavaScript:

# Run this from the open-oni directory
docker-compose exec web manage map_places geonames-user OR

You can even automate it further by grepping only the first line of JS (note that this will hide errors from you!):

# Run this from the open-oni directory
docker-compose exec web manage map_places geonames-user OR | \
  grep -A999999999 "var cities = " >themes/oregon/static/js/cities_list.js

NOTE: When using the map_places command, bear in mind that if you somehow have two cities with the same name, one will end up clobbering the other!

To hitch this plugin to your project wagon, you will need to add a few lines in some files.

onisite.plugins.map needs to go in your INSTALLED_APPS list:

# onisite/settings_local.py

INSTALLED_APPS = (
    'django.contrib.humanize',
    'django.contrib.staticfiles',

    'onisite.plugins.map',
    'themes.default',
    'core',
)

And add the plugin's URLs with url(r'^map/', include("onisite.plugins.map.urls")) to onisite/urls.py:

# onisite/urls.py

from django.urls import include, path, re_path

urlpatterns = [
  re_path(r'^map/', include("onisite.plugins.map.urls")),

  # keep this last or else urls from core may override custom urls
  path('', include("core.urls")),
]

You can add links to the map in your templates with this named path:

<a href="{% url 'map_home' %}">Browse by Location</a>

Customization

You can create your own settings by overriding a block in map.html.

  {% block javascript_map_settings %}
    <script>
      // map settings
      let startLat = 41.5;
      let startLong = -99.316;
      let startZoom = 7;
      let markerColor = "#000000";
    </script>
  {% endblock javascript_map_settings %}

Centering Your Map on a State

By default, the map centers on Nebraska, so if you would prefer to look at a different state when you get to the page, you'll probably want to try finding a different lat / long / zoom combination.