diff options
| author | Claude Paroz <claude@2xlibre.net> | 2013-12-28 11:08:50 +0100 |
|---|---|---|
| committer | Claude Paroz <claude@2xlibre.net> | 2013-12-28 11:08:50 +0100 |
| commit | b7a7baa55471e67b98d509cddf2f0994f7ce786f (patch) | |
| tree | ea12d961978b4a8bbf11c6e1631a8398713ee710 /docs | |
| parent | c81fae6b9588ab9ef1edd7309c00e72a87154bc1 (diff) | |
Fixed #21618 -- Added hints about openlayers.js hosting
Thanks kz26 for the report and Tim Graham for the excellent
review.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/contrib/gis/forms-api.txt | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/ref/contrib/gis/forms-api.txt b/docs/ref/contrib/gis/forms-api.txt index 435bcfc8b1..a556fac1fc 100644 --- a/docs/ref/contrib/gis/forms-api.txt +++ b/docs/ref/contrib/gis/forms-api.txt @@ -156,6 +156,20 @@ Widget classes This is the default widget used by all GeoDjango form fields. ``template_name`` is ``gis/openlayers.html``. + ``OpenLayersWidget`` and :class:`OSMWidget` use the ``openlayers.js`` file + hosted on the ``openlayers.org`` Web site. This works for basic usage + during development, but isn't appropropriate for a production deployment as + ``openlayers.org/api/`` has no guaranteed uptime and runs on a slow server. + You are therefore advised to subclass these widgets in order to specify + your own version of the ``openlayers.js`` file in the ``js`` property of + the inner ``Media`` class (see :ref:`assets-as-a-static-definition`). You + can host a copy of ``openlayers.js`` + `tailored to your needs`_ on your own server or refer to a copy from a + content-delivery network like http://cdnjs.com/. This will also allow + you to serve the JavaScript file(s) using the ``https`` protocol if needed. + + .. _tailored to your needs: http://docs.openlayers.org/library/deploying.html + ``OSMWidget`` .. class:: OSMWidget @@ -163,3 +177,9 @@ Widget classes This widget uses an OpenStreetMap base layer (Mapnik) to display geographic objects on. ``template_name`` is ``gis/openlayers-osm.html``. + + The :class:`OpenLayersWidget` note about JavaScript file hosting above also + applies here. See also this `FAQ answer`_ about ``https`` access to map + tiles. + + .. _FAQ answer: https://help.openstreetmap.org/questions/10920/how-to-embed-a-map-in-my-https-site |
