My favorites | Sign in
Project Logo
                
New issue | Search
for
| Advanced search | Search tips
Issue 13: Basic documentation needed
1 person starred this issue and may be notified of changes. Back to list
Status:  Accepted
Owner:  ----
Type-Defect
Priority-Medium


Sign in to add a comment
 
Reported by roger.moffatt, Jul 16, 2009
This is a really useful project,especially because it does (amongst lots of 
other useful things) the one thing the google parser won't - ie placemarker 
links opening in the SAME page -  but it has taken me over 8 hours to get 
on top of it due the frustrating lack of documentation or basic examples 
with explanations.

This doesn't need to be long, but the essentials needed are;

1) The simplest example showing how to parse an external kml file using 
geoxml rather than GGeoxml which most users will be replacing. The 3rd 
party samples linked to from your site are unfortunately not really 
suitable as tutorial material.

2) Details on the options that are possible. I've had had to beautify the 
compressed script (which has no copyright information by the way, you might 
want to address that for the next release) and pour over the code just to 
find out basic information on how to style infowindow names. It needn't be 
this hard!

3) Ideally you would release a version that doesn't clash with jQuery's use 
of $. I know there are workarounds, but none are very satisfactory when you 
have perhaps 20 or 30 libraries in use. jQuery is probably the most popular 
framework out there and clashing with it isn't good for uptake of geoxml.

I stress it's a GREAT piece of work, but I'm sure the author could pull 
together the documentation that is needed in less than an hour and save 
countless programmers days of frustration as a result ;-)


Comment 1 by lancealandyas, Jul 28, 2009
Uncompressed code is available on the source tab file name geoxmlfull.js
http://geoxml.googlecode.com/svn/trunk/

Documentation in full... is hours and hours of work, do not underestimate.
The starting point might be emulating the EGeoXml documentation content and diverging it (making sure where 
all the differences are - there are certainly more than a few now). 

I could add you to the commiters list so you can add basica to the Wiki?
Sign in to add a comment

Hosted by Google Code