<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
<title></title>
</head>
<body bgcolor="#ffffff" text="#000000">
Hi all,<br>
<br>
I played a bit with joDoc and came up with this:<br>
<a
href="http://mapquery.geodan.nl/jquery.mapquery.core.js.html#MapQuery.Core">http://mapquery.geodan.nl/jquery.mapquery.core.js.html</a><br>
based on<br>
<a
href="https://github.com/stvno/mapquery/blob/master/src/jquery.mapquery.core.js">https://github.com/stvno/mapquery/blob/master/src/jquery.mapquery.core.js</a><br>
<br>
I've take inspiration from jQuery API docs and polymaps <a
href="http://polymaps.org/docs/map.html">http://polymaps.org/docs/map.html</a>
The current stylesheet is the default joDoc one and obviously needs
a bit of love to make the docs more readable. Also I would like to
autogenerate internal hyperlink (similar to the once on top of the
polymaps link).<br>
<br>
And last but not least I'm having troubles with layer options like
types. We do want to put them somewhere, but the current position
isn't very nice.<br>
<br>
Please have a look and give feedback<br>
<br>
Regards,<br>
Steven<br>
<br>
<br>
On 6/30/2011 5:25 PM, Steven M. Ottens wrote:
<blockquote cite="mid:4E0C9552.3050707@minst.net" type="cite">
<meta http-equiv="content-type" content="text/html;
charset=ISO-8859-1">
Hi all,<br>
<br>
I've finished adding new widgets to MapQuery for the moment. I
created examples for all the widgets (except for mqLayerControl).
We now have the proposed list for the 0.1 release:<br>
<pre wrap="">-zoombuttons
-zoomslider
-overviewmap
-layercontrol (in this case mqLayerManager)
-popup with (get)featureinfo
+mouseposition
</pre>
I'd like to leave mqLayerControl outside a possible first release
since it's pretty much the same as mqLayerManager, but hasn't
gotten much love and is a bit old fashioned (eg doesn't listen to
most events). Since mqLayerManager and mqLayerControl are so much
the same we might want to merge them in the future, eg make it
possible to enable/disable certain features of the mqLayerManager.<br>
<br>
The main issue now is: we need documentation. I prefer to generate
most of the API docs from code. Which means we need to put it in
some kind of format and have a system to generate a nice set of
HTML files. Volker mentioned two systems:<br>
-docco: <a moz-do-not-send="true"
href="http://jashkenas.github.com/docco/">http://jashkenas.github.com/docco/</a><br>
-joDoc: <a moz-do-not-send="true"
href="https://github.com/davebalmer/joDoc">https://github.com/davebalmer/joDoc/</a><br>
<br>
So the questions are:<br>
-Have people used other systems to generate docs for javascript?<br>
-Any preferences?<br>
-Do the current widgets and examples make sense?<br>
-Is something vital missing?<br>
-Anyone time to write docs?<br>
-Anyone time to write tests?<br>
<br>
regards,<br>
Steven<br>
<br>
ps. I've got an ubuntu server which we can use for the moment to
generate and host docs and 'autobuilds' until someone figured out
how to do this on github itself. So any system should run ubuntu
(10.04 LTS) without too much hassle at least.<br>
<br>
<pre wrap="">
<fieldset class="mimeAttachmentHeader"></fieldset>
_______________________________________________
MapQuery mailing list
<a class="moz-txt-link-abbreviated" href="mailto:MapQuery@lists.osgeo.org">MapQuery@lists.osgeo.org</a>
<a class="moz-txt-link-freetext" href="http://lists.osgeo.org/mailman/listinfo/mapquery">http://lists.osgeo.org/mailman/listinfo/mapquery</a>
</pre>
</blockquote>
<br>
</body>
</html>