[OpenLayers-Dev] best practices in examples

Tim Schaub tschaub at opengeo.org
Thu Sep 16 16:45:03 EDT 2010


Hey-

We've gotten feedback over the last couple years about our examples 
generating a bit of confusion.  Because, in general, we add to and do 
not modify examples, we are not necessarily demonstrating best-practices 
use of OpenLayers.

In addition to getting rid of examples that demonstrate the use of 
deprecated code, I think we should update existing examples in a couple 
ways.  These are minor, but I think we should (at least) do the following:

* use <!DOCTYPE html> (xhtml is dead)
* remove superfluous "/" attributes on elements that don't need a 
closing tag (i.e. void elements like <br>, <link>, <img>, and <input> 
don't have a closing tag)
* include script tags at the end of the body

Nothing urgent about this, but if folks want to provide patches for the 
current example set, your contributions are welcome.

http://trac.osgeo.org/openlayers/wiki/CodingStandards#WritingExamples

Feedback welcome.
Tim

-- 
Tim Schaub
OpenGeo - http://opengeo.org
Expert service straight from the developers.


More information about the Dev mailing list