| {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. The service feature is also wired into other bitweaver content for easy geo locating of wiki pages, blog posts, articles, etc. 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.
|
| +!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. |
|
|
| -!!A Note about the R1 Version of GmapPackage
|
| -^__IMPORTANT:__ Google closed V1 of their API in early November 2006. At this time there is no plan to migrate the R1 version of the Gmap Package to V2 of the API. This means the R1 version is currently dead and abandon.^
|
| +!Core Features: |
| +!!!Gmap Map Builder |
| +Creating Custom Google Maps with Custom Markers, Polylines, Polygons, and other features |
|
|
| -!!Core Features:
|
| -* Gmap Map Builder
|
| -+ Creating Custom Google Maps with Custom Markers and other features
|
| -* 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.
|
| -* Gmap Content Browser
|
| -+ A universal map interface for searching for bitweaver cms geo located content (like pages, articles, users) and viewing it on the map.
|
| +!!!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. |
|
|
| -!!State of Development of Core Features
|
| -*Gmap Map Builder
|
| -** Map Properties Editor
|
| -++ Stable with only minor bugs.
|
| -** Markers Editor
|
| -++ Stable with only minor UI bugs
|
| -** Marker Styles and Marker Icons Editors
|
| -++ Core functionality is in place but very buggy. Not usable in its current state
|
| -** Polylines Editor
|
| -++ Core functionality is in place but very buggy. Not usable in its current state
|
| -** Poligons Editor
|
| -++ Needs complete overhaul. Xmaps dependency must be removed and schema redefined for use with official Poligons API.
|
| -* Gmap Service
|
| -+ Stable. 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
|
| -+ Stable with only minor 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 Content Browser |
| +A universal map interface for searching for bitweaver geo located content (like pages, articles, users) and viewing it on the map. |
|
|
| -!!Special Installation 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 or test the GmapPackage.
|
|
|
| -!!!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/.
|
| +!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__. |
|
|
| -!!!Get The Code
|
| +__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. |
| + |
| +!!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. |
| + |
| +__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.
|
|
|
|
|
| -!!Development Roadmap
|
| -!!!Priority Goals
|
| -* Clean up Marker Styles and Icon Styles support
|
| -* Clean up Polylines support
|
| -* Debug minor layout issues
|
| -* Overhaul Polygons support
|
| +!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. |
|
|
| -!!!Long Term Goals
|
| -* Make auto map height possible
|
| -* Add comments and stars support to markers
|
| -* Resolve bugs in current editing features.
|
| -* 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 various browsers
|
| +!!Next Steps |
| +* 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]. |
|
|
| -!!Extended Features Descriptions
|
| -Many basic Google Map features are now fully supported and editable via a AJAX UI. When R2 is complete, the best supplemental libraries to Google Maps will be integrated and editable. Gmap Package will support the GxMarker and [http://www.pixeldevelopment.com/pdmarker.asp|PdMarker]. 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 default syntax is used on your bw install, in most cases this means the infoWindow text uses tikiwiki text formatting. 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.
|
| +* 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 |
| + |
| + |
| +!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
|
| +!!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
|