2009/4/11 Jody Garnett wrote: > Good Morning Michael (and user list): >
Evening Boss, > Here is the problem; many of the technical problems (say missing > imports etc...) were not actually out of date - in the svn repository. > As such I need a way to ask people to grab the demo source code from > svn; while still having useful code examples to talk about. This > current technique of providing all the steps needed is not working out > that well from a frustration point of view. I think it would help if the code examples and svn links pointed to the most recent, stable version of GeoTools rather than trunk, except on pages that were specifically discussing a new facility. > 1) Runnable code examples out of svn > > Another example of how to do this is present here: > - http://www.eclipse.org/swt/snippets/ > > This is a single page with links to working code examples on each > topic. Each code example is sure to work (since it is right from svn). > This is *much* easier to maintain; but will miss the ability to > explain (except in comments?). That's an effective way to present things - but possibly more useful for users with some GeoTools experience already under their belt. For those new to GeoTools, or to some major part of it, I think that the panels of code with clear notes supporting them are valuable. > Another example of how to do this is presented here: > - http://docs.codehaus.org/display/GEOTDOC/Feature+Model+Guide > > My understanding is this is how google maps provides its examples. I > really find this helpful when you can cut and paste the code example > in; and read the javadocs for all the class / method definitions in > your IDE tooltips. However as people are fond of pointing out it is > very hard to get your imports right. IDEs help, but I suppose there is still room for confusion with similarly named classes in the library. And it would probably be tedious for both authors and readers to try to preface each page with the required imports. > 3) Suggestions > > I am also open to suggestions. > More demo programs would be nice to have. I'm thinking particularly about small, self-contained ones along the lines of the snippets page. Perhaps a crop of these could be grown over time by modifying some of the unit testing code that is already there ? Is there any way that we could mine the user list more effectively ? You know how some forums have "pinned" topics or a gems page with links to useful discussions and code examples that have been posted. If you think that the codehaus procedures are inhibiting people from contributing to the wiki perhaps it would be possible to host that part of the site elsewhere ? I'll mull over these things further and hope for more inspiration. Michael ------------------------------------------------------------------------------ This SF.net email is sponsored by: High Quality Requirements in a Collaborative Environment. Download a free trial of Rational Requirements Composer Now! http://p.sf.net/sfu/www-ibm-com _______________________________________________ Geotools-gt2-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/geotools-gt2-users
