| {maketoc}
|
| -!R2 Alpha is Under Development
|
| -!!Summary
|
| -This package makes including and using Google Maps on your bitweaver site a snap! It makes the creation of maps, markers, lines, and other information just a matter of pointing and clicking. It also provides a service to other packages, so that if they want to include a map they can. It also provides a map for viewing any geo-located bitweaver content on your site, so if you tag a page or article with a location you can view it on a map.
|
| +!Summary |
| +This package makes including and using Google Maps on your bitweaver site a snap! You can create maps, markers, polylines, and other information with just a little pointing and clicking - no Google Maps API knowledge required! It also provides a service to other packages, to make it easy to add location data to other content. The Gmap Package also provides a universal map for viewing any of such geo-located bitweaver content on your site, so if you tag a page or article with a location you can search for that content by location and view it on a map. |
|
|
| -!!Core Features:
|
| -* Gmap Map Creator, for creating Google Maps with custom markers and other features
|
| -* Gmap Service for putting maps in other packages
|
| -* Gmap Content Browser, for viewing BW geo-located content (like pages, articles, users) on a map
|
| +!Core Features: |
| +!!!Gmap Map Builder |
| +Creating Custom Google Maps with Custom Markers, Polylines, Polygons, and other features |
|
|
| -!!State of Development of Core Features
|
| -*Gmap Map Creator
|
| -+ Some parts of this are functional such as new map creation, but it is very buggy, and critical features like marker creation are not yet oppertational.
|
| -* Gmap Service
|
| -+ This is fully operational. The map service is currently automatically added to all content editing pages when gmap is installed. This provides a point-and-click interface for assigning a location to your articles, wiki pages, users, etc.
|
| -* Gmap Content Browser
|
| -+ This is at an advanced stage of functionality, though there are some bugs. Any geo-located content can be selected and filtered by category, date, and/or location and displayed on a map. A table of content is automatically generated along side the map and links will pop infowindows on the map above corresponding markers. A known bug in the search UI is that sometimes the same category is listed more than once. Additional features to still be added is the flagging of content as a user favorite and requesting favorites.
|
| +!!!Gmap Mapping Service |
| +Lets other packages integrate Google Maps into their features without having to do any map development. One example use that is already integrated is Google Maps can be used for easily attaching geo location data to any bitweaver cms content. Admins can select which content types can be mapped. A Small Map and Permalinks to the Gmap Content Browser can also be included on content pages for easy viewing of where a content item is on a map. |
|
|
| -!!The Difference Between the R1 Version and R2 Version
|
| -The R2 version is a significant upgrade of the Alpha R1 version. While R2 will be similar in functionality to R1, upgrading from the R1 version to the R2 version is not currently supported and may never be. Although the R1 version basically works though there are bugs and some tikiwiki syntax parsing issues, it is recommended that you only use R1 for testing and not anything you want to keep.
|
| +!!!Gmap Content Browser |
| +A universal map interface for searching for bitweaver geo located content (like pages, articles, users) and viewing it on the map. |
|
|
| -The primary change in R2 is that location date, lat/lng pairs, are being managed by the new GeoPackage service. In addition Gmap is also beiing writen to offer itself as a service to all content. In conjuction with the GeoPackage, this makes assigning a location to your wiki page, articles, blog posts, user preferences, etc a snap.
|
|
|
| -R2 will NOT support the Xmaps Library. At this point the Xmaps library which was developed for V1 of the Google Map API has not been redeveloped for compatibility with V2 of the API. Therefore the features that Xmaps enabled will be disabled in the R2 version of this package.
|
| +!Install Instructions |
| +!!Dependencies |
| +The R2 version of the GmapPackage is dependent on the GeoPackage. All location date, lat/lng pairs, are being managed by the GeoPackage service. __You MUST also install the GeoPackage if you want to use GmapPackage__. |
|
|
| +__For strict security enforcement in Gmap package you should also install LibertySecurePackage.__ Gmap has options for making maps and map components private. To strictly enforce those settings in all access points, particularly lists, then you will need LibertySecure. You can run Gmap without LibertySecure, but "private" content will be displayed in lists. |
|
|
| -!R1 Version Documentation
|
| -!!Special R1 Installation Instructions
|
| -!!!You must obtain a Google Map API Key for your site.
|
| -To use the package you need a key from Google. You can sign up for a key [http://www.google.com/apis/maps/signup.html|here] - it is quick and painless and best of all, Free. After you install the package and have your key, you can plugin your key value for your site in the Gmap preferences.
|
| -!!!Change the HTML Tag
|
| -This must be done to get polylines to render in IE. This rather sucks, but there is currently no way to change it via the package, so it must be done manually. Here is what you need to do. Copy kernel/templates/header.tpl to themes/force/header.tpl. In the new file then change the html tag to the following:
|
| -{code}<html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml">{/code}
|
| +!!Configuration |
| +You must obtain a Google Map API Key for your site. |
| +To use the package you need a key from Google. You can sign up for a key [http://www.google.com/apis/maps/signup.html|here] - it is quick and painless and best of all, Free. After you install the package and have your key, you can plugin your key value for your site in the Gmap admin preferences, which you can get to by going to http://yourbitweaversite/kernel/admin/. Or if you just point your browser to the gmap/ directory, while logged in as admin, you will get prompts how to do this. |
|
|
| -!!Summary of Current State of Development
|
| -All basic Google Map features are now fully supported and editable via a AJAX UI. Also, the best supplemental libraries to Google Maps have been introduced and many features are now integrated and editable. Gmap Package now supports the GxMarker and [http://www.pixeldevelopment.com/pdmarker.asp|PdMarker], and the [http://xmaps.busmonster.com/documentation.html|XMaps] library. Also 600+ free custom icon images, as [http://mapki.com/index.php?title=Icon_Image_Sets|listed here] are also included with the package. Additionally, the Marker infoWindow text now utilizes whatever default syntax is used on your bw install, in most cases this means the infoWindow text uses tikiwiki text formating.
|
| +__For non-required additional configuration tips see: ((GmapPackage Configuration Tips))__ |
|
|
| +!!Get The Code |
| You can get the latest version of the package by getting module _bit_gmap from bitweaver CVS.
|
|
|
| -Sometimes a proof of concept is working at [http://www.wjamesphoto.com/bw/gmap/index.php?gmap_id=1|this link]...if you find its not working, I am probably actively testing code changes. If so, you can find me on the bitweaver channel. But I will try to keep it working between changes. -wjames5
|
|
|
| -!!Some Known Bugs - if you find more add it here please
|
| -* If you change the name of a maptype and it is the default on a map, the map will break when it loads if you dont change the default name of the map. The map default maptype should be keyed to the maptype_id not its name
|
| -* The Icon style editing is buggy, both in adding new icon styles and in updating existing ones.
|
| -* New Marker Styles may not be updated menu options.
|
| -* Some characters, particularly in titles are not properly escaped before being Posted in an AJAX exchange.
|
| +!Development Roadmap |
| +!!Bugs |
| +* Content Browser Map - Category options list has duplicates. (NEED HELP) |
| +* Content Browser Map - Content in nested categories is not found when only ancestor is selected (NEED HELP) |
| +* Maptype/Tilelayer/Copyright updating after edit does not work - this is really a TODO -- you can store maptypes - just refresh the map to see the results. Basically the ajax callback does not work at the moment. |
|
|
| !!Next Steps
|
| -!!!Priority Goals
|
| -* __Create a bwGMap class to encapsulate all functions__
|
| -+ A mistake in not doing this in the first place, this is necessary to allow maps in blog and article posts, so that more than one map can be on a page. (as well as making the code clearer).
|
| -* Escape special characters etc for XML
|
| -* Plan for GMap v2 Upgrade
|
| -* Plan for Bitweaver R2 Upgrade
|
| +* backside functionality to browse Marker, polyline, and polygon styles exists, need ui to display info to user while editing overlays. |
| +* cache page requests - including all related data |
| +* stuff javascript |
| +* Polygon drawing assistant basically works - could be nicer |
| +* Create custom display of polys on Gmap Content Browser page |
| +* Create content page versions for Polylines, Polygons, that do not require loading the whole map. |
| +* Clean Up gmap css |
| +* Integrate GxMarker and [http://www.pixeldevelopment.com/pdmarker.asp|PdMarker]. |
|
|
| -!!!Long Term Goals
|
| -* Make auto map height possible
|
| -* Add comments support to markers (with R2)
|
| -* Resolve bugs in current editing features.
|
| -* Multiple instances of same Marker are not updated when changed
|
| -* Support both init Markers (markers that a plotted onload) and set Markers (markers that go into a menu but do not load on the map itself)
|
| -* Test editing UI in prior versions of Mozilla browsers
|
| -* Test editing UI in Safari 1.2.4+ (google maps is no compatible with lower versions)
|
| -* Engine does make use of z-index property of Markers - may remove this option from editing interface as it may be too complex for most users
|
| -* Support Wiki Syntax for text on the map page
|
| -* Get editing UI working Opera 8.5 - this moved to the end, because it may be unlikely
|
| +* Infinity and Beyond: see history below |
|
|
| +!!!Custom History |
| +History features would be for recording changes to gmap package specific data as well as displaying liberty history data. |
| +* Wire in access to Liberty History records |
| +* Map History |
| +* Marker History |
| +* Poly History |
| +!!Final Beta Prep |
| +* Test in various browsers |
|
|
| -!Features
|
| -The Gmap Package supports all the basic Google Map features, markers, infoWindow balloons, custom icons, and polylines. It also supports the best of the hacks that supplement the Google Maps API, GxMarker, PdMarker, XMaps, and custom map types. With all these features you can create great looking maps without writing a single line of javascript. And with its "Sets Model", the Gmap Package makes it easy to re-use map components, like marker styles, custom icons, polylines, etc, over and over on mulitple maps, i.e. create once, use infinately. More about the "Sets Model" is below.
|
| + |
| +!Extended Features Description |
| +Many basic Google Map features are now fully supported and editable via a AJAX UI. Also 600+ free custom icon images, as originally [http://mapki.com/index.php?title=Icon_Image_Sets|listed here] are also included with the package. Additionally, Marker infoWindow text can utilizes whatever text syntaxes your site supports. With all these features you can create great looking maps without writing a single line of javascript. And with its "Sets Model", the Gmap Package makes it easy to re-use map components, like marker styles, custom icons, polylines, etc, over and over on multiple maps, i.e. create once, use infinitely. More about the "Sets Model" is below. |
|
|
| The features of the package are supplemented by a bleeding edge AJAX editing interface. Almost all features of the map can be updated live, without a browser refresh.
|
|
|
| -!! About the AJAX Editing UI
|
| -The Gmap Package has a very robust AJAX based editing interface for live updating of map features. The editing UI and related AJAX transaction methods use the [http://mochikit.com|Mochkit] library. All references to Mochikit are currently contained in one file: gmap/templates/js_edit_methods.js in case Mochikit ever becomes unreliable, or is discovered to have any conflicts with native javascript.
|
| -
|
| -The editing interface is compatible with I.E. 6 and Firefox 1.5. and 1.0.7. The tools have been tested in Opera 8.5 but Opera is choking on a javascript process that copies data from an array into html forms.
|
| -
|
| +!!About the AJAX Editing UI |
| +The Gmap Package has a very robust AJAX based editing interface for live updating of map features. The editing UI and related AJAX transaction methods use the [http://mochikit.com|Mochkit] library. |
|
|
| !!Sets Model Framework
|
| The GmapPackage uses a sets model for associating markers, markericons, maptypes, polylines, polygons, and their styles with maps.
|