wiki:GoogleMapMacro

Version 22 (modified by martin_s, 6 years ago) (diff)

Added description for markers.

Inserts a dynamic Google Map into wiki pages

Description

This macro lets the user insert a full dynamic Google Map. Because a lot of javascript is used (by Google) a Google Map compatible browser is needed. Newer version of Firefox and MS Internet Explorer are compatible.

For javascript-less static maps use the similar GoogleStaticMapMacro.

Please note that this is an alpha version which still lacks some functionality.

Multiple Google Maps on the same wiki page are actively supported.

Feedback: I would like to get some user feedback for this macro. Tell me if you like it or not and what could be better. Feel free to request additional features as long there are supported by the Google Maps API by opening a feature request.

Bugs/Feature Requests

Existing bugs and feature requests for GoogleMapMacro are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out GoogleMapMacro from here using Subversion, or browse the source with Trac.

There is a develop version which can be unstable: check-out | browse

Installation & Configuration

Just copy the 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 get for free from Google. Please check if the Google Map API Terms of Use apply for your Trac project. They do apply IMHO for non-pay open accessible Trac projects.

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.

[components]
googlemap.* = enabled

[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
#default_zoom = 6

Usage

The macro knows the following arguments, which can be used in the normal key1=value1,key2=value2,... syntax. If a key-less value is given it will be taken as center coordinates if it's in the proper format ({float}:{float}) otherwise it's taken as an address.

address
Sets the center of the map to the given address. Please use semi-colons (';') to separate the street, city and country. The value can be surrounded by quotes, e.g. "Street; City; Country". If an address but no zoom value was given an appropriate value will be guessed based on the address accuracy returned by Google. At the moment this isn't very accurate but soon Google might improve this.
center
Sets the center of the map to the given coordinates. The format is {latitude,longitude}.
zoom
Sets zoom factor. Allowed values are between 0 (whole world) and 19 (single house). Very high zoom values might not be supported by Google Maps for all parts of the world.
size
The size either in the format {width}x{height} as numbers in pixel, e.g.: 300x400 means 300px wide and 400px high or in the format {width}{unit}:{height}{unit} where unit can be any CSS unit (em, ex, px, in, cm, mm, pt, pc).
types (optional)
Sets the map types selectable by the user, separated by colons (':'). If not given the standard types of Google Maps are used (Normal, Satellite, Hybrid). The following types are available (values are case-insensitive):
  • normal Normal street-map
  • satellite Satellite picture
  • hybrid Satellite picture with streets as overlay
  • physical Terrain map
type (optional)
Sets the initial map type. See the types argument for the available types. If this argument is not given the first listed type under types is used initially.
controls (optional)
Sets the used map controls. Multiple controls can be given, separated by colon (':'). The value is case-insensitive. If not set the controls MapType and LargeMap are used. If set but empty no controls are displayed. The following controls are available (descriptions taken from the Google Map API page):
  • LargeMap: Control with buttons to pan in four directions, and zoom in and zoom out.
  • SmallMap: Control with buttons to pan in four directions, and zoom in and zoom out, and a zoom slider.
  • SmallZoom: Control with buttons to zoom in and zoom out.
  • Scale: Control that displays the map scale.
  • MapType: Standard map type control for selecting and switching between supported map types via buttons.
  • HierarchicalMapType: Drop-down map type control for switching between supported map types.
  • OverviewMap: Collapsible overview mini-map in the corner of the main map for reference location and navigation (through dragging).
markers (to be implemented)
Allows the user to set labeled markers on given location of the map. The format for a marker is {latitude}:{longitude};{Letter} or "{Address}";{Letter}. If the string 'center' is used instead of an address the center of the map is marked. The marker letter can be either A-Z or 'o', '.' or empty for a plain marker. Multiple markers are separated using the '|' character.

Examples

Using geographic coordinates

Please use a colon, not a comma, as separator for the coordinates.

[[GoogleMap(center=50.0:10.0,zoom=10,size=400x400)]]
or
[[GoogleMap("50.0:10.0",zoom=10,size=400x400)]]
or
[[GoogleMap(50.0:10.0,zoom=10,size=400x400)]]

Using an address

Please use semicolons, not commas, as separators in the address.

[[GoogleMap(address="Street; City; Country",zoom=10,size=400x400)]]
or
[[GoogleMap("Street; City; Country",zoom=10,size=400x400)]]
or, if you really want to:
[[GoogleMap(Street; City; Country,zoom=10,size=400x400)]]

Please note that the address is converted into coordinates by user-side javascript every time the wiki page is loaded. If this fails no map will be shown, only an empty gray rectangle.

Server side address conversion including caching is underway.

Using both

If both address and center coordinates are given, then the result depends on the `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; Country",zoom=10,size=400x400)]]

Select Map Types

To show a map with the standard map types where the satellite map is preselected:

[[GoogleMap("Street; City; Country",zoom=10,size=400x400,type=satellite)]]

To only show a satellite map (please note the added 's'):

[[GoogleMap("Street; City; Country",zoom=10,size=400x400,types=satellite)]]

To show a map with hybrid and satellite map types (in this order) where the satellite map is preselected:

[[GoogleMap("Street; City; Country",zoom=10,size=400x400,types=hybrid:satellite,type=satellite)]]

To show a map with hybrid and satellite map types (in this order) where the hybrid map is preselected:

[[GoogleMap("Street; City; Country",zoom=10,size=400x400,types=hybrid:satellite)]]
or
[[GoogleMap("Street; City; Country",zoom=10,size=400x400,types=hybrid:satellite,type=hybrid)]]

Markers ==

To create three markers: one at the center of the map (A), one at the next street (B) and one at coordinates 10.243,23.343 (C):

[[GoogleMap("Street; City; Country",zoom=10,size=400x400,markers=center;A|"Next street; City; Country";B|10.243:23.343;C)]]

Recent Changes in the Release Branch

[8649] by martin_s on 2010-09-06 12:08:31
tracgooglemap/macro.py
Added support for mulit-line wiki processor syntax. Ref: 7628.
[8648] by martin_s on 2010-09-06 12:07:24
Added stylesheet file.
[8546] by martin_s on 2010-08-30 23:57:36
Added encoding meta-comment and declared SVN keywords as unicode to avoid issues with non-english locales.

Recent Changes in the Develop Branch

Error: Macro ChangeLog(googlemapmacro/dev/0.11, 3) failed
No node googlemapmacro/dev/0.11 at revision 14172

Author/Contributors

Author: martin_s
Contributors:

ToDo/Planned

From high to low priority:

  • Markers!
  • Default values in config file for all arguments.
  • Maybe merge source with GoogleStaticMapMacro to allow addresses there, too.
  • Argument static=yes to render a static map while using GoogleMapMacro format.