1. Andrew Lombardi
  2. django-easy-maps

Commits

Mikhail Korobov  committed 8ced16c

Clarified readme. Fix #2.

  • Participants
  • Parent commits 807e036
  • Branches default

Comments (0)

Files changed (1)

File README.rst

View file
  • Ignore whitespace
    {% easy_map address using 'map.html' %}
    {% easy_map address 200 300 5 using 'map.html' %}
 
-The template will have 'map' (it is the ``easy_maps.models.Address`` instance),
-'width', 'height' and 'zoom' variables. The outer template context is passed
+The template will have 'map' (it is the ``easy_maps.models.Address``
+instance auto-created for passed address on first access), 'width',
+'height' and 'zoom' variables. The outer template context is passed
 to rendered template as well.
 
 The default template can be found here:
 * latitude
 * geocode_error - True if geocoder wasn't able to handle the address
 
+Address model should be considered implementation detail. Its purpose is
+to avoid using geocoder for each request, that's a kind of persistent cache.
+It is included in readme because information about available data can
+be useful for custom map templates.
+
 Admin address preview
 =====================
 
 
     admin.site.register(Firm, FirmAdmin)
 
+'address' field should be a CharField or TextField.
 
 Contributing
 ============