| {maketoc}
|
| -!This Package is in Early Development
|
| -This package helps you include Google Maps for your bitweaver site and helps you manage and share content across your maps. It is being designed like wiki to enable collaborative development of Google Maps.
|
| +!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. |
|
|
| -If you decide to test it out, note that updates are frequent, including database schema changes, so I wouldn't use it to build anything you want to keep at this point.
|
| +!Core Features: |
| +!!!Gmap Map Builder |
| +Creating Custom Google Maps with Custom Markers, Polylines, Polygons, and other features |
|
|
| -!!Special Installation Instructions
|
| -!!!Change the Directory Name
|
| -If you get the package from CVS it will come packaged in a dir named __map__. You must change it to __gmap__. A name change has been applied for to Sourceforge.
|
| -!!!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}
|
| +!!!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. |
|
|
| -!!Summary of Current State of Development
|
| +!!!Gmap Content Browser |
| +A universal map interface for searching for bitweaver geo located content (like pages, articles, users) and viewing it on the map. |
|
|
| -Due to [http://blog.metawrap.com/blog/PermaLink,guid,42b961d5-b539-4d9a-b1e0-108e546ae3e6.aspx|this issue with Prototype], Prototype dependance is being written __out__ of the Gmap package. This is the leading priority, and no development on other features will be ventured until this is complete.
|
|
|
| -Otherwise, the most important map component pieces are in place and ungoing testing. These include, map, marker, polyline, and map type editing. Styles for these are secondary and will come soon. 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. This is a bit strange as the marker editing UI and Polyline editing UI are nearly identical.
|
| +!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__. |
|
|
| -__Next is to implement AJAX UI for creation and editing for:__
|
| -* Markers __(done)__
|
| -* Marker Sets __(done)__
|
| -* Marker Styles
|
| -* Icon Styles
|
| -* Polylines __(done)__
|
| -* Polyline Sets __(done)__
|
| -* Polyline Styles
|
| -* Map Types __(done)__
|
| +__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. |
|
|
| -!!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
|
| -* There is some buggyness with Polyline rendering and it may be symptomatic of something else.
|
| +!!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))__ |
|
|
| -!!Other Next Steps
|
| -!!!Short Term Goals
|
| -* Get editing UI working Opera 8.5
|
| -* 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)
|
| -* Resolve bugs in current editing features.
|
| -** Multiple instances of same Marker are not updated when changed
|
| -** Engine does make use of z-index property of Markers
|
| -* 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)
|
| -* Wiki Syntax for all text
|
| -* Escape special characters etc for XML
|
| +!!Get The Code |
| +You can get the latest version of the package by getting module _bit_gmap from bitweaver CVS. |
|
|
| -!!!Long Term Goals
|
| -* Make auto map height possible
|
| -* Integrate other hack libraries (see map hacks below)
|
| -* Wikify the map and markers
|
|
|
| -Also note:
|
| -The core AJAX functions and the editing UI in the package have been rewritten utilizing the AJAX [http://prototype.conio.net/|Prototype] library. The Prototype library is to be used in the development of all other AJAX features.
|
| +!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. |
|
|
| -You can get the latest version of the package by getting module _bit_map from bitweaver CVS.
|
| +!!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]. |
|
|
| -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
|
| +* 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 |
|
|
| -!!Some Stumbling Blocks
|
| -* How to create admin features like the API key Spiderr put in.
|
| -* How to define features that get using like:
|
| -+ {code}$gBitSystem->isFeatureActive( 'feature_listMaps' ){/code}
|
| -* How to get Preference options set in Schema to show up as options in the package admin panel
|
|
|
| -!!Framework
|
| +!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. |
| + |
| +!!Sets Model Framework |
| The GmapPackage uses a sets model for associating markers, markericons, maptypes, polylines, polygons, and their styles with maps.
|
|
|
| Through the use of various keychains, each object may be associated with many maps, many sets of obejcts, and many styles. Each map has a key chain which associates it with sets of markers, maptypes, polylines, and polygons. Marker Sets, Polyline Sets, and Polygon Sets in turn each have individual objects as well as styles with which they are associated. The reason for this is multifold.
|