Changes between Version 14 and Version 15 of GoogleMapMacro

Timestamp:

Oct 28, 2008, 3:02:41 PM (15 years ago)

Author:

Martin Scharrer

Comment:

Added usage description for server side geocoding

GoogleMapMacro

@@ -34 +34 @@
 
 
-== Installation & Configuration ==
+== Installation & Configuration ==#config
 
 Just copy the [http://trac-hacks.org/browser/googlemapmacro/0.11/googlemap.py?format=raw python file] in the `plugin` directory of your trac installation.
 
-A different Google Map API key is needed for every web domain which can be [http://code.google.com/apis/maps/signup.html get for free from Google].
+A different [http://code.google.com/apis/maps/signup.html Google Map API key] is needed for every web domain which can be get for free from Google.
 
-To enable the macro put the following into your `trac.ini` file, which is located in the `config` directory of your trac installation.
+To enable the macro put the below text into your `trac.ini` file, which is located in the `config` directory of your trac installation.
+You can define project wide default values for some arguments and also whether the geocoding (address-to-coordinates conversion) is done on by the trac server or by the clients web browser.
+Google recommends server side geocoding with caching which is now implemented and can be enabled using `geocoding = server`. 
+Please note that this creates a table 'googlemapmacro' in your trac database which is used for the caching.
+Server side geocoding is recommended but disabled by default.
+
 You need to restart trac to reread the macro file and the configuration file.
 
@@ -49 +54 @@
 [googlemap]
 api_key = <Your Google API key (long hex number)>
+## Server side geocoding (address-to-coordinates conversion) incl. caching (recommended).
+## Please note that this creates a table 'googlemapmacro' in your trac database.
+## Possible settings are 'server' or 'client' (without the quotes). Default is 'client' in order not to change the DB unasked.
+#geocoding = server
 ## Optional default settings:
 #default_size = 400x400
@@ -101 +110 @@
 
 === Using both ===
-Doesn't make this much sense, but is supported anyway. This could be used as failsafe if you aren't sure if the address resolution will be successful.
+If both address and center coordinates are given, then the result depends on the [#config `geocoding` setting]:
+ `server`:: The address is resolved on the trac server and the coordinates are completely ignored.
+ `client`:: The map is first centered at the given coordinates and then moved to the given address after (and if) it was 
+            resolved by the client-side JavaScript code.
 {{{
 [[GoogleMap(center=50.0:10.0,address="Street; City; County",zoom=10,size=400x400)]]
 }}}
-The given coordinates will be shown until the address is resolved, which can take a little when the user has a slow internet connection.
-After (and if) the address is resolved the map will be centered on it.